Paginator component description
Inheritance
object
ComponentBase
Implements
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbPaginator()Returns IgbPaginator
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererElement
protected virtual string ParentTypeName { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererElement
protected virtual bool UseDirectRender { get; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererElement
[Parameter]
public RenderFragment ChildContent { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererElement
protected virtual bool SupportsVisualChildren { get; }Inherited from: BaseRendererElement
[Parameter]
public string Name { get; set; }Parent
Section titled "Parent"Inherited from: BaseRendererElement
public object Parent { get; }MethodTarget
Section titled "MethodTarget"Inherited from: BaseRendererElement
protected virtual string MethodTarget { get; }CurrParent
Section titled "CurrParent"Inherited from: BaseRendererElement
protected object CurrParent { get; }GridBaseDirectiveParent
Section titled "GridBaseDirectiveParent"[CascadingParameter(Name = "GridBaseDirectiveParent")]
protected BaseRendererControl GridBaseDirectiveParent { get; set; }HierarchicalGridParent
Section titled "HierarchicalGridParent"[CascadingParameter(Name = "HierarchicalGridParent")]
protected BaseRendererControl HierarchicalGridParent { get; set; }OverlaySettings
Section titled "OverlaySettings"Sets custom OverlaySettings.
[Parameter]
public IgbOverlaySettings OverlaySettings { get; set; }Gets/Sets the current page of the paginator. The default is 0.
[Parameter]
public double Page { get; set; }PerPage
Section titled "PerPage"Gets/Sets the number of visible items per page in the paginator. The default is 15.
[Parameter]
public double PerPage { get; set; }ResourceStrings
Section titled "ResourceStrings"An accessor that sets the resource strings. By default it uses EN resources.
[Parameter]
public IgbPaginatorResourceStrings ResourceStrings { get; set; }RowIslandParent
Section titled "RowIslandParent"[CascadingParameter(Name = "RowIslandParent")]
protected BaseRendererElement RowIslandParent { get; set; }SelectOptions
Section titled "SelectOptions"Sets custom options in the select of the paginator
[Parameter]
public double[] SelectOptions { get; set; }TotalPages
Section titled "TotalPages"Total pages calculated from totalRecords and perPage
[Parameter]
public double TotalPages { get; set; }TotalRecords
Section titled "TotalRecords"Sets the total records.
[Parameter]
public double TotalRecords { get; set; }public override string Type { get; }Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _nameeventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContentMethods
Section titled "Methods"BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererElement
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererElement
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelper(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererElement
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererElement
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererElement
public string Serialize()Returns any
EnsureValid()
Section titled "EnsureValid()"Inherited from: BaseRendererElement
protected void EnsureValid()Returns any
FromEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
ToEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
Dispose()
Section titled "Dispose()"public void Dispose()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
GetIsFirstPage()
Section titled "GetIsFirstPage()"public bool GetIsFirstPage()Returns any
GetIsFirstPageAsync()
Section titled "GetIsFirstPageAsync()"public Task<bool> GetIsFirstPageAsync()Returns any
GetIsLastPage()
Section titled "GetIsLastPage()"public bool GetIsLastPage()Returns any
GetIsLastPageAsync()
Section titled "GetIsLastPageAsync()"public Task<bool> GetIsLastPageAsync()Returns any
NextPage()
Section titled "NextPage()"public void NextPage()Returns any
NextPageAsync()
Section titled "NextPageAsync()"Goes to the next page of the IgxPaginatorComponent, if the paginator is not already at the last page.
public Task NextPageAsync()Returns any
OnInitializedAsync()
Section titled "OnInitializedAsync()"protected override Task OnInitializedAsync()Returns any
Paginate(double)
Section titled "Paginate(double)"public void Paginate(double val)Parameters
- val:
double
Returns any
PaginateAsync(double)
Section titled "PaginateAsync(double)"Goes to the desired page index. val
public Task PaginateAsync(double val)Parameters
- val:
double
Returns any
PreviousPage()
Section titled "PreviousPage()"public void PreviousPage()Returns any
PreviousPageAsync()
Section titled "PreviousPageAsync()"Goes to the previous page of the IgxPaginatorComponent, if the paginator is not already at the first page.
public Task PreviousPageAsync()Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"public void SetNativeElement(object element)Parameters
- element:
object
Returns any
SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
Events
Section titled "Events"PageChange
Section titled "PageChange"[Parameter]
public EventCallback<IgbNumberEventArgs> PageChange { get; set; }Paging
Section titled "Paging"[Parameter]
public EventCallback<IgbPageCancellableEventArgs> Paging { get; set; }PagingDone
Section titled "PagingDone"[Parameter]
public EventCallback<IgbPageEventArgs> PagingDone { get; set; }PerPageChange
Section titled "PerPageChange"[Parameter]
public EventCallback<IgbNumberEventArgs> PerPageChange { get; set; }PageChangeScript
Section titled "PageChangeScript"[Parameter]
public string PageChangeScript { get; set; }PagingDoneScript
Section titled "PagingDoneScript"[Parameter]
public string PagingDoneScript { get; set; }PagingScript
Section titled "PagingScript"[Parameter]
public string PagingScript { get; set; }PerPageChangeScript
Section titled "PerPageChangeScript"[Parameter]
public string PerPageChangeScript { get; set; }