HtmlForgeX

API Reference

Class

TablerServiceConfigStudio

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

Service-hosted configuration studio shell with connected-service context, navigation, and safe configuration pages.

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 TablerServiceConfigStudio() #
Containers/Tabler/TablerServiceConfigStudio.cs:21

Methods

public TablerServiceConfigStudio AddAction(String text, Nullable<TablerIconType> icon = null, Action<TablerButton> configure = null) #
Containers/Tabler/TablerServiceConfigStudio.cs:82
Returns: TablerServiceConfigStudio

Adds an action button to the connected-service top bar.

Parameters

text System.String requiredposition: 0
icon System.Nullable{HtmlForgeX.TablerIconType} = null optionalposition: 1
configure System.Action{HtmlForgeX.TablerButton} = null optionalposition: 2
public TablerServiceConfigStudio AddFact(String label, String value, Nullable<TablerIconType> icon = null, Nullable<TablerColor> color = null) #
Containers/Tabler/TablerServiceConfigStudio.cs:74
Returns: TablerServiceConfigStudio

Adds a compact fact to the connected-service top bar.

Parameters

label System.String requiredposition: 0
value System.String requiredposition: 1
icon System.Nullable{HtmlForgeX.TablerIconType} = null optionalposition: 2
color System.Nullable{HtmlForgeX.TablerColor} = null optionalposition: 3
public TablerServiceConfigStudio AddPage(String key, Action<ElementContainer> configure, Boolean active = false) #
Containers/Tabler/TablerServiceConfigStudio.cs:133
Returns: TablerServiceConfigStudio

Adds a switchable page without adding a matching sidebar item.

Parameters

key System.String requiredposition: 0
configure System.Action{HtmlForgeX.ElementContainer} requiredposition: 1
active System.Boolean = false optionalposition: 2
public TablerServiceConfigStudio Brand(String text, String subtitle = null, TablerIconType icon = ShieldCheck) #
Containers/Tabler/TablerServiceConfigStudio.cs:48
Returns: TablerServiceConfigStudio

Sets the product/studio brand shown in the sidebar and connected-service header.

Parameters

text System.String requiredposition: 0
subtitle System.String = null optionalposition: 1
icon HtmlForgeX.TablerIconType = ShieldCheck optionalposition: 2
public TablerServiceConfigStudio ConnectedService(String serviceName, String endpoint, String status, TablerColor statusColor = Green) #
Containers/Tabler/TablerServiceConfigStudio.cs:57
Returns: TablerServiceConfigStudio

Sets the currently connected service instance shown in the top context bar.

Parameters

serviceName System.String requiredposition: 0
endpoint System.String requiredposition: 1
status System.String requiredposition: 2
statusColor HtmlForgeX.TablerColor = Green optionalposition: 3
Content 2 overloads
public TablerServiceConfigStudio Content(Element element) #
Containers/Tabler/TablerServiceConfigStudio.cs:127
Returns: TablerServiceConfigStudio

Configures fixed content rendered before switchable pages.

Parameters

configure System.Action{HtmlForgeX.ElementContainer} requiredposition: 0
Content(HtmlForgeX.Element element) #

Adds fixed content rendered before switchable pages.

Parameters

element HtmlForgeX.Element required
GetAuxiliaryChildren() #
Pages 2 overloads
public TablerServiceConfigStudio Pages(Action<TablerServiceConfigPagesBuilder> configure) #
Containers/Tabler/TablerServiceConfigStudio.cs:105
Returns: TablerServiceConfigStudio

Adds switchable configuration pages and matching sidebar items.

Parameters

configure System.Action{HtmlForgeX.TablerServiceConfigPagesBuilder} requiredposition: 0
public TablerServiceConfigStudio Pages(String sectionTitle, Action<TablerServiceConfigPagesBuilder> configure) #
Containers/Tabler/TablerServiceConfigStudio.cs:110
Returns: TablerServiceConfigStudio

Adds switchable configuration pages and matching sidebar items under the specified sidebar section.

Parameters

sectionTitle System.String requiredposition: 0
configure System.Action{HtmlForgeX.TablerServiceConfigPagesBuilder} requiredposition: 1
RegisterLibraries() #
public TablerServiceConfigStudio Runtime(String version, String uptime, String configPath) #
Containers/Tabler/TablerServiceConfigStudio.cs:66
Returns: TablerServiceConfigStudio

Sets version, uptime, and config path facts for the connected service.

Parameters

version System.String requiredposition: 0
uptime System.String requiredposition: 1
configPath System.String requiredposition: 2
public TablerServiceConfigStudio Settings(Action<TablerServiceConfigStudioSettings> configure) #
Containers/Tabler/TablerServiceConfigStudio.cs:138
Returns: TablerServiceConfigStudio

Groups advanced visual options under a smaller fluent surface.

Parameters

configure System.Action{HtmlForgeX.TablerServiceConfigStudioSettings} requiredposition: 0
public TablerServiceConfigStudio Sidebar(Action<TablerServiceConfigSidebar> configure) #
Containers/Tabler/TablerServiceConfigStudio.cs:99
Returns: TablerServiceConfigStudio

Configures the left navigation rail.

Parameters

configure System.Action{HtmlForgeX.TablerServiceConfigSidebar} requiredposition: 0
public override String ToString() #
Containers/Tabler/TablerServiceConfigStudio.cs:241
Returns: String