[This is preliminary documentation and is subject to change.]
Namespace: ContentStudio
Assembly: CS5Interfaces (in CS5Interfaces.dll) Version: 1.0.0.0 (1.0.0.0)
The IPageable type exposes the following members.
Name | Description | |
---|---|---|
PageNumber |
Gets a value that identifies which page of results found. The
first page is 1.
| |
PageSize |
Gets a value that identifies the maximum number of objects that
can be returned on a page.
| |
TotalItems |
Gets the total number of items found.
| |
TotalPages |
Gets the total number of pages.
|
Name | Description | |
---|---|---|
Read |
Navigates the reader to the next page.
| |
ReadPage |
Navigates the reader to a specific page.
|
IPageable can be implemented by data collection classes that need to expose paging functionality. Collections that implements IPageable can, but are not obliged to, implement functionality to calculate the total number of data items found as well as the total number of data pages that one is expected to find.
It is not possible to determine TotalPages and TotalItems before any data is read. These properties should be initialized to -1 to denote that they are not yet available.