HtmlForgeX

API Reference

Class

TablerPagination

Namespace HtmlForgeX
Assembly HtmlForgeX
Base Element

Tabler pagination component for navigating through pages

Inheritance

Constructors

public TablerPagination() #

Initializes a new instance of the TablerPagination class

Methods

public TablerPagination Alignment(TablerPaginationAlignment alignment) #
Returns: TablerPagination

Set pagination alignment

Parameters

alignment HtmlForgeX.TablerPaginationAlignment requiredposition: 0
public static TablerPagination Create(Action<TablerPagination> configure) #
Returns: TablerPagination

Create pagination with fluent configuration

Parameters

configure System.Action{HtmlForgeX.TablerPagination} requiredposition: 0
CreateDescriptivePageItem(System.String arg1, System.String arg2, System.Int32 arg3, System.Boolean arg4, System.String arg5, System.Nullable{HtmlForgeX.TablerIconType} arg6) #

Create a descriptive page item

Parameters

arg1 System.String required
arg2 System.String required
arg3 System.Int32 required
arg4 System.Boolean required
arg5 System.String required
arg6 System.Nullable{HtmlForgeX.TablerIconType} required
CreatePageItem(System.String arg1, System.Int32 arg2, System.Boolean arg3, System.Boolean arg4, System.String arg5, System.Nullable{HtmlForgeX.TablerIconType} arg6) #

Create a standard page item

Parameters

arg1 System.String required
arg2 System.Int32 required
arg3 System.Boolean required
arg4 System.Boolean required
arg5 System.String required
arg6 System.Nullable{HtmlForgeX.TablerIconType} required
public TablerPagination CurrentPage(Int32 page) #
Returns: TablerPagination

Set current page

Parameters

page System.Int32 requiredposition: 0
public TablerPagination Descriptive(Boolean descriptive = true) #
Returns: TablerPagination

Enable descriptive pagination style

Parameters

descriptive System.Boolean = true optionalposition: 0
public TablerPagination FirstText(String text) #
Returns: TablerPagination

Set first button text

Parameters

text System.String requiredposition: 0
public TablerPagination LastText(String text) #
Returns: TablerPagination

Set last button text

Parameters

text System.String requiredposition: 0
public TablerPagination MaxVisiblePages(Int32 max) #
Returns: TablerPagination

Set maximum visible page numbers

Parameters

max System.Int32 requiredposition: 0
public TablerPagination NextDescription(String description) #
Returns: TablerPagination

Set next page description (for descriptive style)

Parameters

description System.String requiredposition: 0
public TablerPagination NextIcon(TablerIconType icon) #
Returns: TablerPagination

Set next button icon

Parameters

icon HtmlForgeX.TablerIconType requiredposition: 0
public TablerPagination NextText(String text) #
Returns: TablerPagination

Set next button text

Parameters

text System.String requiredposition: 0
public TablerPagination OnPageChange(String javascript) #
Returns: TablerPagination

Set JavaScript callback for page changes

Parameters

javascript System.String requiredposition: 0
public TablerPagination PrevDescription(String description) #
Returns: TablerPagination

Set previous page description (for descriptive style)

Parameters

description System.String requiredposition: 0
public TablerPagination PrevIcon(TablerIconType icon) #
Returns: TablerPagination

Set previous button icon

Parameters

icon HtmlForgeX.TablerIconType requiredposition: 0
public TablerPagination PrevText(String text) #
Returns: TablerPagination

Set previous button text

Parameters

text System.String requiredposition: 0
RegisterLibraries() #

Registers the required libraries for this component

public TablerPagination ShowFirstLast(Boolean show = true) #
Returns: TablerPagination

Show or hide first/last buttons

Parameters

show System.Boolean = true optionalposition: 0
public TablerPagination ShowPrevNext(Boolean show = true) #
Returns: TablerPagination

Show or hide previous/next buttons

Parameters

show System.Boolean = true optionalposition: 0
public TablerPagination Size(TablerPaginationSize size) #
Returns: TablerPagination

Set pagination size

Parameters

size HtmlForgeX.TablerPaginationSize requiredposition: 0
public override String ToString() #
Returns: String

Renders the pagination to HTML string

Returns

HTML representation of the pagination

public TablerPagination TotalPages(Int32 total) #
Returns: TablerPagination

Set total number of pages

Parameters

total System.Int32 requiredposition: 0