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

StepperBuilder

Class

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

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class StepperBuilder : WidgetBuilderBase<Stepper, StepperBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Stepper, StepperBuilder>StepperBuilder

Implements: IHtmlString

Constructors

StepperBuilder(Stepper)

Initializes a new instance of the Stepper class.

public StepperBuilder(Stepper component)

Parameters:componentStepper

The component.

Example:

@(Html.Kendo().Stepper()
.Name("stepper")
.Label(true)
)

Methods

Events(Action<StepperEventBuilder>)

Configures the client-side events.

public StepperBuilder Events(Action<StepperEventBuilder> configurator)

Parameters:configuratorAction<StepperEventBuilder>

The client events action.

Returns:

StepperBuilder

Example:

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

Indicator(bool)

Indicates whether the Steps in the Stepper will render their indicator element (the icon or number placed in a circle above the Step label).

public StepperBuilder Indicator(bool value)

Parameters:valuebool

The value that configures the indicator.

Returns:

StepperBuilder

Example:

@(Html.Kendo().Stepper()
.Name("stepper")
.Indicator(true)
)

Label(bool)

Indicates whether the Steps in the Stepper will render their label element (the text placed below the Step indicator circle).

public StepperBuilder Label(bool value)

Parameters:valuebool

The value that configures the label.

Returns:

StepperBuilder

Example:

@(Html.Kendo().Stepper()
.Name("stepper")
.Label(true)
)

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 any previous step.

public StepperBuilder Linear(bool value)

Parameters:valuebool

The value that configures the linear.

Returns:

StepperBuilder

Example:

@(Html.Kendo().Stepper()
.Name("stepper")
.Linear(true)
)

Orientation(StepperOrientationType)

The type of the Stepper orientation (horizontal or vertical).

public StepperBuilder Orientation(StepperOrientationType value)

Parameters:valueStepperOrientationType

The value that configures the orientation.

Returns:

StepperBuilder

Example:

@(Html.Kendo().Stepper()
.Name("stepper")
.Orientation(StepperOrientationType.Horizontal)
)

SelectOnFocus(bool)

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.

public StepperBuilder SelectOnFocus(bool value)

Parameters:valuebool

The value that configures the selectonfocus.

Returns:

StepperBuilder

Example:

@(Html.Kendo().Stepper()
.Name("stepper")
.SelectOnFocus(true)
)

Steps(Action<StepperStepFactory>)

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.

public StepperBuilder Steps(Action<StepperStepFactory> configurator)

Parameters:configuratorAction<StepperStepFactory>

The action that configures the steps.

Returns:

StepperBuilder