PagedDataBoundComponent<T> Class

Base classes of components that support paging.

Inheritance

Object

ComponentBase

RadzenComponent

PagedDataBoundComponent<T>

Implements

IComponent

IHandleEvent

IHandleAfterRender

Namespace: Radzen

Assembly: Radzen.Blazor.dll

Syntax

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

Type Parameters

Name Description
TThe type of the data item

Constructors

PagedDataBoundComponent<T>Link to this section

Base classes of components that support paging.

Declaration
public PagedDataBoundComponent<T>()

Fields

bottomPagerLink to this section

The bottom pager

Declaration
protected RadzenPager bottomPager

skipLink to this section

The skip

Declaration
protected int skip

topPagerLink to this section

The top pager

Declaration
protected RadzenPager topPager

Properties

AllowPagingLink to this section

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

Declaration
public bool AllowPaging { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether paging is allowed. Set to false by default.

CountLink to this section

Gets or sets the count.

Declaration
public int Count { get; set; }
Property Value
Type Description
intGets or sets the count.

CurrentPageLink to this section

Gets or sets the current page.

Declaration
public int CurrentPage { get; set; }
Property Value
Type Description
intGets or sets the current page.

DataLink to this section

Gets or sets the data.

Declaration
public IEnumerable<T> Data { get; set; }
Property Value
Type Description
IEnumerable<T>Gets or sets the data.

DensityLink to this section

Gets or sets a value indicating pager density.

Declaration
public Density Density { get; set; }
Property Value
Type Description
DensityGets or sets a value indicating pager density.

FirstPageAriaLabelLink to this section

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

Declaration
public string FirstPageAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the pager's first page button's aria-label attribute.

FirstPageTitleLink to this section

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

Declaration
public string FirstPageTitle { get; set; }
Property Value
Type Description
stringGets or sets the pager's first page button's title attribute.

LastPageAriaLabelLink to this section

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

Declaration
public string LastPageAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the pager's last page button's aria-label attribute.

LastPageTitleLink to this section

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

Declaration
public string LastPageTitle { get; set; }
Property Value
Type Description
stringGets or sets the pager's last page button's title attribute.

LoadDataLink to this section

Gets or sets the load data.

Declaration
public EventCallback<LoadDataArgs> LoadData { get; set; }
Property Value
Type Description
EventCallback<LoadDataArgs>Gets or sets the load data.

LoadingTemplateLink to this section

Gets or sets the loading template.

Declaration
public RenderFragment LoadingTemplate { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the loading template.

NextPageAriaLabelLink to this section

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

Declaration
public string NextPageAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the pager's next page button's aria-label attribute.

NextPageLabelLink to this section

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

Declaration
public string NextPageLabel { get; set; }
Property Value
Type Description
stringGets or sets the pager's optional next page button's label text.

NextPageTitleLink to this section

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

Declaration
public string NextPageTitle { get; set; }
Property Value
Type Description
stringGets or sets the pager's next page button's title attribute.

PageLink to this section

Gets or sets the page callback.

Declaration
public EventCallback<PagerEventArgs> Page { get; set; }
Property Value
Type Description
EventCallback<PagerEventArgs>Gets or sets the page callback.

PageAriaLabelFormatLink to this section

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

Declaration
public string PageAriaLabelFormat { get; set; }
Property Value
Type Description
stringGets or sets the pager's numeric page number buttons' aria-label attributes.

PageNumbersCountLink to this section

Gets or sets the page numbers count.

Declaration
public int PageNumbersCount { get; set; }
Property Value
Type Description
intGets or sets the page numbers count.

PageSizeLink to this section

Gets or sets the size of the page.

Declaration
public int PageSize { get; set; }
Property Value
Type Description
intGets or sets the size of the page.

PageSizeOptionsLink to this section

Gets or sets the page size options.

Declaration
public IEnumerable<int> PageSizeOptions { get; set; }
Property Value
Type Description
IEnumerable<int>Gets or sets the page size options.

PageSizeTextLink to this section

Gets or sets the page size description text.

Declaration
public string PageSizeText { get; set; }
Property Value
Type Description
stringGets or sets the page size description text.

PageTitleFormatLink to this section

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

Declaration
public string PageTitleFormat { get; set; }
Property Value
Type Description
stringGets or sets the pager's numeric page number buttons' title attributes.

PagedViewLink to this section

Gets the paged view.

Declaration
public IQueryable<T> PagedView { get; }
Property Value
Type Description
IQueryable<T>Gets the paged view.

PagerAlwaysVisibleLink to this section

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

Declaration
public bool PagerAlwaysVisible { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether pager is visible even when not enough data for paging.

PagerHorizontalAlignLink to this section

Gets or sets the horizontal align.

Declaration
public HorizontalAlign PagerHorizontalAlign { get; set; }
Property Value
Type Description
HorizontalAlignGets or sets the horizontal align.

PagerPositionLink to this section

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

Declaration
public PagerPosition PagerPosition { get; set; }
Property Value
Type Description
PagerPositionGets or sets the pager position. Set to PagerPosition.Bottom by default.

PagingSummaryFormatLink to this section

Gets or sets the pager summary format. PagingSummaryTemplate has preference over this property.

Declaration
public string PagingSummaryFormat { get; set; }
Property Value
Type Description
stringGets or sets the pager summary format. PagingSummaryTemplate has preference over this property.

PagingSummaryTemplateLink to this section

Gets or sets the pager summary template. Has preference over PagingSummaryFormat.

Declaration
public RenderFragment<PagingInformation> PagingSummaryTemplate { get; set; }
Property Value
Type Description
RenderFragment<PagingInformation>Gets or sets the pager summary template. Has preference over PagingSummaryFormat.

PrevPageAriaLabelLink to this section

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

Declaration
public string PrevPageAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the pager's previous page button's aria-label attribute.

PrevPageLabelLink to this section

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

Declaration
public string PrevPageLabel { get; set; }
Property Value
Type Description
stringGets or sets the pager's optional previous page button's label text.

PrevPageTitleLink to this section

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

Declaration
public string PrevPageTitle { get; set; }
Property Value
Type Description
stringGets or sets the pager's previous page button's title attribute.

ShowPagingSummaryLink to this section

Gets or sets the pager summary visibility.

Declaration
public bool ShowPagingSummary { get; set; }
Property Value
Type Description
boolGets or sets the pager summary visibility.

TemplateLink to this section

Gets or sets the template.

Declaration
public RenderFragment<T> Template { get; set; }
Property Value
Type Description
RenderFragment<T>Gets or sets the template.

ViewLink to this section

Gets the view.

Declaration
public IQueryable<T> View { get; }
Property Value
Type Description
IQueryable<T>Gets the view.

Methods

CalculatePagerLink to this section

Calculates the pager.

Declaration
protected void CalculatePager()

DisposeLink to this section

Declaration
public override void Dispose()

FirstPageLink to this section

Firsts the page.

Declaration
public Task FirstPage(bool forceReload)
Parameters
Type Name Description
bool forceReload if set to true [force reload].
Returns
Type Description
Task

GoToPageLink to this section

Goes to page.

Declaration
public Task GoToPage(int page, bool forceReload)
Parameters
Type Name Description
int page The page.
bool forceReload if set to true [force reload].
Returns
Type Description
Task

LastPageLink to this section

Lasts the page.

Declaration
public Task LastPage()
Returns
Type Description
Task

NextPageLink to this section

Nexts the page.

Declaration
public Task NextPage()
Returns
Type Description
Task

OnAfterRenderAsyncLink to this section

Called when [after render asynchronous].

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
bool firstRender if set to true [first render].
Returns
Type Description
TaskTask.

OnCollectionChangedLink to this section

Called when INotifyCollectionChanged CollectionChanged is raised.

Declaration
protected virtual void OnCollectionChanged(object sender, Collections.Specialized.NotifyCollectionChangedEventArgs args)
Parameters
Type Name Description
object sender
Collections.Specialized.NotifyCollectionChangedEventArgs args

OnDataChangedLink to this section

Called when [data changed].

Declaration
protected virtual void OnDataChanged()

OnPageChangedLink to this section

Handles the page changed event.

Declaration
protected Task OnPageChanged(PagerEventArgs args)
Parameters
Type Name Description
PagerEventArgs args The PagerEventArgs instance containing the event data.
Returns
Type Description
Task

OnPageSizeChangedLink to this section

Called when [page size changed].

Declaration
protected virtual Task OnPageSizeChanged(int value)
Parameters
Type Name Description
int value The value.
Returns
Type Description
Task

OnParametersSetAsyncLink to this section

Called when [parameters set asynchronous].

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
TaskTask.

PrevPageLink to this section

Previouses the page.

Declaration
public Task PrevPage()
Returns
Type Description
Task

ReloadLink to this section

Reloads this instance.

Declaration
public virtual Task Reload()
Returns
Type Description
Task

SetParametersAsyncLink to this section

Set parameters as an asynchronous operation.

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Type Name Description
ParameterView parameters The parameters.
Returns
Type Description
TaskA Task representing the asynchronous operation.
An error has occurred. This app may no longer respond until reloaded. Reload 🗙