Class PagedDataBoundComponent<T>

Base classes of components that support paging.

Inheritance

object

ComponentBase

RadzenComponent

PagedDataBoundComponent<T>

RadzenDataGrid<TItem>

RadzenDataList<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(MouseEventArgs)

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.GetComponentCssClass()

RadzenComponent.Debounce(Func<Task>, int)

RadzenComponent.OnInitialized()

RadzenComponent.RaiseContextMenu(MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

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.BuildRenderTree(RenderTreeBuilder)

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

Assembly: Radzen.Blazor.dll

Syntax

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

Type Parameters

Name	Description
T	The type of the data item

Constructors

PagedDataBoundComponent()

Base classes of components that support paging.

Declaration

public PagedDataBoundComponent()

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
int

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

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

Property Value

Type	Description
bool	true if paging is allowed; otherwise, false.

Count

Gets or sets the count.

Declaration

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

Property Value

Type	Description
int	The count.

CurrentPage

Gets or sets the current page.

Declaration

public int CurrentPage { get; set; }

Property Value

Type	Description
int	The current page.

Data

Gets or sets the data.

Declaration

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

Property Value

Type	Description
IEnumerable<T>	The data.

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

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

LoadData

Gets or sets the load data.

Declaration

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

Property Value

Type	Description
EventCallback<LoadDataArgs>	The load data.

LoadingTemplate

Gets or sets the loading template.

Declaration

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

[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

Page

Gets or sets the page callback.

Declaration

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

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

Property Value

Type	Description
string

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

Declaration

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

Property Value

Type	Description
int	The size of the page.

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

PagedView

Gets the paged view.

Declaration

public virtual IQueryable<T> PagedView { get; }

Property Value

Type	Description
IQueryable<T>	The paged view.

PagerAlwaysVisible

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

Declaration

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

Property Value

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

PagerHorizontalAlign

Gets or sets the horizontal align.

Declaration

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

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

Property Value

Type	Description
PagerPosition	The pager position.

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.

Template

Gets or sets the template.

Declaration

[Parameter]
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(bool)

Firsts the page.

Declaration

public Task FirstPage(bool forceReload = false)

Parameters

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

Returns

Type	Description
Task

GoToPage(int, bool)

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

Lasts the page.

Declaration

public Task LastPage()

Returns

Type	Description
Task

NextPage()

Nexts the page.

Declaration

public Task NextPage()

Returns

Type	Description
Task

OnAfterRenderAsync(bool)

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
Task	Task.

Overrides

RadzenComponent.OnAfterRenderAsync(bool)

OnCollectionChanged(object, NotifyCollectionChangedEventArgs)

Called when INotifyCollectionChanged CollectionChanged is raised.

Declaration

protected virtual void OnCollectionChanged(object sender, NotifyCollectionChangedEventArgs args)

Parameters

Type	Name	Description
object	sender
NotifyCollectionChangedEventArgs	args

OnDataChanged()

Called when [data changed].

Declaration

protected virtual void OnDataChanged()

OnPageChanged(PagerEventArgs)

Handles the PageChanged event.

Declaration

protected Task OnPageChanged(PagerEventArgs args)

Parameters

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

Returns

Type	Description
Task

OnPageSizeChanged(int)

Called when [page size changed].

Declaration

protected virtual Task OnPageSizeChanged(int value)

Parameters

Type	Name	Description
int	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()

Previouses the page.

Declaration

public Task PrevPage()

Returns

Type	Description
Task

Reload()

Reloads this instance.

Declaration

public virtual Task Reload()

Returns

Type	Description
Task

SetParametersAsync(ParameterView)

Set parameters as an asynchronous operation.

Declaration

public override 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

IComponent

IHandleEvent

IHandleAfterRender

IDisposable