Class PagerPropertiesBuilder

Inheritance

System.Object

PagerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class PagerPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

PagerPropertiesBuilder()

Initializes a new instance of the PagerPropertiesBuilder class.

Declaration

public PagerPropertiesBuilder()

PagerPropertiesBuilder(Pager)

Initializes a new instance of the PagerPropertiesBuilder class by the specified Pager object.

Declaration

public PagerPropertiesBuilder(Pager pager)

Parameters

Type	Name	Description
Pager	pager

Fields

pager

Specifies the instance of the Pager class.

Declaration

public Pager pager

Field Value

Type	Description
Pager

Methods

ClientSideEvents(Action<PagerClientSideEventsBuilder>)

Specifies to trigger the Pager client side events.

Declaration

public PagerPropertiesBuilder ClientSideEvents(Action<PagerClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<PagerClientSideEventsBuilder>	clientSideEvents

Returns

Type	Description
PagerPropertiesBuilder

CssClass(String)

Specifies the root CSS class to Pager for theme customization with specified string argument.

Declaration

public PagerPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass	cssClass

Returns

Type	Description
PagerPropertiesBuilder	This method returns string value

CurrentPage(Int32)

Specifies the current page of the pager.

Declaration

public PagerPropertiesBuilder CurrentPage(int currentPage)

Parameters

Type	Name	Description
System.Int32	currentPage

Returns

Type	Description
PagerPropertiesBuilder

CustomText(String)

Specifies the Cutom Text to be added to the numeric elements in pager with specified string argument.

Declaration

public PagerPropertiesBuilder CustomText(string customText)

Parameters

Type	Name	Description
System.String	customText	customText

Returns

Type	Description
PagerPropertiesBuilder	This method returns string value

Enabled()

Allows the pager to respond for user interaction.

Declaration

public PagerPropertiesBuilder Enabled()

Returns

Type	Description
PagerPropertiesBuilder

Enabled(Boolean)

Allows the pager to respond for user interaction with specified boolean argument.

Declaration

public PagerPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled

Returns

Type	Description
PagerPropertiesBuilder

EnableExternalMessage()

Allows the pager to enableExternalMessage.

Declaration

public PagerPropertiesBuilder EnableExternalMessage()

Returns

Type	Description
PagerPropertiesBuilder

EnableExternalMessage(Boolean)

Allows the pager to enableExternal Message of pager with specified boolean value.

Declaration

public PagerPropertiesBuilder EnableExternalMessage(bool enableExternalMessage)

Parameters

Type	Name	Description
System.Boolean	enableExternalMessage

Returns

Type	Description
PagerPropertiesBuilder

EnableQueryString()

Specifies whether enable the enableQueryString of the pager.

Declaration

public PagerPropertiesBuilder EnableQueryString()

Returns

Type	Description
PagerPropertiesBuilder

EnableQueryString(Boolean)

Specifies whether enable the enableQueryString of the pager.

Declaration

public PagerPropertiesBuilder EnableQueryString(bool enableQueryString)

Parameters

Type	Name	Description
System.Boolean	enableQueryString

Returns

Type	Description
PagerPropertiesBuilder

EnableRTL()

Specifies to align the pager in right to left direction.

Declaration

public PagerPropertiesBuilder EnableRTL()

Returns

Type	Description
PagerPropertiesBuilder

EnableRTL(Boolean)

Specifies to align the pager in right to left direction with the specified argument.

Declaration

public PagerPropertiesBuilder EnableRTL(bool enableRTL)

Parameters

Type	Name	Description
System.Boolean	enableRTL

Returns

Type	Description
PagerPropertiesBuilder

ExternalMessage(String)

Specifies the External message to be displayed in the pager.

Declaration

public PagerPropertiesBuilder ExternalMessage(string externalMessage)

Parameters

Type	Name	Description
System.String	externalMessage	externalMessage

Returns

Type	Description
PagerPropertiesBuilder	This method returns string value

IsResponsive()

Specifies whether the pager is responsive or not.

Declaration

public PagerPropertiesBuilder IsResponsive()

Returns

Type	Description
PagerPropertiesBuilder

IsResponsive(Boolean)

Specifies whether the pager is responsive or not.

Declaration

public PagerPropertiesBuilder IsResponsive(bool isResponsive)

Parameters

Type	Name	Description
System.Boolean	isResponsive

Returns

Type	Description
PagerPropertiesBuilder

Locale(String)

Localize pager page info to specified localization.

Declaration

public PagerPropertiesBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale	locale

Returns

Type	Description
PagerPropertiesBuilder	This method returns string value

PageCount(Int32)

Defines the total number of page count (numeric items) to be displayed in pager container.

Declaration

public PagerPropertiesBuilder PageCount(int pageCount)

Parameters

Type	Name	Description
System.Int32	pageCount

Returns

Type	Description
PagerPropertiesBuilder

PageSize(Int32)

Defines the page size value of the pager.

Declaration

public PagerPropertiesBuilder PageSize(int pageSize)

Parameters

Type	Name	Description
System.Int32	pageSize

Returns

Type	Description
PagerPropertiesBuilder

PageSizeList(List<Int32>)

Defines the pageSizeList of the pager where pager renders with a drop-down which list the number of page sizes available, when a value from drop-down is selected then the page size value of pager will get updated accordingly.

Declaration

public PagerPropertiesBuilder PageSizeList(List<int> pageSizeList)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	pageSizeList

Returns

Type	Description
PagerPropertiesBuilder

PageSizeMessage(String)

Specifies the Pagesize message to be displayed in the pager when a dropdown of pagesize contains more than one value.

Declaration

public PagerPropertiesBuilder PageSizeMessage(string pageSizeMessage)

Parameters

Type	Name	Description
System.String	pageSizeMessage	pageSizeMessage

Returns

Type	Description
PagerPropertiesBuilder	This method returns string value

Render()

Renders the Pager instance.

Declaration

public void Render()

ShowGoToPage()

Specifies whether the pager goto page to be visible or not.

Declaration

public PagerPropertiesBuilder ShowGoToPage()

Returns

Type	Description
PagerPropertiesBuilder

ShowGoToPage(Boolean)

Specifies whether the pager goto page to be visible or not.

Declaration

public PagerPropertiesBuilder ShowGoToPage(bool showGoToPage)

Parameters

Type	Name	Description
System.Boolean	showGoToPage

Returns

Type	Description
PagerPropertiesBuilder

ShowPageInfo()

Specifies whether the pager page info to be visible or not.

Declaration

public PagerPropertiesBuilder ShowPageInfo()

Returns

Type	Description
PagerPropertiesBuilder

ShowPageInfo(Boolean)

Specifies whether the pager page info to be visible or not.

Declaration

public PagerPropertiesBuilder ShowPageInfo(bool showPageInfo)

Parameters

Type	Name	Description
System.Boolean	showPageInfo

Returns

Type	Description
PagerPropertiesBuilder

ToHtmlString()

Represents an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

TotalPages(Int32)

Specifies the total number of pages in the pager.

Declaration

public PagerPropertiesBuilder TotalPages(int totalPages)

Parameters

Type	Name	Description
System.Int32	totalPages

Returns

Type	Description
PagerPropertiesBuilder

TotalRecordsCount(Int32)

Specifies the number of total records count of the pager.

Declaration

public PagerPropertiesBuilder TotalRecordsCount(int totalRecordsCount)

Parameters

Type	Name	Description
System.Int32	totalRecordsCount

Returns

Type	Description
PagerPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString