Class TreeGridPageSettings

Configures Tree Grid page.

Inheritance

System.Object

TreeGridPageSettings

Namespace: Syncfusion.Blazor.TreeGrid

Assembly: Syncfusion.Blazor.dll

Syntax

public class TreeGridPageSettings : OwningComponentBase

Constructors

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
System.Int32

EnableQueryString

If EnableQueryString is 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 bool EnableQueryString { get; set; }

Property Value

Type
System.Boolean

PageCount

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

Declaration

public int PageCount { get; set; }

Property Value

Type
System.Int32

PageSize

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

Declaration

public int PageSize { get; set; }

Property Value

Type
System.Int32

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 PageSizeMode PageSizeMode { get; set; }

Property Value

Type
PageSizeMode

PageSizes

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 object PageSizes { get; set; }

Property Value

Type
System.Object

Template

Defines the template which renders customized elements in pager instead of default elements. The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type PagerTemplateContext of the grid.

Declaration

public RenderFragment<object> Template { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

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.