BarItem.Enabled Property

Determines whether the current BarItem is active.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

C#

[DefaultValue(true)]
[DXCategory("Behavior")]
public virtual bool Enabled { get; set; }

VB.NET

<DefaultValue(True)>
<DXCategory("Behavior")>
Public Overridable Property Enabled As Boolean

Property Value

Type	Default	Description
Boolean	true	true if the current BarItem is enabled; otherwise, false.

Remarks

If a specific BarItem is enabled, then its icon and caption appear in full color: and the item can be clicked to perform specific actions. If it is disabled, then its icon and caption appear shaded: and it cannot be clicked.

Related GitHub Examples

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

winforms-overlay-form-display-custom-button/CS/Form1.cs#L40

async void OnRunTaskItemClick(object sender, ItemClickEventArgs e) {
    biRunTask.Enabled = false;
    string taskResult;

winforms-spreadsheet-use-custom-cell-editors/CS/DevAVInvoicing/Form1.cs#L118

    DefinedName invoiceItems = sheet.DefinedNames.GetDefinedName("InvoiceItems");
    btnRemoveRecord.Enabled = invoiceItems != null && invoiceItems.Range.RowCount > 1 && invoiceItems.Range.IsIntersecting(sheet.SelectedCell);
}

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L311

    BarButtonItem barButton = richEdit.Tag as BarButtonItem;
    barButton.Enabled = !richEdit.IsSelectionInTable();
}

winforms-scheduler-sync-with-google-calendars/CS/GCSync/Form1.cs#L122

void UpdateBbiAvailability() {
    this.bbiSynchronize.Enabled = !String.IsNullOrEmpty(this.activeCalendarId) && this.allowEventLoad;
}

winforms-spreadsheet-spell-check-cell-text/CS/SpreadsheetSpellchecking/Form1.cs#L51

BarButtonItem item = new BarButtonItem(BarManager, command.Caption);
item.Enabled = command.Enabled;
item.Tag = command;

VB.NET

winforms-overlay-form-display-custom-button/VB/Form1.vb#L43

Private Async Sub OnRunTaskItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    biRunTask.Enabled = False
    Dim taskResult As String

winforms-spreadsheet-use-custom-cell-editors/VB/DevAVInvoicing/Form1.vb#L109

    Dim invoiceItems As DefinedName = sheet.DefinedNames.GetDefinedName("InvoiceItems")
    btnRemoveRecord.Enabled = invoiceItems IsNot Nothing AndAlso invoiceItems.Range.RowCount > 1 AndAlso invoiceItems.Range.IsIntersecting(sheet.SelectedCell)
Else

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L318

    Dim barButton As BarButtonItem = TryCast(richEdit.Tag, BarButtonItem)
    barButton.Enabled = Not richEdit.IsSelectionInTable()
End Sub

winforms-scheduler-sync-with-google-calendars/VB/GCSync/Form1.vb#L116

Private Sub UpdateBbiAvailability()
    bbiSynchronize.Enabled = Not String.IsNullOrEmpty(activeCalendarId) AndAlso allowEventLoad
End Sub

winforms-spreadsheet-spell-check-cell-text/VB/SpreadsheetSpellchecking/Form1.vb#L56

Dim item As BarButtonItem = New BarButtonItem(BarManager, command.Caption)
item.Enabled = command.Enabled
item.Tag = command