HtmlForgeX

API Reference

Class

TablerCheckbox

Namespace HtmlForgeX
Assembly HtmlForgeX
Base Element
Implements

Checkbox input element styled with Tabler classes.

Inheritance

Usage

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

Accepted by parameters

Constructors

public TablerCheckbox(String name) #

Initializes the checkbox with the specified name.

Parameters

name System.String requiredposition: 0

Methods

public TablerCheckbox Checked(Boolean checked = true) #
Returns: TablerCheckbox

Sets whether the checkbox is checked by default.

Parameters

checked System.Boolean = true optionalposition: 0
Whether the checkbox is checked.

Returns

The current TablerCheckbox instance.

public TablerCheckbox Description(String text) #
Returns: TablerCheckbox

Sets the description text displayed below the label.

Parameters

text System.String requiredposition: 0
The description text.

Returns

The current TablerCheckbox instance.

public TablerCheckbox Disabled(Boolean disabled = true) #
Returns: TablerCheckbox

Sets whether the checkbox is disabled.

Parameters

disabled System.Boolean = true optionalposition: 0
Whether the checkbox is disabled.

Returns

The current TablerCheckbox instance.

public TablerCheckbox Hint(String text) #
Returns: TablerCheckbox

Adds non-error help text below the control.

Parameters

text System.String requiredposition: 0
public TablerCheckbox Id(String id) #
Returns: TablerCheckbox

Sets the HTML id attribute for the checkbox input.

Parameters

id System.String requiredposition: 0
public TablerCheckbox Inline(Boolean inline = true) #
Returns: TablerCheckbox

Sets whether the checkbox should be displayed inline.

Parameters

inline System.Boolean = true optionalposition: 0
Whether the checkbox is inline.

Returns

The current TablerCheckbox instance.

public TablerCheckbox Label(String text) #
Returns: TablerCheckbox

Sets the label text displayed next to the checkbox.

Parameters

text System.String requiredposition: 0
The label text.

Returns

The current TablerCheckbox instance.

public TablerCheckbox Required(Boolean required = true) #
Returns: TablerCheckbox

Marks the checkbox as required.

Parameters

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

Returns

The current TablerCheckbox instance.

public override String ToString() #
Returns: String

Generates the HTML markup for the checkbox element.

public TablerCheckbox Validation(ValidationState state, String message) #
Returns: TablerCheckbox

Sets validation state and message for the checkbox.

Parameters

state HtmlForgeX.ValidationState requiredposition: 0
message System.String requiredposition: 1
public TablerCheckbox Value(String value) #
Returns: TablerCheckbox

Sets the value submitted when the checkbox is checked. Useful for checkbox groups.

Parameters

value System.String requiredposition: 0