Skip to main content

SwitchBuilder Methods

A Switch control.
Name Description
AccessKey(JS) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
AccessKey(String) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
ActiveStateEnabled(JS) Mirrors the client-side activeStateEnabled option.
ActiveStateEnabled(Boolean) Mirrors the client-side activeStateEnabled option.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FocusStateEnabled(JS) Mirrors the client-side focusStateEnabled option.
FocusStateEnabled(Boolean) Mirrors the client-side focusStateEnabled option.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
Height(JS) Mirrors the client-side height option.
Height(Double) Mirrors the client-side height option.
Height(String) Mirrors the client-side height option.
Hint(JS) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
Hint(String) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
HoverStateEnabled(JS) Mirrors the client-side hoverStateEnabled option.
HoverStateEnabled(Boolean) Mirrors the client-side hoverStateEnabled option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
IsDirty(JS)
IsDirty(Boolean)
IsValid(JS) Specifies or indicates whether the editor's value is valid. Mirrors the client-side isValid option.
IsValid(Boolean) Specifies or indicates whether the editor's value is valid. Mirrors the client-side isValid option.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
Name(JS) Mirrors the client-side name option.
Name(String) Mirrors the client-side name option.
OnContentReady(RazorBlock) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnContentReady(String) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnValueChanged(RazorBlock) A function that is executed after the UI component's value is changed. Mirrors the client-side onValueChanged option.
OnValueChanged(String) A function that is executed after the UI component's value is changed. Mirrors the client-side onValueChanged option.
Option(String, Object) Specifies an option by its name.
ReadOnly(JS) Specifies whether the editor is read-only. Mirrors the client-side readOnly option.
ReadOnly(Boolean) Specifies whether the editor is read-only. Mirrors the client-side readOnly option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
SwitchedOffText(JS) Specifies the text displayed when the UI component is switched off. Mirrors the client-side switchedOffText option.
SwitchedOffText(String) Specifies the text displayed when the UI component is switched off. Mirrors the client-side switchedOffText option.
SwitchedOnText(JS) Specifies the text displayed when the UI component is switched on. Mirrors the client-side switchedOnText option.
SwitchedOnText(String) Specifies the text displayed when the UI component is switched on. Mirrors the client-side switchedOnText option.
TabIndex(JS) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
TabIndex(Int32) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
ValidationError(Object) Information on the broken validation rule. Contains the first item from the validationErrors array. Mirrors the client-side validationError option.
ValidationErrors(JS) An array of the validation rules that failed. Mirrors the client-side validationErrors option.
ValidationErrors(IEnumerable) An array of the validation rules that failed. Mirrors the client-side validationErrors option.
ValidationMessageMode(ValidationMessageMode) Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. Mirrors the client-side validationMessageMode option.
ValidationMessagePosition(Position) Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy. Mirrors the client-side validationMessagePosition option.
ValidationRules(Action<ValidationRulesFactory>)
ValidationStatus(ValidationStatus) Indicates or specifies the current validation status. Mirrors the client-side validationStatus option.
Value(JS) A Boolean value specifying whether the current switch state is 'On' or 'Off'. Mirrors the client-side value option.
Value(Nullable<Boolean>) A Boolean value specifying whether the current switch state is 'On' or 'Off'. Mirrors the client-side value option.
Visible(JS) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Visible(Boolean) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Width(JS) Specifies the UI component's width. Mirrors the client-side width option.
Width(Double) Specifies the UI component's width. Mirrors the client-side width option.
Width(String) Specifies the UI component's width. Mirrors the client-side width option.
See Also