CheckEdit Class
A check box editor.
Namespace: DevExpress.Xpf.Editors
Assembly: DevExpress.Xpf.Core.v24.1.dll
NuGet Package: DevExpress.Wpf.Core
#Declaration
public class CheckEdit :
BaseEdit,
IBooleanExportSettings,
IExportSettings,
ICommandSource
#Remarks
The CheckEdit class is a check editor that allows end users to edit Boolean values.
Tip
The Check
For information on derived features and API, refer to the following class description: Base
#Create a CheckEdit
<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.
<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.
<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.
<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.
<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 | Check |
Background when the editor is checked | Checked |
Border |
Checked |
Border |
Focused |
#Standard Appearance Customization Properties
Property | Description |
---|---|
Border |
Gets or sets a brush that describes the border background of a control. |
Border |
Gets or sets the border thickness of a control. |
Corner |
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.