HtmlForgeX

API Reference

Class

TablerEntityCollection

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/Tabler/TablerEntityCollection.cs:11
Base Element
Modifiers sealed

Hosts one shared entity dataset and lets the user switch between table, list, and card views.

Inheritance

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public TablerEntityCollection() #
Containers/Tabler/TablerEntityCollection.cs:11

Methods

ActionButton 2 overloads
public TablerEntityCollection ActionButton(String text, Action<TablerButton> configure = null) #
Containers/Tabler/TablerEntityCollection.cs:126
Returns: TablerEntityCollection

Adds a trailing action button above the shared collection views.

Parameters

text System.String requiredposition: 0
configure System.Action{HtmlForgeX.TablerButton} = null optionalposition: 1
public TablerEntityCollection ActionButton(String text, String href, Action<TablerButton> configure = null) #
Containers/Tabler/TablerEntityCollection.cs:134
Returns: TablerEntityCollection

Adds a trailing action button that links to another route.

Parameters

text System.String requiredposition: 0
href System.String requiredposition: 1
configure System.Action{HtmlForgeX.TablerButton} = null optionalposition: 2
public TablerEntityCollection ActionDropdown(String text, Action<TablerDropdown> configure) #
Containers/Tabler/TablerEntityCollection.cs:142
Returns: TablerEntityCollection

Adds a trailing dropdown for secondary collection actions.

Parameters

text System.String requiredposition: 0
configure System.Action{HtmlForgeX.TablerDropdown} requiredposition: 1
AddRecord 2 overloads
public TablerEntityCollection AddRecord(TablerDashboardEntityRecord record) #
Containers/Tabler/TablerEntityCollection.cs:52
Returns: TablerEntityCollection
EditorBrowsable(2)

Adds a shared entity record to the collection.

Parameters

record HtmlForgeX.TablerEntityRecord requiredposition: 0
AddRecord(HtmlForgeX.TablerDashboardEntityRecord record) #

Adds a shared entity record using the legacy dashboard record name.

Parameters

record HtmlForgeX.TablerDashboardEntityRecord required
AddRecords 2 overloads
public TablerEntityCollection AddRecords(IEnumerable<TablerDashboardEntityRecord> records) #
Containers/Tabler/TablerEntityCollection.cs:75
Returns: TablerEntityCollection
EditorBrowsable(2)

Adds multiple shared entity records to the collection.

Parameters

records System.Collections.Generic.IEnumerable{HtmlForgeX.TablerEntityRecord} requiredposition: 0
AddRecords(System.Collections.Generic.IEnumerable{HtmlForgeX.TablerDashboardEntityRecord} records) #

Adds multiple shared entity records using the legacy dashboard record name.

Parameters

records System.Collections.Generic.IEnumerable{HtmlForgeX.TablerDashboardEntityRecord} required
public TablerEntityCollection FilterChip(String text, Boolean active = false, TablerColor accent = Azure, Nullable<TablerIconType> icon = null, Action<TablerButton> configure = null) #
Containers/Tabler/TablerEntityCollection.cs:115
Returns: TablerEntityCollection

Adds a leading filter chip above the shared collection views.

Parameters

text System.String requiredposition: 0
active System.Boolean = false optionalposition: 1
accent HtmlForgeX.TablerColor = Azure optionalposition: 2
icon System.Nullable{HtmlForgeX.TablerIconType} = null optionalposition: 3
configure System.Action{HtmlForgeX.TablerButton} = null optionalposition: 4
GetAuxiliaryChildren() #
public TablerEntityCollection Records(String name, String selected, params Int32[] counts) #
Containers/Tabler/TablerEntityCollection.cs:107
Returns: TablerEntityCollection

Adds a records-per-page selector above the shared collection views.

Parameters

name System.String requiredposition: 0
selected System.String requiredposition: 1
counts System.Int32[] requiredposition: 2
RegisterLibraries() #
public TablerEntityCollection Search(String name, String placeholder = "Search", Action<TablerInput> configure = null) #
Containers/Tabler/TablerEntityCollection.cs:99
Returns: TablerEntityCollection

Adds a compact search field above the shared collection views.

Parameters

name System.String requiredposition: 0
placeholder System.String = "Search" optionalposition: 1
configure System.Action{HtmlForgeX.TablerInput} = null optionalposition: 2
public TablerEntityCollection Settings(Action<TablerEntityCollectionSettings> configure) #
Containers/Tabler/TablerEntityCollection.cs:31
Returns: TablerEntityCollection

Groups less-common display toggles under a single fluent entry point.

Parameters

configure System.Action{HtmlForgeX.TablerEntityCollectionSettings} requiredposition: 0
public override String ToString() #
Containers/Tabler/TablerEntityCollection.cs:269
Returns: String