DataPager Class
Assembly: Qlik.Engine.dll
A class providing a paging interface for a pageable structure.
Inheritance
-
System.Object
- DataPager
Syntax
public abstract class DataPager : IDisposable, IChangeNotifierConstructors
| Name | Description |
|---|---|
| DataPager(GenericObject, String) |
Creates an interface for a pageable structure. |
Fields
| Name | Description |
|---|---|
| DefaultPageHeight |
The default page height to use if no current page is defined. |
| DefaultPageWidth |
The default page width to use if no current page is defined. |
| Path |
The property path to the pageable structure that the data pager provides an interface for. |
Properties
| Name | Description |
|---|---|
| AtEdge |
Returns true for all pages that are at the edge of the data table. |
| AtEdgeBottom |
Returns true for all pages that are at the bottom edge of the data table. |
| AtEdgeLeft |
Returns true for all pages that are at the left edge of the data table. |
| AtEdgeRight |
Returns true for all pages that are at the right edge of the data table. |
| AtEdgeTop |
Returns true for all pages that are at the top edge of the data table. |
| CurrentPages |
The current set of pages. |
| NumberOfColumns |
The total number of columns in the data table. |
| NumberOfRows |
The total number of rows in the data table. |
| OutsideEdge |
Returns true for all pages that are completely outside the edge of the data table. |
Methods
| Name | Description |
|---|---|
| Dispose() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| Dispose(Boolean) |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| GetAllData(NxPage) |
Get all data from pager using the argument as initial page for iteration. |
| GetAllData(Int32) |
Get all data from pager starting from row 0 with page size width set to NumberOfColumns. Equivalent to: |
| GetCurrentPagesAsync() |
The current set of pages. |
| GetData() |
Returns data for CurrentPages. |
| GetData(IEnumerable<NxPage>) |
Returns data for the argument pages, or from CurrentPages if page argument is null. Moves CurrentPages to the argument pages. |
| GetData(Func<IEnumerable<NxPage>, IEnumerable<NxPage>>) |
Moves CurrentPages according to transform and returns data from the resulting pages. |
| GetDataAsync() |
Returns data for CurrentPages. |
| GetDataAsync(AsyncHandle) |
Returns data for CurrentPages. |
| GetDataAsync(AsyncHandle, IEnumerable<NxPage>) |
Returns data for the argument pages, or from CurrentPages if page argument is null. Moves CurrentPages to the argument pages. |
| GetDataAsync(AsyncHandle, Func<IEnumerable<NxPage>, IEnumerable<NxPage>>) |
Moves CurrentPages according to transform and returns data from the resulting pages. |
| GetDataAsync(GenericObject, AsyncHandle, String, IEnumerable<NxPage>) |
Returns data from the pageable structure. |
| GetDataAsync(IEnumerable<NxPage>) |
Returns data for the argument pages, or from CurrentPages if page argument is null. Moves CurrentPages to the argument pages. |
| GetDataAsync(Func<IEnumerable<NxPage>, IEnumerable<NxPage>>) |
Moves CurrentPages according to transform and returns data from the resulting pages. |
| GetFirstPage() |
Moves CurrentPages to the first page and returns the data. |
| GetFirstPageAsync() |
Moves CurrentPages to the first page and returns the data. |
| GetFirstPageAsync(AsyncHandle) |
Moves CurrentPages to the first page and returns the data. |
| GetInitialData() |
Returns data as defined by the InitialDataFetch setting. |
| GetInitialDataAsync() |
Returns data as defined by the InitialDataFetch setting. |
| GetLastPage() |
Moves CurrentPages to the last page and returns the data. |
| GetLastPageAsync() |
Moves CurrentPages to the last page and returns the data. |
| GetLastPageAsync(AsyncHandle) |
Moves CurrentPages to the last page and returns the data. |
| GetNextPage() |
Moves CurrentPages to the next page and returns the data. |
| GetNextPageAsync() |
Moves CurrentPages to the next page and returns the data. |
| GetNextPageAsync(AsyncHandle) |
Moves CurrentPages to the next page and returns the data. |
| GetPreviousPage() |
Moves CurrentPages to the previous page and returns the data. |
| GetPreviousPageAsync() |
Move CurrentPages to the previous page and returns the data. |
| GetPreviousPageAsync(AsyncHandle) |
Moves CurrentPages to the previous page and returns the data. |
| IteratePages(IEnumerable<NxPage>, Func<IEnumerable<NxPage>, IEnumerable<NxPage>>) |
Iterates through pages by repeatedly applying the argument transform and returning the data. Application is performed until an iteration moves all pages outside the edge of the table. |
| IteratePagesAsync(AsyncHandle, IEnumerable<NxPage>, Func<IEnumerable<NxPage>, IEnumerable<NxPage>>) |
Iterates through pages by repeatedly applying the argument transform and returning the data. Application is performed until an iteration moves all pages outside the edge of the table. |
| IteratePagesAsync(IEnumerable<NxPage>, Func<IEnumerable<NxPage>, IEnumerable<NxPage>>) |
Iterates through pages by repeatedly applying the argument transform and returning the data. Application is performed until an iteration moves all pages outside the edge of the table. |
| MoveCurrentPages(Func<IEnumerable<NxPage>, IEnumerable<NxPage>>) |
Moves CurrentPages according to transform without getting data. |
| OnChanged() |
Invokes the Changed event. |
Events
| Name | Description |
|---|---|
| Changed |
This event fires either when the CurrentPages changes, or the generic object the pager observes notifies a change. |
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!