Class TreeGridPageSettings
Configures Tree Grid page.
Inheritance
Namespace: Syncfusion.Blazor.TreeGrid
Assembly: Syncfusion.Blazor.dll
Syntax
public class TreeGridPageSettings : OwningComponentBaseConstructors
TreeGridPageSettings()
Declaration
public TreeGridPageSettings()Properties
CurrentPage
Defines the current page number of the pager in TreeGrid.
Declaration
public int CurrentPage { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The current page number. The default is 1. |
EnableQueryString
If EnableQueryString is set to true, then it passes current page information as a query string along with the URL while navigating to another page in TreeGrid.
Declaration
public bool EnableQueryString { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | true if query strings along with URLs are enabled; otherwise, false. |
PageCount
Defines the number of pages to be displayed in the TreeGrid pager container.
Declaration
public int PageCount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The number of pages. The default is 8. |
PageSize
Defines the number of records to be displayed in TreeGrid per page.
Declaration
public int PageSize { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The page size. The default is 12. |
PageSizeMode
Specifies the mode of record count on a page. The options are, All: Count all the records. Root: Count only zeroth level parent records.
Declaration
public PageSizeMode PageSizeMode { get; set; }Property Value
| Type | Description |
|---|---|
| PageSizeMode | One of the PageSizeMode enumeration values. The default is Root. |
PageSizes
If PageSizes is set to true or an array of values, it renders a DropDownList in the pager of TreeGrid which allows selecting pageSize from DropDownList.
Declaration
public object PageSizes { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | A boolean or array of values for page sizes. |
Template
Defines the template which renders customized elements in the pager instead of default elements.
Declaration
public RenderFragment<object> Template { get; set; }Property Value
| Type | Description |
|---|---|
| Microsoft.AspNetCore.Components.RenderFragment<System.Object> | Custom template content rendered in the pager. |
Remarks
The parameters passed to the templates can be accessed using an implicit parameter named context.
The context is of type PagerTemplateContext of the grid.
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)Parameters
| Type | Name | Description |
|---|---|---|
| Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder | __builder |
OnInitializedAsync()
Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.
Declaration
protected override Task OnInitializedAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing any asynchronous operation. |
OnParametersSetAsync()
Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.
Declaration
protected override Task OnParametersSetAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing any asynchronous operation. |