Edit this page

Telerik.Web.UI.RadButton

RadButton control provides the features, that ASP.NET: Button, ImageButton, LinkButton, RadioButton and CheckBox controls have.

Inheritance Hierarchy

  • System.Object
  • System.Web.UI.Control
  • System.Web.UI.WebControls.WebControl
  • Telerik.Web.UI.RadWebControl : IControl, IControlResolver, IPostBackDataHandler, IScriptControl, ISkinnableControl
  • Telerik.Web.UI.RadButton : IButtonControl, ICheckBoxControl, INamingContainer, IPostBackEventHandler

Properties

AccessKey String

Gets or sets the accessKey of the RadButton control.

AutoPostBack Boolean

Gets or sets a bool value indicating whether the RadButton control automatically posts back to the server when clicked.

ButtonType RadButtonType

Gets or sets the type of the button. RadButtonType:StandardButton(default), LinkButton and ToggleButton.

CausesValidation Boolean

Gets or sets a value indicating whether validation is performed when the RadButton control is clicked.

Checked Boolean

Gets or sets a bool value indicating whether the RadButton control is checked.

ClientIDMode ClientIDMode

This property is overridden in order to support controls which implement INamingContainer.
The default value is changed to "AutoID".

CommandArgument String

Gets or sets an optional parameter passed to the Command event along with the associated CommandName.

CommandName String

Gets or sets the command name associated with the RadButton control that is passed to the Command event.

ContentTemplate ITemplate

Gets or sets the template for the RadButton control.

CssClass String

Gets or sets the CSS class rendered by the RadButton control on the client.

CssClassFormatString String

The CssClass property will now be used instead of the former Skin
and will be modified in AddAttributesToRender()

DisabledButtonCssClass String

Gets or sets the CSS class applied to the RadButton control when it is in a disabled state.

EnableAjaxSkinRendering String

Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests

Remarks

If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax.

EnableAriaSupport Boolean

When set to true enables support for WAI-ARIA

EnableBrowserButtonStyle Boolean

Gets or sets a bool value indicating whether the client browser's default styling will be applied to the RadButton control.When this property is set to true, the control will look like standard HTML input of type="button" or type="submit",
with the default styles applied by the client browser.
Use this property when ButtonType="StandardButton".

EnableEmbeddedBaseStylesheet Boolean

Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.

Remarks

If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.

EnableEmbeddedScripts Boolean

Gets or sets the value, indicating whether to render script references to the embedded scripts or not.

Remarks

If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.

EnableEmbeddedSkins String

Gets or sets the value, indicating whether to render links to the embedded skins or not.

Remarks

If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.

EnableRippleEffect Boolean

Returns true if ripple effect should be added

EnableSplitButton Boolean

Gets or sets a bool value indicating whether an additional button (besides the primary button) will be rendered in the RadButton control.

GroupName String

Gets or sets the name of the group the RadButton control, configured as a radio button (ToggleType='Radio'), belongs to.

Height Unit

Gets or sets the height of the RadButton control.

HoveredCssClass String

Gets or sets the CSS class applied to the RadButton control when the mouse pointer is over the control.

Icon RadButtonIcon

Gets the object that controls the Primary and Secondary Icon related properties.

Image RadButtonImage

Gets the object that control the Image properties. A RadButton control can be rendered as an ImageButton, or it can have a BackgroundImage.

IsSkinSet String

For internal use.

NavigateUrl String

Gets or sets the URL to link to when the RadButton control is clicked.

OnClientCheckedChanged String

Gets or sets the name of the JavaScript function that will be called after the Checked property of the RadButton control is changed.

OnClientCheckedChanging String

Gets or sets the name of the JavaScript function that will be called when the Checked property of the RadButton control is about to be changed.

OnClientClicked String

Gets or sets the name of the JavaScript function that will be called when the RadButton is clicked, after the OnClientClicking event.

OnClientClicking String

Gets or sets the name of the JavaScript function that will be called when the RadButton is clicked. The event is cancelable.

OnClientLoad String

Gets or sets the name of the JavaScript function that will be called when the RadButton is loaded on the page.

OnClientMouseOut String

Gets or sets the name of the JavaScript function that will be called when the mouse pointer leaves the RadButton.

OnClientMouseOver String

Gets or sets the name of the JavaScript function that will be called when the mouse pointer hovers over the RadButton.

OnClientToggleStateChanged String

Gets or sets the name of the JavaScript function that will be called after the SelectedToggleStateIndex property of the RadButton control is changed.

OnClientToggleStateChanging String

Gets or sets the name of the JavaScript function that will be called when the SelectedToggleStateIndex property of the RadButton control is about to be changed.

PostBackUrl String

Gets or sets the URL of the page to post to from the current page when the RadButton control is clicked.

PressedCssClass String

Gets or sets the CSS class applied to the RadButton control when the control is pressed.

Primary Boolean

Gets/Sets the primary appearance of the button.

ReadOnly Boolean

Gets or sets a bool value indicating whether the RadButton control is in a read-only mode.

ReadOnlyCssClass Boolean

Gets or sets the CSS class applied to the RadButton control when it is in ReadOnly mode. The property is set to true.

RegisterWithScriptManager Boolean

Gets or sets the value, indicating whether to register with the ScriptManager control on the page.

Remarks

If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.

RenderMode RenderMode

Specifies the rendering mode of the control. Setting the mode to Lightweight will yield
HTML 5/CSS 3 html and css.

Remarks

Lightweight rendering mode might change the outlook of the component in some older browsers
that don't support CSS3/HTML5.

ResolvedRenderMode RenderMode

Returns resolved RenderMode should the original value was Auto

RuntimeSkin String

Gets the real skin name for the control user interface. If Skin is not set, returns
"Default", otherwise returns Skin.

