IDataGridViewEditingControl Interfaz
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Define una funcionalidad común para los controles que se hospedan en las celdas de un control DataGridView.
public interface class IDataGridViewEditingControlpublic interface IDataGridViewEditingControltype IDataGridViewEditingControl = interfacePublic Interface IDataGridViewEditingControl- Derivado
Ejemplos
En el ejemplo de código siguiente se proporciona una implementación de esta interfaz que deriva de DateTimePicker. Este ejemplo forma parte de un ejemplo más grande disponible en How to: Host Controls in Windows Forms DataGridView Cells.
class CalendarEditingControl : DateTimePicker, IDataGridViewEditingControl
{
DataGridView dataGridView;
private bool valueChanged = false;
int rowIndex;
public CalendarEditingControl()
{
this.Format = DateTimePickerFormat.Short;
}
// Implements the IDataGridViewEditingControl.EditingControlFormattedValue
// property.
public object EditingControlFormattedValue
{
get
{
return this.Value.ToShortDateString();
}
set
{
if (value is String)
{
try
{
// This will throw an exception of the string is
// null, empty, or not in the format of a date.
this.Value = DateTime.Parse((String)value);
}
catch
{
// In the case of an exception, just use the
// default value so we're not left with a null
// value.
this.Value = DateTime.Now;
}
}
}
}
// Implements the
// IDataGridViewEditingControl.GetEditingControlFormattedValue method.
public object GetEditingControlFormattedValue(
DataGridViewDataErrorContexts context)
{
return EditingControlFormattedValue;
}
// Implements the
// IDataGridViewEditingControl.ApplyCellStyleToEditingControl method.
public void ApplyCellStyleToEditingControl(
DataGridViewCellStyle dataGridViewCellStyle)
{
this.Font = dataGridViewCellStyle.Font;
this.CalendarForeColor = dataGridViewCellStyle.ForeColor;
this.CalendarMonthBackground = dataGridViewCellStyle.BackColor;
}
// Implements the IDataGridViewEditingControl.EditingControlRowIndex
// property.
public int EditingControlRowIndex
{
get
{
return rowIndex;
}
set
{
rowIndex = value;
}
}
// Implements the IDataGridViewEditingControl.EditingControlWantsInputKey
// method.
public bool EditingControlWantsInputKey(
Keys key, bool dataGridViewWantsInputKey)
{
// Let the DateTimePicker handle the keys listed.
switch (key & Keys.KeyCode)
{
case Keys.Left:
case Keys.Up:
case Keys.Down:
case Keys.Right:
case Keys.Home:
case Keys.End:
case Keys.PageDown:
case Keys.PageUp:
return true;
default:
return !dataGridViewWantsInputKey;
}
}
// Implements the IDataGridViewEditingControl.PrepareEditingControlForEdit
// method.
public void PrepareEditingControlForEdit(bool selectAll)
{
// No preparation needs to be done.
}
// Implements the IDataGridViewEditingControl
// .RepositionEditingControlOnValueChange property.
public bool RepositionEditingControlOnValueChange
{
get
{
return false;
}
}
// Implements the IDataGridViewEditingControl
// .EditingControlDataGridView property.
public DataGridView EditingControlDataGridView
{
get
{
return dataGridView;
}
set
{
dataGridView = value;
}
}
// Implements the IDataGridViewEditingControl
// .EditingControlValueChanged property.
public bool EditingControlValueChanged
{
get
{
return valueChanged;
}
set
{
valueChanged = value;
}
}
// Implements the IDataGridViewEditingControl
// .EditingPanelCursor property.
public Cursor EditingPanelCursor
{
get
{
return base.Cursor;
}
}
protected override void OnValueChanged(EventArgs eventargs)
{
// Notify the DataGridView that the contents of the cell
// have changed.
valueChanged = true;
this.EditingControlDataGridView.NotifyCurrentCellDirty(true);
base.OnValueChanged(eventargs);
}
}
Class CalendarEditingControl
Inherits DateTimePicker
Implements IDataGridViewEditingControl
Private dataGridViewControl As DataGridView
Private valueIsChanged As Boolean = False
Private rowIndexNum As Integer
Public Sub New()
Me.Format = DateTimePickerFormat.Short
End Sub
Public Property EditingControlFormattedValue() As Object _
Implements IDataGridViewEditingControl.EditingControlFormattedValue
Get
Return Me.Value.ToShortDateString()
End Get
Set(ByVal value As Object)
Try
' This will throw an exception of the string is
' null, empty, or not in the format of a date.
Me.Value = DateTime.Parse(CStr(value))
Catch
' In the case of an exception, just use the default
' value so we're not left with a null value.
Me.Value = DateTime.Now
End Try
End Set
End Property
Public Function GetEditingControlFormattedValue(ByVal context _
As DataGridViewDataErrorContexts) As Object _
Implements IDataGridViewEditingControl.GetEditingControlFormattedValue
Return Me.Value.ToShortDateString()
End Function
Public Sub ApplyCellStyleToEditingControl(ByVal dataGridViewCellStyle As _
DataGridViewCellStyle) _
Implements IDataGridViewEditingControl.ApplyCellStyleToEditingControl
Me.Font = dataGridViewCellStyle.Font
Me.CalendarForeColor = dataGridViewCellStyle.ForeColor
Me.CalendarMonthBackground = dataGridViewCellStyle.BackColor
End Sub
Public Property EditingControlRowIndex() As Integer _
Implements IDataGridViewEditingControl.EditingControlRowIndex
Get
Return rowIndexNum
End Get
Set(ByVal value As Integer)
rowIndexNum = value
End Set
End Property
Public Function EditingControlWantsInputKey(ByVal key As Keys, _
ByVal dataGridViewWantsInputKey As Boolean) As Boolean _
Implements IDataGridViewEditingControl.EditingControlWantsInputKey
' Let the DateTimePicker handle the keys listed.
Select Case key And Keys.KeyCode
Case Keys.Left, Keys.Up, Keys.Down, Keys.Right, _
Keys.Home, Keys.End, Keys.PageDown, Keys.PageUp
Return True
Case Else
Return Not dataGridViewWantsInputKey
End Select
End Function
Public Sub PrepareEditingControlForEdit(ByVal selectAll As Boolean) _
Implements IDataGridViewEditingControl.PrepareEditingControlForEdit
' No preparation needs to be done.
End Sub
Public ReadOnly Property RepositionEditingControlOnValueChange() _
As Boolean Implements _
IDataGridViewEditingControl.RepositionEditingControlOnValueChange
Get
Return False
End Get
End Property
Public Property EditingControlDataGridView() As DataGridView _
Implements IDataGridViewEditingControl.EditingControlDataGridView
Get
Return dataGridViewControl
End Get
Set(ByVal value As DataGridView)
dataGridViewControl = value
End Set
End Property
Public Property EditingControlValueChanged() As Boolean _
Implements IDataGridViewEditingControl.EditingControlValueChanged
Get
Return valueIsChanged
End Get
Set(ByVal value As Boolean)
valueIsChanged = value
End Set
End Property
Public ReadOnly Property EditingControlCursor() As Cursor _
Implements IDataGridViewEditingControl.EditingPanelCursor
Get
Return MyBase.Cursor
End Get
End Property
Protected Overrides Sub OnValueChanged(ByVal eventargs As EventArgs)
' Notify the DataGridView that the contents of the cell have changed.
valueIsChanged = True
Me.EditingControlDataGridView.NotifyCurrentCellDirty(True)
MyBase.OnValueChanged(eventargs)
End Sub
End Class
Comentarios
Esta interfaz se implementa mediante controles, como DataGridViewComboBoxEditingControl y DataGridViewTextBoxEditingControl, que se hospedan en las celdas correspondientes DataGridView , como DataGridViewComboBoxCell y DataGridViewTextBoxCell, cuando están en modo de edición.
Los tipos de celda que pueden hospedar controles de edición establecen su EditType propiedad en un Type objeto que representa el tipo de control de edición. Cuando la celda entra en modo de edición, se realizan los pasos siguientes:
El DataGridView control crea una instancia del tipo de control de edición.
El DataGridView control llama al método de celda InitializeEditingControl . Puede invalidar este método para transferir el valor de celda al control de edición.
El DataGridView control llama al método de control ApplyCellStyleToEditingControl de edición y pasa el estilo actual de la celda. Puede implementar este método para inicializar la apariencia del control de edición para que coincida con la apariencia de la celda.
El DataGridView control llama al método de control PrepareEditingControlForEdit de edición. Puede implementar este método para realizar ajustes finales en el control de edición, como seleccionar el valor del control.
Para obtener más información sobre cómo implementar IDataGridViewEditingControl, vea How to: Host Controls in Windows Forms DataGridView Cells.
Los tipos de celda, como DataGridViewCheckBoxCell , proporcionan una interfaz de usuario (UI) para especificar valores sin hospedar un control de edición implementan la IDataGridViewEditingCell interfaz . La interfaz de usuario en este caso se muestra independientemente de si la celda está en modo de edición.
Otros tipos de celda, como DataGridViewButtonCell, proporcionan una interfaz de usuario, pero no almacenan valores especificados por el usuario. En este caso, el tipo de celda no implementa IDataGridViewEditingCell ni hospeda un control de edición.
Propiedades
| EditingControlDataGridView |
Obtiene o establece el control DataGridView que contiene la celda. |
| EditingControlFormattedValue |
Obtiene o establece el valor con formato de la celda que el editor está modificando. |
| EditingControlRowIndex |
Obtiene o establece el índice correspondiente a la fila primaria de la celda en la que se hospeda. |
| EditingControlValueChanged |
Obtiene o establece un valor que indica si el valor del control de edición difiere del valor de la celda donde se hospeda. |
| EditingPanelCursor |
Obtiene el cursor que se utiliza cuando el puntero del mouse se sitúa sobre la propiedad EditingPanel, pero no sobre el control de edición. |
| RepositionEditingControlOnValueChange |
Obtiene o establece un valor que indica si el contenido de la celda debe cambiar de posición cada vez que se modifique el valor. |
Métodos
| ApplyCellStyleToEditingControl(DataGridViewCellStyle) |
Cambia la interfaz de usuario (UI) del control para que sea coherente con el estilo de celda especificado. |
| EditingControlWantsInputKey(Keys, Boolean) |
Determina si la tecla especificada es una tecla de entrada estándar que el control de edición debería procesar, o una clave especial que DataGridView debe procesar. |
| GetEditingControlFormattedValue(DataGridViewDataErrorContexts) |
Recupera el valor con formato de la celda. |
| PrepareEditingControlForEdit(Boolean) |
Prepara la celda actualmente seleccionada para su edición. |
