HtmlForgeX

API Reference

Class

SmartWizardStep

Namespace HtmlForgeX
Assembly HtmlForgeX

Represents a step in the SmartWizard component.

Inheritance

Constructors

public SmartWizardStep(String title) #

Initializes a new instance of the SmartWizardStep class.

Parameters

title System.String requiredposition: 0
The step title.

Methods

public SmartWizardStep AsDisabled() #
Returns: SmartWizardStep

Marks the step as disabled.

Returns

The current instance for method chaining.

public SmartWizardStep AsDone() #
Returns: SmartWizardStep

Marks the step as done/completed.

Returns

The current instance for method chaining.

public SmartWizardStep AsHidden() #
Returns: SmartWizardStep

Marks the step as hidden.

Returns

The current instance for method chaining.

public SmartWizardStep AsOptional() #
Returns: SmartWizardStep

Marks the step as optional.

Returns

The current instance for method chaining.

BuildStepAnchor(System.Int32 arg1, System.Boolean arg2) #

Builds the step anchor markup.

Parameters

arg1 System.Int32 required
arg2 System.Boolean required
BuildStepContent(System.Int32 arg1, System.Boolean arg2) #

Builds the step content markup.

Parameters

arg1 System.Int32 required
arg2 System.Boolean required
GetIconClass(HtmlForgeX.TablerIconType arg1) #

Converts TablerIconType to CSS class name.

Parameters

arg1 HtmlForgeX.TablerIconType required
GetStepIndex(System.Collections.Generic.List{HtmlForgeX.SmartWizardStep} arg1) #

Gets the step index for state arrays.

Parameters

arg1 System.Collections.Generic.List{HtmlForgeX.SmartWizardStep} required
public SmartWizardStep WithAjaxContent(String url, Boolean cache = true) #
Returns: SmartWizardStep

Configures ajax content loading for this step.

Parameters

url System.String requiredposition: 0
The URL to load content from.
cache System.Boolean = true optionalposition: 1
Whether to cache the loaded content.

Returns

The current instance for method chaining.

public SmartWizardStep WithAnchorClass(String cssClass) #
Returns: SmartWizardStep

Sets a custom CSS class for the step anchor.

Parameters

cssClass System.String requiredposition: 0
The CSS class name.

Returns

The current instance for method chaining.

public SmartWizardStep WithContentClass(String cssClass) #
Returns: SmartWizardStep

Sets a custom CSS class for the step content.

Parameters

cssClass System.String requiredposition: 0
The CSS class name.

Returns

The current instance for method chaining.

public SmartWizardStep WithError() #
Returns: SmartWizardStep

Marks the step as having an error.

Returns

The current instance for method chaining.

public SmartWizardStep WithIcon(TablerIconType icon) #
Returns: SmartWizardStep

Sets the step icon.

Parameters

icon HtmlForgeX.TablerIconType requiredposition: 0
The icon type.

Returns

The current instance for method chaining.

public SmartWizardStep WithProgress(Int32 progress) #
Returns: SmartWizardStep

Sets the step progress percentage.

Parameters

progress System.Int32 requiredposition: 0
The progress percentage (0-100).

Returns

The current instance for method chaining.

public SmartWizardStep WithState(SmartWizardStepState state) #
Returns: SmartWizardStep

Sets the step state.

Parameters

state HtmlForgeX.SmartWizardStepState requiredposition: 0
The step state.

Returns

The current instance for method chaining.

public SmartWizardStep WithSubtitle(String subtitle) #
Returns: SmartWizardStep

Sets the step subtitle or description.

Parameters

subtitle System.String requiredposition: 0
The subtitle text.

Returns

The current instance for method chaining.

public SmartWizardStep WithValidation(String functionName) #
Returns: SmartWizardStep

Sets a custom validation function for this step.

Parameters

functionName System.String requiredposition: 0
The JavaScript function name for validation.

Returns

The current instance for method chaining.

public SmartWizardStep WithWarning() #
Returns: SmartWizardStep

Marks the step as having a warning.

Returns

The current instance for method chaining.

Properties

public String Id { get; set; } #

Gets or sets the step identifier.

public String Title { get; set; } #

Gets or sets the step title.

public String Subtitle { get; set; } #

Gets or sets the step subtitle or description.

public Nullable<TablerIconType> Icon { get; set; } #

Gets or sets the step icon.

public SmartWizardStepState State { get; set; } #

Gets or sets the step state.

public Boolean Disabled { get; set; } #

Gets or sets whether this step is disabled.

public Boolean Hidden { get; set; } #

Gets or sets whether this step is hidden.

public String AnchorClass { get; set; } #

Gets or sets a custom CSS class for the step anchor.

public String ContentClass { get; set; } #

Gets or sets a custom CSS class for the step content.

public String AjaxUrl { get; set; } #

Gets or sets the URL for ajax content loading.

public Boolean CacheAjax { get; set; } #

Gets or sets whether to cache ajax content.

public String ValidationFunction { get; set; } #

Gets or sets custom validation function name.

public Boolean Optional { get; set; } #

Gets or sets whether this step is optional.

public Nullable<Int32> Progress { get; set; } #

Gets or sets the step progress percentage (0-100).

Extension Methods

public static SmartTab SmartTab(SmartWizardStep step, Action<SmartTab> configure = null) #
Returns: SmartTab

Adds a SmartTab component to the element.

Parameters

element HtmlForgeX.Element requiredposition: 0
The element to add the SmartTab to.
configure System.Action{HtmlForgeX.SmartTab} = null optionalposition: 1
Configuration action for the SmartTab.

Returns

The SmartTab instance for further configuration.

public static SmartWizard SmartWizard(SmartWizardStep step, Action<SmartWizard> configure = null) #
Returns: SmartWizard

Adds a SmartWizard component to the element.

Parameters

element HtmlForgeX.Element requiredposition: 0
The element to add the SmartWizard to.
configure System.Action{HtmlForgeX.SmartWizard} = null optionalposition: 1
Configuration action for the SmartWizard.

Returns

The SmartWizard instance for further configuration.