Class RadDataPager

Provides a user interface for paging through a collection of data.

Inheritance

System.Object

RadDataPager

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.Data.dll

Syntax

[TelerikToolboxCategory("Data")]
public class RadDataPager : Control, IThemable

Constructors

RadDataPager()

Initializes a new instance of the RadDataPager class.

Declaration

public RadDataPager()

Fields

AutoEllipsisModeProperty

Identifies the AutoEllipsisMode dependency property.

Declaration

public static readonly DependencyProperty AutoEllipsisModeProperty

Field Value

System.Windows.DependencyProperty

CanChangePageProperty

Identifies the CanChangePage dependency property.

Declaration

public static readonly DependencyProperty CanChangePageProperty

Field Value

System.Windows.DependencyProperty The identifier for the CanChangePage dependency property.

CanMoveToFirstPageProperty

Identifies the CanMoveToFirstPage dependency property.

Declaration

public static readonly DependencyProperty CanMoveToFirstPageProperty

Field Value

System.Windows.DependencyProperty The identifier for the CanMoveToFirstPage dependency property.

CanMoveToLastPageProperty

Identifies the CanMoveToLastPage dependency property.

Declaration

public static readonly DependencyProperty CanMoveToLastPageProperty

Field Value

System.Windows.DependencyProperty The identifier for the CanMoveToLastPage dependency property.

CanMoveToNextPageProperty

Identifies the CanMoveToNextPage dependency property.

Declaration

public static readonly DependencyProperty CanMoveToNextPageProperty

Field Value

System.Windows.DependencyProperty The identifier for the CanMoveToNextPage dependency property.

CanMoveToPreviousPageProperty

Identifies the CanMoveToPreviousPage dependency property.

Declaration

public static readonly DependencyProperty CanMoveToPreviousPageProperty

Field Value

System.Windows.DependencyProperty The identifier for the CanMoveToPreviousPage dependency property.

DisplayModeProperty

Identifies the DisplayMode dependency property.

Declaration

public static readonly DependencyProperty DisplayModeProperty

Field Value

System.Windows.DependencyProperty

IsTotalItemCountFixedProperty

Identifies the IsTotalItemCountFixed dependency property.

Declaration

public static readonly DependencyProperty IsTotalItemCountFixedProperty

Field Value

System.Windows.DependencyProperty

ItemCountProperty

Identifies the ItemCount dependency property.

Declaration

public static readonly DependencyProperty ItemCountProperty

Field Value

System.Windows.DependencyProperty

NumericButtonCountProperty

Identifies the NumericButtonCount dependency property.

Declaration

public static readonly DependencyProperty NumericButtonCountProperty

Field Value

System.Windows.DependencyProperty

NumericButtonStyleProperty

Identifies the NumericButtonStyle dependency property.

Declaration

public static readonly DependencyProperty NumericButtonStyleProperty

Field Value

System.Windows.DependencyProperty

PageCountProperty

Identifies the PageCount dependency property.

Declaration

public static readonly DependencyProperty PageCountProperty

Field Value

System.Windows.DependencyProperty

PagedSourceProperty

Identifies the PagedSource dependency property.

Declaration

public static readonly DependencyProperty PagedSourceProperty

Field Value

System.Windows.DependencyProperty

PageIndexProperty

Identifies the PageIndex dependency property.

Declaration

public static readonly DependencyProperty PageIndexProperty

Field Value

System.Windows.DependencyProperty

PageSizeProperty

Identifies the PageSize dependency property.

Declaration

public static readonly DependencyProperty PageSizeProperty

Field Value

System.Windows.DependencyProperty

SourceProperty

Identifies the Source dependency property.

Declaration

public static readonly DependencyProperty SourceProperty

Field Value

System.Windows.DependencyProperty

TextBoxStyleProperty

Identifies the TextBoxStyle dependency property.

Declaration

public static readonly DependencyProperty TextBoxStyleProperty

Field Value

System.Windows.DependencyProperty

Properties

AutoEllipsisMode

Gets or sets a value indicating whether ellipsis will be shown.

Declaration

public AutoEllipsisModes AutoEllipsisMode { get; set; }

Property Value

AutoEllipsisModes

CanChangePage

Gets a value that indicates whether the user can move to another page.

Declaration

public bool CanChangePage { get; }

Property Value

System.Boolean `true` if this user can move to another page; otherwise, `false`.

CanMoveToFirstPage

Gets a value that indicates whether the user can move to the first page.

Declaration

public bool CanMoveToFirstPage { get; }

Property Value

System.Boolean `true` if this user can move to the first page; otherwise, `false`.

CanMoveToLastPage

Gets a value that indicates whether the user can move to the last page.

Declaration

public bool CanMoveToLastPage { get; }

Property Value

System.Boolean `true` if this user can move to the last page; otherwise, `false`.

CanMoveToNextPage

Gets a value that indicates whether the user can move to the next page.

Declaration

public bool CanMoveToNextPage { get; }

Property Value

System.Boolean `true` if this user can move to the next page; otherwise, `false`.

CanMoveToPreviousPage

Gets a value that indicates whether the user can move to the previous page.

Declaration

public bool CanMoveToPreviousPage { get; }

