Class TreeGridPageSettingsBuilder
Inheritance
System.Object
TreeGridPageSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridPageSettingsBuilder : ControlBuilder
Constructors
TreeGridPageSettingsBuilder()
Declaration
public TreeGridPageSettingsBuilder()
TreeGridPageSettingsBuilder(TreeGridPageSettings)
Declaration
public TreeGridPageSettingsBuilder(TreeGridPageSettings model)
Parameters
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
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
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
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
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
Returns
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
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
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
