ASP.NET Core - EJ2

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

    Show / Hide Table of Contents

    Class TreeGridPageSettingsBuilder

    Inheritance
    System.Object
    ControlBuilder
    TreeGridPageSettingsBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.TreeGrid
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class TreeGridPageSettingsBuilder : ControlBuilder

    Constructors

    TreeGridPageSettingsBuilder()

    Declaration
    public TreeGridPageSettingsBuilder()

    TreeGridPageSettingsBuilder(TreeGridPageSettings)

    Declaration
    public TreeGridPageSettingsBuilder(TreeGridPageSettings model)
    Parameters
    Type Name Description
    TreeGridPageSettings model

    Methods

    CurrentPage(Double)

    Defines the current page number of the pager in TreeGrid.

    Declaration
    public TreeGridPageSettingsBuilder CurrentPage(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    TreeGridPageSettingsBuilder

    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 in TreeGrid.

    Declaration
    public TreeGridPageSettingsBuilder EnableQueryString(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    TreeGridPageSettingsBuilder

    PageCount(Double)

    Defines the number of pages to be displayed in the TreeGrid pager container.

    Declaration
    public TreeGridPageSettingsBuilder PageCount(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    TreeGridPageSettingsBuilder

    PageSize(Double)

    Defines the number of records to be displayed in TreeGrid per page.

    Declaration
    public TreeGridPageSettingsBuilder PageSize(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    TreeGridPageSettingsBuilder

    PageSizeMode(PageSizeMode)

    Specifies the mode of record count in a page. The options are, All: Count all the records. Root: Count only zeroth level parent records.

    Declaration
    public TreeGridPageSettingsBuilder PageSizeMode(PageSizeMode value)
    Parameters
    Type Name Description
    PageSizeMode value
    Returns
    Type Description
    TreeGridPageSettingsBuilder

    PageSizes(Boolean)

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

    Declaration
    public TreeGridPageSettingsBuilder PageSizes(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    TreeGridPageSettingsBuilder

    PageSizes(Object)

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

    Declaration
    public TreeGridPageSettingsBuilder PageSizes(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    TreeGridPageSettingsBuilder

    Template(String)

    Defines the template which renders customized elements in pager of TreeGrid instead of default elements. It accepts either template string or HTML element ID.

    Declaration
    public TreeGridPageSettingsBuilder Template(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    TreeGridPageSettingsBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved