SpreadsheetControl.CellEditorOpened Event

Occurs after a cell editor was activated by a user.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Win.Spreadsheet

Declaration

C#

public event CellEditorOpenedEventHandler CellEditorOpened

VB.NET

Public Event CellEditorOpened As CellEditorOpenedEventHandler

Event Data

The CellEditorOpened event's data class is CellEditorOpenedEventArgs. The following properties provide information specific to this event:

Property	Description
CustomEditorType	Returns the type of the custom cell editor.
Editor	Returns the active cell editor.
IsCustom	Indicates whether the active cell editor is custom.

Remarks

The CellEditorOpened event fires after a user activates a cell editor to edit a cell value. This event allows you to do the following:

• Access the active cell editor (Editor) and determine its type (IsCustom, CustomEditorType).
• Handle the editor’s keyboard events to execute custom actions or implement custom shortcuts.

• Spell check text in the editor. Refer to the following example for implementation details:

  View Example: WinForms Spreadsheet - Spell Check Text in a Cell Editor

• Handle the editor’s TextChanged event to track text changes and validate user input, as shown in the example below.

Example. Use the CellEditorOpened Event to Validate User Input

The code sample below demonstrates how to use a regular expression to check that a user enters a US phone number in the correct format. If a user types an invalid number, the editor’s background color changes to Salmon. If a number in the correct format is entered, the editor’s background color resets to the original color and the phone number is converted to the following format: [phone].

C#

using System;
using System.Drawing;
using System.Text.RegularExpressions;

namespace SpreadsheetApp
{
    public partial class Form1 : DevExpress.XtraBars.Ribbon.RibbonForm
    {
        // Specify the regular expression to check a phone number.
        Regex phoneNumber = new Regex(@"^\(?([0-9]{3})\)?[-. ]?([0-9]{3})[-. ]?([0-9]{4})$");
        Color editorBackColor = Color.Transparent;

        public Form1()
        {
            InitializeComponent();
            spreadsheetControl1.CellEditorOpened += spreadsheetControl1_CellEditorOpened;
            spreadsheetControl1.LoadDocument(@"Documents\Employees.xlsx");
        }

        private void spreadsheetControl1_CellEditorOpened(object sender,
            DevExpress.XtraSpreadsheet.CellEditorOpenedEventArgs e)
        {
            // If a user activates an editor for a cell in the "Phone Number" column,
            // the editor's TextChanged event fires.
            if (spreadsheetControl1.ActiveCell.ColumnIndex == 5 &&
                spreadsheetControl1.ActiveCell.RowIndex > 3)
            {
                var editor = e.Editor;
                this.editorBackColor = editor.BackColor;
                editor.TextChanged += Editor_TextChanged;
            }
        }

        private void Editor_TextChanged(object sender, EventArgs e)
        {
            // Access the active cell editor. This example assumes
            // that the target cell contains the default editor
            // (a Windows text box control).
            var textEditor = sender as System.Windows.Forms.TextBox;
            if (textEditor == null)
                return;
            // If the entered number matches the specified regular expression,
            // convert this number to the standard phone number format.
            if (phoneNumber.IsMatch(textEditor.Text))
            {
                textEditor.Text = phoneNumber.Replace(textEditor.Text, "($1) $2-$3");
                textEditor.BackColor = editorBackColor;
            }
            else
                // Otherwise, change the editor's background to the Salmon color
                // to indicate that the user input is invalid.
                textEditor.BackColor = Color.Salmon;
        }
    }
}

VB.NET

Imports System
Imports System.Drawing
Imports System.Text.RegularExpressions
Imports System.Windows.Forms

Namespace SpreadsheetApp
    Public Class Form1
        Inherits DevExpress.XtraBars.Ribbon.RibbonForm

        ' Specify the regular expression to check a phone number.
        Private phoneNumber As New Regex("^\(?([0-9]{3})\)?[-. ]?([0-9]{3})[-. ]?([0-9]{4})$")
        Private editorBackColor As Color = Color.Transparent

        Public Sub New()
            InitializeComponent()
            AddHandler spreadsheetControl1.CellEditorOpened, AddressOf spreadsheetControl1_CellEditorOpened
            spreadsheetControl1.LoadDocument("Documents\Employees.xlsx")
        End Sub

        Private Sub spreadsheetControl1_CellEditorOpened(ByVal sender As Object,
            ByVal e As DevExpress.XtraSpreadsheet.CellEditorOpenedEventArgs)
            ' If a user activates an editor for a cell in the "Phone Number" column,
            ' the editor's TextChanged event fires.
            If spreadsheetControl1.ActiveCell.ColumnIndex = 5 AndAlso
                spreadsheetControl1.ActiveCell.RowIndex > 3 Then
                Dim editor As Control = e.Editor
                Me.editorBackColor = editor.BackColor
                AddHandler editor.TextChanged, AddressOf Editor_TextChanged
            End If
        End Sub

        Private Sub Editor_TextChanged(ByVal sender As Object, ByVal e As EventArgs)
            ' Access the active cell editor. This example assumes
            ' that the target cell contains the default editor
            ' (a Windows text box control).
            Dim textEditor As TextBox = TryCast(sender, TextBox)
            If textEditor Is Nothing Then
                Return
            End If
            ' If the entered number matches the specified regular expression,
            ' convert this number to the standard phone number format.
            If phoneNumber.IsMatch(textEditor.Text) Then
                textEditor.Text = phoneNumber.Replace(textEditor.Text, "($1) $2-$3")
                textEditor.BackColor = editorBackColor
            Else
                ' Otherwise, change the editor's background to the Salmon color
                ' to indicate that the user input is invalid.
                textEditor.BackColor = Color.Salmon
            End If
        End Sub
    End Class
End Namespace

Related Events

SpreadsheetControl.CellBeginEdit

Occurs before a cell editor is opened.

SpreadsheetControl.CellEndEdit

Occurs before a cell editor is closed and the entered value is committed.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CellEditorOpened event.

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-spell-check-cell-text/CS/SpreadsheetSpellchecking/Form1.cs#L24

    spreadsheetControl.CellEditorOpened += OnSpreadsheetControl_CellEditorOpened;
}

VB.NET

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

    AddHandler Me.BarManager.QueryShowPopupMenu, AddressOf OnBarManager_QueryShowPopupMenu
    AddHandler Me.spreadsheetControl.CellEditorOpened, AddressOf OnSpreadsheetControl_CellEditorOpened
End Sub