Class DataPagerExt

Handles paging for an System.ComponentModel.IPagedCollectionView.

Inheritance

System.Object

DataPagerExt

Namespace: Syncfusion.Windows.Controls.Grid

Assembly: Syncfusion.Grid.Wpf.dll

Syntax

[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualState(Name = "MoveEnabled", GroupName = "MoveStates")]
[TemplateVisualState(Name = "MoveDisabled", GroupName = "MoveStates")]
[TemplateVisualState(Name = "MoveFirstEnabled", GroupName = "MoveFirstStates")]
[TemplateVisualState(Name = "MoveFirstDisabled", GroupName = "MoveFirstStates")]
[TemplateVisualState(Name = "MovePreviousEnabled", GroupName = "MovePreviousStates")]
[TemplateVisualState(Name = "MovePreviousDisabled", GroupName = "MovePreviousStates")]
[TemplateVisualState(Name = "MoveNextEnabled", GroupName = "MoveNextStates")]
[TemplateVisualState(Name = "MoveNextDisabled", GroupName = "MoveNextStates")]
[TemplateVisualState(Name = "MoveLastEnabled", GroupName = "MoveLastStates")]
[TemplateVisualState(Name = "MoveLastDisabled", GroupName = "MoveLastStates")]
[TemplateVisualState(Name = "TotalPageCountKnown", GroupName = "TotalPageCountKnownStates")]
[TemplateVisualState(Name = "TotalPageCountUnknown", GroupName = "TotalPageCountKnownStates")]
[TemplateVisualState(Name = "FirstLastNumeric", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "FirstLastPreviousNext", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "FirstLastPreviousNextNumeric", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "Numeric", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "PreviousNext", GroupName = "DisplayModeStates")]
[TemplateVisualState(Name = "PreviousNextNumeric", GroupName = "DisplayModeStates")]
public class DataPagerExt : Control

Constructors

DataPagerExt()

Initializes a new instance of the DataPager class.

Declaration

public DataPagerExt()

Fields

AutoEllipsisProperty

Identifies the AutoEllipsis dependency property.

Declaration

public static readonly DependencyProperty AutoEllipsisProperty

Field Value

Type
System.Windows.DependencyProperty

CanChangePageProperty

Identifies the CanChangePage dependency property.

Declaration

public static readonly DependencyProperty CanChangePageProperty

Field Value

Type
System.Windows.DependencyProperty

CanMoveToFirstPageProperty

Identifies the CanMoveToFirstPage dependency property.

Declaration

public static readonly DependencyProperty CanMoveToFirstPageProperty

Field Value

Type
System.Windows.DependencyProperty

CanMoveToLastPageProperty

Identifies the CanMoveToLastPage dependency property.

Declaration

public static readonly DependencyProperty CanMoveToLastPageProperty

Field Value

Type
System.Windows.DependencyProperty

CanMoveToNextPageProperty

Identifies the CanMoveToNextPage dependency property.

Declaration

public static readonly DependencyProperty CanMoveToNextPageProperty

Field Value

Type
System.Windows.DependencyProperty

CanMoveToPreviousPageProperty

Identifies the CanMoveToPreviousPage dependency property.

Declaration

public static readonly DependencyProperty CanMoveToPreviousPageProperty

Field Value

Type
System.Windows.DependencyProperty

DisplayModeProperty

Identifies the DisplayMode dependency property.

Declaration

public static readonly DependencyProperty DisplayModeProperty

Field Value

Type
System.Windows.DependencyProperty

GridDataOnDemandPageLoadingEvent

Declaration

public static readonly RoutedEvent GridDataOnDemandPageLoadingEvent

Field Value

Type
System.Windows.RoutedEvent

IsTotalItemCountFixedProperty

Identifies the IsTotalItemCountFixed dependency property.

Declaration

public static readonly DependencyProperty IsTotalItemCountFixedProperty

Field Value

Type
System.Windows.DependencyProperty

ItemCountProperty

Identifies the ItemCount dependency property.

Declaration

public static readonly DependencyProperty ItemCountProperty

Field Value

Type
System.Windows.DependencyProperty

NumericButtonCountProperty

Identifies the NumericButtonCount dependency property.

Declaration

public static readonly DependencyProperty NumericButtonCountProperty

Field Value

Type
System.Windows.DependencyProperty

NumericButtonStyleProperty

Identifies the NumericButtonStyle dependency property.

Declaration

public static readonly DependencyProperty NumericButtonStyleProperty

Field Value

Type
System.Windows.DependencyProperty

PageCountProperty

Identifies the PageCount dependency property.

Declaration

public static readonly DependencyProperty PageCountProperty

Field Value

Type
System.Windows.DependencyProperty

PageIndexProperty

Identifies the PageIndex dependency property.

Declaration

public static readonly DependencyProperty PageIndexProperty

Field Value

Type
System.Windows.DependencyProperty

