Class GridPageSettings

Configures grid paging.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfDataBoundComponent
GridPageSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class GridPageSettings : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

GridPageSettings()

Declaration
public GridPageSettings()

Properties

CurrentPage

Defines the current page number of the pager.

Declaration
[Parameter]
public int CurrentPage { get; set; }
Property Value
Type
int

EnableExternalMessage

Enable or disable the ExternalMessage.

Declaration
public bool EnableExternalMessage { get; set; }
Property Value
Type
bool

EnableQueryString

If EnableQueryString set to true, then it pass current page information as a query string along with the URL while navigating to other page.

Declaration
[Parameter]
public bool EnableQueryString { get; set; }
Property Value
Type
bool

ExternalMessage

Defines the pager External message.

Declaration
public string ExternalMessage { get; set; }
Property Value
Type
string

PageCount

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

Declaration
[Parameter]
public int PageCount { get; set; }
Property Value
Type
int

PageSize

Defines the number of records to be displayed per page.

Declaration
[Parameter]
public int PageSize { get; set; }
Property Value
Type
int

PageSizes

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

Declaration
[Parameter]
public object PageSizes { get; set; }
Property Value
Type
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
[Parameter]
[JsonIgnore]
public RenderFragment<object> Template { get; set; }
Property Value
Type
RenderFragment<object>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements