Class RadzenPager

RadzenPager component.

Inheritance

System.Object

RadzenComponent

RadzenPager

Implements

IDisposable

Inherited Members

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, Int32)

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.OnInitialized()

RadzenComponent.SetParametersAsync(ParameterView)

RadzenComponent.Reference

RadzenComponent.RaiseContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Dispose()

RadzenComponent.CurrentStyle

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenPager : RadzenComponent, IDisposable

Examples

<RadzenPager Count="100" PageSize="10" PageNumbersCount="5" PageChanged=@(args => Console.WriteLine($"Skip: {args.Skip}, Top: {args.Top}")) />

Fields

endPage

Gets or sets end page.

Declaration

protected int endPage

Field Value

Type	Description
System.Int32

numberOfPageLinks

Gets or sets number of page links.

Declaration

protected int numberOfPageLinks

Field Value

Type	Description
System.Int32

numberOfPages

Gets or sets number of pages.

Declaration

protected int numberOfPages

Field Value

Type	Description
System.Int32

skip

Gets or sets number of recrods to skip.

Declaration

protected int skip

Field Value

Type	Description
System.Int32

startPage

Gets or sets start page.

Declaration

protected int startPage

Field Value

Type	Description
System.Int32

Properties

AlwaysVisible

Gets or sets a value indicating whether pager is visible even when not enough data for paging.

Declaration

public bool AlwaysVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if pager is visible even when not enough data for paging otherwise, false.

Count

Gets or sets the total items count.

Declaration

public int Count { get; set; }

Property Value

Type	Description
System.Int32	The total items count.

CurrentPage

Gets the current page.

Declaration

public int CurrentPage { get; }

Property Value

Type	Description
System.Int32	The current page.

Density

Gets or sets a value indicating Pager density.

Declaration

public Density Density { get; set; }

Property Value

Type	Description
Density

FirstPageAriaLabel

Gets or sets the pager's first page button's aria-label attribute.

Declaration

public string FirstPageAriaLabel { get; set; }

Property Value

Type	Description
System.String

FirstPageTitle

Gets or sets the pager's first page button's title attribute.

Declaration

public string FirstPageTitle { get; set; }

Property Value

Type	Description
System.String

HorizontalAlign

Gets or sets the horizontal align.

Declaration

public HorizontalAlign HorizontalAlign { get; set; }

Property Value

Type	Description
HorizontalAlign	The horizontal align.

LastPageAriaLabel

Gets or sets the pager's last page button's aria-label attribute.

Declaration

public string LastPageAriaLabel { get; set; }

Property Value

Type	Description
System.String

LastPageTitle

Gets or sets the pager's last page button's title attribute.

Declaration

public string LastPageTitle { get; set; }

Property Value

Type	Description
System.String

NextPageAriaLabel

Gets or sets the pager's next page button's aria-label attribute.

Declaration

public string NextPageAriaLabel { get; set; }

Property Value

Type	Description
System.String

NextPageLabel

Gets or sets the pager's optional next page button's label text.

Declaration

public string NextPageLabel { get; set; }

Property Value

Type	Description
System.String

NextPageTitle

Gets or sets the pager's next page button's title attribute.

Declaration

public string NextPageTitle { get; set; }

Property Value

Type	Description
System.String

PageAriaLabelFormat

Gets or sets the pager's numeric page number buttons' aria-label attributes.

Declaration

public string PageAriaLabelFormat { get; set; }

Property Value

Type	Description
System.String

PageChanged

Gets or sets the page changed callback.

Declaration

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

Property Value

Type	Description
EventCallback<PagerEventArgs>	The page changed callback.

PageNumbersCount

Gets or sets the page numbers count.

Declaration

public int PageNumbersCount { get; set; }

Property Value

Type	Description
System.Int32	The page numbers count.

PageSize

Gets or sets the page size.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
System.Int32	The page size.

PageSizeChanged

Gets or sets the page size changed callback.

Declaration

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

Property Value

Type	Description
EventCallback<System.Int32>	The page size changed callback.

