StepperBuilder
Properties
WriteAction - Func
Methods
Indicator(System.Boolean)
Indicates whether the Steps in the Stepper will render their indicator element (the icon or number placed in a circle above the Step label).
Parameters
value - System.Boolean
The value for Indicator
RETURNS
Returns the current StepperBuilder instance.
Label(System.Boolean)
Indicates whether the Steps in the Stepper will render their label element (the text placed below the Step indicator circle).
Parameters
value - System.Boolean
The value for Label
RETURNS
Returns the current StepperBuilder instance.
Linear(System.Boolean)
Indicates whether the Stepper will force the user to follow the Steps sequence or not. If set to "false" it will allow the user to select any step. If in its default state ("true") the user will be able to select the step immediately after the currently selected step or the previous step.
Parameters
value - System.Boolean
The value for Linear
RETURNS
Returns the current StepperBuilder instance.
SelectOnFocus(System.Boolean)
Applicable for scenarios when keyboard is used for navigation. Indicates whether the selection will change upon focus change or it will require additional action (Enter or Spacebar key press) in order to select the focused step.
Parameters
value - System.Boolean
The value for SelectOnFocus
RETURNS
Returns the current StepperBuilder instance.
SelectOnFocus()
Applicable for scenarios when keyboard is used for navigation. Indicates whether the selection will change upon focus change or it will require additional action (Enter or Spacebar key press) in order to select the focused step.
RETURNS
Returns the current StepperBuilder instance.
Steps(System.Action)
Array of steps to be rendered in the Stepper. If the array contains objects, their fields will be used for each Step. If the array contains strings, those will be used as Step labels.
Parameters
configurator - System.Action<StepperStepFactory>
The configurator for the steps setting.
RETURNS
Returns the current instance of StepperBuilder .
Orientation(Kendo.Mvc.UI.StepperOrientationType)
The type of the Stepper orientation (horizontal or vertical).
Parameters
value - StepperOrientationType
The value for Orientation
RETURNS
Returns the current StepperBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<StepperEventBuilder>
The client events action.
RETURNS
Returns the current StepperBuilder instance.
Example
@(Html.Kendo().Stepper()
.Name("Stepper")
.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.