menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridPageSettings - API Reference

    Show / Hide Table of Contents

    Class GridPageSettings

    Configures grid paging.

    Inheritance
    System.Object
    SfBaseComponent
    SfDataBoundComponent
    GridPageSettings
    Inherited Members
    SfDataBoundComponent.SetDataManager<T>(Object)
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    SfBaseComponent.Dispose()
    SfBaseComponent.Dispose(Boolean)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    Namespace: Syncfusion.Blazor.Grids
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class GridPageSettings : SfDataBoundComponent

    Constructors

    GridPageSettings()

    Declaration
    public GridPageSettings()

    Properties

    CurrentPage

    Defines the current page number of the pager.

    Declaration
    public int CurrentPage { get; set; }
    Property Value
    Type Description
    System.Int32

    EnableExternalMessage

    Enable or disable the ExternalMessage.

    Declaration
    public bool EnableExternalMessage { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    public bool EnableQueryString { get; set; }
    Property Value
    Type Description
    System.Boolean

    ExternalMessage

    Defines the pager External message.

    Declaration
    public string ExternalMessage { get; set; }
    Property Value
    Type Description
    System.String

    PageCount

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

    Declaration
    public int PageCount { get; set; }
    Property Value
    Type Description
    System.Int32

    PageSize

    Defines the number of records to be displayed per page.

    Declaration
    public int PageSize { get; set; }
    Property Value
    Type Description
    System.Int32

    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
    public object PageSizes { get; set; }
    Property Value
    Type Description
    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 Description
    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()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnParametersSetAsync()
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved