New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

WizardBuilder

Class

Defines the fluent API for configuring the Kendo Wizard for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class WizardBuilder : WidgetBuilderBase<Wizard, WizardBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Wizard, WizardBuilder>WizardBuilder

Implements: IHtmlString

Constructors

WizardBuilder(Wizard)

Initializes a new instance of the Wizard class.

public WizardBuilder(Wizard component)

Parameters:componentWizard

The component.

Methods

ActionBar(bool)

Indicates whether the Steps in the Wizard will render their Buttons and Pager element.

public WizardBuilder ActionBar(bool value)

Parameters:valuebool

The value that configures the actionbar.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.ActionBar(true)
)

ContentPosition(WizardContentPosition)

The position of the Wizard step content according to the embedded Stepper widget.

public WizardBuilder ContentPosition(WizardContentPosition value)

Parameters:valueWizardContentPosition

The value that configures the contentposition.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.ContentPosition(WizardContentPosition.Right)
)

Events(Action<WizardEventBuilder>)

Configures the client-side events.

public WizardBuilder Events(Action<WizardEventBuilder> configurator)

Parameters:configuratorAction<WizardEventBuilder>

The client events action.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("Wizard")
.Events(events =&gt; events
.Activate("onActivate")
)
)

LoadOnDemand(bool)

Indicates whether the step content will be loaded on demand when a given step is selected. Applicable when the step configuration has "contentUrl" set.

public WizardBuilder LoadOnDemand(bool value)

Parameters:valuebool

The value that configures the loadondemand.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.LoadOnDemand(true)
)

Messages(Action<WizardMessagesSettingsBuilder>)

Provides configuration options for the messages present in the Wizard widget.

public WizardBuilder Messages(Action<WizardMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<WizardMessagesSettingsBuilder>

The action that configures the messages.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.Messages(messages =&gt; messages.Done("Completed"))
)

Pager(bool)

Indicates whether the Steps in the Wizard will render their Pager element.

public WizardBuilder Pager(bool value)

Parameters:valuebool

The value that configures the pager.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.Pager(true)
)

ReloadOnSelect(bool)

Indicates whether the step content will be reloaded on each navigation to given step. Applicable when the step configuration has "contentUrl" set.

public WizardBuilder ReloadOnSelect(bool value)

Parameters:valuebool

The value that configures the reloadonselect.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.ReloadOnSelect(true)
)

Stepper(Action<WizardStepperSettingsBuilder>)

Provides configuration options for the Stepper instance of the Wizard widget.

public WizardBuilder Stepper(Action<WizardStepperSettingsBuilder> configurator)

Parameters:configuratorAction<WizardStepperSettingsBuilder>

The action that configures the stepper.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.Stepper(stepper =&gt; stepper.Label(true))
)

Steps(Action<WizardStepFactory>)

Array of steps to be rendered in the Wizard.

public WizardBuilder Steps(Action<WizardStepFactory> configurator)

Parameters:configuratorAction<WizardStepFactory>

The action that configures the steps.

Returns:

WizardBuilder

Tag(string)

Allow rendering of form element instead of the default div.

public WizardBuilder Tag(string tagName)

Parameters:tagNamestring

The tag that will be rendered as for the Wizard widget

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.Tag("form")
)

ValidateForms(Action<WizardValidateFormsSettingsBuilder>)

Indicates whether the Wizard will automatically validate any Kendo Form configured for a Step. Validation will be executed upon Step navigation.

public WizardBuilder ValidateForms(Action<WizardValidateFormsSettingsBuilder> configurator)

Parameters:configuratorAction<WizardValidateFormsSettingsBuilder>

The action that configures the validateforms.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.ValidateForms(forms =&gt; forms.ValidateOnPrevious(true))
)

ValidateForms(bool)

Indicates whether the Wizard will automatically validate any Kendo Form configured for a Step. Validation will be executed upon Step navigation.

public WizardBuilder ValidateForms(bool enabled)

Parameters:enabledbool

Enables or disables the validateforms option.

Returns:

WizardBuilder

Example:

@(Html.Kendo().Wizard()
.Name("wizard")
.ValidateForms(true)
)