Class
BookPagedCollectionView

Provides paging functionality for RadBook.

Definition

Namespace:Telerik.Windows.Controls.Book

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

cs-api-definition
[SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")]
public class BookPagedCollectionView : IPagedCollectionView, IEnumerable, INotifyPropertyChanged

Inheritance: objectBookPagedCollectionView

Implements: IEnumerableINotifyPropertyChangedIPagedCollectionView

Constructors

BookPagedCollectionView(RadBook)

Initializes a new instance of the BookPagedCollectionView class.

Declaration

cs-api-definition
public BookPagedCollectionView(RadBook owner)

Parameters

owner

RadBook

The owner.

Properties

CanChangePage

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

Declaration

cs-api-definition
public bool CanChangePage { get; }

Property Value

bool

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

Implements IPagedCollectionView.CanChangePage

IsPageChanging

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

Declaration

cs-api-definition
public bool IsPageChanging { get; }

Property Value

bool

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

Implements IPagedCollectionView.IsPageChanging

ItemCount

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

Declaration

cs-api-definition
public int ItemCount { get; }

Property Value

int

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

Implements IPagedCollectionView.ItemCount

PageIndex

Gets the zero-based index of the current page.

Declaration

cs-api-definition
public int PageIndex { get; }

Property Value

int

The zero-based index of the current page.

Implements IPagedCollectionView.PageIndex

PageSize

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

Declaration

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

Property Value

int

The number of items to display on a page.

Implements IPagedCollectionView.PageSize

TotalItemCount

Gets the total number of items in the source collection.

Declaration

cs-api-definition
public int TotalItemCount { get; }

Property Value

int

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

Implements IPagedCollectionView.TotalItemCount

Methods

GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration

cs-api-definition
public IEnumerator GetEnumerator()

Returns

IEnumerator

An IEnumerator object that can be used to iterate through the collection.

Implements IEnumerable.GetEnumerator()

MoveToFirstPage()

Sets the first page as the current page.

Declaration

cs-api-definition
public bool MoveToFirstPage()

Returns

bool

Implements IPagedCollectionView.MoveToFirstPage()

MoveToLastPage()

Sets the last page as the current page.

Declaration

cs-api-definition
public bool MoveToLastPage()

Returns

bool

Implements IPagedCollectionView.MoveToLastPage()

MoveToNextPage()

Moves to the page after the current page.

Declaration

cs-api-definition
public bool MoveToNextPage()

Returns

bool

Implements IPagedCollectionView.MoveToNextPage()

MoveToPage(int)

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

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Usage", "CA2233:OperationsShouldNotOverflow", MessageId = "pageIndex*2")]
public bool MoveToPage(int pageIndex)

Parameters

pageIndex

int

The index of the page to move to.

Returns

bool

Implements IPagedCollectionView.MoveToPage(int)

MoveToPreviousPage()

Moves to the page before the current page.

Declaration

cs-api-definition
public bool MoveToPreviousPage()

Returns

bool

Implements IPagedCollectionView.MoveToPreviousPage()

Events

PageChanged

Occurs when page has changed.

Declaration

cs-api-definition
public event EventHandler<EventArgs> PageChanged

Event Value

EventHandler<EventArgs>

Implements IPagedCollectionView.PageChanged

PageChanging

Occurs when a page is changing.

Declaration

cs-api-definition
public event EventHandler<PageChangingEventArgs> PageChanging

Event Value

EventHandler<PageChangingEventArgs>

Implements IPagedCollectionView.PageChanging

PropertyChanged

Occurs when a property has changed value.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged