ToggleButton.IsChecked Property

 

Gets or sets whether the ToggleButton is checked.

Namespace:   System.Windows.Controls.Primitives
Assembly:  PresentationFramework (in PresentationFramework.dll)

[TypeConverterAttribute(typeof(NullableBoolConverter))]
[LocalizabilityAttribute(LocalizationCategory.None, Readability = Readability.Unreadable)]
public Nullable<bool> IsChecked { get; set; }

Property Value

Type: System.Nullable<Boolean>

true if the ToggleButton is checked; false if the ToggleButton is unchecked; otherwise null. The default is false.

A control that inherits from ToggleButton determines its behavior when this property is null.

When the IsThreeState property is set to true, a user can click a CheckBox to pick three possible states. The following table describes the three states of a CheckBox.

State of the CheckBox

Value of IsChecked

Checked

true

Unchecked

false

Indeterminate

null

If IsThreeState is false, you can still programmatically set this property to null to put the CheckBox in an indeterminate state, but the user cannot set the CheckBox to the indeterminate state through the user interface (UI).

If you set this property to null on a RadioButton, the RadioButton is unchecked.

<object IsChecked="Boolean"/>

- or -

<object IsChecked="{x:Null Markup Extension}"/>

Identifier field

IsCheckedProperty

Metadata properties set to true

BindsTwoWayByDefault

The following example creates a CheckBox set to an indeterminate state.

<CheckBox Name="checkBox1" IsThreeState="True" 
          IsChecked="{x:Null}">
  A CheckBox in an indeterminate state
</CheckBox>

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: