IPageable Interface Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Provides paging functionality for a data reader or a collection that supports paging.

Namespace: ContentStudio
Assembly: CS5Interfaces (in CS5Interfaces.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

public interface IPageable

The IPageable type exposes the following members.

Properties

  NameDescription
Public propertyPageNumber
Gets a value that identifies which page of results found. The first page is 1.
Public propertyPageSize
Gets a value that identifies the maximum number of objects that can be returned on a page.
Public propertyTotalItems
Gets the total number of items found.
Public propertyTotalPages
Gets the total number of pages.
Top
Methods

  NameDescription
Public methodRead
Navigates the reader to the next page.
Public methodReadPage
Navigates the reader to a specific page.
Top
Remarks

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.

See Also

Reference