HtmlForgeX

API Reference

Class

TablerSelect

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/Tabler/Forms/TablerSelect.cs:17
Base Element
Implements
ILabelModeAware

Dropdown/select element styled for the Tabler framework.

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 TablerSelect(String name) #
Containers/Tabler/Forms/TablerSelect.cs:17

Initializes or configures TablerSelect.

Parameters

name System.String requiredposition: 0

Methods

public TablerSelect Attribute(String name, String value) #
Containers/Tabler/Forms/TablerSelect.cs:130
Returns: TablerSelect

Adds an arbitrary attribute to the underlying select element. Intended for advanced scenarios such as collection helper hooks.

Parameters

name System.String requiredposition: 0
value System.String requiredposition: 1
public TablerSelect Floating(Boolean enable = true) #
Containers/Tabler/Forms/TablerSelect.cs:141
Returns: TablerSelect

Render with Tabler floating label layout (form-floating). Ignored for inline label mode.

Parameters

enable System.Boolean = true optionalposition: 0
public TablerSelect Hint(String text) #
Containers/Tabler/Forms/TablerSelect.cs:139
Returns: TablerSelect

Adds non-error help text below the control.

Parameters

text System.String requiredposition: 0
public TablerSelect Label(String text) #
Containers/Tabler/Forms/TablerSelect.cs:39
Returns: TablerSelect

Sets the label text displayed above the select element.

Parameters

text System.String requiredposition: 0
The label text.

Returns

The current TablerSelect instance.

public TablerSelect Multiple(Boolean multiple = true) #
Containers/Tabler/Forms/TablerSelect.cs:45
Returns: TablerSelect

Allows multiple items to be selected.

Parameters

multiple System.Boolean = true optionalposition: 0
Whether multiple selection is enabled.

Returns

The current TablerSelect instance.

Option 3 overloads
public TablerSelect Option(String text, Country country) #
Containers/Tabler/Forms/TablerSelect.cs:91
Returns: TablerSelect

Adds a selectable option.

Parameters

text System.String requiredposition: 0
Display text for the option.
value System.String requiredposition: 1
Value submitted when the option is selected.

Returns

The current TablerSelect instance.

public TablerSelect Option(String text, String value, Action<TablerSelectOption> config) #
Containers/Tabler/Forms/TablerSelect.cs:80
Returns: TablerSelect

Adds a selectable option with additional configuration (e.g., icon/flag, attributes).

Parameters

text System.String requiredposition: 0
Display text for the option.
value System.String requiredposition: 1
Value submitted when the option is selected.
config System.Action{HtmlForgeX.TablerSelectOption} requiredposition: 2
Optional configuration callback for advanced settings.
Option(System.String text, HtmlForgeX.Country country) #

Adds an option using a Country enum. Value is the ISO2 code (lowercase) and a flag is attached.

Parameters

text System.String required
country HtmlForgeX.Country required
public TablerSelect Options(IEnumerable<String> values) #
Containers/Tabler/Forms/TablerSelect.cs:112
Returns: TablerSelect

Adds multiple options based on the provided collection of values.

Parameters

values System.Collections.Generic.IEnumerable{System.String} requiredposition: 0
Values to use for both option text and value.

Returns

The current TablerSelect instance.

public TablerSelect OptionsFromAllCountries() #
Containers/Tabler/Forms/TablerSelect.cs:100
Returns: TablerSelect

Adds options for all countries discovered on this platform (ISO 3166-1) with flags. Value is the ISO2 code (lowercase).

RegisterLibraries() #

Registers any required JavaScript libraries for enhanced select controls.

public TablerSelect Required(Boolean required = true) #
Containers/Tabler/Forms/TablerSelect.cs:57
Returns: TablerSelect

Marks the select as required.

Parameters

required System.Boolean = true optionalposition: 0
Whether the select is required.

Returns

The current TablerSelect instance.

public TablerSelect Searchable(Boolean enable = true) #
Containers/Tabler/Forms/TablerSelect.cs:51
Returns: TablerSelect

Enables client-side search functionality for the select element.

Parameters

enable System.Boolean = true optionalposition: 0
Whether search should be enabled.

Returns

The current TablerSelect instance.

public TablerSelect Selected(params String[] values) #
Containers/Tabler/Forms/TablerSelect.cs:123
Returns: TablerSelect

Sets selected values for multi-select.

Parameters

values System.String[] requiredposition: 0
public TablerSelect TagsMode(Boolean enable = true) #
Containers/Tabler/Forms/TablerSelect.cs:143
Returns: TablerSelect

Enable tags mode (free-creation). Uses TomSelect; no inline JS.

Parameters

enable System.Boolean = true optionalposition: 0
public override String ToString() #
Containers/Tabler/Forms/TablerSelect.cs:165
Returns: String

Generates the HTML markup for the select element and associated script.

public TablerSelect Validation(ValidationState state, String message) #
Containers/Tabler/Forms/TablerSelect.cs:64
Returns: TablerSelect

Sets validation state and message for the select element.

Parameters

state HtmlForgeX.ValidationState requiredposition: 0
Validation state.
message System.String requiredposition: 1
Message shown below the select.

Returns

The current TablerSelect instance.

public TablerSelect Value(String value) #
Containers/Tabler/Forms/TablerSelect.cs:118
Returns: TablerSelect

Sets the selected value for single-select.

Parameters

value System.String requiredposition: 0