Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfPager - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfPager

    Inheritance
    System.Object
    Syncfusion.Blazor.SfBaseComponent
    SfDataBoundComponent
    SfPager
    Inherited Members
    SfDataBoundComponent.SetDataManager<T>(Object)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    Namespace: Syncfusion.Blazor.Grids
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class SfPager : SfDataBoundComponent, IPager

    Constructors

    SfPager()

    Declaration
    public SfPager()

    Properties

    ChildContent

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    CurrentPage

    Defines the current page number of pager.

    Declaration
    public double CurrentPage { get; set; }
    Property Value
    Type Description
    System.Double

    CustomText

    Defines the customized text to append with numeric items.

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

    EnableExternalMessage

    If EnableExternalMessage set to true, then it adds the message to Pager.

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

    EnablePagerMessage

    If EnablePagerMessage set to true, then it adds the pager information.

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

    EnablePersistence

    Enable or disable persisting component's state between page reloads.

    Declaration
    public bool EnablePersistence { 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

    EnableRtl

    Enable or disable rendering component in right to left direction.

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

    ExternalMessage

    Defines the external message of Pager.

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

    ID

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

    Locale

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

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

    PageCount

    Defines the number of pages to display in pager container.

    Declaration
    public double PageCount { get; set; }
    Property Value
    Type Description
    System.Double

    PageSize

    Defines the records count of visible page.

    Declaration
    public double PageSize { get; set; }
    Property Value
    Type Description
    System.Double

    PageSizes

    If PageSizes set to true or list of values, It renders DropDownList in the pager which allow us to select page size 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.

    Declaration
    public RenderFragment<PagerTemplateContext> Template { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<PagerTemplateContext>
    Remarks

    The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type PagerTemplateContext.

    TotalPages

    Gets or Sets the total records count which is used to render numeric container.

    Declaration
    public double TotalPages { get; set; }
    Property Value
    Type Description
    System.Double

    TotalRecordsCount

    Gets or Sets the total records count which is used to render numeric container.

    Declaration
    public double TotalRecordsCount { get; set; }
    Property Value
    Type Description
    System.Double

    UnMatchedAttributes

    Declaration
    public IDictionary<string, object> UnMatchedAttributes { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    GetLocalizedLabel(String)

    Gets the localized label by locale keyword.

    Declaration
    public Task<string> GetLocalizedLabel(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    GoToPage(Double)

    Navigate to target page by given number.

    Declaration
    public Task GoToPage(double pageNo)
    Parameters
    Type Name Description
    System.Double pageNo
    Returns
    Type Description
    System.Threading.Tasks.Task

    OnAfterRenderAsync(Boolean)

    Declaration
    protected override Task OnAfterRenderAsync(bool firstRender)
    Parameters
    Type Name Description
    System.Boolean firstRender
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)

    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 - 2021 Syncfusion Inc. All Rights Reserved