BarCheckItem.IsChecked Property

Gets or sets whether the item is in the pushed state. This is a dependency property.

Namespace: DevExpress.Xpf.Bars

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

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public bool? IsChecked { get; set; }

VB.NET

Public Property IsChecked As Boolean?

Property Value

Type	Description
Nullable<Boolean>	true if the item is in the pushed state; otherwise, false.

Remarks

Use the IsChecked property to specify the item’s check state. By default, a bar check item has two states - Checked and Unchecked. If the BarCheckItem.IsThreeState option is enabled, the item supports three states: Checked, Unchecked and Indeterminate.

Changing the IsChecked property fires the BarCheckItem.CheckedChanged event.

Related GitHub Examples

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

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

mvvm-application-with-wpf-bars/CS/Bars_in_MVVM_Application/MainWindow.xaml#L44

<dxb:BarCheckItem x:Name="completed" Content="Completed"
                  IsChecked="{Binding SelectedIssue.Completed}"
                  IsEnabled="{DXBinding 'SelectedIssue != null'}"

wpf-docklayoutmanager-merge-ribbon-controls/CS/WpfApplication1/MainWindow.xaml#L32

<dxr:RibbonStatusBarControl.RightItems>
    <dxb:BarCheckItem x:Name="biLeft" Glyph="{dx:DXImage Image=AlignLeft_16x16.png}" GroupIndex="1" IsChecked="True" MergeType="MergeItems"/>
    <dxb:BarCheckItem x:Name="biCenter" Glyph="{dx:DXImage Image=AlignCenter_16x16.png}" GroupIndex="1" MergeType="MergeItems"/>

wpf-pivot-grid-create-context-menu-for-field-values/CS/WpfPivotGrid_CustomMenu/MainWindow.xaml#L20

<dxb:BarCheckItem Name="ShowColumnGrandTotals"
              IsChecked="{Binding ElementName=pivotGrid, Path=ShowColumnGrandTotals, Mode=TwoWay}"
              Content="Show Column Grand Totals" />

C#

wpf-pivot-grid-show-top-n-values-in-context-menu/CS/ContextMenuToShowTopN_Example/MainWindow.xaml.cs#L57

if (IsTopFiveValuesApplied(valueItem))
    item.IsChecked = true;
item.CheckedChanged += Item_CheckedChanged;

wpf-pivot-grid-change-summary-display-type/CS/HeaderMenuCustomizationExample/HeaderMenuHelper.cs#L81

checkItem.Content = enumValue.ToString();
checkItem.IsChecked = Object.Equals(field.Tag, enumValue)||
    enumValue.Equals(FieldSummaryDisplayType.Default) && field.Tag == null;

VB.NET

wpf-pivot-grid-show-top-n-values-in-context-menu/VB/ContextMenuToShowTopN_Example/MainWindow.xaml.vb#L54

If IsTopFiveValuesApplied(valueItem) Then
    item.IsChecked = True
End If

wpf-pivot-grid-change-summary-display-type/VB/HeaderMenuCustomizationExample/HeaderMenuHelper.vb#L80

checkItem.Content = enumValue.ToString()
checkItem.IsChecked = Object.Equals(field.Tag, enumValue) OrElse enumValue.Equals(FieldSummaryDisplayType.Default) AndAlso field.Tag Is Nothing
checkItem.Tag = New Object() {field, [property], enumValue}