ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PagerBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class PagerBuilder

    Inheritance
    System.Object
    ControlBuilder
    PagerBuilder
    Inherited Members
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.Grids
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class PagerBuilder : ControlBuilder

    Constructors

    PagerBuilder()

    Declaration
    public PagerBuilder()

    PagerBuilder(Pager)

    Declaration
    public PagerBuilder(Pager model)
    Parameters
    Type Name Description
    Pager model

    Fields

    model

    Declaration
    public Pager model
    Field Value
    Type Description
    Pager

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    Click(Object)

    Triggers when click on the numeric items.

    Declaration
    public PagerBuilder Click(object click)
    Parameters
    Type Name Description
    System.Object click
    Returns
    Type Description
    PagerBuilder

    Created(Object)

    Triggers when Pager is created.

    Declaration
    public PagerBuilder Created(object created)
    Parameters
    Type Name Description
    System.Object created
    Returns
    Type Description
    PagerBuilder

    CurrentPage(Double)

    Defines the current page number of pager.

    Declaration
    public PagerBuilder CurrentPage(double currentPage)
    Parameters
    Type Name Description
    System.Double currentPage
    Returns
    Type Description
    PagerBuilder

    CustomText(String)

    Defines the customized text to append with numeric items.

    Declaration
    public PagerBuilder CustomText(string customText)
    Parameters
    Type Name Description
    System.String customText
    Returns
    Type Description
    PagerBuilder

    DropDownChanged(Object)

    Triggers after pageSize is selected in DropDownList.

    Declaration
    public PagerBuilder DropDownChanged(object dropDownChanged)
    Parameters
    Type Name Description
    System.Object dropDownChanged
    Returns
    Type Description
    PagerBuilder

    EnableExternalMessage(Boolean)

    If enableExternalMessage set to true, then it adds the message to Pager.

    Declaration
    public PagerBuilder EnableExternalMessage(bool enableExternalMessage = true)
    Parameters
    Type Name Description
    System.Boolean enableExternalMessage
    Returns
    Type Description
    PagerBuilder

    EnablePagerMessage(Boolean)

    If enablePagerMessage set to true, then it adds the pager information.

    Declaration
    public PagerBuilder EnablePagerMessage(bool enablePagerMessage = true)
    Parameters
    Type Name Description
    System.Boolean enablePagerMessage
    Returns
    Type Description
    PagerBuilder

    EnablePersistence(Boolean)

    Enable or disable persisting component's state between page reloads.

    Declaration
    public PagerBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    PagerBuilder

    EnableQueryString(Boolean)

    If enableQueryString set to true, then it pass current page information as a query string along with the URL while navigating to other page.

    Declaration
    public PagerBuilder EnableQueryString(bool enableQueryString = true)
    Parameters
    Type Name Description
    System.Boolean enableQueryString
    Returns
    Type Description
    PagerBuilder

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public PagerBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    PagerBuilder

    ExternalMessage(String)

    Defines the external message of Pager.

    Declaration
    public PagerBuilder ExternalMessage(string externalMessage)
    Parameters
    Type Name Description
    System.String externalMessage
    Returns
    Type Description
    PagerBuilder

    HtmlAttributes(Object)

    Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

    Declaration
    public PagerBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    PagerBuilder

    Locale(String)

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    public PagerBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    PagerBuilder

    PageCount(Double)

    Defines the number of pages to display in pager container.

    Declaration
    public PagerBuilder PageCount(double pageCount)
    Parameters
    Type Name Description
    System.Double pageCount
    Returns
    Type Description
    PagerBuilder

    PageSize(Double)

    Defines the records count of visible page.

    Declaration
    public PagerBuilder PageSize(double pageSize)
    Parameters
    Type Name Description
    System.Double pageSize
    Returns
    Type Description
    PagerBuilder

    PageSizes(Boolean)

    If pageSizes set to true or Array of values, It renders DropDownList in the pager which allow us to select pageSize from DropDownList.

    Declaration
    public PagerBuilder PageSizes(bool pageSizes = true)
    Parameters
    Type Name Description
    System.Boolean pageSizes
    Returns
    Type Description
    PagerBuilder

    PageSizes(Object)

    If pageSizes set to true or Array of values, It renders DropDownList in the pager which allow us to select pageSize from DropDownList.

    Declaration
    public PagerBuilder PageSizes(object pageSizes)
    Parameters
    Type Name Description
    System.Object pageSizes
    Returns
    Type Description
    PagerBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    Microsoft.AspNetCore.Html.HtmlString

    Template(String)

    Defines the template as string or HTML element ID which renders customized elements in pager instead of default elements.

    Declaration
    public PagerBuilder Template(string template)
    Parameters
    Type Name Description
    System.String template
    Returns
    Type Description
    PagerBuilder

    TotalRecordsCount(Double)

    Gets or Sets the total records count which is used to render numeric container.

    Declaration
    public PagerBuilder TotalRecordsCount(double totalRecordsCount)
    Parameters
    Type Name Description
    System.Double totalRecordsCount
    Returns
    Type Description
    PagerBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved