Class RadToggleButton

Represents a RadToggleButton. A ToggleButton may have the following states: On, Off, and Indeterminate. The button may have only the first two states if the IsThreeState property is set to false.

The RadToggleButton class is a simple wrapper for the RadToggleButtonElement. All UI and logic functionality is implemented in the RadToggleButtonElement class. The latter can be nested in other telerik controls. RadToggleButton acts to transfer events to and from the its corresponding RadToggleButtonElement instance.

Inheritance
System.Object
RadControl
RadButtonBase
RadToggleButton
RadCheckBox
RadRadioButton
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadToggleButton : RadButtonBase, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadToggleButton()

Initializes a new instance of the RadToggleButton class.

Declaration
public RadToggleButton()

Properties

ButtonElement

Gets the instance of RadToggleButtonElement wrapped by this control. RadToggleButtonElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadToggleButton.

Declaration
public RadToggleButtonElement ButtonElement { get; }
Property Value
RadToggleButtonElement

CheckState

Gets or sets the System.Windows.Forms.CheckState. CheckState enumeration defines the following values: Unchecked, Checked, and Indeterminate.

Declaration
public CheckState CheckState { get; set; }
Property Value
System.Windows.Forms.CheckState

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Overrides

IsChecked

Gets or sets a boolean value indicating where the button is checked.

Declaration
[RadDefaultValue("IsChecked", typeof(RadToggleButtonElement))]
public virtual bool IsChecked { get; set; }
Property Value
System.Boolean

IsThreeState

Gets or sets a boolean value indicating where the button is checked.

Declaration
[RadDefaultValue("IsThreeState", typeof(RadToggleButtonElement))]
public bool IsThreeState { get; set; }
Property Value
System.Boolean

ReadOnly

Gets or sets a value indicating whether the toggle button is read only.

Declaration
public bool ReadOnly { get; set; }
Property Value
System.Boolean

true if the toggle button is read only; otherwise, false.

ToggleState

Declaration
[RadDefaultValue("ToggleState", typeof(RadToggleButtonElement))]
public ToggleState ToggleState { get; set; }
Property Value
ToggleState

Methods

ButtonElement_ToggleStateChanged(Object, StateChangedEventArgs)

Declaration
protected virtual void ButtonElement_ToggleStateChanged(object sender, StateChangedEventArgs args)
Parameters
System.Object sender

StateChangedEventArgs args

ButtonElement_ToggleStateChanging(Object, StateChangingEventArgs)

Declaration
protected virtual void ButtonElement_ToggleStateChanging(object sender, StateChangingEventArgs args)
Parameters
System.Object sender

StateChangingEventArgs args

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

Overrides

CreateButtonElement()

Create main button element that is specific for RadToggleButton.

Declaration
protected override RadButtonElement CreateButtonElement()
Returns
RadButtonElement

The element that encapsulates the functionality of RadToggleButton
Overrides

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

OnCheckStateChanged(EventArgs)

Raises the CheckStateChanged event.

Declaration
protected virtual void OnCheckStateChanged(EventArgs e)
Parameters
System.EventArgs e

OnCheckStateChanging(CheckStateChangingEventArgs)

Raises the CheckStateChanging event.

Declaration
protected virtual void OnCheckStateChanging(CheckStateChangingEventArgs e)
Parameters
CheckStateChangingEventArgs e

OnToggleChanged(EventArgs)

Declaration
protected virtual void OnToggleChanged(EventArgs e)
Parameters
System.EventArgs e

OnToggleStateChanged(EventArgs)

Raises the StateChanged event.

Declaration
protected virtual void OnToggleStateChanged(EventArgs e)
Parameters
System.EventArgs e

OnToggleStateChanging(StateChangingEventArgs)

Raises the StateChanging event.

Declaration
protected virtual void OnToggleStateChanging(StateChangingEventArgs e)
Parameters
StateChangingEventArgs e

res_CheckStateChanged(Object, EventArgs)

Declaration
protected virtual void res_CheckStateChanged(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

res_CheckStateChanging(Object, CheckStateChangingEventArgs)

Declaration
protected virtual void res_CheckStateChanging(object sender, CheckStateChangingEventArgs args)
Parameters
System.Object sender

CheckStateChangingEventArgs args

res_PropertyChanged(Object, PropertyChangedEventArgs)

Declaration
protected virtual void res_PropertyChanged(object sender, PropertyChangedEventArgs e)
Parameters
System.Object sender

System.ComponentModel.PropertyChangedEventArgs e

ResetBackColorThemeOverrides()

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

SetBackColorThemeOverrides()

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

Events

CheckStateChanged

Occurs when the element's check state changed.

Declaration
public event EventHandler CheckStateChanged
Event Type
System.EventHandler

CheckStateChanging

Occurs when the elements's check state is changing.

Declaration
public event CheckStateChangingEventHandler CheckStateChanging
Event Type
CheckStateChangingEventHandler

ToggleStateChanged

Occurs when the element's state changes.

Declaration
public event StateChangedEventHandler ToggleStateChanged
Event Type
StateChangedEventHandler

ToggleStateChanging

Occurs when the elements's state is changing.

Declaration
public event StateChangingEventHandler ToggleStateChanging
Event Type
StateChangingEventHandler

Extension Methods