System.Windows.Controls Nam ...


.NET Framework Class Library
CheckBox Class

Updated: February 2009

Represents a control that a user can select and clear.

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
Syntax

Visual Basic (Declaration)
<LocalizabilityAttribute(LocalizationCategory.CheckBox)> _
Public Class CheckBox _
    Inherits ToggleButton
Visual Basic (Usage)
Dim instance As CheckBox
C#
[LocalizabilityAttribute(LocalizationCategory.CheckBox)]
public class CheckBox : ToggleButton
Visual C++
[LocalizabilityAttribute(LocalizationCategory::CheckBox)]
public ref class CheckBox : public ToggleButton
JScript
public class CheckBox extends ToggleButton
XAML Object Element Usage
<CheckBox>
  Content
</CheckBox>
Remarks

CheckBox controls inherit from ToggleButton and can have three states: checked (selected), unchecked (cleared), and indeterminate.

Content Model: CheckBox is a ContentControl. Its content property is Content. For more information on the content model for CheckBox, see Controls Content Model Overview.

Dependency properties for this control might be set by the control’s default style. If a property is set by a default style, the property might change from its default value when the control appears in the application. The default style is determined by which desktop theme is used when the application is running. For more information, see Themes.

Examples

The following example creates a CheckBox and handles the Checked, Unchecked, and Indeterminate events.

XAML
<Grid>
  <Grid.RowDefinitions>
    <RowDefinition Height="Auto"/>
    <RowDefinition Height="Auto"/>
    <RowDefinition Height="Auto"/>
  </Grid.RowDefinitions>

  <TextBlock Text="CheckBox Demonstration" Margin="0,20,10,20"
             FontFamily="Verdana" FontSize="18" FontWeight="Bold"
             Foreground="#FF5C9AC9" Grid.Row="0"/>

  <CheckBox x:Name="cb1" Grid.Row="1" Margin="5,0,0,0" 
            Content="Three-state CheckBox" IsThreeState="True"
            Checked="HandleCheck" Unchecked="HandleUnchecked" 
            Indeterminate="HandleThirdState" />
  <TextBlock x:Name="text1" Grid.Row="2" Margin="5,0,0,0" />
</Grid>
Visual Basic
Private Sub HandleCheck(ByVal sender As Object, ByVal e As RoutedEventArgs)
    text1.Text = "The CheckBox is checked."
End Sub

Private Sub HandleUnchecked(ByVal sender As Object, ByVal e As RoutedEventArgs)
    text1.Text = "The CheckBox is unchecked."
End Sub

Private Sub HandleThirdState(ByVal sender As Object, ByVal e As RoutedEventArgs)
    text1.Text = "The CheckBox is in the indeterminate state."
End Sub
C#
private void HandleCheck(object sender, RoutedEventArgs e)
{
    text1.Text = "The CheckBox is checked.";
}

private void HandleUnchecked(object sender, RoutedEventArgs e)
{
    text1.Text = "The CheckBox is unchecked.";
}

private void HandleThirdState(object sender, RoutedEventArgs e)
{
    text1.Text = "The CheckBox is in the indeterminate state.";
}
Inheritance Hierarchy

System..::.Object
  System.Windows.Threading..::.DispatcherObject
    System.Windows..::.DependencyObject
      System.Windows.Media..::.Visual
        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
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.
Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0
See Also

Reference

Other Resources

Change History

Date

History

Reason

February 2009

Described how default styles change dependency properties.

Customer feedback.

October 2008

Added new example.

Customer feedback.

Tags :


Page view tracker