Class IgbPaginator
Paginator component description
@igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, *
Inheritance
System.Object
IgbPaginator
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbPaginator : IgbDisplayDensityBaseElement, JsonSerializable
Constructors
IgbPaginator()
Declaration
Properties
GridBaseDirectiveParent
Declaration
protected BaseRendererControl GridBaseDirectiveParent { 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
Declaration
public 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
Declaration
public 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.
Declaration
public IgbPaginatorResourceStrings ResourceStrings { 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
Declaration
public double[] SelectOptions { get; set; }
Property Value
Type |
Description |
System.Double[] |
|
TotalPages
Total pages calculated from totalRecords and perPage
Declaration
public 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
Declaration
public 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
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
Declaration
public 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
Declaration
public 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
Declaration
public Task PreviousPageAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Implements