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

RadToggleButton

Class

RadToggleButton provides toggle functionality to a button, allowing the user to configure different states toggled on each button press or by provided API.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[TelerikToolboxCategory("Navigation")]
[ToolboxBitmap(typeof(RadToggleButton), "Toolbox.Icons.Button.png")]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(PostBackButtonBase))]
[ClientScriptResource("Telerik.Web.UI.RadToggleButton", "Telerik.Web.UI.Button.RadButtonScripts.js")]
[EmbeddedSkin("Button")]
[EmbeddedSkin("Button", "Default")]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Classic, typeof(RadButton))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadButton))]
public class RadToggleButton : PostBackButtonBase, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, INamingContainer, IButtonControl, IPostBackEventHandler

Inheritance: objectControlWebControlRadWebControlRadButtonBasePostBackButtonBaseRadToggleButton...

Implements: IAttributeAccessorIButtonControlIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorINamingContainerIParserAccessorIPostBackDataHandlerIPostBackEventHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members PostBackButtonBase.RaisePostBackEvent(string)PostBackButtonBase.ValidatePage(string)PostBackButtonBase.RegisterForEventValidation()PostBackButtonBase.LoadPostData(string, NameValueCollection)PostBackButtonBase.GetPostbackEventReference()PostBackButtonBase.OnClick(ButtonClickEventArgs)PostBackButtonBase.OnCommand(ButtonCommandEventArgs)PostBackButtonBase.AutoPostBackPostBackButtonBase.CausesValidationPostBackButtonBase.CommandArgumentPostBackButtonBase.CommandNamePostBackButtonBase.PostBackUrlPostBackButtonBase.SingleClickPostBackButtonBase.SingleClickTextPostBackButtonBase.ValidationGroupPostBackButtonBase.UseSubmitBehaviorPostBackButtonBase.ClickPostBackButtonBase.CommandWebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.LoadViewState(object)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.RenderContents(HtmlTextWriter)WebControl.SaveViewState()WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagKeyWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.OnPreRender(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RadToggleButton()

public RadToggleButton()

Properties

ConfirmSettings

RadButtonConfirmSettings

Gets the object that controls the built-in confirmation dialog properties.

[PersistenceMode(PersistenceMode.InnerProperty)]
public RadButtonConfirmSettings ConfirmSettings { get; }

OnClientToggleStateChanged

string

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

[ClientControlEvent]
[ClientPropertyName("toggleStateChanged")]
public string OnClientToggleStateChanged { get; set; }

OnClientToggleStateChanging

string

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

[ClientControlEvent]
[ClientPropertyName("toggleStateChanging")]
public string OnClientToggleStateChanging { get; set; }

SelectedToggleState

ButtonToggleState

Gets the currently selected ToggleState of the RadToggleButton control.

[Browsable(false)]
[Bindable(false)]
[Themeable(false)]
public virtual ButtonToggleState SelectedToggleState { get; }

SelectedToggleStateIndex

int

Gets or sets the index of the currently selected ToggleState of the RadToggleButton control.

[Themeable(false)]
[ClientControlProperty]
[ClientPropertyName("selectedToggleStateIndex")]
public virtual int SelectedToggleStateIndex { get; set; }

ToggleStates

ButtonToggleStateCollection

Gets a collection of ButtonToggleState objects that belong to the RadToggleButton control.

[Themeable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ButtonToggleStateCollection ToggleStates { get; }

Methods

ClearSelection()

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

public virtual void ClearSelection()

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: PostBackButtonBase.DescribeComponent(IScriptDescriptor)

FindToggleStateByText(string)

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

public virtual ButtonToggleState FindToggleStateByText(string text)

Parameters:textstring

Text of the ToggleState

Returns:

ButtonToggleState

FindToggleStateByValue(string)

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

public virtual ButtonToggleState FindToggleStateByValue(string value)

Parameters:valuestring

Value of the ToggleState

Returns:

ButtonToggleState

OnToggleStateChanged(ToggleButtonStateChangedEventArgs)

Raises the ToggleStateChaned event of the RadButton control.

protected virtual void OnToggleStateChanged(ToggleButtonStateChangedEventArgs e)

Parameters:eToggleButtonStateChangedEventArgs

RaisePostDataChangedEvent()

Invokes the OnToggleStateChanged methods, when the SelectedToggleStateIndex property of the control has changed.

protected override void RaisePostDataChangedEvent()

Overrides: RadWebControl.RaisePostDataChangedEvent()

Render(HtmlTextWriter)

protected override void Render(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadWebControl.Render(HtmlTextWriter)

SetSelectedToggleStateByText(string)

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.

public virtual void SetSelectedToggleStateByText(string text)

Parameters:textstring

Text of the ToggleState to be selected

SetSelectedToggleStateByValue(string)

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.

public virtual void SetSelectedToggleStateByValue(string value)

Parameters:valuestring

Value of the ToggleState to be selected

Adds or removes an event handler method from the ToggleStateChanged event. The event is fired when the value of the SelectedToggleStateIndex property changes between posts to the server. Valid only when RadToggleButton has ToggleType set with value, different than None

public event ToggleButtonStateChangedEventHandler ToggleStateChanged