BarCheckItem.Checked Property

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

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

C#

[Bindable(false)]
[DefaultValue(false)]
public virtual bool Checked { get; set; }

VB.NET

<DefaultValue(False)>
<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-export-cell-range-to-a-datatable/CS/ExportToDataTableExample/Form1.cs#L23

{
    if (barCheckItemStopEmptyRow.Checked) {
        ExportSelectionStopOnEmptyRow();

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/Heatmap/HeatmapItemExtensionModule.cs#L108

if(SelectedCustomItem != null) {
    barShowLabelsItem.Checked = SelectedCustomItem.Metadata.ShowLabels;
    barShowLegendItem.Checked = SelectedCustomItem.Metadata.ShowLegend;

winforms-rich-edit-implement-ms-office-word-format-painter/CS/DXApplication9/Form1.cs#L49

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

XAF_how-to-create-a-custom-action-type-with-a-custom-control-barcheckitem-associated-with-it-e1977/CS/CustomActionControl.Module.Win/ActionControls/BarCheckItemCheckableSimpleActionControl.cs#L22

public bool Checked {
    get { return BarItem.Checked; }
    set { BarItem.Checked = value; }

winforms-spreadsheet-load-and-save-a-password-encrypted-files/CS/EncryptionExample/Form1.cs#L77

private void barCheckSubscribeEvent_CheckedChanged(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    if (barCheckSubscribeEvent.Checked)
        spreadsheetControl1.EncryptedFilePasswordRequest += SpreadsheetControl1_EncryptedFilePasswordRequest;

VB.NET

how-to-export-cell-range-to-a-datatable/VB/ExportToDataTableExample/Form1.vb#L23

Private Sub barButtonItemRangeToDataTable_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs)
    If barCheckItemStopEmptyRow.Checked Then
        ExportSelectionStopOnEmptyRow()

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/Heatmap/HeatmapItemExtensionModule.vb#L123

If SelectedCustomItem IsNot Nothing Then
    barShowLabelsItem.Checked = SelectedCustomItem.Metadata.ShowLabels
    barShowLegendItem.Checked = SelectedCustomItem.Metadata.ShowLegend

winforms-rich-edit-implement-ms-office-word-format-painter/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()

XAF_how-to-create-a-custom-action-type-with-a-custom-control-barcheckitem-associated-with-it-e1977/VB/CustomActionControl.Module.Win/ActionControls/BarCheckItemCheckableSimpleActionControl.vb#L28

Get
    Return BarItem.Checked
End Get

winforms-spreadsheet-load-and-save-a-password-encrypted-files/VB/EncryptionExample/Form1.vb#L78

Private Sub barCheckSubscribeEvent_CheckedChanged(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs)
    If barCheckSubscribeEvent.Checked Then
        AddHandler spreadsheetControl1.EncryptedFilePasswordRequest, AddressOf SpreadsheetControl1_EncryptedFilePasswordRequest