Table of Contents

Class PagedDataBoundComponent<T>

Namespace
Radzen
Assembly
Radzen.Blazor.dll

Base classes of components that support paging.

public class PagedDataBoundComponent<T> : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Type Parameters

T

The type of the data item

Inheritance
PagedDataBoundComponent<T>
Implements
Derived
Inherited Members

Constructors

PagedDataBoundComponent() 

public PagedDataBoundComponent()

Fields

bottomPager

The bottom pager

protected RadzenPager bottomPager

Field Value

RadzenPager

skip

The skip

protected int skip

Field Value

int

topPager

The top pager

protected RadzenPager topPager

Field Value

RadzenPager

Properties

AllowPaging

Gets or sets a value indicating whether paging is allowed. Set to false by default.

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

Property Value

bool

true if paging is allowed; otherwise, false.

Count

Gets or sets the count.

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

Property Value

int

The count.

CurrentPage

Gets or sets the current page.

public int CurrentPage { get; set; }

Property Value

int

The current page.

Data

Gets or sets the data.

[Parameter]
public IEnumerable<T> Data { get; set; }

Property Value

IEnumerable<T>

The data.

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

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

LoadData

Gets or sets the load data.

[Parameter]
public EventCallback<LoadDataArgs> LoadData { get; set; }

Property Value

EventCallback<LoadDataArgs>

The load data.

LoadingTemplate

Gets or sets the loading template.

[Parameter]
public RenderFragment LoadingTemplate { get; set; }

Property Value

RenderFragment

The loading template.

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

Page

Gets or sets the page callback.

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

Property Value

EventCallback<PagerEventArgs>

The page callback.

PageAriaLabelFormat

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

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

Property Value

string

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 size of the page.

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

Property Value

int

The size of the page.

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

PagedView

Gets the paged view.

public virtual IQueryable<T> PagedView { get; }

Property Value

IQueryable<T>

The paged view.

PagerAlwaysVisible

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

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

Property Value

bool

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

PagerHorizontalAlign

Gets or sets the horizontal align.

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

Property Value

HorizontalAlign

The horizontal align.

PagerPosition

Gets or sets the pager position. Set to PagerPosition.Bottom by default.

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

Property Value

PagerPosition

The pager position.

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.

Template

Gets or sets the template.

[Parameter]
public RenderFragment<T> Template { get; set; }

Property Value

RenderFragment<T>

The template.

View

Gets the view.

public virtual IQueryable<T> View { get; }

Property Value

IQueryable<T>

The view.

Methods

CalculatePager()

Calculates the pager.

protected void CalculatePager()

Dispose() 

public override void Dispose()

FirstPage(bool)

Firsts the page.

public Task FirstPage(bool forceReload = false)

Parameters

forceReload bool

if set to true [force reload].

Returns

Task

GoToPage(int, bool)

Goes to 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()

Lasts the page.

public Task LastPage()

Returns

Task

NextPage()

Nexts the page.

public Task NextPage()

Returns

Task

OnAfterRenderAsync(bool)

Called when [after render asynchronous].

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

if set to true [first render].

Returns

Task

Task.

OnCollectionChanged(object, NotifyCollectionChangedEventArgs)

Called when INotifyCollectionChanged CollectionChanged is raised.

protected virtual void OnCollectionChanged(object sender, NotifyCollectionChangedEventArgs args)

Parameters

sender object
args NotifyCollectionChangedEventArgs

OnDataChanged()

Called when [data changed].

protected virtual void OnDataChanged()

OnPageChanged(PagerEventArgs)

Handles the PageChanged event.

protected Task OnPageChanged(PagerEventArgs args)

Parameters

args PagerEventArgs

The PagerEventArgs instance containing the event data.

Returns

Task

OnPageSizeChanged(int)

Called when [page size changed].

protected virtual Task OnPageSizeChanged(int value)

Parameters

value int

The value.

Returns

Task

OnParametersSetAsync()

Called when [parameters set asynchronous].

protected override Task OnParametersSetAsync()

Returns

Task

Task.

PrevPage()

Previouses the page.

public Task PrevPage()

Returns

Task

Reload()

Reloads this instance.

public virtual Task Reload()

Returns

Task

SetParametersAsync(ParameterView)

Set parameters as an asynchronous operation.

public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters ParameterView

The parameters.

Returns

Task

A Task representing the asynchronous operation.