Skip to main content

ButtonBuilder Methods

A Button 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) Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option.
ActiveStateEnabled(Boolean) Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option.
Content(RazorBlock) Specifies content for a Button control.
Content(String) Specifies content for a Button control.
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) Specifies the UI component's height. Mirrors the client-side height option.
Height(Double) Specifies the UI component's height. Mirrors the client-side height option.
Height(String) Specifies the UI component's height. 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.
Icon(JS) Specifies the icon to be displayed on the button. Mirrors the client-side icon option.
Icon(String) Specifies the icon to be displayed on the button. Mirrors the client-side icon 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.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnClick(RazorBlock) A function that is executed when the Button is clicked or tapped. Mirrors the client-side onClick option.
OnClick(String) A function that is executed when the Button is clicked or tapped. Mirrors the client-side onClick 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.
Option(String, Object) Specifies an option by its name.
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.
StylingMode(ButtonStylingMode) Specifies how the button is styled. Mirrors the client-side stylingMode 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.
Template(JS) Specifies the client-side template.
Template(RazorBlock) Specifies the client-side template.
Template(TemplateName) Specifies the client-side template.
Template(String) Specifies the client-side template.
Text(JS) The text displayed on the button. Mirrors the client-side text option.
Text(String) The text displayed on the button. Mirrors the client-side text option.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
Type(ButtonType) Specifies the button type. Mirrors the client-side type option.
Type(JS)
Type(String)
UseSubmitBehavior(JS) Specifies whether the button submits an HTML form. Mirrors the client-side useSubmitBehavior option.
UseSubmitBehavior(Boolean) Specifies whether the button submits an HTML form. Mirrors the client-side useSubmitBehavior option.
ValidationGroup(JS) Specifies the name of the validation group to be accessed in the click event handler. Mirrors the client-side validationGroup option.
ValidationGroup(String) Specifies the name of the validation group to be accessed in the click event handler. Mirrors the client-side validationGroup 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