WizardBuilder
Properties
WriteAction - Func
Methods
Steps(System.Action)
Array of steps to be rendered in the Wizard.
Parameters
configurator - System.Action<WizardStepFactory>
The configurator for the steps setting.
RETURNS
Returns the current WizardBuilder instance.
Example
@(Html.Kendo().Wizard()
.Name("wizard")
.Steps(steps =>
{
steps.Add().ContentUrl(Url.Content("~/shared/web/wizard/ajax/ajaxContent1.html")).Title("Welcome")
.Buttons(b =>
{
b.Next();
});
})
)
Tag(System.String)
The tag that will be rendered. Defaults to "div". Could be test to "form" to act as a form element.
Parameters
value - System.String
The value for Tag
RETURNS
Returns the current WizardBuilder instance.
Example
@(Html.Kendo().Wizard()
.Name("wizard")
.Tag("div")
)
ActionBar(System.Boolean)
Indicates whether the Steps in the Wizard will render their Buttons and Pager element.
Parameters
value - System.Boolean
The value for ActionBar
RETURNS
Returns the current WizardBuilder instance.
LoadOnDemand(System.Boolean)
Indicates whether the step content will be loaded on demand when a given step is selected. Applicable when the step configuration has "contentUrl" set.
Parameters
value - System.Boolean
The value for LoadOnDemand
RETURNS
Returns the current WizardBuilder instance.
LoadOnDemand()
Indicates whether the step content will be loaded on demand when a given step is selected. Applicable when the step configuration has "contentUrl" set.
RETURNS
Returns the current WizardBuilder instance.
Messages(System.Action)
Provides configuration options for the messages present in the Wizard widget.
Parameters
configurator - System.Action<WizardMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of WizardBuilder .
Pager(System.Boolean)
Indicates whether the Steps in the Wizard will render their Pager element.
Parameters
value - System.Boolean
The value for Pager
RETURNS
Returns the current WizardBuilder instance.
ReloadOnSelect(System.Boolean)
Indicates whether the step content will be reloaded on each navigation to given step. Applicable when the step configuration has "contentUrl" set.
Parameters
value - System.Boolean
The value for ReloadOnSelect
RETURNS
Returns the current WizardBuilder instance.
Stepper(System.Action)
Provides configuration options for the Stepper instance of the Wizard widget.
Parameters
configurator - System.Action<WizardStepperSettingsBuilder>
The configurator for the stepper setting.
RETURNS
Returns the current instance of WizardBuilder .
ValidateForms(System.Action)
Indicates whether the Wizard will automatically validate any Kendo Form configured for a Step. Validation will be executed upon Step navigation.
Parameters
configurator - System.Action<WizardValidateFormsSettingsBuilder>
The configurator for the validateforms setting.
RETURNS
Returns the current instance of WizardBuilder .
ValidateForms(System.Boolean)
Indicates whether the Wizard will automatically validate any Kendo Form configured for a Step. Validation will be executed upon Step navigation.
Parameters
enabled - System.Boolean
Enables or disables the validateforms option.
RETURNS
Returns the current instance of WizardValidateFormsSettingsBuilder .
ContentPosition(Kendo.Mvc.UI.WizardContentPosition)
The position of the Wizard step content according to the embedded Stepper widget.
Parameters
value - WizardContentPosition
The value for ContentPosition
RETURNS
Returns the current WizardBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<WizardEventBuilder>
The client events action.
RETURNS
Returns the current WizardBuilder instance.
Example
@(Html.Kendo().Wizard()
.Name("Wizard")
.Events(events => events
.Activate("onActivate")
)
)
ToComponent()
Returns the internal view component.
RETURNS
The instance that represents the component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
RETURNS
Returns the current instance.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
RETURNS
Returns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNS
Returns the current instance.
ScriptAttributes(System.Object,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Object
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)
Sets the JavaScript attributes to the initialization script.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes - System.Boolean
Argument which determines whether attributes should be overriden.
RETURNS
Returns the current instance.
Render()
Renders the component in place.
ToHtmlString()
Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)
Parameters
writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)
Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters
value - System.Boolean
RETURNS
Returns the current instance.