SpreadsheetControl.IsCellEditorActive Property

Gets whether the cell editor is currently active.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Win.Spreadsheet

Declaration

C#

[Browsable(false)]
public bool IsCellEditorActive { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property IsCellEditorActive As Boolean

Property Value

Type	Description
Boolean	true if the cell editor is opened; otherwise, false.

Remarks

Before the cell editor is opened, the SpreadsheetControl.CellBeginEdit event is raised. You can handle this event to obtain the location of the opened cell editor or to prevent the cell editor from being opened. To close the cell editor, use the SpreadsheetControl.CloseCellEditor method. The SpreadsheetControl.CellEndEdit or SpreadsheetControl.CellCancelEdit event occurs before the cell editor is closed, depending on whether an entered cell value is committed or rolled back.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IsCellEditorActive 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-spreadsheet-use-custom-cell-editors/CS/DevAVInvoicing/Form1.cs#L159

if (sheet.Name == "Invoice") {
    if (spreadsheetControl1.IsCellEditorActive)
        spreadsheetControl1.CloseCellEditor(CellEditorEnterValueMode.Cancel);

winforms-spreadsheet-control-create-a-data-entry-form/CS/DataEntryFormSample/SpreadsheetBindingManager.cs#L268

{
    if (control != null && control.IsCellEditorActive)
        control.CloseCellEditor(mode);

winforms-spreadsheet-bind-to-ms-sql-server-database/CS/SuppliersExample/Form1.cs#L148

void CloseInplaceEditor() {
    if (spreadsheetControl1.IsCellEditorActive)
        spreadsheetControl1.CloseCellEditor(DevExpress.XtraSpreadsheet.CellEditorEnterValueMode.Default);

VB.NET

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

If Equals(sheet.Name, "Invoice") Then
    If spreadsheetControl1.IsCellEditorActive Then spreadsheetControl1.CloseCellEditor(CellEditorEnterValueMode.Cancel)
    sheet.Rows.Remove(sheet.SelectedCell.TopRowIndex, 1)

winforms-spreadsheet-control-create-a-data-entry-form/VB/DataEntryFormSample/SpreadsheetBindingManager.vb#L239

Private Sub DeactivateCellEditor(Optional ByVal mode As CellEditorEnterValueMode = CellEditorEnterValueMode.Cancel)
    If _control IsNot Nothing AndAlso _control.IsCellEditorActive Then
        _control.CloseCellEditor(mode)

winforms-spreadsheet-bind-to-ms-sql-server-database/VB/SuppliersExample/Form1.vb#L143

Private Sub CloseInplaceEditor()
    If spreadsheetControl1.IsCellEditorActive Then spreadsheetControl1.CloseCellEditor(DevExpress.XtraSpreadsheet.CellEditorEnterValueMode.Default)
End Sub