ToggleButton Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

Inheritance Hierarchy

System..::.Object
System.Windows..::.DependencyObject
System.Windows..::.UIElement
System.Windows..::.FrameworkElement
System.Windows.Controls..::.Control
System.Windows.Controls..::.ContentControl
System.Windows.Controls.Primitives..::.ButtonBase
System.Windows.Controls.Primitives..::.ToggleButton
System.Windows.Controls..::.CheckBox
System.Windows.Controls..::.RadioButton

Namespace: System.Windows.Controls.Primitives
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

<TemplateVisualStateAttribute(Name := "MouseOver", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Normal", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Pressed", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Disabled", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Unfocused", GroupName := "FocusStates")> _
<TemplateVisualStateAttribute(Name := "Focused", GroupName := "FocusStates")> _
<TemplateVisualStateAttribute(Name := "Checked", GroupName := "CheckStates")> _
<TemplateVisualStateAttribute(Name := "Unchecked", GroupName := "CheckStates")> _
<TemplateVisualStateAttribute(Name := "Indeterminate", GroupName := "CheckStates")> _
Public Class ToggleButton _
    Inherits ButtonBase
[TemplateVisualStateAttribute(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Pressed", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Unfocused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "Focused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "Checked", GroupName = "CheckStates")]
[TemplateVisualStateAttribute(Name = "Unchecked", GroupName = "CheckStates")]
[TemplateVisualStateAttribute(Name = "Indeterminate", GroupName = "CheckStates")]
public class ToggleButton : ButtonBase
<ToggleButton .../>
-or-
<ToggleButton>
  singleObject
</ToggleButton>
-or-
<ToggleButton>contentString</ToggleButton>

XAML Values

  • singleObject
    A single object element that declares the content.

  • contentString
    A string that is displayed as content through the default template ContentPresenter. For more information, see "String Content of a ContentControl" section of ContentControl.

The ToggleButton type exposes the following members.

Constructors

Name Description
ToggleButton Initializes a new instance of the ToggleButton class.

Top

Properties

Name Description
ActualHeight Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
ActualWidth Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
AllowDrop Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement.)
Background (Inherited from Control.)
BorderBrush (Inherited from Control.)
BorderThickness (Inherited from Control.)
CacheMode Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
CharacterSpacing (Inherited from Control.)
ClickMode Gets or sets when the Click event occurs. (Inherited from ButtonBase.)
Clip Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Command Gets or sets the command to invoke when this button is pressed. (Inherited from ButtonBase.)
CommandParameter Gets or sets the parameter to pass to the Command property. (Inherited from ButtonBase.)
Content Gets or sets the value of the ContentControl dependency property. (Inherited from ContentControl.)
ContentTemplate Gets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl.)
Cursor Infrastructure. Gets or sets the cursor image that displays while the pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
DataContext Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
DefaultStyleKey (Inherited from Control.)
DesiredSize Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
FlowDirection Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
FontFamily (Inherited from Control.)
FontSize (Inherited from Control.)
FontStretch (Inherited from Control.)
FontStyle (Inherited from Control.)
FontWeight (Inherited from Control.)
Foreground (Inherited from Control.)
Height Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
HorizontalAlignment Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.)
HorizontalContentAlignment (Inherited from Control.)
IsChecked Gets or sets whether the ToggleButton is checked.
IsEnabled (Inherited from Control.)
IsFocused Gets a value that determines whether the button has focus. (Inherited from ButtonBase.)
IsHitTestVisible Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
IsMouseOver Gets a value indicating whether the finger is located over this button control. (Inherited from ButtonBase.)
IsPressed Gets a value that indicates whether a ButtonBase is currently in a pressed state. (Inherited from ButtonBase.)
IsTabStop (Inherited from Control.)
IsThreeState Gets or sets whether the control supports two or three states.
Language Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Margin Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
MaxHeight Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MaxWidth Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MinHeight Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
MinWidth Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Name Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.)
Opacity Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
OpacityMask Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Padding (Inherited from Control.)
Parent Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Projection Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
RenderSize Gets the final render size of a UIElement. (Inherited from UIElement.)
RenderTransform Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
RenderTransformOrigin Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Resources Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.)
Style Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
TabIndex (Inherited from Control.)
TabNavigation (Inherited from Control.)
Tag Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Template (Inherited from Control.)
Triggers Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
UseLayoutRounding Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.)
UseOptimizedManipulationRouting Gets or sets a value that indicates whether the system should handle input events or whether the FrameworkElement should handle input events. (Inherited from FrameworkElement.)
VerticalAlignment Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.)
VerticalContentAlignment (Inherited from Control.)
Visibility Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
Width Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)

