Class TreeGridPageSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
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)
Sets the current page number in the TreeGrid, defining which page of data is initially displayed to users.
Declaration
public TreeGridPageSettingsBuilder CurrentPage(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
EnableQueryString(Boolean)
When set to true, appends the current page information as a query string to the remote service URL during page navigation within the TreeGrid.
Declaration
public TreeGridPageSettingsBuilder EnableQueryString(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
PageCount(Double)
Determines the number of page numbers displayed in the TreeGrid pager container. This setting helps users navigate between different parts of the dataset.
Declaration
public TreeGridPageSettingsBuilder PageCount(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
PageSize(Double)
Specifies the number of records to display per page in the TreeGrid. Adjust this setting to control the volume of data presented on each page.
Declaration
public TreeGridPageSettingsBuilder PageSize(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
PageSizeMode(PageSizeMode)
Specifies the mode for counting records on a page, determining whether all records are counted or only zeroth level parent records. The available options are:
All: Includes all records in the count.
Root: Includes only zeroth level parent records.
Declaration
public TreeGridPageSettingsBuilder PageSizeMode(PageSizeMode value)
Parameters
Returns
PageSizes(Boolean)
Enables a DropDownList in the TreeGrid pager, allowing users to select the page size. Accepts either a boolean to toggle this feature or an array of page size options.
Declaration
public TreeGridPageSettingsBuilder PageSizes(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
PageSizes(Object)
Enables a DropDownList in the TreeGrid pager, allowing users to select the page size. Accepts either a boolean to toggle this feature or an array of page size options.
Declaration
public TreeGridPageSettingsBuilder PageSizes(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Template(String)
Provides a custom template for rendering pager elements in the TreeGrid, offering enhanced flexibility and control over the pager's appearance and functionality. Accepts a template string or the ID of an HTML element.
Declaration
public TreeGridPageSettingsBuilder Template(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
