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

SwitchBuilder

Class

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

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class SwitchBuilder : WidgetBuilderBase<Switch, SwitchBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Switch, SwitchBuilder>SwitchBuilder

Implements: IHtmlString

Constructors

SwitchBuilder(Switch)

Initializes a new instance of the Switch class.

public SwitchBuilder(Switch component)

Parameters:componentSwitch

The component.

Methods

Checked(bool)

The checked state of the widget.

public SwitchBuilder Checked(bool value)

Parameters:valuebool

The value that configures the checked.

Returns:

SwitchBuilder

Example:

@(Html.Kendo().Switch()
.Name("switch")
.Checked(true)
)

Enabled(bool)

Defines the text of the checked and unchecked labels that are shown within the Switch. All labels could be localized.

public SwitchBuilder Enabled(bool value)

Parameters:valuebool

The value that configures the enable.

Returns:

SwitchBuilder

Example:

@(Html.Kendo().Switch()
.Name("switch")
.Enabled(true)
)

Events(Action<SwitchEventBuilder>)

Configures the client-side events.

public SwitchBuilder Events(Action<SwitchEventBuilder> configurator)

Parameters:configuratorAction<SwitchEventBuilder>

The client events action.

Returns:

SwitchBuilder

Example:

@( Html.Kendo().Switch()
.Name("Switch")
.Events(events =&gt; events
.Change("onChange")
)
)

Messages(Action<SwitchMessagesSettingsBuilder>)

Defines the text of the checked and unchecked labels that are shown within the Switch. All labels could be localized.

public SwitchBuilder Messages(Action<SwitchMessagesSettingsBuilder> configurator)

Parameters:configuratorAction<SwitchMessagesSettingsBuilder>

The action that configures the messages.

Returns:

SwitchBuilder

Example:

@(Html.Kendo().Switch()
.Name("switch")
.Messages(m =&gt; m.Checked("Yes"))
)

ReadOnly(bool)

If set to true the Kendo UI Switch will render into its read-only state.

public SwitchBuilder ReadOnly(bool value)

Parameters:valuebool

The value that configures the readonly.

Returns:

SwitchBuilder

Example:

@(Html.Kendo().Switch()
.Name("switch")
.ReadOnly(true)
)

Size(ComponentSize?)

Sets the size of the component.

public SwitchBuilder Size(ComponentSize? value)

Parameters:valueComponentSize?

The value for Size

Returns:

SwitchBuilder

Example:

@(Html.Kendo().Switch()
.Name("switch")
.Size(ComponentSize.Large)
)

ThumbRounded(Rounded?)

Sets a value controlling the thumb's border radius.

public SwitchBuilder ThumbRounded(Rounded? value)

Parameters:valueRounded?

The value for ThumbRounded

Returns:

SwitchBuilder

Example:

@(Html.Kendo().Switch()
.Name("switch")
.ThumbRounded(Rounded.Medium)
)

TrackRounded(Rounded?)

Sets a value controlling the track's border radius.

public SwitchBuilder TrackRounded(Rounded? value)

Parameters:valueRounded?

The value for TrackRounded

Returns:

SwitchBuilder

Example:

@(Html.Kendo().Switch()
.Name("switch")
.TrackRounded(Rounded.Medium)
)

Width(object)

The width of the Kendo UI Switch.

public SwitchBuilder Width(object value)

Parameters:valueobject

The value that configures the width.

Returns:

SwitchBuilder

Example:

@(Html.Kendo().Switch()
.Name("switch")
.Width(200)
)