Intersoft ClientUI Documentation
UXDataPager Class
Members 



Provides a user interface for paging through a collection of data.
Object Model
UXDataPager ClassISFramework ClassPageDescriptor ClassUXDataPagerResource Class
Syntax
<StyleTypedPropertyAttribute(Property="NumericButtonStyle", StyleTargetType=Intersoft.Client.UI.Aqua.UXToggleButton)>
<TemplatePartAttribute(Name="NumericButtonPanel", Type=System.Windows.Controls.Panel)>
<TemplateVisualStateAttribute(Name="Disabled", GroupName="CommonStates")>
<TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNext")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNext")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNextNumeric")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNextNumeric")>
<DescriptionAttribute("Provides a user interface for paging through a collection of data.")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastNumeric")>
<TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="Numeric")>
Public Class UXDataPager 
   Inherits Intersoft.Client.Framework.ISControl
   Implements Intersoft.Client.Framework.IControlIntersoft.Client.Framework.IFramework, Intersoft.Client.Framework.ILicensing 
Dim instance As UXDataPager
[StyleTypedPropertyAttribute(Property="NumericButtonStyle", StyleTargetType=Intersoft.Client.UI.Aqua.UXToggleButton)]
[TemplatePartAttribute(Name="NumericButtonPanel", Type=System.Windows.Controls.Panel)]
[TemplateVisualStateAttribute(Name="Disabled", GroupName="CommonStates")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNext")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNext")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNextNumeric")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNextNumeric")]
[DescriptionAttribute("Provides a user interface for paging through a collection of data.")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastNumeric")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="Numeric")]
public class UXDataPager : Intersoft.Client.Framework.ISControl, Intersoft.Client.Framework.IControlIntersoft.Client.Framework.IFramework, Intersoft.Client.Framework.ILicensing  
[StyleTypedPropertyAttribute(Property="NumericButtonStyle", StyleTargetType=Intersoft.Client.UI.Aqua.UXToggleButton)]
[TemplatePartAttribute(Name="NumericButtonPanel", Type=System.Windows.Controls.Panel)]
[TemplateVisualStateAttribute(Name="Disabled", GroupName="CommonStates")]
[TemplateVisualStateAttribute(GroupName="CommonStates", Name="Normal")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNext")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNext")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="PreviousNextNumeric")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastPreviousNextNumeric")]
[DescriptionAttribute("Provides a user interface for paging through a collection of data.")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="FirstLastNumeric")]
[TemplateVisualStateAttribute(GroupName="DisplayModeStates", Name="Numeric")]
public ref class UXDataPager : public Intersoft.Client.Framework.ISControl, Intersoft.Client.Framework.IControlIntersoft.Client.Framework.IFramework, Intersoft.Client.Framework.ILicensing  
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.

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"/>
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 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

UXDataPager Members
Intersoft.Client.UI.Data Namespace

Send Feedback