Top

Methods

Name Description
AddHandler Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
ApplyTemplate (Inherited from Control.)
Arrange Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.)
ArrangeOverride Provides the behavior for the Arrange pass of Windows Phone layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
CaptureMouse Sets touch capture to a UIElement. (Inherited from UIElement.)
CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Focus (Inherited from Control.)
GetAnimationBaseValue Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
GetBindingExpression Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetTemplateChild (Inherited from Control.)
GetType Gets the Type of the current instance. (Inherited from Object.)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Measure Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.)
MeasureOverride Provides the behavior for the Measure pass of Windows Phone layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
OnApplyTemplate Builds the visual tree for the ToggleButton when a new template is applied. (Overrides FrameworkElement..::.OnApplyTemplate()()().)
OnClick Called when the ToggleButton is tapped by the user or the activated using the keyboard. (Overrides ButtonBase..::.OnClick()()().)
OnContentChanged Called when the ContentControl property changes. (Overrides ContentControl..::.OnContentChanged(Object, Object).)
OnCreateAutomationPeer Returns a ToggleButtonAutomationPeer for use by the Windows Phone automation infrastructure. (Overrides UIElement..::.OnCreateAutomationPeer()()().)
OnDoubleTap (Inherited from Control.)
OnDragEnter (Inherited from Control.)
OnDragLeave (Inherited from Control.)
OnDragOver (Inherited from Control.)
OnDrop (Inherited from Control.)
OnGotFocus Provides handling for the GotFocus event. (Inherited from ButtonBase.)
OnHold (Inherited from Control.)
OnIsPressedChanged Called when the value of the IsPressed property changes. (Inherited from ButtonBase.)
OnKeyDown Provides class handling for the KeyDown event that occurs when the user presses a key while this control has focus. (Inherited from ButtonBase.)
OnKeyUp Provides class handling for the KeyUp routed event that occurs when the user releases a key while this control has focus. (Inherited from ButtonBase.)
OnLostFocus Provides handling for the LostFocus event. (Inherited from ButtonBase.)
OnLostMouseCapture Provides handling for the LostMouseCapture event. (Inherited from ButtonBase.)
OnManipulationCompleted (Inherited from Control.)
OnManipulationDelta (Inherited from Control.)
OnManipulationStarted (Inherited from Control.)
OnMouseEnter Provides class handling for the MouseEnter event that occurs when the user’s touch enters this control. (Inherited from ButtonBase.)
OnMouseLeave Provides class handling for the MouseLeave routed event that occurs when the user’s touch leaves an element. (Inherited from ButtonBase.)
OnMouseLeftButtonDown Provides class handling for the MouseLeftButtonDown event that occurs when the user touches the control. (Inherited from ButtonBase.)
OnMouseLeftButtonUp Provides class handling for the MouseLeftButtonUp event that occurs when the user lifts their finger while it is over this control. (Inherited from ButtonBase.)
OnMouseMove Provides class handling for the MouseMove event that occurs when the mouse pointer moves while over this element. (Inherited from ButtonBase.)
OnMouseRightButtonDown (Inherited from Control.)
OnMouseRightButtonUp (Inherited from Control.)
OnMouseWheel (Inherited from Control.)
OnTap (Inherited from Control.)
OnTextInput (Inherited from Control.)
OnTextInputStart (Inherited from Control.)
OnTextInputUpdate (Inherited from Control.)
OnToggle Called by the OnClick method to implement toggle behavior.
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
ReleaseMouseCapture Removes touch capture from a UIElement. After this call, typically no object holds touch capture. (Inherited from UIElement.)
RemoveHandler Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
SetBinding Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
ToString Returns the string representation of a ToggleButton object. (Overrides Object..::.ToString()()().)
TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)

