Paginator component description @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *
InheritanceSystem.Object
IgbPaginator
ImplementsSystem.IDisposable
Namespace: IgniteUI.Blazor.Controls Assembly: IgniteUI.Blazor.dll Syntaxpublic class IgbPaginator : BaseRendererElement, JsonSerializable, IDisposable
Constructors IgbPaginator() Declaration Properties GridBaseDirectiveParent Declaration
protected BaseRendererControl GridBaseDirectiveParent { get; set; }
Property Value HierarchicalGridParent Declaration
protected BaseRendererControl HierarchicalGridParent { get; set; }
Property Value OverlaySettings Declaration
public IgbOverlaySettings OverlaySettings { get; set; }
Property Value Page
An @Input property, sets current page of the IgxPaginatorComponent
. The default is 0.
let page = this.paginator.page;
@memberof IgxPaginatorComponent
Declarationpublic double Page { get; set; }
Property Value Type Description System.Double PageChange Declaration
public EventCallback<IgbNumberEventArgs> PageChange { get; set; }
Property Value PageChangeScript Declaration
public string PageChangeScript { get; set; }
Property Value Type Description System.String Paging Declaration
public EventCallback<IgbPageCancellableEventArgs> Paging { get; set; }
Property Value PagingDone Declaration
public EventCallback<IgbPageEventArgs> PagingDone { get; set; }
Property Value Type Description Microsoft.AspNetCore.Components.EventCallback<IgbPageEventArgs> PagingDoneScript Declaration
public string PagingDoneScript { get; set; }
Property Value Type Description System.String PagingScript Declaration
public string PagingScript { get; set; }
Property Value Type Description System.String PerPage
An @Input property, sets number of visible items per page in the IgxPaginatorComponent
. The default is 15.
let itemsPerPage = this.paginator.perPage;
@memberof IgxPaginatorComponent
Declarationpublic double PerPage { get; set; }
Property Value Type Description System.Double PerPageChange Declaration
public EventCallback<IgbNumberEventArgs> PerPageChange { get; set; }
Property Value PerPageChangeScript Declaration
public string PerPageChangeScript { get; set; }
Property Value Type Description System.String ResourceStrings
An accessor that sets the resource strings. By default it uses EN resources.
Declarationpublic IgbPaginatorResourceStrings ResourceStrings { get; set; }
Property Value RowIslandParent Declaration
protected BaseRendererElement RowIslandParent { get; set; }
Property Value SelectOptions
An @Input property that sets custom options in the select of the paginator
let options = this.paginator.selectOptions;
@memberof IgxPaginatorComponent
Declarationpublic double[] SelectOptions { get; set; }
Property Value Type Description System.Double[] TotalPages
Total pages calculated from totalRecords and perPage
Declarationpublic double TotalPages { get; set; }
Property Value Type Description System.Double TotalRecords
An @Input property that sets the total records.
let totalRecords = this.paginator.totalRecords;
@memberof IgxPaginatorComponent
Declarationpublic double TotalRecords { get; set; }
Property Value Type Description System.Double Type Declaration
public override string Type { get; }
Property Value Type Description System.String Overrides Methods Dispose() Declaration EnsureModulesLoaded() Declaration
protected override void EnsureModulesLoaded()
Overrides FindByName(String) Declaration
public override object FindByName(string name)
Parameters Type Name Description System.String name Returns Type Description System.Object Overrides GetIsFirstPage() Declaration
public bool GetIsFirstPage()
Returns Type Description System.Boolean GetIsFirstPageAsync() Declaration
public Task<bool> GetIsFirstPageAsync()
Returns Type Description System.Threading.Tasks.Task<System.Boolean> GetIsLastPage() Declaration
public bool GetIsLastPage()
Returns Type Description System.Boolean GetIsLastPageAsync() Declaration
public Task<bool> GetIsLastPageAsync()
Returns Type Description System.Threading.Tasks.Task<System.Boolean> NextPage() Declaration NextPageAsync()
Goes to the next page of the IgxPaginatorComponent
, if the paginator is not already at the last page.
this.paginator.nextPage();
@memberof IgxPaginatorComponent
Declarationpublic Task NextPageAsync()
Returns Type Description System.Threading.Tasks.Task OnInitializedAsync() Declaration
protected override Task OnInitializedAsync()
Returns Type Description System.Threading.Tasks.Task Paginate(Double) Declaration
public void Paginate(double val)
Parameters Type Name Description System.Double val PaginateAsync(Double)
Goes to the desired page index.
this.paginator.paginate(1);
val @memberof IgxPaginatorComponent
Declarationpublic Task PaginateAsync(double val)
Parameters Type Name Description System.Double val Returns Type Description System.Threading.Tasks.Task PreviousPage() Declaration
public void PreviousPage()
PreviousPageAsync()
Goes to the previous page of the IgxPaginatorComponent
, if the paginator is not already at the first page.
this.paginator.previousPage();
@memberof IgxPaginatorComponent
Declarationpublic Task PreviousPageAsync()
Returns Type Description System.Threading.Tasks.Task SetNativeElement(Object) Declaration
public void SetNativeElement(object element)
Parameters Type Name Description System.Object element SetNativeElementAsync(Object) Declaration
public Task SetNativeElementAsync(object element)
Parameters Type Name Description System.Object element Returns Type Description System.Threading.Tasks.Task Implements
System.IDisposable
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4