Class SfPager

Methods partial class

Inheritance

System.Object

SfBaseComponent

SfPager

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Namespace: Syncfusion.Blazor.Navigations

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfPager : SfBaseComponent

Constructors

SfPager()

Declaration

public SfPager()

Properties

Click

An event that is raised when click the numeric item.

Declaration

public EventCallback<PageClickEventArgs> Click { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PageClickEventArgs>

Remarks

Event handler receives a object which provides the details of new page navigation.

Examples

<SfPager>
<PagerEvents Click="OnClick"></ PagerEvents >
</SfPager>
@code{
   public void OnClick (PageClickEventArgs args)
   {
   }
}

Created

An event that is raised when pager component is created

Declaration

public EventCallback Created { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback

Examples

<SfPager>
<PagerEvents Created="Created" ></PagerEvents>
</SfPager>
@code{
   public void Created()
   {
   }
}

CssClass

Specifies the CSS class name that can be appended with the root element of the Pager. One or more custom CSS classes can be added to a Pager.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String

CurrentPage

Defines the current page number of pager.

Declaration

public int CurrentPage { get; set; }

Property Value

Type	Description
System.Int32

EnablePersistence

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

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Enabling this property will store the pager state such as current page, pagesize, current focus and pager dropdown in the window.localStorage when the component is disposed.

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

ID

Defines the pager component Id.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

NumericItemPrefix

Defines the customized text to append with numeric items.

Declaration

public string NumericItemPrefix { get; set; }

Property Value

Type	Description
System.String

NumericItemsCount

Defines the number of pages to display in pager container.

Declaration

public int NumericItemsCount { get; set; }

Property Value

Type	Description
System.Int32

PageChanged

An event that is raised when navigated to new page

Declaration

public EventCallback<PageChangedEventArgs> PageChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PageChangedEventArgs>

Remarks

Event handler receives a object which provides the details of navigated page.

Examples

<SfPager>
<PagerEvents PageChanged="Changed" ></ PagerEvents >
</SfPager>
@code{
   public void Changed(ChangedEventArgs args)
   {
   }
}

PageChanging

An event that is raised when navigating to new page

Declaration

public EventCallback<PageChangingEventArgs> PageChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PageChangingEventArgs>

Remarks

Event handler receives a object which provides the details of new page navigation.

Examples

<SfPager>
<PagerEvents Changing="Changing"></ PagerEvents >
</SfPager>
@code{
   public void Changing (ChangingEventArgs args)
   {
   }
}

PageSize

Defines the records count of visible page.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
System.Int32

PageSizeChanged

An event that is raised when dynamically change the page size using pagesizes dropdown

Declaration

public EventCallback<PageSizeChangedArgs> PageSizeChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PageSizeChangedArgs>

Remarks

Event handler receives a object which provides the details of updated pagesize.

Examples

<SfPager>
<PagerEvents PageSizeChanged="PageSizeChanged" ></ PagerEvents >
</SfPager>
@code{
   public void PageSizeChanged(PageSizeChangedArgs args)
   {
   }
}

PageSizeChanging

An event that is raised when pager component when dynamically change the page size using pagesizes dropdown

Declaration

public EventCallback<PageSizeChangingArgs> PageSizeChanging { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PageSizeChangingArgs>

Remarks

Event handler receives a object which provides the details of current pagesize.

Examples

<SfPager>
<PagerEvents PageSizeChanging="PageSizeChanging"></ PagerEvents >
</SfPager>
@code{
   public void PageSizeChanging (PageSizeChangingArgs args)
   {
   }
}

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

ShowPagerMessage

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

Declaration

public bool ShowPagerMessage { get; set; }

Property Value

Type	Description
System.Boolean

Template

Defines the template which renders customized elements in pager instead of default elements.

Declaration

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

Property Value

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

Remarks

The parameters passed to the templates can be accessed using implicit parameter named context.

TotalItemsCount

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

Declaration

public int TotalItemsCount { get; set; }

Property Value

Type	Description
System.Int32

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

GoToFirstPageAsync()

Navigate to First page.

Declaration

public Task GoToFirstPageAsync()

Returns

Type	Description
System.Threading.Tasks.Task

GoToLastPageAsync()

Navigate to Last page.

Declaration

public Task GoToLastPageAsync()

Returns

Type	Description
System.Threading.Tasks.Task

GoToNextPageAsync()

Navigate to Next page.

Declaration

public Task GoToNextPageAsync()

Returns

Type	Description
System.Threading.Tasks.Task

GoToPageAsync(Int32)

Navigate to target page by given number.

Declaration

public Task GoToPageAsync(int pageNo)

Parameters

Type	Name	Description
System.Int32	pageNo

Returns

Type	Description
System.Threading.Tasks.Task

GoToPreviousPageAsync()

Navigate to Previous page.

Declaration

public Task GoToPreviousPageAsync()

Returns

Type	Description
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender	Set to true for the first time component rendering; otherwise gets false.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.

Overrides

SfBaseComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

RefreshAsync()

Applies all the property changes and render the component again.

Declaration

public Task RefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

SetParametersAsync(ParameterView)

Sets parameters supplied by the component's parent in the render tree.

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.ParameterView	parameters

Returns

Type	Description
System.Threading.Tasks.Task

UpdateNumericItemsCountAsync(Int32)

Used to update the Page count

Declaration

public Task UpdateNumericItemsCountAsync(int numericItemCount)

Parameters

Type	Name	Description
System.Int32	numericItemCount

Returns

Type	Description
System.Threading.Tasks.Task

UpdatePageSizeAsync(Int32)

Used to update the Page size

Declaration

public Task UpdatePageSizeAsync(int pageSize)

Parameters

Type	Name	Description
System.Int32	pageSize

Returns

Type	Description
System.Threading.Tasks.Task