Top

Events

Name Description
BindingValidationError Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Checked Occurs when a ToggleButton is checked.
Click Occurs when a Button is tapped. (Inherited from ButtonBase.)
DoubleTap Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement.)
Hold Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Indeterminate Occurs when the state of a ToggleButton is switched to the indeterminate state.
IsEnabledChanged (Inherited from Control.)
KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
LayoutUpdated Occurs when the layout of the Windows Phone visual tree changes. (Inherited from FrameworkElement.)
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement.)
LostMouseCapture Occurs when the UIElement loses touch capture. (Inherited from UIElement.)
ManipulationCompleted Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement.)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
MouseEnter Occurs when a screen tap occurs within the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeave Occurs when a touch event occurs outside the bounding area of a UIElement. (Inherited from UIElement.)
MouseLeftButtonDown Occurs when a UIElement is tapped. (Inherited from UIElement.)
MouseLeftButtonUp Occurs when the finger is lifted off of a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseMove Occurs when the coordinate position of the finger on the screen while touching a UIElement (or while a UIElement holds touch capture). (Inherited from UIElement.)
MouseWheel Infrastructure. Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Tap Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
TextInput Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
TextInputStart Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
TextInputUpdate Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Unchecked Occurs when a ToggleButton is unchecked.
Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)

Top

Fields

Name Description
IsCheckedProperty Identifies the IsChecked dependency property.
IsThreeStateProperty Identifies the IsThreeState dependency property.

Top

Remarks

The IsChecked property specifies the state of the ToggleButton. The IsThreeState property specifies whether the ToggleButton has two or three states. If the ToggleButton is configured to have three states, it allows the user to choose a third, indeterminate state. For example, you could use a three-state toggle button to indicate Yes, No, or Not Applicable.

Content Model: ToggleButton is a ContentControl. Its content property is Content.

Examples

The following example shows how to create a three-state ToggleButton control.

    Private Sub ThreeStateToggle_Click(sender As Object, e As RoutedEventArgs)
        ThreeStateTextBlock.Text = "IsChecked: " + ThreeStateToggle.IsChecked.ToString()
    End Sub

    Private Sub TwoStateToggle_Click(sender As Object, e As RoutedEventArgs)
        TwoStateTextBlock.Text = "IsChecked: " + TwoStateToggle.IsChecked.ToString()
    End Sub
private void ThreeStateToggle_Click(object sender, RoutedEventArgs e)
{
    ThreeStateTextBlock.Text = "IsChecked: " + ThreeStateToggle.IsChecked.ToString();
}

private void TwoStateToggle_Click(object sender, RoutedEventArgs e)
{
    TwoStateTextBlock.Text = "IsChecked: " + TwoStateToggle.IsChecked.ToString();
}
<StackPanel x:Name="LayoutRoot" Background="Transparent" Margin="10">

    <ToggleButton Margin="5" Content="Three State" Name="ThreeStateToggle" Click="ThreeStateToggle_Click" IsThreeState="True"/>
    <TextBlock Name="ThreeStateTextBlock">IsChecked: </TextBlock>

    <ToggleButton Margin="5" Content="Two State" Name="TwoStateToggle" Click="TwoStateToggle_Click" IsThreeState="False" />
    <TextBlock Name="TwoStateTextBlock" >IsChecked: </TextBlock>
</StackPanel>

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Windows.Controls.Primitives Namespace

CheckBox

RadioButton