Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / StepperStepBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

StepperStepBuilder

Class

Defines the fluent API for configuring the StepperStep settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class StepperStepBuilder

Inheritance: objectStepperStepBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

StepperStepBuilder(StepperStep)

Initialize the StepperStepBuilder

C#
public StepperStepBuilder(StepperStep settings)
Parameters:settingsStepperStep

The StepperStep

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =>
{
s.Add().Label("Personal Info").Icon("user");
})
)

Methods

Enabled(bool)

Defines whether the Step is enabled or not. By default all steps are enabled.

C#
public StepperStepBuilder Enabled(bool value)
Parameters:valuebool

The value that configures the enabled.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =>
{
s.Add().Label("Personal Info").Icon("user").Enabled(false);
})
)

Error(bool)

Defines whether the Step is in error state (is invalid). By default all steps are valid.

C#
public StepperStepBuilder Error(bool value)
Parameters:valuebool

The value that configures the error.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =>
{
s.Add().Label("Personal Info").Icon("user").Error(false);
})
)

Icon(string)

Defines a name of an existing icon in the Kendo UI theme sprite. The icon will be displayed in the indicator element of that Step. For a list of available icon names, please refer to the Web Font Icons article.

C#
public StepperStepBuilder Icon(string value)
Parameters:valuestring

The value that configures the icon.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =>
{
s.Add().Label("Personal Info").Icon("user");
})
)

IconTemplate(string)

The template used to render the icon in the indicator of the step.The fields which can be used in the template are: label String - the label set on the step; icon String - the icon specified for this step (if any); successIcon String - the successIcon specified for this step (if any); enabled Boolean - indicates whether the step is enabled (true) or disabled (false); error Boolean - indicates whether the step has error (true) or not (false); selected Boolean - indicates whether the step is selected; previous Boolean - indicates whether the step is before the currently selected or not; index Number - a zero-based index of the current step; isFirstStep Boolean - indicates whether the step is the initial one in the Stepper; isLastStep Boolean - indicates whether the step is the last one in the Stepper; indicatorVisible Boolean - indicates whether the indicator, which holds the icon should be displayed or not or labelVisible Boolean - indicates whether the label section of the step should be displayed or not.

C#
public StepperStepBuilder IconTemplate(string value)
Parameters:valuestring

The value that configures the icontemplate.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =>
{
s.Add().Label("Personal Info").Icon("user").IconTemplate("content");
})
)

IconTemplate<TModel>(TemplateBuilder<TModel>)

The template used to render the icon in the indicator of the step.The fields which can be used in the template are: label String - the label set on the step; icon String - the icon specified for this step (if any); successIcon String - the successIcon specified for this step (if any); enabled Boolean - indicates whether the step is enabled (true) or disabled (false); error Boolean - indicates whether the step has error (true) or not (false); selected Boolean - indicates whether the step is selected; previous Boolean - indicates whether the step is before the currently selected or not; index Number - a zero-based index of the current step; isFirstStep Boolean - indicates whether the step is the initial one in the Stepper; isLastStep Boolean - indicates whether the step is the last one in the Stepper; indicatorVisible Boolean - indicates whether the indicator, which holds the icon should be displayed or not or labelVisible Boolean - indicates whether the label section of the step should be displayed or not.

C#
public StepperStepBuilder IconTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the icontemplate.

Returns:

StepperStepBuilder

IconTemplateHandler(string)

The template used to render the icon in the indicator of the step.The fields which can be used in the template are: label String - the label set on the step; icon String - the icon specified for this step (if any); successIcon String - the successIcon specified for this step (if any); enabled Boolean - indicates whether the step is enabled (true) or disabled (false); error Boolean - indicates whether the step has error (true) or not (false); selected Boolean - indicates whether the step is selected; previous Boolean - indicates whether the step is before the currently selected or not; index Number - a zero-based index of the current step; isFirstStep Boolean - indicates whether the step is the initial one in the Stepper; isLastStep Boolean - indicates whether the step is the last one in the Stepper; indicatorVisible Boolean - indicates whether the indicator, which holds the icon should be displayed or not or labelVisible Boolean - indicates whether the label section of the step should be displayed or not.

