ColumnView.EditingValue Property

Gets or sets the currently edited value.

Namespace : DevExpress.XtraGrid.Views.Base

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

[Browsable(false)]
public virtual object EditingValue { get; set; }

<Browsable(False)>
Public Overridable Property EditingValue As Object

Property Value

Type	Description
Object

An object representing the currently edited cell value. null ( Nothing in Visual Basic) if no cell is presently being edited.

Remarks

You can use the BaseView.IsEditing property to determine whether the end-user is presently editing a cell. If the property returns true , you can use the EditingValue property to access or change the edit value. Otherwise, the property returns a null reference and assigning values has no effect.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the EditingValue member must not be invoked for these Views. The EditingValue member can only be used with Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

GridControl.MainView - returns the top most View in a grid;
GridControl.FocusedView - returns the focused View;
GridControl.DefaultView - returns the currently maximized View;
the sender parameter of View specific events;
GridView.GetDetailView - returns a detail clone View for a specific master row.

Example

The following sample code handles the ColumnView.ShownEditor event to set the edited cell’s value to an empty string if the edited cell belongs to the Department column and contains any text.

C#
VB.NET

csharp

private void gridView1_ShownEditor(object sender, System.EventArgs e) {
   if (gridView1.FocusedColumn.Name != "Department") return;
   gridView1.EditingValue = "";
}

Private Sub GridView1_ShownEditor(ByVal sender As System.Object, _
  ByVal e As System.EventArgs) Handles GridView1.ShownEditor
   If Not GridView1.FocusedColumn.Name Is "Department" Then Exit Sub
   GridView1.EditingValue = ""
End Sub