PageSizeProperty

Identifies the PageSize dependency property.

Declaration

public static readonly DependencyProperty PageSizeProperty

Field Value

Type
System.Windows.DependencyProperty

SourceProperty

Identifies the Source dependency property.

Declaration

public static readonly DependencyProperty SourceProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

AutoEllipsis

Gets or sets a value that indicates whether or not to use an ellipsis as the last button.

Declaration

public bool AutoEllipsis { get; set; }

Property Value

Type
System.Boolean

CanChangePage

Gets a value that indicates whether or not the user is allowed to move to another page

Declaration

public bool CanChangePage { get; }

Property Value

Type
System.Boolean

CanMoveToFirstPage

Gets a value that indicates whether or not the System.Windows.Controls.DataPager will allow the user to attempt to move to the first page if System.Windows.Controls.DataPager.CanChangePage is true.

Declaration

public bool CanMoveToFirstPage { get; }

Property Value

Type
System.Boolean

CanMoveToLastPage

Gets a value that indicates whether or not the System.Windows.Controls.DataPager will allow the user to attempt to move to the last page if System.Windows.Controls.DataPager.CanChangePage is true.

Declaration

public bool CanMoveToLastPage { get; }

Property Value

Type
System.Boolean

CanMoveToNextPage

Gets a value that indicates whether or not the System.Windows.Controls.DataPager will allow the user to attempt to move to the next page ifSystem.Windows.Controls.DataPager.CanChangePage is true.

Declaration

public bool CanMoveToNextPage { get; }

Property Value

Type
System.Boolean

CanMoveToPreviousPage

Gets a value that indicates whether or not the System.Windows.Controls.DataPager will allow the user to attempt to move to the previous page if System.Windows.Controls.DataPager.CanChangePage is true.

Declaration

public bool CanMoveToPreviousPage { get; }

Property Value

Type
System.Boolean

DisplayMode

Gets or sets a value that indicates how the System.Windows.Controls.DataPager user interface is displayed

Declaration

public PagerDisplayMode DisplayMode { get; set; }

Property Value

Type
PagerDisplayMode

EventSource

Declaration

public IPagedCollectionView EventSource { get; set; }

Property Value

Type
Syncfusion.Windows.Data.IPagedCollectionView

IsPagingOnDemand

Declaration

public bool IsPagingOnDemand { get; set; }

Property Value

Type
System.Boolean

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

Type
System.Boolean

ItemCount

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

Declaration

public int ItemCount { get; }

Property Value

Type
System.Int32

NumericButtonCount

Gets or sets a value that indicates the number of page buttons shown on the System.Windows.Controls.DataPager user interface.

Declaration

public int NumericButtonCount { get; set; }

Property Value

Type
System.Int32

NumericButtonStyle

Gets or sets the style that will be used for the numeric buttons.

Declaration

public Style NumericButtonStyle { get; set; }

Property Value

Type
System.Windows.Style

PageCount

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

Declaration

public int PageCount { get; set; }

Property Value

Type
System.Int32

PageIndex

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

Declaration

public int PageIndex { get; set; }

Property Value

Type
System.Int32

PageSize

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

Declaration

public int PageSize { get; set; }

Property Value

Type
System.Int32

Source

Gets or sets the System.ComponentModel.IPagedCollectionView .

Declaration

public IEnumerable Source { get; set; }

Property Value

Type
System.Collections.IEnumerable

Methods

add_OnDemandDataSourceLoad(GridDataOnDemandPageLoadingEventHandler)

Declaration

public void add_OnDemandDataSourceLoad(GridDataOnDemandPageLoadingEventHandler value)

Parameters

Type	Name	Description
GridDataOnDemandPageLoadingEventHandler	value

OnApplyTemplate()

Applies the control's template, retrieves the elements within it, and sets up events.

Declaration

public override void OnApplyTemplate()

remove_OnDemandDataSourceLoad(GridDataOnDemandPageLoadingEventHandler)

Declaration

public void remove_OnDemandDataSourceLoad(GridDataOnDemandPageLoadingEventHandler value)

Parameters

Type	Name	Description
GridDataOnDemandPageLoadingEventHandler	value

UpdateControl()

Updates the current page, the total pages, and the state of the control.

Declaration

public void UpdateControl()

Events

OnDemandDataSourceLoad

Declaration

public event GridDataOnDemandPageLoadingEventHandler OnDemandDataSourceLoad

Event Type

Type
GridDataOnDemandPageLoadingEventHandler

PageIndexChanged

EventHandler for when PageIndex has changed.

Declaration

public event EventHandler<EventArgs> PageIndexChanged

Event Type

Type
System.EventHandler<System.EventArgs>

PageIndexChanging

EventHandler for when PageIndex is changing.

Declaration

public event EventHandler<CancelEventArgs> PageIndexChanging

Event Type

Type
System.EventHandler<System.ComponentModel.CancelEventArgs>