DataPager Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Provides a user interface for paging through a collection of data.
Inheritance Hierarchy
System.Object
System.Windows.DependencyObject
System.Windows.UIElement
System.Windows.FrameworkElement
System.Windows.Controls.Control
System.Windows.Controls.DataPager
Namespace: System.Windows.Controls
Assembly: System.Windows.Controls.Data (in System.Windows.Controls.Data.dll)
Syntax
'Declaration
<TemplateVisualStateAttribute(Name := "Numeric", GroupName := "DisplayModeStates")> _
<StyleTypedPropertyAttribute(Property := "NumericButtonStyle", StyleTargetType := GetType(ToggleButton))> _
<TemplatePartAttribute(Name := "CurrentPageSuffixTextBlock", Type := GetType(TextBlock))> _
<TemplateVisualStateAttribute(Name := "FirstLastPreviousNextNumeric", GroupName := "DisplayModeStates")> _
<TemplateVisualStateAttribute(Name := "MoveLastDisabled", GroupName := "MoveLastStates")> _
<TemplateVisualStateAttribute(Name := "MovePreviousEnabled", GroupName := "MovePreviousStates")> _
<TemplatePartAttribute(Name := "FirstPageButton", Type := GetType(ButtonBase))> _
<TemplatePartAttribute(Name := "PreviousPageButton", Type := GetType(ButtonBase))> _
<TemplatePartAttribute(Name := "CurrentPagePrefixTextBlock", Type := GetType(TextBlock))> _
<TemplatePartAttribute(Name := "CurrentPageTextBox", Type := GetType(TextBox))> _
<TemplatePartAttribute(Name := "NextPageButton", Type := GetType(ButtonBase))> _
<TemplatePartAttribute(Name := "LastPageButton", Type := GetType(ButtonBase))> _
<TemplatePartAttribute(Name := "NumericButtonPanel", Type := GetType(Panel))> _
<TemplateVisualStateAttribute(Name := "Normal", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Disabled", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "PreviousNext", GroupName := "DisplayModeStates")> _
<TemplateVisualStateAttribute(Name := "MoveEnabled", GroupName := "MoveStates")> _
<TemplateVisualStateAttribute(Name := "MoveDisabled", GroupName := "MoveStates")> _
<TemplateVisualStateAttribute(Name := "MoveFirstEnabled", GroupName := "MoveFirstStates")> _
<TemplateVisualStateAttribute(Name := "MoveFirstDisabled", GroupName := "MoveFirstStates")> _
<TemplateVisualStateAttribute(Name := "FirstLastNumeric", GroupName := "DisplayModeStates")> _
<TemplateVisualStateAttribute(Name := "MovePreviousDisabled", GroupName := "MovePreviousStates")> _
<TemplateVisualStateAttribute(Name := "MoveNextEnabled", GroupName := "MoveNextStates")> _
<TemplateVisualStateAttribute(Name := "MoveNextDisabled", GroupName := "MoveNextStates")> _
<TemplateVisualStateAttribute(Name := "MoveLastEnabled", GroupName := "MoveLastStates")> _
<TemplateVisualStateAttribute(Name := "TotalPageCountKnown", GroupName := "TotalPageCountKnownStates")> _
<TemplateVisualStateAttribute(Name := "TotalPageCountUnknown", GroupName := "TotalPageCountKnownStates")> _
<TemplateVisualStateAttribute(Name := "PreviousNextNumeric", GroupName := "DisplayModeStates")> _
<TemplateVisualStateAttribute(Name := "FirstLastPreviousNext", GroupName := "DisplayModeStates")> _
Public Class DataPager _
Inherits Control
[TemplateVisualStateAttribute(Name = "Numeric", GroupName = "DisplayModeStates")]
[StyleTypedPropertyAttribute(Property = "NumericButtonStyle", StyleTargetType = typeof(ToggleButton))]
[TemplatePartAttribute(Name = "CurrentPageSuffixTextBlock", Type = typeof(TextBlock))]
[TemplateVisualStateAttribute(Name = "FirstLastPreviousNextNumeric", GroupName = "DisplayModeStates")]
[TemplateVisualStateAttribute(Name = "MoveLastDisabled", GroupName = "MoveLastStates")]
[TemplateVisualStateAttribute(Name = "MovePreviousEnabled", GroupName = "MovePreviousStates")]
[TemplatePartAttribute(Name = "FirstPageButton", Type = typeof(ButtonBase))]
[TemplatePartAttribute(Name = "PreviousPageButton", Type = typeof(ButtonBase))]
[TemplatePartAttribute(Name = "CurrentPagePrefixTextBlock", Type = typeof(TextBlock))]
[TemplatePartAttribute(Name = "CurrentPageTextBox", Type = typeof(TextBox))]
[TemplatePartAttribute(Name = "NextPageButton", Type = typeof(ButtonBase))]
[TemplatePartAttribute(Name = "LastPageButton", Type = typeof(ButtonBase))]
[TemplatePartAttribute(Name = "NumericButtonPanel", Type = typeof(Panel))]
[TemplateVisualStateAttribute(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "PreviousNext", GroupName = "DisplayModeStates")]
[TemplateVisualStateAttribute(Name = "MoveEnabled", GroupName = "MoveStates")]
[TemplateVisualStateAttribute(Name = "MoveDisabled", GroupName = "MoveStates")]
[TemplateVisualStateAttribute(Name = "MoveFirstEnabled", GroupName = "MoveFirstStates")]
[TemplateVisualStateAttribute(Name = "MoveFirstDisabled", GroupName = "MoveFirstStates")]
[TemplateVisualStateAttribute(Name = "FirstLastNumeric", GroupName = "DisplayModeStates")]
[TemplateVisualStateAttribute(Name = "MovePreviousDisabled", GroupName = "MovePreviousStates")]
[TemplateVisualStateAttribute(Name = "MoveNextEnabled", GroupName = "MoveNextStates")]
[TemplateVisualStateAttribute(Name = "MoveNextDisabled", GroupName = "MoveNextStates")]
[TemplateVisualStateAttribute(Name = "MoveLastEnabled", GroupName = "MoveLastStates")]
[TemplateVisualStateAttribute(Name = "TotalPageCountKnown", GroupName = "TotalPageCountKnownStates")]
[TemplateVisualStateAttribute(Name = "TotalPageCountUnknown", GroupName = "TotalPageCountKnownStates")]
[TemplateVisualStateAttribute(Name = "PreviousNextNumeric", GroupName = "DisplayModeStates")]
[TemplateVisualStateAttribute(Name = "FirstLastPreviousNext", GroupName = "DisplayModeStates")]
public class DataPager : Control
<sdk:DataPager .../>
The DataPager type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ActualHeight | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.) |
|
ActualWidth | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.) |
|
AllowDrop | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.) |
|
AutoEllipsis | Gets or sets a value that indicates whether to use an ellipsis as the last numeric button. |
|
Background | Gets or sets a brush that provides the background of the control. (Inherited from Control.) |
|
BorderBrush | Gets or sets a brush that describes the border background of a control. (Inherited from Control.) |
|
BorderThickness | Gets or sets the border thickness of a control. (Inherited from Control.) |
|
CacheMode | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.) |
|
CanChangePage | Gets a value that indicates whether the user can move to another page. |
|
CanMoveToFirstPage | Gets a value that indicates whether the user can move to the first page. |
|
CanMoveToLastPage | Gets a value that indicates whether the user can move to the last page. |
|
CanMoveToNextPage | Gets a value that indicates whether the user can move to the next page. |
|
CanMoveToPreviousPage | Gets a value that indicates whether the user can move to the previous page. |
|
CharacterSpacing | Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.) |
|
Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) |
|
Cursor | Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.) |
|
DataContext | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.) |
.gif "Protected property") |
DefaultStyleKey | Gets or sets the key that references the default style for the control. (Inherited from Control.) |
|
DesiredSize | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.) |
|
Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) |
|
DisplayMode | Gets or sets a value that indicates how the DataPager user interface is displayed. |
|
Effect | Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.) |
|
FlowDirection | Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.) |
|
FontFamily | Gets or sets the font used to display text in the control. (Inherited from Control.) |
|
FontSize | Gets or sets the size of the text in this control. (Inherited from Control.) |
|
FontStretch | Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.) |
|
FontStyle | Gets or sets the style in which the text is rendered. (Inherited from Control.) |
|
FontWeight | Gets or sets the thickness of the specified font. (Inherited from Control.) |
|
Foreground | Gets or sets a brush that describes the foreground color. (Inherited from Control.) |
|
Height | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.) |
|
HorizontalAlignment | Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.) |
|
HorizontalContentAlignment | Gets or sets the horizontal alignment of the control's content. (Inherited from Control.) |
|
IsEnabled | Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control.) |
|
IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) |
|
IsTabStop | Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.) |
|
IsTotalItemCountFixed | Gets or sets a value that indicates whether the total number of items in the collection is fixed. |
|
ItemCount | Gets the current number of known items in the source data collection. |
|
Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) |
|
Margin | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MaxHeight | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MaxWidth | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MinHeight | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MinWidth | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
Name | Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.) |
|
NumericButtonCount | Gets or sets a value that indicates the number of page buttons shown on the DataPager user interface. |
|
NumericButtonStyle | Gets or sets the style that will be used for the numeric buttons. |
|
Opacity | Gets or sets the degree of the object's opacity. (Inherited from UIElement.) |
|
OpacityMask | Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.) |
|
Padding | Gets or sets the padding inside a control. (Inherited from Control.) |
|
PageCount | Gets the current number of known pages if the source is an IPagedCollectionView. |
|
PageIndex | Gets or sets the index of the current page. |
|
PageSize | Gets or sets a value that indicates the number of items displayed on a page. |
|
Parent | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.) |
|
Projection | Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.) |
|
RenderSize | Gets the final render size of a UIElement. (Inherited from UIElement.) |
|
RenderTransform | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.) |
|
RenderTransformOrigin | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.) |
|
Resources | Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.) |
|
Source | Gets or sets the data collection that the DataPager controls paging for. |
|
Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) |
|
TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. (Inherited from Control.) |
|
TabNavigation | Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control.) |
|
Tag | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.) |
|
Template | Gets or sets a control template. (Inherited from Control.) |
|
Triggers | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.) |
|
UseLayoutRounding | Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.) |
|
VerticalAlignment | Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.) |
|
VerticalContentAlignment | Gets or sets the vertical alignment of the control's content. (Inherited from Control.) |
|
Visibility | Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.) |
|
Width | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AddHandler | Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.) |
|
ApplyTemplate | Loads the relevant control template so that its parts can be referenced. (Inherited from Control.) |
|
Arrange | Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.) |
.gif "Protected method") |
ArrangeOverride | Provides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.) |
|
CaptureMouse | Sets mouse capture to a UIElement. (Inherited from UIElement.) |
|
CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) |
|
ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.) |
|
Focus | Attempts to set the focus on the control. (Inherited from Control.) |
|
GetAnimationBaseValue | Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) |
|
GetBindingExpression | Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetTemplateChild | Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) |
|
InvalidateArrange | Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.) |
|
InvalidateMeasure | Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.) |
|
Measure | Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.) |
|
MeasureOverride | Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnApplyTemplate | Builds the visual tree for the DataPager control when a new template is applied. (Overrides FrameworkElement.OnApplyTemplate().) |
|
OnCreateAutomationPeer | Returns a DataPagerAutomationPeer for use by the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().) |
|
OnDragEnter | Called before the DragEnter event occurs. (Inherited from Control.) |
|
OnDragLeave | Called before the DragLeave event occurs. (Inherited from Control.) |
|
OnDragOver | Called before the DragOver event occurs. (Inherited from Control.) |
|
OnDrop | Called before the Drop event occurs. (Inherited from Control.) |
|
OnGotFocus | Called before the GotFocus event occurs. (Inherited from Control.) |
|
OnKeyDown | Called before the KeyDown event occurs. (Inherited from Control.) |
|
OnKeyUp | Called before the KeyUp event occurs. (Inherited from Control.) |
|
OnLostFocus | Called before the LostFocus event occurs. (Inherited from Control.) |
|
OnLostMouseCapture | Called before the LostMouseCapture event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.) |
|
OnMouseEnter | Called before the MouseEnter event occurs. (Inherited from Control.) |
|
OnMouseLeave | Called before the MouseLeave event occurs. (Inherited from Control.) |
|
OnMouseLeftButtonDown | Called before the MouseLeftButtonDown event occurs. (Inherited from Control.) |
|
OnMouseLeftButtonUp | Called before the MouseLeftButtonUp event occurs. (Inherited from Control.) |
|
OnMouseMove | Called before the MouseMove event occurs. (Inherited from Control.) |
|
OnMouseRightButtonDown | Called before the MouseRightButtonDown event occurs. (Inherited from Control.) |
|
OnMouseRightButtonUp | Called before the MouseRightButtonUp event occurs. (Inherited from Control.) |
|
OnMouseWheel | Called before the MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.) |
|
OnTextInput | Called before the TextInput event occurs. (Inherited from Control.) |
|
OnTextInputStart | Called before the TextInputStart event occurs. (Inherited from Control.) |
|
OnTextInputUpdate | Called before the TextInputUpdate event occurs. (Inherited from Control.) |
|
ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) |
|
ReleaseMouseCapture | Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.) |
|
RemoveHandler | Removes the specified routed event handler from this UIElement. (Inherited from UIElement.) |
|
SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) |
|
SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.) |
|
UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
BindingValidationError | Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.) |
|
DataContextChanged | Occurs when the data context for this element changes. (Inherited from FrameworkElement.) |
|
DragEnter | Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.) |
|
DragLeave | Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.) |
|
DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.) |
|
Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.) |
|
GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement.) |
|
IsEnabledChanged | Occurs when the IsEnabled property changes. (Inherited from Control.) |
|
KeyDown | Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.) |
|
KeyUp | Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.) |
|
LayoutUpdated | Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.) |
|
Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.) |
|
LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement.) |
|
LostMouseCapture | Occurs when the UIElement loses mouse capture. (Inherited from UIElement.) |
|
MediaCommand | Occurs when a button is pressed on a remote control. (Inherited from UIElement.) |
|
MouseEnter | Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.) |
|
MouseLeave | Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.) |
|
MouseLeftButtonDown | Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.) |
|
MouseLeftButtonUp | Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) |
|
MouseMove | Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) |
|
MouseRightButtonDown | Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.) |
|
MouseRightButtonUp | Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.) |
|
MouseWheel | Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.) |
|
PageIndexChanged | Occurs when the PageIndex has changed. |
|
PageIndexChanging | Occurs when the PageIndex is changing. |
|
SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.) |
|
TextInput | Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.) |
|
TextInputStart | Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.) |
|
TextInputUpdate | Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.) |
|
Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") .gif "Static member") |
AutoEllipsisProperty | Identifies the AutoEllipsis dependency property. |
|
CanChangePageProperty | Identifies the CanChangePage dependency property. |
|
CanMoveToFirstPageProperty | Identifies the CanMoveToFirstPage dependency property. |
|
CanMoveToLastPageProperty | Identifies the CanMoveToLastPage dependency property. |
|
CanMoveToNextPageProperty | Identifies the CanMoveToNextPage dependency property. |
|
CanMoveToPreviousPageProperty | Identifies the CanMoveToPreviousPage dependency property. |
|
DisplayModeProperty | Identifies the DisplayMode dependency property. |
|
IsTotalItemCountFixedProperty | Identifies the IsTotalItemCountFixed dependency property. |
|
ItemCountProperty | Identifies the ItemCount dependency property. |
|
NumericButtonCountProperty | Identifies the NumericButtonCount dependency property. |
|
NumericButtonStyleProperty | Identifies the NumericButtonStyle dependency property. |
|
PageCountProperty | Identifies the PageCount dependency property. |
|
PageIndexProperty | Identifies the PageIndex dependency property. |
|
PageSizeProperty | Identifies the PageSize dependency property. |
|
SourceProperty | Identifies the Source dependency property. |
Top
Remarks
The DataPager control provides a configurable user interface for paging through a data collection. You typically use a collection that implements IPagedCollectionView as the data source and the IPagedCollectionView provides the paging functionality. You can bind the DataPager to any IEnumerable collection; however, the DataPager will behave as if the data is all on a single page. To provide paging functionality for an IEnumerable collection, you can wrap it in the PagedCollectionView class.
.gif "Note") Note: |
|---|
If you use the DataPager in an application with an Entity Framework data store, you must order the data returned by your queries for the DataPager to work correctly. The Entity Framework does not support paging of data without an OrderBy clause. |
The paged data is typically displayed in a control that represents a collection, such as a DataGrid or ListBox. To use a DataPager to page through data in another control, you assign the control's ItemsSource property and the DataPager.Source property to the same data collection.
You can modify the appearance of the DataPager by setting the DisplayMode property. If you use a DisplayMode that displays numeric buttons, you can change the number of buttons displayed by setting the NumericButtonCount property. You can set the AutoEllipsis property to true to have the DataPager display an ellipsis in place of the last numeric button, unless the ellipsis would be the last page. You can also modify the appearance of the numeric buttons by setting a custom NumericButtonStyle.
The following illustration shows the DataPager configured to use different display modes.
DataPager Display Modes
.png "DataPager display modes")
| Note: |
|---|
The DataPager control is available as part of the libraries in the Silverlight Software Development Kit (SDK). For more information, see the Silverlight Tools. |
Customizing the DataPager Control
To apply the same property settings to multiple DataPager controls, use the Style property. To change the visual structure and visual behavior of a DataPager, copy and modify its default style and template. For more information, see Control Customization.
Dependency properties for this control might be set by the default style of the control. If a dependency property for a DataPager is set by its default style, the property might change from its default value when the DataPager appears in the application. For more information, see Dependency Property Value Precedence. You can get the default style and template for DataPager from DataPager Styles and Templates.
| Note: |
|---|
Setting a visual property will only have an effect if that property is both present in DataPager control's default template and is set by using a TemplateBinding. You can find a list of visual properties in the "Changing the Visual Structure of a Control" section of Customizing the Appearance of an Existing Control by Using a ControlTemplate. |
Examples
The following code example demonstrates how to use a DataPager to page through data displayed in a ListBox. The List<T> that stores the data is wrapped in a PagedCollectionView, which provides paging functionality. Both the DataPager and the ListBox use the PagedCollectionView as their data source.
<!-- NOTE:
By convention, the sdk prefix indicates a URI-based XAML namespace declaration
for Silverlight SDK client libraries. This namespace declaration is valid for
Silverlight 4 only. In Silverlight 3, you must use individual XAML namespace
declarations for each CLR assembly and namespace combination outside the scope
of the default Silverlight XAML namespace. For more information, see the help
topic "Prefixes and Mappings for Silverlight Libraries".
-->
<UserControl x:Class="DataPagerSample.MainPage"
xmlns:sdk="https://schemas.microsoft.com/winfx/2006/xaml/presentation/sdk"
xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
xmlns:d="https://schemas.microsoft.com/expression/blend/2008"
xmlns:mc="https://schemas.openxmlformats.org/markup-compatibility/2006"
mc:Ignorable="d" d:DesignWidth="640" d:DesignHeight="480">
<Grid x:Name="LayoutRoot" Width="400">
<StackPanel Margin="10">
<sdk:DataPager x:Name="dataPager1"
PageSize="5"
AutoEllipsis="True"
NumericButtonCount="3"
DisplayMode="FirstLastPreviousNextNumeric"
IsTotalItemCountFixed="True"/>
<ListBox x:Name="listBox1" />
</StackPanel>
</Grid>
</UserControl>
Imports System.Windows.Data
Partial Public Class MainPage
Inherits UserControl
Public Sub New()
InitializeComponent()
Dim itemList As New List(Of String)
' Generate some items to add to the list.
For index As Integer = 1 To 33
Dim sb As New System.Text.StringBuilder("Item ")
sb.Append(index.ToString)
itemList.Add(sb.ToString)
Next
' Wrap the itemList in a PagedCollectionView for paging functionality
Dim itemListView As New PagedCollectionView(itemList)
' Set the DataPager and ListBox to the same data source.
dataPager1.Source = itemListView
listBox1.ItemsSource = itemListView
End Sub
End Class
using System;
using System.Collections.Generic;
using System.Windows.Controls;
using System.Windows.Data;
namespace DataPagerSample
{
public partial class MainPage : UserControl
{
public MainPage()
{
InitializeComponent();
List<String> itemList = new List<String>();
// Generate some items to add to the list.
for (int i = 1; i <= 33; i++)
{
System.Text.StringBuilder sb = new System.Text.StringBuilder("Item ");
sb.Append(i.ToString());
itemList.Add(sb.ToString());
}
// Wrap the itemList in a PagedCollectionView for paging functionality
PagedCollectionView itemListView = new PagedCollectionView(itemList);
// Set the DataPager and ListBox to the same data source.
dataPager1.Source = itemListView;
listBox1.ItemsSource = itemListView;
}
}
}
Version Information
Silverlight
Supported in: 5, 4, 3
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.