Appearance in WPF DataPager (SfDataPager)

5 May 20217 minutes to read

SfDataPager supports appearance styles by using the following properties.

• AutoEllipsisMode
• AccentBrush
• DisplayMode
• Orientation

AutoEllipsisMode

The AutoEllipsis button is displayed when the page count is greater than numeric button count. The SfDataPager control allows you to define the AutoEllipsis button by using the AutoEllipsisMode property which is the Enum type.

• AutoEllipsisMode – This Property is used to set the AutoEllipsisMode. By default, it is set to None.
• AutoEllipsisText– This property is used to change the AutoEllipsisButton Text.

The following table explains the different AutoEllipsisModes.

Enum Values	Description
After	Displays the ellipsis button after the numeric buttons.
Before	Displays the ellipsis button before the numeric buttons.
Both	Displays the ellipsis button before and after the numeric buttons.
None	It does not display the AutoEllipsisButton.

NOTE

By Default AutoEllipsisMode is set to None.

The following code example explains how to change the AutoEllipsisText.

XAML

<Window.DataContext>
    <local:ViewModel/>
</Window.DataContext>
<Grid>
    <Grid.RowDefinitions>
        <RowDefinition Height="*" />
        <RowDefinition Height="Auto" />
    </Grid.RowDefinitions>
    <sfgrid:SfDataGrid AutoGenerateColumns="True" 
                       Grid.Row="0"
                       ItemsSource="{Binding ElementName=sfDataPager,Path=PagedSource}"/>
    <datapager:SfDataPager x:Name="sfDataPager"
                           Grid.Row="1"
                           AutoEllipsisMode="After"
                           NumericButtonCount="10"
                           AutoEllipsisText="...etc" 
                           PageSize="16" 
                           Source="{Binding OrdersDetails}" />
</Grid>

The following screenshot displays the output for AutoEllipsisText changed as …etc.

AccentBrush

AccentBrush properties are used to decorate the SfDataPager control with a solid color. There are two AccentBrush properties in the SfDataPager control:

• AccentBackground – Property that is applied to the background color for NavigationButtons and current selected numeric page button. By default, it set to DarkGray.
• AccentForeground – Property that is applied to the foreground color for the current selected numeric page button. By default, it set to White.
• NumericButtonStyle – Property that is applied to the Style of Numeric Button. This is the Style type property. By default, it set to Null.

The following code example explains how to apply the AccentBackground and AccentForeground properties for the SfDataPager control.

XAML

<Window.DataContext>
    <local:Viewmodel/>
</Window.DataContext>
<Grid>
    <sfgrid:SfDataGrid AutoGenerateColumns="True" 
                       ItemsSource="{Binding ElementName=sfDataPager,Path =PagedSource}"/>
    <datapager:SfDataPager x:Name="sfDataPager"
                           AccentBackground="#FF8CBF26"
                           AccentForeground="White" 
                           NumericButtonCount="10"      
                           PageSize="16"
                           Source="{Binding OrdersDetails}"/>
</Grid>

The following screenshot displays the output for AccentBackground and AccentForeGround applied to the SfDataPager.

The following code example explains how to use NumericButtonStyle in SfDataPager.

XAML

<Window.DataContext>
    <local:Viewmodel/>
</Window.DataContext>
<Window.Resources>
    <Style TargetType="datapager:NumericButton">
        <Setter Property="BorderBrush" Value="Blue"/>
        <Setter Property="BorderThickness" Value="2"/>
    </Style>
</Window.Resources>
<Grid>
    <Grid.RowDefinitions>
        <RowDefinition Height="*"/>
        <RowDefinition Height="50"/>
    </Grid.RowDefinitions>
    <sfgrid:SfDataGrid AutoGenerateColumns="True" 
                       Grid.Row="0"
                       ItemsSource="{Binding ElementName=sfDataPager,Path=PagedSource}"/>
    <datapager:SfDataPager x:Name="sfDataPager"
                           PageCount="16"
                           Grid.Row="1"
                           AutoEllipsisMode="Both"
                           AccentBackground="DodgerBlue"  
                           NumericButtonCount="10" 
                           Source="{Binding OrdersDetails}"/>
</Grid>

The following screenshot displays the output of NumericButtonStyle.

Display Modes

The SfDataPager control allows you to choose the elements that are visible in the control. This can be achieved by using the DisplayMode property.The following table explains the PageDisplayMode enum values.

Enum Values	Description
FirstLastPreviousNextNumeric	Displays all the navigation buttons and numeric page buttons.
FirstLastNumeric	Displays the first page, last page navigation button and numeric page buttons.
PreviousNextNumeric	Displays the previous, next page navigation buttons and numeric page buttons.
FirstLastPreviousNext	Displays only the page navigation buttons. Numeric page buttons are not displayed.
FirstLast	Displays only the first and last page navigation buttons.
PreviousNext	Displays only the previous and next page navigation buttons.
Numeric	Displays only the numeric page buttons.
First	Displays only the first page navigation button.
Last	Displays only the last page navigation button.
Previous	Displays only the previous page navigation button.
Next	Displays only the next page navigation button.
None	It does not display anything

NOTE

By Default, DisplayMode is set to FirstLastPreviousNextNumeric.

Orientation

SfDataPager allows you to arrange the child elements either horizontally or vertically. This can be achieved by using the Orientation Property. Orientation is an Enum type. The following table describes the Orientation enum values.

Enum Value	Description
Horizontal	This is the default enum value for Orientation. Arranges all the Navigation Buttons and Numeric Buttons Horizontally.
Vertical	Arranges all the Navigation Buttons and Numeric Buttons Vertically.