Property Value

System.Boolean `true` if this user can move to the previous page; otherwise, `false`.

DisplayMode

Gets or sets the pager display mode.

Declaration

public PagerDisplayModes DisplayMode { get; set; }

Property Value

PagerDisplayModes The pager display mode.

IsTotalItemCountFixed

Gets or sets a value that indicates whether or not the total number of items in the collection is fixed.

Declaration

public bool IsTotalItemCountFixed { get; set; }

Property Value

System.Boolean `true` if the total item count fixed; otherwise, `false`.

ItemCount

Gets or sets the current number of known items in the System.ComponentModel.IPagedCollectionView.

Declaration

public int ItemCount { get; set; }

Property Value

System.Int32 The item count.

NumericButtonCount

Gets or sets the numeric button count.

Declaration

public int NumericButtonCount { get; set; }

Property Value

System.Int32 The numeric button count.

NumericButtonStyle

Gets or sets the numeric and ellipsis buttons style.

Declaration

public Style NumericButtonStyle { get; set; }

Property Value

System.Windows.Style The numeric button style.

PageCount

Gets the current number of pages in the System.ComponentModel.IPagedCollectionView.

Declaration

public int PageCount { get; }

Property Value

System.Int32 The page count.

PagedSource

Gets the paged source.

Declaration

public IPagedCollectionView PagedSource { get; }

Property Value

IPagedCollectionView The paged source.

Remarks

Binding the ItemsSource property of an ItemsControl to the PagedSource property will enable paging for this control through RadDataPager.

PageIndex

Gets or sets the current System.ComponentModel.IPagedCollectionView.PageIndex in the System.ComponentModel.IPagedCollectionView .

Declaration

public int PageIndex { get; set; }

Property Value

System.Int32 The index of the page.

PageSize

Gets or sets the current System.ComponentModel.IPagedCollectionView.PageSize in the System.ComponentModel.IPagedCollectionView .

Declaration

public int PageSize { get; set; }

Property Value

System.Int32 The page size.

Source

Gets or sets the data collection that the RadDataPager controls paging for.

Declaration

public IEnumerable Source { get; set; }

Property Value

System.Collections.IEnumerable The data collection associated with this pager control.

TextBoxStyle

Gets or sets the page text box style.

Declaration

public Style TextBoxStyle { get; set; }

Property Value

System.Windows.Style The page text box style.

Methods

BeginInit()

Starts the initialization process for this element.

Declaration

public override void BeginInit()

EndInit()

Indicates that the initialization process for the element is complete.

Declaration

public override void EndInit()

Exceptions

System.InvalidOperationException System.Windows.FrameworkElement.EndInit was called without System.Windows.FrameworkElement.BeginInit having previously been called on the element.

MoveToFirstPage()

Sets the first page as the current page.

Declaration

public bool MoveToFirstPage()

Returns

System.Boolean `true` if this operation was successful; otherwise, `false`.

MoveToLastPage()

Sets the last page as the current page.

Declaration

public bool MoveToLastPage()

Returns

System.Boolean `true` if this operation was successful; otherwise, `false`.

MoveToNextPage()

Moves to the page after the current page.

Declaration

public bool MoveToNextPage()

Returns

System.Boolean `true` if this operation was successful; otherwise, `false`.

MoveToPage(Int32)

Moves to the page at the specified index.

Declaration

public bool MoveToPage(int pageIndex)

Parameters

System.Int32 pageIndex The index of the page to move to.

Returns

System.Boolean `true` if this operation was successful; otherwise, `false`.

MoveToPreviousPage()

Moves to the page before the current page.

Declaration

public bool MoveToPreviousPage()

Returns

System.Boolean `true` if this operation was successful; otherwise, `false`.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration

public override void OnApplyTemplate()

OnCreateAutomationPeer()

When implemented in a derived class, returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Silverlight automation infrastructure.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer The class-specific System.Windows.Automation.Peers.AutomationPeer subclass to return.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

System.EventArgs e The System.Windows.RoutedEventArgs that contains the event data.

OnPageIndexChanged(PageIndexChangedEventArgs)

Raises the PageIndexChanged event.

Declaration

protected virtual void OnPageIndexChanged(PageIndexChangedEventArgs args)

Parameters

PageIndexChangedEventArgs args The PageIndexChangedEventArgs instance containing the event data.

OnPageIndexChanging(PageIndexChangingEventArgs)

Raises the PageIndexChanging event.

Declaration

protected virtual void OnPageIndexChanging(PageIndexChangingEventArgs args)

Parameters

PageIndexChangingEventArgs args The PageIndexChangingEventArgs instance containing the event data.

ResetTheme()

Resets the theme.

Declaration

public void ResetTheme()

Events

PageIndexChanged

Occurs when the page index has changed.

Declaration

public event EventHandler<PageIndexChangedEventArgs> PageIndexChanged

Event Type

System.EventHandler<PageIndexChangedEventArgs>

PageIndexChanging

Occurs when the page index is about to change.

Declaration

public event EventHandler<PageIndexChangingEventArgs> PageIndexChanging

Event Type

System.EventHandler<PageIndexChangingEventArgs>

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)