Interface
IPagedCollectionView

Provides paging functionality for a collection view.

Definition

Namespace:Telerik.Windows.Data

Assembly:Telerik.Windows.Data.dll

Syntax:

cs-api-definition
public interface IPagedCollectionView

Properties

CanChangePage

Gets a value that indicates whether the PageIndex value is allowed to change.

Declaration

cs-api-definition
bool CanChangePage { get; }

Property Value

bool

true if the PageIndex value is allowed to change; otherwise, false.

IsPageChanging

Gets a value that indicates whether a page index change is in process.

Declaration

cs-api-definition
bool IsPageChanging { get; }

Property Value

bool

true if the page index is changing; otherwise, false.

ItemCount

Gets the minimum number of items known to be in the source collection.

Declaration

cs-api-definition
int ItemCount { get; }

Property Value

int

The minimum number of items known to be in the source collection.

PageIndex

Gets the zero-based index of the current page.

Declaration

cs-api-definition
int PageIndex { get; }

Property Value

int

The zero-based index of the current page.

PageSize

Gets or sets the number of items to display on a page.

Declaration

cs-api-definition
int PageSize { get; set; }

Property Value

int

The number of items to display on a page.

TotalItemCount

Gets the total number of items in the source collection.

Declaration

cs-api-definition
int TotalItemCount { get; }

Property Value

int

The total number of items in the source collection, or -1 if the total number is unknown.

Methods

MoveToFirstPage()

Sets the first page as the current page.

Declaration

cs-api-definition
bool MoveToFirstPage()

Returns

bool

true if the operation was successful; otherwise, false.

MoveToLastPage()

Sets the last page as the current page.

Declaration

cs-api-definition
bool MoveToLastPage()

Returns

bool

true if the operation was successful; otherwise, false.

MoveToNextPage()

Moves to the page after the current page.

Declaration

cs-api-definition
bool MoveToNextPage()

Returns

bool

true if the operation was successful; otherwise, false.

MoveToPage(int)

Requests a page move to the page at the specified index.

Declaration

cs-api-definition
bool MoveToPage(int pageIndex)

Parameters

pageIndex

int

The index of the page to move to.

Returns

bool

true if the operation was successful; otherwise, false.

MoveToPreviousPage()

Moves to the page before the current page.

Declaration

cs-api-definition
bool MoveToPreviousPage()

Returns

bool

true if the operation was successful; otherwise, false.

Events

PageChanged

Occurs when the PageIndex has changed.

Declaration

cs-api-definition
event EventHandler<EventArgs> PageChanged

Event Value

EventHandler<EventArgs>

PageChanging

Occurs when the PageIndex is changing.

Declaration

cs-api-definition
event EventHandler<PageChangingEventArgs> PageChanging

Event Value

EventHandler<PageChangingEventArgs>