VGridControlBase.ActiveEditor Property

Gets a control’s active editor.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v19.1.dll

Declaration

C#

[Browsable(false)]
public BaseEdit ActiveEditor { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property ActiveEditor As BaseEdit

Property Value

Type	Description
BaseEdit	A BaseEdit object that represents the currently active editor. null (Nothing in Visual Basic) if no cell is being edited at the moment.

Remarks

Cell values are edited by editors inherited from the BaseEdit class. Once an end-user starts to edit a cell value, the cell’s editor is created. When editing finishes, the cell editor is destroyed. Thus, there can be only one active editor instance at any time.

The ActiveEditor property can be used to change editor settings dynamically with respect to the cell they are bound to. This property is also useful if you need to perform specific actions (such as open the editor’s dropdown window, etc.) when end-users activate particular editors or when they perform specific actions during editing. Note that you will need to handle the VGridControlBase.ShownEditor event to respond to editor activation.

Note

The ActiveEditor property returns a BaseEdit object. This object is the base for all editors that can be used as in-place in a vertical grid. Thus, you may need to typecast to use editor-specific properties.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ActiveEditor 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-use-the-vertical-grid-for-in-place-editing-and-in-view-mode-e2330/CS/WindowsApplication3/Custom Edit.cs#L161

public override bool DoValidate() {
    if(grid.ActiveEditor != null && grid.ActiveEditor.IsModified)
        grid.PostEditor();

how-to-implement-newitemrow-in-vgridcontrol-e4230/CS/VGridControl/CustomVGridControl/VGridControlDescendant.cs#L71

this.ShowEditor();
if (this.ActiveEditor is TextEdit)
    (this.ActiveEditor as TextEdit).DeselectAll();

VB.NET

how-to-use-the-vertical-grid-for-in-place-editing-and-in-view-mode-e2330/VB/WindowsApplication3/Custom Edit.vb#L167

Public Overrides Function DoValidate() As Boolean
    If grid.ActiveEditor IsNot Nothing AndAlso grid.ActiveEditor.IsModified Then
        grid.PostEditor()

how-to-implement-newitemrow-in-vgridcontrol-e4230/VB/VGridControl/CustomVGridControl/VGridControlDescendant.vb#L64

Me.ShowEditor()
If TypeOf Me.ActiveEditor Is TextEdit Then
    TryCast(Me.ActiveEditor, TextEdit).DeselectAll()