Class ToggleButton

Base class for controls that can switch states, such as CheckBox and RadioButton.

Inheritance
System.Object
DependencyObject
UIElement
FrameworkElement
Control
ContentControl
ButtonBase
ToggleButton
CheckBox
AccordionButton
RadioButton
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: System.Windows.Controls.Primitives
Assembly: OpenSilver.dll
Syntax
public class ToggleButton : ButtonBase, IControl, IFrameworkElement, IUIElement, IDependencyObject

Constructors

| Improve this Doc View Source

ToggleButton()

Initializes a new instance of the ToggleButton class.

Declaration
public ToggleButton()

Fields

| Improve this Doc View Source

IsCheckedProperty

Identifies the IsChecked dependency property.

Declaration
public static readonly DependencyProperty IsCheckedProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

IsThreeStateProperty

Identifies the IsThreeState dependency property.

Declaration
public static readonly DependencyProperty IsThreeStateProperty
Field Value
Type Description
DependencyProperty

Properties

| Improve this Doc View Source

IsChecked

Gets or sets whether the ToggleButton is checked.

Declaration
public bool? IsChecked { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

true if the ToggleButton is checked; false if the ToggleButton is unchecked; otherwise null. The default is false.
| Improve this Doc View Source

IsThreeState

Gets or sets whether the control supports two or three states.

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

true if the control supports three states; otherwise, false. The default is false.

Methods

| Improve this Doc View Source

OnChecked(RoutedEventArgs)

Raises the Checked event.

Declaration
protected virtual void OnChecked(RoutedEventArgs e)
Parameters
Type Name Description
RoutedEventArgs e
| Improve this Doc View Source

OnClick()

Called when the ToggleButton is clicked by the mouse or the keyboard.

Declaration
protected override void OnClick()
Overrides
| Improve this Doc View Source

OnContentChanged(Object, Object)

Called when the ContentControl property changes.

Declaration
protected override void OnContentChanged(object oldContent, object newContent)
Parameters
Type Name Description
System.Object oldContent

The content to be replaced.
System.Object newContent

The new content to display.
Overrides
| Improve this Doc View Source

OnCreateAutomationPeer()

Returns a ToggleButtonAutomationPeer for use by the Silverlight automation infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type Description
AutomationPeer

A ToggleButtonAutomationPeer for the ToggleButton object.
Overrides
| Improve this Doc View Source

OnIndeterminate(RoutedEventArgs)

Raises the Indeterminate event.

Declaration
protected virtual void OnIndeterminate(RoutedEventArgs e)
Parameters
Type Name Description
RoutedEventArgs e
| Improve this Doc View Source

OnToggle()

Called by the OnClick() method to implement toggle behavior.

Declaration
protected virtual void OnToggle()
| Improve this Doc View Source

OnUnchecked(RoutedEventArgs)

Raises the Unchecked event.

Declaration
protected virtual void OnUnchecked(RoutedEventArgs e)
Parameters
Type Name Description
RoutedEventArgs e
| Improve this Doc View Source

ToString()

Returns the string representation of a ToggleButton object.

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Events

| Improve this Doc View Source

Checked

Occurs when a ToggleButton is checked.

Declaration
public event RoutedEventHandler Checked
Event Type
Type Description
RoutedEventHandler
| Improve this Doc View Source

Indeterminate

Occurs when the state of a ToggleButton is switched to the indeterminate state.

Declaration
public event RoutedEventHandler Indeterminate
Event Type
Type Description
RoutedEventHandler
| Improve this Doc View Source

Unchecked

Occurs when a ToggleButton is unchecked.

Declaration
public event RoutedEventHandler Unchecked
Event Type
Type Description
RoutedEventHandler

Extension Methods