PageSizeOptions

Gets or sets the page size options.

Declaration

public IEnumerable<int> PageSizeOptions { get; set; }

Property Value

Type	Description
IEnumerable<System.Int32>	The page size options.

PageSizeText

Gets or sets the page size description text.

Declaration

public string PageSizeText { get; set; }

Property Value

Type	Description
System.String	The page size description text.

PageTitleFormat

Gets or sets the pager's numeric page number buttons' title attributes.

Declaration

public string PageTitleFormat { get; set; }

Property Value

Type	Description
System.String

PagingSummaryFormat

Gets or sets the pager summary format.

Declaration

public string PagingSummaryFormat { get; set; }

Property Value

Type	Description
System.String	The pager summary format.

Remarks

PagingSummaryTemplate has preference

PagingSummaryTemplate

Gets or sets the pager summary template.

Declaration

public RenderFragment<PagingInformation>? PagingSummaryTemplate { get; set; }

Property Value

Type	Description
System.Nullable<RenderFragment<PagingInformation>>

Remarks

Has preference over PagingSummaryFormat

PrevPageAriaLabel

Gets or sets the pager's previous page button's aria-label attribute.

Declaration

public string PrevPageAriaLabel { get; set; }

Property Value

Type	Description
System.String

PrevPageLabel

Gets or sets the pager's optional previous page button's label text.

Declaration

public string PrevPageLabel { get; set; }

Property Value

Type	Description
System.String

PrevPageTitle

Gets or sets the pager's previous page button's title attribute.

Declaration

public string PrevPageTitle { get; set; }

Property Value

Type	Description
System.String

ShowPagingSummary

Gets or sets the pager summary visibility.

Declaration

public bool ShowPagingSummary { get; set; }

Property Value

Type	Description
System.Boolean	The pager summary visibility.

Methods

CalculatePager()

Calculates the pager.

Declaration

protected void CalculatePager()

FirstPage(Boolean)

Goes to first page.

Declaration

public async Task FirstPage(bool forceReload = false)

Parameters

Type	Name	Description
System.Boolean	forceReload	if set to true [force reload].

Returns

Type	Description
Task

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
System.String

Overrides

RadzenComponent.GetComponentCssClass()

GetPage()

Gets the page.

Declaration

protected int GetPage()

Returns

Type	Description
System.Int32	System.Int32.

GetVisible()

Gets the visible.

Declaration

protected bool GetVisible()

Returns

Type	Description
System.Boolean	true if XXXX, false otherwise.

GoToPage(Int32, Boolean)

Goes to specified page.

Declaration

public async Task GoToPage(int page, bool forceReload = false)

Parameters

Type	Name	Description
System.Int32	page	The page.
System.Boolean	forceReload	if set to true [force reload].

Returns

Type	Description
Task

LastPage()

Goes to last page.

Declaration

public async Task LastPage()

Returns

Type	Description
Task

NextPage()

Goes to next page.

Declaration

public async Task NextPage()

Returns

Type	Description
Task

OnAfterRenderAsync(Boolean)

Called by the Blazor runtime.

Declaration

protected override async Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
Task

Overrides

RadzenComponent.OnAfterRenderAsync(Boolean)

OnKeyDown(KeyboardEventArgs)

Handles the KeyDown event.

Declaration

protected virtual async Task OnKeyDown(KeyboardEventArgs args)

Parameters

Type	Name	Description
KeyboardEventArgs	args	The instance containing the event data.

Returns

Type	Description
Task

OnPageSizeChanged(Object)

Called when page size changed.

Declaration

protected async Task OnPageSizeChanged(object value)

Parameters

Type	Name	Description
System.Object	value	The value.

Returns

Type	Description
Task

OnParametersSetAsync()

Called when parameters set asynchronous.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
Task	Task.

PrevPage()

Goes to previous page.

Declaration

public async Task PrevPage()

Returns

Type	Description
Task

Reload()

Reloads this instance.

Declaration

public virtual async Task Reload()

Returns

Type	Description
Task

Implements

IDisposable