SwitchBuilder
Properties
WriteAction - Func
Methods
Checked(System.Boolean)
The checked state of the Switch.
Parameters
value - System.Boolean
The value for Checked
RETURNS
Returns the current SwitchBuilder instance.
Checked()
The checked state of the Switch.
RETURNS
Returns the current SwitchBuilder instance.
Enabled(System.Boolean)
If set to false, the Switch will be disabled and will not allow the user to change its checked state.
Parameters
value - System.Boolean
The value for Enabled
RETURNS
Returns the current SwitchBuilder instance.
Readonly(System.Boolean)
If set to true, the Switch will render into its read-only state.
Parameters
value - System.Boolean
The value for Readonly
RETURNS
Returns the current SwitchBuilder instance.
Readonly()
If set to true, the Switch will render into its read-only state.
RETURNS
Returns the current SwitchBuilder instance.
Messages(System.Action)
Defines the text of the checked and unchecked labels that are displayed within the Switch. All labels support localization.
Parameters
configurator - System.Action<SwitchMessagesSettingsBuilder>
The configurator for the messages setting.
RETURNS
Returns the current instance of SwitchBuilder .
Width(System.Double)
The width of the Switch.
Parameters
value - System.Double
The value for Width
RETURNS
Returns the current SwitchBuilder instance.
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the component.
Parameters
value - ComponentSize
The value for Size
RETURNS
Returns the current SwitchBuilder instance.
TrackRounded(Kendo.Mvc.UI.Rounded)
Sets a value controlling the track's border radius.
Parameters
value - Rounded
The value for TrackRounded
RETURNS
Returns the current SwitchBuilder instance.
ThumbRounded(Kendo.Mvc.UI.Rounded)
Sets a value controlling the thumb's border radius.
Parameters
value - Rounded
The value for ThumbRounded
RETURNS
Returns the current SwitchBuilder instance.
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<SwitchEventBuilder>
The client events action.
RETURNS
Returns the current SwitchBuilder instance.
Example
@(Html.Kendo().Switch()
.Name("Switch")
.Events(events => events
.Change("onChange")
)
)
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.