HtmlForgeX

API Reference

Class

TablerServiceConfigForm

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

Reusable editable form for service configuration fields backed by JSON paths.

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

Methods

public TablerServiceConfigForm AddComboBox(String key, String label, String value, params String[] suggestions) #
Containers/Tabler/TablerServiceConfigStudio.cs:1534
Returns: TablerServiceConfigForm

Adds a combobox field with predefined suggestions while still allowing service-specific values.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
value System.String requiredposition: 2
suggestions System.String[] requiredposition: 3
public TablerServiceConfigForm AddMultiSelect(String key, String label, IEnumerable<String> values, params String[] options) #
Containers/Tabler/TablerServiceConfigStudio.cs:1539
Returns: TablerServiceConfigForm

Adds a multi-select field for bounded array-like choices.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
values System.Collections.Generic.IEnumerable{System.String} requiredposition: 2
options System.String[] requiredposition: 3
public TablerServiceConfigForm AddNumber(String key, String label, String value = "", String placeholder = null, String help = null, Action<TablerServiceConfigFormFieldSettings> configure = null) #
Containers/Tabler/TablerServiceConfigStudio.cs:1514
Returns: TablerServiceConfigForm

Adds a number input field.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
value System.String = "" optionalposition: 2
placeholder System.String = null optionalposition: 3
help System.String = null optionalposition: 4
configure System.Action{HtmlForgeX.TablerServiceConfigFormFieldSettings} = null optionalposition: 5
public TablerServiceConfigForm AddSecret(String key, String label, String reference = "", String help = null, Action<TablerServiceConfigFormFieldSettings> configure = null) #
Containers/Tabler/TablerServiceConfigStudio.cs:1549
Returns: TablerServiceConfigForm

Adds a secret/reference field. The value is intended to be a reference, not raw secret material.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
reference System.String = "" optionalposition: 2
help System.String = null optionalposition: 3
configure System.Action{HtmlForgeX.TablerServiceConfigFormFieldSettings} = null optionalposition: 4
AddSelect 2 overloads
public TablerServiceConfigForm AddSelect(String key, String label, String value, params String[] options) #
Containers/Tabler/TablerServiceConfigStudio.cs:1524
Returns: TablerServiceConfigForm

Adds a select field with simple option values.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
value System.String requiredposition: 2
options System.String[] requiredposition: 3
public TablerServiceConfigForm AddSelect(String key, String label, String value, IReadOnlyList<String> options, Action<TablerServiceConfigFormFieldSettings> configure) #
Containers/Tabler/TablerServiceConfigStudio.cs:1529
Returns: TablerServiceConfigForm

Adds a select field with item-level constraints.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
value System.String requiredposition: 2
options System.Collections.Generic.IReadOnlyList{System.String} requiredposition: 3
configure System.Action{HtmlForgeX.TablerServiceConfigFormFieldSettings} requiredposition: 4
public TablerServiceConfigForm AddText(String key, String label, String value = "", String placeholder = null, String help = null, Action<TablerServiceConfigFormFieldSettings> configure = null) #
Containers/Tabler/TablerServiceConfigStudio.cs:1509
Returns: TablerServiceConfigForm

Adds a text input field.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
value System.String = "" optionalposition: 2
placeholder System.String = null optionalposition: 3
help System.String = null optionalposition: 4
configure System.Action{HtmlForgeX.TablerServiceConfigFormFieldSettings} = null optionalposition: 5
public TablerServiceConfigForm AddTextArea(String key, String label, String value = "", String placeholder = null, String help = null, Action<TablerServiceConfigFormFieldSettings> configure = null) #
Containers/Tabler/TablerServiceConfigStudio.cs:1544
Returns: TablerServiceConfigForm

Adds a multi-line text area field.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
value System.String = "" optionalposition: 2
placeholder System.String = null optionalposition: 3
help System.String = null optionalposition: 4
configure System.Action{HtmlForgeX.TablerServiceConfigFormFieldSettings} = null optionalposition: 5
public TablerServiceConfigForm AddToggle(String key, String label, Boolean enabled, String help = null, Action<TablerServiceConfigFormFieldSettings> configure = null) #
Containers/Tabler/TablerServiceConfigStudio.cs:1519
Returns: TablerServiceConfigForm

Adds an on/off toggle field.

Parameters

key System.String requiredposition: 0
label System.String requiredposition: 1
enabled System.Boolean requiredposition: 2
help System.String = null optionalposition: 3
configure System.Action{HtmlForgeX.TablerServiceConfigFormFieldSettings} = null optionalposition: 4
public TablerServiceConfigForm Path(String path) #
Containers/Tabler/TablerServiceConfigStudio.cs:1487
Returns: TablerServiceConfigForm

Sets the base JSON path represented by this form.

Parameters

path System.String requiredposition: 0
RegisterLibraries() #
public TablerServiceConfigForm Settings(Action<TablerServiceConfigFormSettings> configure) #
Containers/Tabler/TablerServiceConfigStudio.cs:1554
Returns: TablerServiceConfigForm

Groups advanced display options under a smaller fluent surface.

Parameters

configure System.Action{HtmlForgeX.TablerServiceConfigFormSettings} requiredposition: 0
public TablerServiceConfigForm Submit(String method, String endpoint, String label = null, params String[] paths) #
Containers/Tabler/TablerServiceConfigStudio.cs:1493
Returns: TablerServiceConfigForm

Configures a typed endpoint used to submit this form's declared configuration roots.

Parameters

method System.String requiredposition: 0
endpoint System.String requiredposition: 1
label System.String = null optionalposition: 2
paths System.String[] requiredposition: 3
public TablerServiceConfigForm Title(String title, String subtitle = null) #
Containers/Tabler/TablerServiceConfigStudio.cs:1480
Returns: TablerServiceConfigForm

Sets an optional form title and subtitle.

Parameters

title System.String requiredposition: 0
subtitle System.String = null optionalposition: 1
public override String ToString() #
Containers/Tabler/TablerServiceConfigStudio.cs:1581
Returns: String