Class PagedDataBoundComponent<T>

Base classes of components that support paging.

Inheritance

System.Object

RadzenComponent

PagedDataBoundComponent<T>

RadzenDataGrid<TItem>

RadzenDataList<TItem>

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.GetComponentCssClass()

RadzenComponent.Debounce(Func<Task>, Int32)

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.OnInitialized()

RadzenComponent.Reference

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

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.CurrentStyle

Namespace: Radzen

Assembly: Radzen.Blazor.dll

Syntax

public class PagedDataBoundComponent<T> : RadzenComponent, IDisposable

Type Parameters

Name	Description
T	The type of the data item

Fields

bottomPager

The bottom pager

Declaration

protected RadzenPager bottomPager

Field Value

Type	Description
RadzenPager

skip

The skip

Declaration

protected int skip

Field Value

Type	Description
System.Int32

topPager

The top pager

Declaration

protected RadzenPager topPager

Field Value

Type	Description
RadzenPager

Properties

AllowPaging

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
System.Boolean	true if paging is allowed; otherwise, false.

Count

Gets or sets the count.

Declaration

public int Count { get; set; }

Property Value

Type	Description
System.Int32	The count.

CurrentPage

Gets or sets the current page.

Declaration

public int CurrentPage { get; set; }

Property Value

Type	Description
System.Int32	The current page.

Data

Gets or sets the data.

Declaration

public IEnumerable<T> Data { get; set; }

Property Value

Type	Description
IEnumerable<T>	The data.

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

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

LoadData

Gets or sets the load data.

Declaration

public EventCallback<LoadDataArgs> LoadData { get; set; }

Property Value

Type	Description
EventCallback<LoadDataArgs>	The load data.

LoadingTemplate

Gets or sets the loading template.

Declaration

public RenderFragment LoadingTemplate { get; set; }

Property Value

Type	Description
RenderFragment	The loading template.

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

Page

Gets or sets the page callback.

Declaration

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

Property Value

Type	Description
EventCallback<PagerEventArgs>	The page callback.

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

PagedView

Gets the paged view.

Declaration

public virtual IQueryable<T> PagedView { get; }

Property Value

Type	Description
IQueryable<T>	The paged view.

PageNumbersCount

Gets or sets the page numbers count.

Declaration

public int PageNumbersCount { get; set; }

Property Value

Type	Description
System.Int32	The page numbers count.

PagerAlwaysVisible

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
System.Boolean	true if pager is visible even when not enough data for paging otherwise, false.

PagerHorizontalAlign

Gets or sets the horizontal align.

Declaration

public HorizontalAlign PagerHorizontalAlign { get; set; }

Property Value

Type	Description
HorizontalAlign	The horizontal align.

PagerPosition

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

Declaration

public PagerPosition PagerPosition { get; set; }

Property Value

Type	Description
PagerPosition	The pager position.

PageSize

Gets or sets the size of the page.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
System.Int32	The size of the page.

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.

Template

Gets or sets the template.

Declaration

public RenderFragment<T> Template { get; set; }

Property Value

Type	Description
RenderFragment<T>	The template.

View

Gets the view.

Declaration

public virtual IQueryable<T> View { get; }

Property Value

Type	Description
IQueryable<T>	The view.

Methods

CalculatePager()

Calculates the pager.

Declaration

protected void CalculatePager()

Dispose()

Detaches event handlers and disposes Reference.

Declaration

public override void Dispose()

Overrides

RadzenComponent.Dispose()

FirstPage(Boolean)

Firsts the 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

GoToPage(Int32, Boolean)

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

Lasts the page.

Declaration

public async Task LastPage()

Returns

Type	Description
Task

NextPage()

Nexts the page.

Declaration

public async Task NextPage()

Returns

Type	Description
Task

OnAfterRenderAsync(Boolean)

Called when [after render asynchronous].

Declaration

protected override async Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender	if set to true [first render].

Returns

Type	Description
Task	Task.

Overrides

RadzenComponent.OnAfterRenderAsync(Boolean)

OnCollectionChanged(Object, NotifyCollectionChangedEventArgs)

Called when INotifyCollectionChanged CollectionChanged is raised.

Declaration

protected virtual void OnCollectionChanged(object sender, NotifyCollectionChangedEventArgs args)

Parameters

Type	Name	Description
System.Object	sender
NotifyCollectionChangedEventArgs	args

OnDataChanged()

Called when [data changed].

Declaration

protected virtual void OnDataChanged()

OnPageChanged(PagerEventArgs)

Handles the PageChanged event.

Declaration

protected async Task OnPageChanged(PagerEventArgs args)

Parameters

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

Returns

Type	Description
Task

OnPageSizeChanged(Int32)

Called when [page size changed].

Declaration

protected virtual async Task OnPageSizeChanged(int value)

Parameters

Type	Name	Description
System.Int32	value	The value.

Returns

Type	Description
Task

OnParametersSetAsync()

Called when [parameters set asynchronous].

Declaration

protected override async Task OnParametersSetAsync()

Returns

Type	Description
Task	Task.

PrevPage()

Previouses the page.

Declaration

public async Task PrevPage()

Returns

Type	Description
Task

Reload()

Reloads this instance.

Declaration

public virtual async Task Reload()

Returns

Type	Description
Task

SetParametersAsync(ParameterView)

Set parameters as an asynchronous operation.

Declaration

public override async Task SetParametersAsync(ParameterView parameters)

Parameters

Type	Name	Description
ParameterView	parameters	The parameters.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Overrides

RadzenComponent.SetParametersAsync(ParameterView)

Implements

IDisposable