Table of Contents

Class RadzenPager

Namespace
Radzen.Blazor
Assembly
Radzen.Blazor.dll

RadzenPager component.

public class RadzenPager : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance
RadzenPager
Implements
Inherited Members

Examples

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

Constructors

RadzenPager() 

public RadzenPager()

Fields

endPage

Gets or sets end page.

protected int endPage

Field Value

int

Gets or sets number of page links.

protected int numberOfPageLinks

Field Value

int

numberOfPages

Gets or sets number of pages.

protected int numberOfPages

Field Value

int

skip

Gets or sets number of recrods to skip.

protected int skip

Field Value

int

startPage

Gets or sets start page.

protected int startPage

Field Value

int

Properties

AlwaysVisible

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

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

Property Value

bool

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

Count

Gets or sets the total items count.

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

Property Value

int

The total items count.

CurrentPage

Gets the current page.

public int CurrentPage { get; }

Property Value

int

The current page.

Density

Gets or sets a value indicating Pager density.

[Parameter]
public Density Density { get; set; }

Property Value

Density

FirstPageAriaLabel

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

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

Property Value

string

FirstPageTitle

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

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

Property Value

string

HorizontalAlign

Gets or sets the horizontal align.

[Parameter]
public HorizontalAlign HorizontalAlign { get; set; }

Property Value

HorizontalAlign

The horizontal align.

LastPageAriaLabel

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

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

Property Value

string

LastPageTitle

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

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

Property Value

string

NextPageAriaLabel

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

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

Property Value

string

NextPageLabel

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

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

Property Value

string

NextPageTitle

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

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

Property Value

string

PageAriaLabelFormat

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

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

Property Value

string

PageChanged

Gets or sets the page changed callback.

[Parameter]
public EventCallback<PagerEventArgs> PageChanged { get; set; }

Property Value

EventCallback<PagerEventArgs>

The page changed callback.

PageNumbersCount

Gets or sets the page numbers count.

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

Property Value

int

The page numbers count.

PageSize

Gets or sets the page size.

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

Property Value

int

The page size.

PageSizeChanged

Gets or sets the page size changed callback.

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

Property Value

EventCallback<int>

The page size changed callback.

PageSizeOptions

Gets or sets the page size options.

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

Property Value

IEnumerable<int>

The page size options.

PageSizeText

Gets or sets the page size description text.

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

Property Value

string

The page size description text.

PageTitleFormat

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

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

Property Value

string

PagingSummaryFormat

Gets or sets the pager summary format.

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

Property Value

string

The pager summary format.

PrevPageAriaLabel

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

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

Property Value

string

PrevPageLabel

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

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

Property Value

string

PrevPageTitle

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

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

Property Value

string

ShowPagingSummary

Gets or sets the pager summary visibility.

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

Property Value

bool

The pager summary visibility.

Methods

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

CalculatePager()

Calculates the pager.

protected void CalculatePager()

FirstPage(bool)

Goes to first page.

public Task FirstPage(bool forceReload = false)

Parameters

forceReload bool

if set to true [force reload].

Returns

Task

GetComponentCssClass() 

protected override string GetComponentCssClass()

Returns

string

GetPage()

Gets the page.

protected int GetPage()

Returns

int

System.Int32.

GetVisible()

Gets the visible.

protected bool GetVisible()

Returns

bool

true if XXXX, false otherwise.

GoToPage(int, bool)

Goes to specified page.

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

Parameters

page int

The page.

forceReload bool

if set to true [force reload].

Returns

Task

LastPage()

Goes to last page.

public Task LastPage()

Returns

Task

NextPage()

Goes to next page.

public Task NextPage()

Returns

Task

OnAfterRenderAsync(bool) 

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Returns

Task

OnKeyDown(KeyboardEventArgs)

Handles the KeyDown event.

protected virtual Task OnKeyDown(KeyboardEventArgs args)

Parameters

args KeyboardEventArgs

The KeyboardEventArgs instance containing the event data.

Returns

Task

OnPageSizeChanged(object)

Called when page size changed.

protected Task OnPageSizeChanged(object value)

Parameters

value object

The value.

Returns

Task

OnParametersSetAsync()

Called when parameters set asynchronous.

protected override Task OnParametersSetAsync()

Returns

Task

Task.

PrevPage()

Goes to previous page.

public Task PrevPage()

Returns

Task

Reload()

Reloads this instance.

public virtual Task Reload()

Returns

Task