SelectedToggleState RadButtonToggleState

Gets the currently selected ToggleState of the RadButton control when used as a custom toggle button.

SelectedToggleStateIndex RadButtonToggleState

Gets or sets the index of the currently selected ToggleState of the RadButton control, when used as a custom toggle button.

SingleClick Boolean

Gets or sets a bool value indicating whether the RadButton control will be immediately disabled after the user has clicks it. (i.e. enables/disables "Single Click" functionality)

SingleClickText String

Gets or sets the text displayed in the RadButton control after the button is being clicked and disabled. (i.e. the text used for the 'Single Click' functionality)

Skin String

Gets or sets the skin name for the control user interface.

Remarks

If this property is not set, the control will render using the skin named "Default".
If EnableEmbeddedSkins is set to false, the control will not render skin.

SplitButtonCssClass String

Gets or sets the CSS class applied to the SplitButton of the RadButton control.

SplitButtonPosition ButtonPosition

Gets or sets the position (relative to the RadButton's text) of the split button.

Target String

Gets or sets the target window or frame in which to display the Web page content linked to when the RadButton control is clicked.

Text String

Gets or sets the text displayed in the RadButton control.

ToggleStates RadButtonToggleStateCollection

Gets a collection of RadButtonToggleState objects that belong to the RadButton control.

ToggleType ButtonToggleType

Gets or sets the toggle type of the RadButton control when used as a toggle button.
The Default is ButtonToggleType='None'.

ToolTip String

Gets or sets the text that will be displayed in the tooltip of the RadButton control when it is hovered.

UseSubmitBehavior Boolean

Gets or sets a value indicating whether the RadButton control uses the client browser's submit mechanism or the ASP.NET postback mechanism.

ValidationGroup String

Gets or sets the group of controls for which the RadButton control causes validation when it posts back to the server.

Value String

Gets or sets an optional Value of the RadButton control.

Width Unit

Gets or sets the width of the RadButton control.

Methods

AddAttributesToRender

Adds the attributes of the RadButton control to the output stream for rendering on the client.

Parameters

writer System.Web.UI.HtmlTextWriter

An HtmlTextWriter that contains the output stream to render on the client.

Returns

System.Void

ApplyConditionalRendering

Use this from RenderContents of the inheritor

Returns

System.Void

ClearSelection

Clears out the list selection and sets the Selected property of all ToggleState objects to false.

Returns

System.Void

ControlPreRender

Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason

Returns

System.Void

FindToggleStateByText

Find a RadButton's ToggleState by the value of its Text property

Parameters

text System.String

Text of the ToggleState

Returns

Telerik.Web.UI.RadButtonToggleState

FindToggleStateByValue

Find a RadButton's ToggleState by the value of its Value property

Parameters

value System.String

Value of the ToggleState

Returns

Telerik.Web.UI.RadButtonToggleState

GetEmbeddedSkinNames

Returns the names of all embedded skins. Used by Telerik.Web.Examples.

Returns

System.Collections.Generic.List1`

GetPostbackEventReference

Creates a PostBackOptions object that represents the RadButton control's postback behavior, and returns the client script
generated as a result of the PostBackOptions.

Returns

System.String The client script that represents the RadButton control's PostBackOptions.

GetPostBackOptions

Creates a PostBackOptions object that represents the RadButton control's postback behavior.

Returns

System.Web.UI.PostBackOptions A PostBackOptions that represents the RadButton control's postback behavior.

LoadClientState

Loads the client state data

Parameters

clientState System.Collections.Generic.Dictionary{System.String,System.Object}

Returns

System.Void

LoadPostData

Executed when post data is loaded from the request

Parameters

postDataKey System.String

postCollection System.Collections.Specialized.NameValueCollection

Returns

System.Boolean

OnCheckedChanged

Raises the CheckedChanged event of the RadButton control.

Parameters

e System.EventArgs

Returns

System.Void

OnClick

Raises the Click event of the RadButton control.

Parameters

e Telerik.Web.UI.ButtonClickEventArgs

A ButtonClickEventArgs that contains the event data.

Returns

System.Void

OnCommand

Raises the Command event of the RadButton control.

Parameters

e Telerik.Web.UI.ButtonCommandEventArgs

A ButtonCommandEventArgs that contains the event data.

Returns

System.Void

OnToggleStateChanged

Raises the ToggleStateChaned event of the RadButton control.

Parameters

e Telerik.Web.UI.ButtonToggleStateChangedEventArgs

Returns

System.Void

RaisePostBackEvent

Raises events for the RadButton control when it posts back to the server.

Parameters

eventArgument System.String

The argument for the event.

Returns

System.Void

RaisePostDataChangedEvent

Invokes the OnCheckedChanged and OnToggleStateChanged methods,
when the Checked and SelectedToggleStateIndex properties of the RadButton control have changed.

Returns

System.Void

RaisePostDataChangedEvent

Executed when post data changes should invoke a changed event

Returns

System.Void

RegisterCssReferences

Registers the CSS references

Returns

System.Void

RegisterScriptControl

Registers the control with the ScriptManager

Returns

System.Void

SaveClientState

Saves the client state data

Returns

System.String

SetSelectedToggleStateByText

Sets the selected state by provided value.If multiple ToggleStates have equal value the first one will be selected.If ToggleState with the provided value is not registered the current ToggleState will not be changed.

Parameters

text System.String

Text of the ToggleState to be selected

Returns

System.Void

SetSelectedToggleStateByValue

Sets the selected state by provided value.If multiple ToggleStates have equal value the first one will be selected.If ToggleState with the provided value is not registered the current ToggleState will not be changed.

Parameters

value System.String

Value of the ToggleState to be selected

Returns

System.Void