C#
public StepperStepBuilder IconTemplateHandler(string value)
Parameters:valuestring

The value that configures the icontemplate.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =&gt;
{
s.Add().Label("Personal Info").Icon("user").IconTemplateHandler("handler");
})
)

IconTemplateId(string)

The template used to render the icon in the indicator of the step.The fields which can be used in the template are: label String - the label set on the step; icon String - the icon specified for this step (if any); successIcon String - the successIcon specified for this step (if any); enabled Boolean - indicates whether the step is enabled (true) or disabled (false); error Boolean - indicates whether the step has error (true) or not (false); selected Boolean - indicates whether the step is selected; previous Boolean - indicates whether the step is before the currently selected or not; index Number - a zero-based index of the current step; isFirstStep Boolean - indicates whether the step is the initial one in the Stepper; isLastStep Boolean - indicates whether the step is the last one in the Stepper; indicatorVisible Boolean - indicates whether the indicator, which holds the icon should be displayed or not or labelVisible Boolean - indicates whether the label section of the step should be displayed or not.

C#
public StepperStepBuilder IconTemplateId(string value)
Parameters:valuestring

The value that configures the icontemplate.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =&gt;
{
s.Add().Label("Personal Info").Icon("user").IconTemplateId("id");
})
)

IconTemplateView(MvcHtmlString)

The template used to render the icon in the indicator of the step.The fields which can be used in the template are: label String - the label set on the step; icon String - the icon specified for this step (if any); successIcon String - the successIcon specified for this step (if any); enabled Boolean - indicates whether the step is enabled (true) or disabled (false); error Boolean - indicates whether the step has error (true) or not (false); selected Boolean - indicates whether the step is selected; previous Boolean - indicates whether the step is before the currently selected or not; index Number - a zero-based index of the current step; isFirstStep Boolean - indicates whether the step is the initial one in the Stepper; isLastStep Boolean - indicates whether the step is the last one in the Stepper; indicatorVisible Boolean - indicates whether the indicator, which holds the icon should be displayed or not or labelVisible Boolean - indicates whether the label section of the step should be displayed or not.

C#
public StepperStepBuilder IconTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the icontemplate.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =&gt;
{
s.Add().Label("Personal Info").Icon("user").IconTemplateView(Html.Partial("IconTemplateView"));
})
)

Label(string)

Defines the label (text) of the Step.

C#
public StepperStepBuilder Label(string value)
Parameters:valuestring

The value that configures the label.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =&gt;
{
s.Add().Label("Personal Info").Icon("user");
})
)

Selected(bool)

Defines whether the Step is selected.

C#
public StepperStepBuilder Selected(bool value)
Parameters:valuebool

The value that configures the selected.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =&gt;
{
s.Add().Label("Personal Info").Icon("user").Selected(true);
})
)

SuccessIcon(string)

Defines a name of an existing icon in the Kendo UI theme sprite. The icon will be displayed in the indicator element of that Step, when the step is a previous one and it does not have an error. For a list of available icon names, please refer to the Web Font Icons article.

C#
public StepperStepBuilder SuccessIcon(string value)
Parameters:valuestring

The value that configures the successicon.

Returns:

StepperStepBuilder

Example:
C#
@(Html.Kendo().Stepper()
.Name("stepper")
.Steps(s =&gt;
{
s.Add().Label("Personal Info").SuccessIcon("user");
})
)
In this article
DefinitionConstructorsStepperStepBuilder(StepperStep)MethodsEnabled(bool)Error(bool)Icon(string)IconTemplate(string)IconTemplate<TModel>(TemplateBuilder<TModel>)IconTemplateHandler(string)IconTemplateId(string)IconTemplateView(MvcHtmlString)Label(string)Selected(bool)SuccessIcon(string)
Not finding the help you need?
Contact Support