SummaryProperties Class

Provides the pager summary settings.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.1.dll

Declaration

C#

public class SummaryProperties :
    PagerButtonProperties

VB.NET

Public Class SummaryProperties
    Inherits PagerButtonProperties

Related API Members

The following members return SummaryProperties objects:

• ASPxPagerBase.Summary
• PagerSettingsEx.Summary

Remarks

The pager summary is used to indicate the current page and provide total information about pages. The SummaryProperties class allows you to customize the summary. The class provides the following summary properties:

• The Visible property allows you to control summary visibility.
• The SummaryProperties.Position property specifies the position of the summary text: to the left of a pager contents, to the right of a pager contents, or inside a pager contents.
• The Text property specifies the pattern used to format a summary text. The default value is Page {0} of {1} ({2} items).
• The SummaryProperties.AllPagesText property specifies the pattern used to format a summary text when the content of all pages is displayed. The default value is Pages: {0} - {1} ({2} items).

The arguments used within summary patterns are:

• {0} - the current page number;
• {1} - the total number of pages;
• {2} - the total number of items (on all pages).

Example

ASPX

<dx:ASPxPager ID="ASPxPager1" runat="server" ItemCount="3" ItemsPerPage="1" OnPageIndexChanged="ASPxPager1_PageIndexChanged">
     <LastPageButton Visible="True">
     </LastPageButton>
     <FirstPageButton Visible="True">
     </FirstPageButton>
     <Summary Position="Inside" Text="Page {0} of {1} " />
</dx:ASPxPager>

Implements

IStateManager

IPropertiesOwner

Inheritance

Object

StateManager

PropertiesBase

PagerButtonProperties

SummaryProperties

ImageGalleryPagerSummaryProperties

NewsControlPagerSummaryProperties