Class RadzenPager

RadzenPager component.

Inheritance

object

ComponentBase

RadzenComponent

RadzenPager

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(MouseEventArgs)

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, int)

RadzenComponent.OnInitialized()

RadzenComponent.SetParametersAsync(ParameterView)

RadzenComponent.RaiseContextMenu(MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Dispose()

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenPager : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Examples

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

Constructors

RadzenPager()

RadzenPager component.

Declaration

public RadzenPager()

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
int

numberOfPageLinks

Gets or sets number of page links.

Declaration

protected int numberOfPageLinks

Field Value

Type	Description
int

numberOfPages

Gets or sets number of pages.

Declaration

protected int numberOfPages

Field Value

Type	Description
int

skip

Gets or sets number of recrods to skip.

Declaration

protected int skip

Field Value

Type	Description
int

startPage

Gets or sets start page.

Declaration

protected int startPage

Field Value

Type	Description
int

Properties

AlwaysVisible

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

Declaration

[Parameter]
public bool AlwaysVisible { get; set; }

Property Value

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

Count

Gets or sets the total items count.

Declaration

[Parameter]
public int Count { get; set; }

Property Value

Type	Description
int	The total items count.

CurrentPage

Gets the current page.

Declaration

public int CurrentPage { get; }

Property Value

Type	Description
int	The current page.

Density

Gets or sets a value indicating Pager density.

Declaration

[Parameter]
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

[Parameter]
public string FirstPageAriaLabel { get; set; }

Property Value

Type	Description
string

FirstPageTitle

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

Declaration

[Parameter]
public string FirstPageTitle { get; set; }

Property Value

Type	Description
string

HorizontalAlign

Gets or sets the horizontal align.

Declaration

[Parameter]
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

[Parameter]
public string LastPageAriaLabel { get; set; }

Property Value

Type	Description
string

LastPageTitle

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

Declaration

[Parameter]
public string LastPageTitle { get; set; }

Property Value

Type	Description
string

NextPageAriaLabel

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

Declaration

[Parameter]
public string NextPageAriaLabel { get; set; }

Property Value

Type	Description
string

NextPageLabel

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

Declaration

[Parameter]
public string NextPageLabel { get; set; }

Property Value

Type	Description
string

NextPageTitle

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

Declaration

[Parameter]
public string NextPageTitle { get; set; }

Property Value

Type	Description
string

PageAriaLabelFormat

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

Declaration

[Parameter]
public string PageAriaLabelFormat { get; set; }

Property Value

Type	Description
string

PageChanged

Gets or sets the page changed callback.

Declaration

[Parameter]
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

[Parameter]
public int PageNumbersCount { get; set; }

Property Value

Type	Description
int	The page numbers count.

PageSize

Gets or sets the page size.

Declaration

[Parameter]
public int PageSize { get; set; }

Property Value

Type	Description
int	The page size.

PageSizeChanged

Gets or sets the page size changed callback.

Declaration

[Parameter]
public EventCallback<int> PageSizeChanged { get; set; }

Property Value

Type	Description
EventCallback<int>	The page size changed callback.

PageSizeOptions

Gets or sets the page size options.

Declaration

[Parameter]
public IEnumerable<int> PageSizeOptions { get; set; }

Property Value

Type	Description
IEnumerable<int>	The page size options.

PageSizeText

Gets or sets the page size description text.

Declaration

[Parameter]
public string PageSizeText { get; set; }

Property Value

Type	Description
string	The page size description text.

PageTitleFormat

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

Declaration

[Parameter]
public string PageTitleFormat { get; set; }

Property Value

Type	Description
string

PagingSummaryFormat

Gets or sets the pager summary format.

Declaration

[Parameter]
public string PagingSummaryFormat { get; set; }

Property Value

Type	Description
string	The pager summary format.

Remarks

PagingSummaryTemplate has preference

PagingSummaryTemplate

Gets or sets the pager summary template.

Declaration

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

Property Value

Type	Description
RenderFragment<PagingInformation>

Remarks

Has preference over PagingSummaryFormat

PrevPageAriaLabel

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

Declaration

[Parameter]
public string PrevPageAriaLabel { get; set; }

Property Value

Type	Description
string

PrevPageLabel

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

Declaration

[Parameter]
public string PrevPageLabel { get; set; }

Property Value

Type	Description
string

PrevPageTitle

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

Declaration

[Parameter]
public string PrevPageTitle { get; set; }

Property Value

Type	Description
string

ShowPagingSummary

Gets or sets the pager summary visibility.

Declaration

[Parameter]
public bool ShowPagingSummary { get; set; }

Property Value

Type	Description
bool	The pager summary visibility.

Methods

BuildRenderTree(RenderTreeBuilder)

RadzenPager component.

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

CalculatePager()

Calculates the pager.

Declaration

protected void CalculatePager()

FirstPage(bool)

Goes to first page.

Declaration

public Task FirstPage(bool forceReload = false)

Parameters

Type	Name	Description
bool	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
string

Overrides

RadzenComponent.GetComponentCssClass()

GetPage()

Gets the page.

Declaration

protected int GetPage()

Returns

Type	Description
int	System.Int32.

GetVisible()

Gets the visible.

Declaration

protected bool GetVisible()

Returns

Type	Description
bool	true if XXXX, false otherwise.

GoToPage(int, bool)

Goes to specified page.

Declaration

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

Parameters

Type	Name	Description
int	page	The page.
bool	forceReload	if set to true [force reload].

Returns

Type	Description
Task

LastPage()

Goes to last page.

Declaration

public Task LastPage()

Returns

Type	Description
Task

NextPage()

Goes to next page.

Declaration

public Task NextPage()

Returns

Type	Description
Task

OnAfterRenderAsync(bool)

Called by the Blazor runtime.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
bool	firstRender

Returns

Type	Description
Task

Overrides

RadzenComponent.OnAfterRenderAsync(bool)

OnKeyDown(KeyboardEventArgs)

Handles the KeyDown event.

Declaration

protected virtual Task OnKeyDown(KeyboardEventArgs args)

Parameters

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

Returns

Type	Description
Task

OnPageSizeChanged(object)

Called when page size changed.

Declaration

protected Task OnPageSizeChanged(object value)

Parameters

Type	Name	Description
object	value	The value.

Returns

Type	Description
Task

OnParametersSetAsync()

Called when parameters set asynchronous.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
Task	Task.

Overrides

ComponentBase.OnParametersSetAsync()

PrevPage()

Goes to previous page.

Declaration

public Task PrevPage()

Returns

Type	Description
Task

Reload()

Reloads this instance.

Declaration

public virtual Task Reload()

Returns

Type	Description
Task

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable