CheckEdit Class

A check box editor.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v24.1.dll

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public class CheckEdit :
    BaseEdit,
    IBooleanExportSettings,
    IExportSettings,
    ICommandSource

VB.NET

Public Class CheckEdit
    Inherits BaseEdit
    Implements IBooleanExportSettings,
               IExportSettings,
               ICommandSource

Remarks

The CheckEdit class is a check editor that allows end users to edit Boolean values.

Tip

The CheckEdit class inherits its features from the BaseEdit class.

For information on derived features and API, refer to the following class description: BaseEdit.

Create a CheckEdit

XAML

<Window ...
    xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">

<!-- Specify a value using the CheckEdit.IsChecked property -->
<dxe:CheckEdit IsChecked="True" />

<!-- Specify a value using the BaseEdit.EditValue property -->
<dxe:CheckEdit EditValue="False" />

Editor Value

Use the CheckEdit.IsChecked property to specify the editor’s state. To set the editor to the indeterminate state (if supported), set the CheckEdit.IsChecked property to null.

After the CheckEdit.IsChecked property’s value has been changed, the check editor fires the corresponding event (CheckEdit.Checked, CheckEdit.Unchecked or CheckEdit.Indeterminate).

Optional Indeterminate State

Set the CheckEdit.IsThreeState property to true to use the null value of the CheckEdit control. This value adds the Indeterminate state to the editor.

Xaml

<dxe:CheckEdit Content="Checked" IsThreeState="True" IsChecked="True"/>
<dxe:CheckEdit Content="Indeterminate" IsThreeState="True" IsChecked="{x:Null}"/>
<dxe:CheckEdit Content="Unchecked" IsThreeState="True" IsChecked="False"/>

Use the CheckEdit.ReverseCheckOrder property to set the order of CheckEdit states.

Xaml

 <dxe:CheckEdit IsThreeState="True" ReverseCheckOrder="True"/>

The image below illustrates the order of CheckEdit states when ReverseCheckOrder is set to true.

Appearance Customization

Custom Glyphs

To make the CheckEdit display custom glyphs instead of the standard glyphs, pass the ImageCheckEditStyleSettings object to the CheckEdit‘s StyleSettings property.

Use the CheckedGlyph, IndeterminateGlyph, and UncheckedGlyph properties to specify glyphs for all CheckEdit states.

XAML

<dxe:CheckEdit
  Content="CheckEdit"
  CheckedGlyph="TrafficLightGreen.png"
  UncheckedGlyph="TrafficLightRed.png"
  IndeterminateGlyph="TrafficLightYellow.png"
  IsThreeState="True">
  <dxe:CheckEdit.StyleSettings>
      <dxe:ImageCheckEditStyleSettings />
  </dxe:CheckEdit.StyleSettings>
</dxe:CheckEdit>

The CheckEdit control scales the specified glyphs to 16px. To customize the rendered image size, pass a custom data template to the GlyphTemplate property, as in the code sample below.

XAML

<dxe:CheckEdit
    Content="CheckEdit"
    CheckedGlyph="TrafficLightGreen.png"
    UncheckedGlyph="TrafficLightRed.png"
    IndeterminateGlyph="TrafficLightYellow.png"
    IsThreeState="True">
    <dxe:CheckEdit.GlyphTemplate>
        <DataTemplate>
            <Image Source="{Binding}" Height="32" Width="72"/>
        </DataTemplate>
    </dxe:CheckEdit.GlyphTemplate>
    <dxe:CheckEdit.StyleSettings>
        <dxe:ImageCheckEditStyleSettings />
    </dxe:CheckEdit.StyleSettings>
</dxe:CheckEdit>

Custom Content

To specify the editor’s content, use the CheckEdit.Content property.

Use the ContentTemplate and ContentTemplateSelector properties to customize the editor’s content appearance.

CheckBox Width/Height

Use the CheckBoxWidth and CheckBoxHeight properties to specify the glyph’s width and height.

CheckEdit Colors

Use the following properties to specify CheckEdit element colors:

Element	Property
Glyph	CheckEditGlyphBrush
Background when the editor is checked	CheckedStateBackground
BorderBrush when the editor is checked	CheckedStateBorderBrush
BorderBrush when the editor is focused	FocusedBorderBrush

Standard Appearance Customization Properties

Property	Description
BorderBrush	Gets or sets a brush that describes the border background of a control.
BorderThickness	Gets or sets the border thickness of a control.
CornerRadius	Gets or sets the editor’s corner radius. This is a dependency property.
Foreground	Gets or sets a brush that describes the foreground color.

Optimized for In-Place Editing

CheckEdit can be used as a standalone or in-place editor nested in a container control. The CheckEditSettings class implements the in-place editing functionality. Refer to the Assign Editors to Cells topic for more information.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CheckEdit class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-data-grid-change-cell-template-based-on-custom-logic/CS/Window1.xaml#L15

<DataTemplate x:Key="booleanEditor">
    <dxe:CheckEdit Name="PART_Editor" />
</DataTemplate>

how-to-custom-draw-chart-series-points-e4550/CS/CustomDrawChart/MainWindow.xaml#L13

<StackPanel Grid.Row="0" Grid.Column="0">
    <dxe:CheckEdit Name="chbCustomDraw" Content="Custom Draw" IsChecked="True"
                   Checked="chbCustomDraw_Checked" Unchecked="chbCustomDraw_Unchecked" />

wpf-reporting-create-a-document-sections-based-on-the-input-values/CS/MainWindow.xaml#L75

<Label Grid.Row="6" Margin="5">Print Page Info:</Label>
<dxe:CheckEdit Name="cePageInfo" Grid.Column="2" Grid.Row="6" Margin="5" HorizontalAlignment="Center" />

how-to-invoke-the-default-appointment-recurrence-dialog-from-a-custom-edit-appointment-form-e3796/CS/WpfApplication1/CustomAppointmentForm.xaml#L87

<!--All day event-->
<dxe:CheckEdit Name="chkAllDay" Margin="0,0,0,8"
           HorizontalAlignment="Left"

wpf-use-devexpress-theme-in-applications/CS/DevExpress.Examples.ThemeSwitcher/MainWindow.xaml#L43

<dxe:CheckEdit Content="DXCheckEdit" Margin="10,0" />

Inheritance

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

BaseEdit

CheckEdit