Class RadToggleButtonElement

Represents a toggle button element. The toggle button supports two or three states depending on the IsThreeState property.

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

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
RadButtonItem
RadButtonElement
RadToggleButtonElement
ContentControlToggleButtonElement
AlphabeticalToggleButton
CategorizedAlphabeticalToggleButton
ListViewGroupToggleButton
MiniMapToggleButtonElement
RadCheckBoxElement
RadRadioButtonElement
FormatPainterToggleButtonElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadToggleButtonElement : RadButtonElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IButtonControl, IImageElement

Constructors

RadToggleButtonElement()

Declaration
public RadToggleButtonElement()

Fields

CheckedRoutedEvent

Identifies the Checked routed event.

Declaration
public static RoutedEvent CheckedRoutedEvent
Field Value
RoutedEvent

Indeterminate

Identifies the Indeterminate routed event.

Declaration
public static RoutedEvent Indeterminate
Field Value
RoutedEvent

ToggleStateChangingRoutedEvent

Identifies the ToggleStateChanging routed event.

Declaration
public static RoutedEvent ToggleStateChangingRoutedEvent
Field Value
RoutedEvent

ToggleStateProperty

Identifies the ToggleState dependency property.

Declaration
public static RadProperty ToggleStateProperty
Field Value
RadProperty

Unchecked

Identifies the Unchecked routed event.

Declaration
public static RoutedEvent Unchecked
Field Value
RoutedEvent

Properties

CheckState

Gets or sets the check state of the toggle button using CheckState enumeration. CheckState enumeration defines the following values: Unchecked, Checked, and Indeterminate.

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

IsChecked

Gets or sets a value indicating whether the button is checked. Returns true if the toggle state is not Off; otherwise, false.

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

IsThreeState

Gets or sets a value indicating whether the toggle button has three or two states. When true, the button supports Checked, Unchecked, and Indeterminate states.

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

ReadOnly

Gets or sets a value indicating whether the toggle button element is read only. When read-only, the button cannot be toggled by user interaction but can still be changed programmatically.

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

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

ToggleState

Gets or sets the toggle state of the button using ToggleState enumeration. Toggle state enumeration defines the following values: Off, Indeterminate, and On.

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

Methods

CreateChildElements()

Creates the child elements of the toggle button.

Declaration
protected override void CreateChildElements()
Overrides

GetXPVisualStyle()

Gets the visual style element for Windows XP theme rendering based on the current state of the toggle button.

Declaration
public override VisualStyleElement GetXPVisualStyle()
Returns
System.Windows.Forms.VisualStyles.VisualStyleElement

The System.Windows.Forms.VisualStyles.VisualStyleElement corresponding to the current state of the toggle button.
Overrides

OnCheckStateChanged(EventArgs)

Raises the CheckStateChanged event.

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

An System.EventArgs that contains the event data.

OnCheckStateChanging(CheckStateChangingEventArgs)

Raises the CheckStateChanging event.

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

A CheckStateChangingEventArgs that contains the event data.

OnClick(EventArgs)

Handles the Click event and performs toggle if not in read-only mode.

Declaration
protected override void OnClick(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnIsCheckedChanged(EventArgs)

Raises the IsCheckedChanged event.

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

An System.EventArgs that contains the event data.

OnToggle()

Performs the toggle operation by changing the toggle state based on the current state and whether three-state mode is enabled.

Declaration
protected virtual void OnToggle()

OnToggleStateChanged(StateChangedEventArgs)

Raises the StateChanged event.

Declaration
protected virtual void OnToggleStateChanged(StateChangedEventArgs e)
Parameters
StateChangedEventArgs e

A StateChangedEventArgs that contains the event data.

OnToggleStateChanging(StateChangingEventArgs)

Raises the StateChanging event and checks if the indeterminate state is allowed.

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

A StateChangingEventArgs that contains the event data.

SetToggleState(ToggleState)

Sets the toggle state of the button by calling the core implementation.

Declaration
protected virtual void SetToggleState(ToggleState value)
Parameters
ToggleState value

The new toggle state value to set.

Events

CheckStateChanged

Occurs when the elements's check state changes.

Declaration
public event EventHandler CheckStateChanged
Event Type
System.EventHandler

CheckStateChanging

Occurs before the elements's check state changes.

Declaration
public event CheckStateChangingEventHandler CheckStateChanging
Event Type
CheckStateChangingEventHandler

ToggleStateChanged

Occurs when the elements's state changes.

Declaration
public event StateChangedEventHandler ToggleStateChanged
Event Type
StateChangedEventHandler

ToggleStateChanging

Occurs before the elements's state changes.

Declaration
public event StateChangingEventHandler ToggleStateChanging
Event Type
StateChangingEventHandler

Extension Methods