BarCheckItem.Checked Property

Gets or sets a value indicating whether the item is in the pushed state.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

[DefaultValue(false)]
[SmartTagProperty("Checked", "Behavior", 2)]
[Bindable(false)]
public virtual bool Checked { get; set; }

VB.NET

<DefaultValue(False)>
<SmartTagProperty("Checked", "Behavior", 2)>
<Bindable(False)>
Public Overridable Property Checked As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true, if the item is currently in the pushed state; otherwise, false.

Remarks

Use the Checked property to specify the check state of a bar item (checked or unchecked). When this property’s value is true, the check item appears sunken.

Values of the Checked and BarCheckItem.Down properties are synchronized. Changing either property raises the BarCheckItem.CheckedChanged event.

Important

To bind the item’s checked state to a specific source via the BarItem.DataBindings collection, use the BarCheckItem.BindableChecked property rather than the Checked property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Checked 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.

C#

how-to-implement-the-basic-idea-of-the-microsoft-excel-format-painter-feature-for-spreadsh-t590741/CS/WindowsFormsApplication1/FormatPainterProvider.cs#L35

    if (sourceCell != null && e.SheetName == sourceCell.Worksheet.Name)
        biFormatPainter.Checked = false;
}

how-to-share-a-single-barmanager-between-different-usercontrols-e1927/CS/B143239/MainForm.cs#L32

    explorerPanel.Visibility =
        (((BarCheckItem)e.Item).Checked) ? DockVisibility.Visible :DockVisibility.Hidden;
}

how-to-create-a-component-which-automatically-create-a-menu-for-all-registered-skins-e2058/CS/WindowsApplication1/MySkinsBarMenuHelper.cs#L175

    if(aItem != null)
        aItem.Checked = AvailableStyle(LookAndFeelStyle.Skin) && LookAndFeel.LookAndFeel.SkinName == item.Caption;
}

grid-views-and-grid-controls-view-repository-e3828/CS/DXWindowsApplication5/Form1.cs#L87

if (checkShowFooter.Enabled)
    checkShowFooter.Checked = (gridControl1.MainView as GridView).OptionsView.ShowFooter;
else

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/CS/DXApplication9/Form1.cs#L49

{
    if(barCheckItem1.Checked) {
        ApplyFormatToSelectedText();

VB.NET

how-to-implement-the-basic-idea-of-the-microsoft-excel-format-painter-feature-for-spreadsh-t590741/VB/WindowsFormsApplication1/FormatPainterProvider.vb#L36

If sourceCell IsNot Nothing AndAlso e.SheetName = sourceCell.Worksheet.Name Then
    biFormatPainter.Checked = False
End If

how-to-share-a-single-barmanager-between-different-usercontrols-e1927/VB/B143239/MainForm.vb#L33

Private Sub OnBarCheckItemExplorerItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs) Handles checkItemExplorer.ItemClick
    If CType(e.Item, BarCheckItem).Checked Then
        explorerPanel.Visibility = DockVisibility.Visible

how-to-create-a-component-which-automatically-create-a-menu-for-all-registered-skins-e2058/VB/WindowsApplication1/MySkinsBarMenuHelper.vb#L189

If aItem IsNot Nothing Then
    aItem.Checked = AvailableStyle(LookAndFeelStyle.Skin) AndAlso LookAndFeel.LookAndFeel.SkinName = item.Caption
End If

grid-views-and-grid-controls-view-repository-e3828/VB/DXWindowsApplication5/Form1.vb#L81

If checkShowFooter.Enabled Then
    checkShowFooter.Checked = (TryCast(gridControl1.MainView, GridView)).OptionsView.ShowFooter
Else

how-to-implement-the-basic-idea-of-the-ms-office-word-format-painter-for-richeditcontrol-e5223/VB/DXApplication9/Form1.vb#L47

Private Sub richEditControl_MouseUp(ByVal sender As Object, ByVal e As MouseEventArgs) Handles richEditControl.MouseUp
    If barCheckItem1.Checked Then
        ApplyFormatToSelectedText()