DataGridView Properties


.NET Framework Class Library
DataGridView.EditingControl Property

Note: This property is new in the .NET Framework version 2.0.

Gets the control hosted by the current cell, if a cell with an editing control is in edit mode.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

Syntax

Visual Basic (Declaration)
Public ReadOnly Property EditingControl As Control
Visual Basic (Usage)
Dim instance As DataGridView
Dim value As Control

value = instance.EditingControl
C#
public Control EditingControl { get; }
C++
public:
property Control^ EditingControl {
    Control^ get ();
}
J#
/** @property */
public Control get_EditingControl ()
JScript
public function get EditingControl () : Control

Property Value

The Control hosted by the current cell.
Remarks

If the cell is not in edit mode or the cell type does not accommodate an editing control, this property returns a null reference (Nothing in Visual Basic).

Example

The following code example illustrates how to use this property in an overridden method of a custom cell type. In the example, a reference to the editing control is retrieved, cast to a custom editing control type, and then populated with the current value of the cell.

This example is part of a larger example available in How to: Host Controls in Windows Forms DataGridView Cells.

Visual Basic
Public Overrides Sub InitializeEditingControl(ByVal rowIndex As Integer, _
    ByVal initialFormattedValue As Object, _
    ByVal dataGridViewCellStyle As DataGridViewCellStyle)

    ' Set the value of the editing control to the current cell value.
    MyBase.InitializeEditingControl(rowIndex, initialFormattedValue, _
        dataGridViewCellStyle)

    Dim ctl As CalendarEditingControl = _
        CType(DataGridView.EditingControl, CalendarEditingControl)
    ctl.Value = CType(Me.Value, DateTime)

End Sub
C#
public override void InitializeEditingControl(int rowIndex, object 
    initialFormattedValue, DataGridViewCellStyle dataGridViewCellStyle)
{
    // Set the value of the editing control to the current cell value.
    base.InitializeEditingControl(rowIndex, initialFormattedValue, 
        dataGridViewCellStyle);
    CalendarEditingControl ctl = 
        DataGridView.EditingControl as CalendarEditingControl;
    ctl.Value = (DateTime)this.Value;
}
Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0
See Also

Tags :


Page view tracker