Intersoft ClientUI Documentation
UXDataPager Class
Members  See Also  Send Feedback
Intersoft.Client.UI.Data Namespace : UXDataPager Class






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

Object Model

UXDataPager Class

Syntax

Visual Basic (Declaration) 
<TemplateVisualStateAttribute(Name="FirstLastNumeric", GroupName="DisplayModeStates")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNext")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNextNumeric")>
<TemplatePartAttribute(Name="NumericButtonPanel", Type=System.Windows.Controls.Panel)>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNextNumeric")>
<StyleTypedPropertyAttribute(Property="NumericButtonStyle", StyleTargetType=Intersoft.Client.UI.Aqua.UXToggleButton)>
<DescriptionAttribute("Provides a user interface for paging through a collection of data.")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNext")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="Numeric")>
Public Class UXDataPager 
   Inherits Intersoft.Client.Framework.ISControl
   Implements IControl, IFramework, ILicensing 
Visual Basic (Usage)Copy Code
Dim instance As UXDataPager
C# 
[TemplateVisualStateAttribute(Name="FirstLastNumeric", GroupName="DisplayModeStates")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNext")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNextNumeric")]
[TemplatePartAttribute(Name="NumericButtonPanel", Type=System.Windows.Controls.Panel)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNextNumeric")]
[StyleTypedPropertyAttribute(Property="NumericButtonStyle", StyleTargetType=Intersoft.Client.UI.Aqua.UXToggleButton)]
[DescriptionAttribute("Provides a user interface for paging through a collection of data.")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNext")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="Numeric")]
public class UXDataPager : Intersoft.Client.Framework.ISControl, IControl, IFramework, ILicensing 
Delphi 
public class UXDataPager = class(Intersoft.Client.Framework.ISControl, IControl, IFramework, ILicensing)
JScript 
TemplateVisualStateAttribute(Name="FirstLastNumeric", GroupName="DisplayModeStates")
TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNext")
TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNextNumeric")
TemplatePartAttribute(Name="NumericButtonPanel", Type=System.Windows.Controls.Panel)
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")
TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNextNumeric")
StyleTypedPropertyAttribute(Property="NumericButtonStyle", StyleTargetType=Intersoft.Client.UI.Aqua.UXToggleButton)
DescriptionAttribute("Provides a user interface for paging through a collection of data.")
TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNext")
TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")
TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="Numeric")
public class UXDataPager extends Intersoft.Client.Framework.ISControl implements IControl, IFramework, ILicensing 
Managed Extensions for C++ 
[TemplateVisualStateAttribute(Name="FirstLastNumeric", GroupName="DisplayModeStates")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNext")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNextNumeric")]
[TemplatePartAttribute(Name="NumericButtonPanel", Type=System.Windows.Controls.Panel)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNextNumeric")]
[StyleTypedPropertyAttribute(Property="NumericButtonStyle", StyleTargetType=Intersoft.Client.UI.Aqua.UXToggleButton)]
[DescriptionAttribute("Provides a user interface for paging through a collection of data.")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNext")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="Numeric")]
public __gc class UXDataPager : public Intersoft.Client.Framework.ISControl, IControl, IFramework, ILicensing 
C++/CLI 
[TemplateVisualStateAttribute(Name="FirstLastNumeric", GroupName="DisplayModeStates")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNext")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNextNumeric")]
[TemplatePartAttribute(Name="NumericButtonPanel", Type=System.Windows.Controls.Panel)]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNextNumeric")]
[StyleTypedPropertyAttribute(Property="NumericButtonStyle", StyleTargetType=Intersoft.Client.UI.Aqua.UXToggleButton)]
[DescriptionAttribute("Provides a user interface for paging through a collection of data.")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNext")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Disabled")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="Numeric")]
public ref class UXDataPager : public Intersoft.Client.Framework.ISControl, IControl, IFramework, ILicensing 

Example

The following illustration shows the UXDataPager configured to use different display mode.

XAML Copy Code 
    <Intersoft:UXDataPager PageSize="20" QueryOperation="Client" Source="{Binding Customers}"
                        Margin="8" DisplayMode="FirstLastNumeric"/>
    <Intersoft:UXDataPager PageSize="20" QueryOperation="Client" Source="{Binding Customers}"
                        Margin="8" DisplayMode="FirstLastPreviousNext"/>
    <Intersoft:UXDataPager PageSize="20" QueryOperation="Client" Source="{Binding Customers}"
                        Margin="8" DisplayMode="FirstLastPreviousNextNumeric"/>
    <Intersoft:UXDataPager PageSize="20" QueryOperation="Client" Source="{Binding Customers}" NumericButtonCount="3" AutoEllipsis="True"
                        Margin="8" DisplayMode="FirstLastPreviousNextNumeric"/>
    <Intersoft:UXDataPager PageSize="20" QueryOperation="Client" Source="{Binding Customers}" NumericButtonCount="2"
                        Margin="8" DisplayMode="FirstLastPreviousNextNumeric"/>
    <Intersoft:UXDataPager PageSize="20" QueryOperation="Client" Source="{Binding Customers}"
                        Margin="8" DisplayMode="Numeric"/>
    <Intersoft:UXDataPager PageSize="20" QueryOperation="Client" Source="{Binding Customers}"
                        Margin="8" DisplayMode="PreviousNext"/>
    <Intersoft:UXDataPager PageSize="20" QueryOperation="Client" Source="{Binding Customers}"
                        Margin="8" DisplayMode="PreviousNextNumeric"/>

Remarks

The UXDataPager control provides a configurable user interface for paging through a data collection. Similar to the other ClientUI data controls, UXDataPager supports both server side and client side operation.

Client Data Operation

Client data operation means that the data operation, in this case data paging, is executed in the client side against the data source provided to the UXDataPager. To use this operation, you set the QueryOperation property to Client.

You typically use a collection that implements IPagedCollectionView as the data source. The IPagedCollectionView provides paging support to the underlying collection. You can bind the UXDataPager to any IEnumerable collection; however, the UXDataPager will behave as if the data is all on a single page. To provide paging functionality for an IEnumerable collection, you can wrap the collection in a PagedCollectionView instance.

To learn how to implement data paging using UXDataPager, see How-to: Implement Data Paging using UXDataPager.

Server Data Operation

Server data operation means that data operation in this case data paging is processed in the server. This means that UXDataPager does not handle the paging operation by its own. Instead, UXDataPager provides the query information allowing you to process it further.

To use this mode, you set the QueryOperation property to Server. When this mode is selected, UXDataPager will not attempt to perform the data operation on the given data source. Instead, it will store and distribute the query information on certain properties such as PageIndex, PageSize and TotalItemCount which are defined in the PageDescriptor property. When one of these properties change, the QueryChanged event of the associated QueryDescriptor will be raised. This allows you to streamline the query processing in a centralized function, which is one of the strong benefits of QueryDescriptor. For more information about QueryDescriptor, see QueryDescriptor Overview.

To learn how to implement data paging using PageDescriptor and UXDataPager, see How-to: Implement Data Paging using PageDescriptor and UXDataPager.

Inheritance Hierarchy

System.Object
   System.Windows.DependencyObject
      System.Windows.UIElement
         System.Windows.FrameworkElement
            System.Windows.Controls.Control
               Intersoft.Client.Framework.ISControl
                  Intersoft.Client.UI.Data.UXDataPager

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2012 All Rights Reserved.