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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[DefaultBindingProperty("Text")]
public class RadToggleButton : RadButtonBase, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, ISupportRootUIAutomationInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadButtonBaseRadToggleButton...
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadToggleButton class. Creates a toggle button with default settings and unchecked state.
public RadToggleButton()Properties
Gets the RadToggleButtonElement that represents the visual element of this toggle button control. This element contains the visual styling and behavior logic for the toggle button.
[Browsable(false)]
public RadToggleButtonElement ButtonElement { get; }A RadToggleButtonElement that represents the button's visual element.
Gets or sets the check state of the toggle button using CheckState enumeration. Supports three states: Checked, Unchecked, and Indeterminate (when IsThreeState is true).
[Browsable(true)]
[Bindable(true)]
public CheckState CheckState { get; set; }One of the CheckState enumeration values.
Gets the default size for the toggle button control.
protected override Size DefaultSize { get; }Overrides:
Gets or sets a value indicating whether UI Automation support is enabled for this toggle button. Enables accessibility features for screen readers and other assistive technologies.
public override bool EnableUIAutomation { get; set; }true if UI Automation is enabled; otherwise, false.
Overrides:
Implements:
Gets or sets a value indicating whether the toggle button is in the checked state. This is a simplified boolean representation of the button's toggle state.
[Browsable(true)]
[Bindable(true)]
public virtual bool IsChecked { get; set; }true if the button is checked; otherwise, false.
Gets or sets a value indicating whether the toggle button supports three states. When true, the button can have Checked, Unchecked, and Indeterminate states.
[Browsable(true)]
[Bindable(true)]
public bool IsThreeState { get; set; }true if the button supports three states; otherwise, false.
Gets or sets a value indicating whether the toggle button is in read-only mode. When read-only, the button cannot be toggled by user interaction but can still be changed programmatically.
[Browsable(true)]
public bool ReadOnly { get; set; }true if the button is read-only; otherwise, false.
Gets or sets the toggle state of the button using the ToggleState enumeration. This property provides more granular control over the button's state than IsChecked.
[Browsable(true)]
[Bindable(true)]
public ToggleState ToggleState { get; set; }One of the ToggleState enumeration values (Off, On, Indeterminate).
Methods
Handles the ToggleStateChanged event from the underlying button element and forwards it to the control's event.
protected virtual void ButtonElement_ToggleStateChanged(object sender, StateChangedEventArgs args)The source of the event.
argsStateChangedEventArgsA StateChangedEventArgs that contains the event data.
Handles the ToggleStateChanging event from the underlying button element and forwards it to the control's event.
protected virtual void ButtonElement_ToggleStateChanging(object sender, StateChangingEventArgs args)The source of the event.
argsStateChangingEventArgsA StateChangingEventArgs that contains the event data.
Creates an accessibility instance for the toggle button to support assistive technologies.
protected override AccessibleObject CreateAccessibilityInstance()An AccessibleObject that provides accessibility support for the toggle button.
Overrides:
Create main button element that is specific for RadToggleButton.
protected override RadButtonElement CreateButtonElement()The element that encapsulates the functionality of RadToggleButton
Overrides:
Creates the child items for the toggle button and establishes event handlers with the underlying button element.
protected override void CreateChildItems(RadElement parent)The parent RadElement that will contain the child items.
Overrides:
Initializes and returns the UI Automation provider for this toggle button control.
protected virtual IRadRawElementProviderFragmentRoot InitializeUIAutomationProvider()IRadRawElementProviderFragmentRoot
An IRadRawElementProviderFragmentRoot that provides UI Automation support.
Raises the CheckStateChanging event.
protected virtual void OnCheckStateChanging(CheckStateChangingEventArgs e)A CheckStateChangingEventArgs that contains the event data.
Raises the StateChanging event.
protected virtual void OnToggleStateChanging(StateChangingEventArgs e)A StateChangingEventArgs that contains the event data.
Handles the CheckStateChanging event from the underlying button element and forwards it to the control's event.
protected virtual void res_CheckStateChanging(object sender, CheckStateChangingEventArgs args)The source of the event.
argsCheckStateChangingEventArgsA CheckStateChangingEventArgs that contains the event data.
Handles property changes from the underlying button element, specifically for the IsChecked property.
protected virtual void res_PropertyChanged(object sender, PropertyChangedEventArgs e)The source of the event.
ePropertyChangedEventArgsA PropertyChangedEventArgs that contains the event data.
Resets the background color theme overrides to their default values.
protected override void ResetBackColorThemeOverrides()Overrides:
Resets the forecolor theme overrides to their default values.
protected override void ResetForeColorThemeOverrides()Overrides:
Sets theme overrides for the background color property across all visual states of the button element.
protected override void SetBackColorThemeOverrides()Overrides:
Sets theme overrides for the forecolor property across all visual states of the button element.
protected override void SetForeColorThemeOverrides()Overrides:
Events
Occurs after the check state has changed. This event is fired after the CheckState property has been updated.
[Browsable(true)]
public event EventHandler CheckStateChangedOccurs before the check state changes, providing an opportunity to cancel the change. Event handlers can validate the new state and cancel if necessary.
[Browsable(true)]
public event CheckStateChangingEventHandler CheckStateChangingOccurs after the toggle state has changed. This event is fired after the ToggleState property has been updated to its new value.
[Browsable(true)]
public event StateChangedEventHandler ToggleStateChangedOccurs before the toggle state changes, allowing the change to be cancelled. Event handlers can set the Cancel property of the event args to prevent the state change.
[Browsable(true)]
public event StateChangingEventHandler ToggleStateChanging