IDataGridViewEditingControl インターフェイス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
DataGridView のセル内にホストされるコントロールの共通する機能を定義します。
public interface class IDataGridViewEditingControlpublic interface IDataGridViewEditingControltype IDataGridViewEditingControl = interfacePublic Interface IDataGridViewEditingControl- 派生
例
次のコード例では、派生 DateTimePicker元のこのインターフェイスの実装を示します。 この例は、「方法: Windows フォーム DataGridView セルのコントロールをホストする」で使用できるより大きな例の一部です。
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
注釈
このインターフェイスは、編集モードの場合や、DataGridViewComboBoxEditingControlDataGridViewTextBoxEditingControl対応するDataGridViewセルDataGridViewComboBoxCellDataGridViewTextBoxCellによってホストされるコントロール (and など) によって実装されます。
編集コントロールをホストできるセルの種類は、編集コントロールの種類をType表すプロパティに設定EditTypeします。 セルが編集モードになると、次の手順が実行されます。
コントロールは DataGridView 、編集コントロールの種類のインスタンスを作成します。
コントロールは DataGridView セル InitializeEditingControl メソッドを呼び出します。 このメソッドをオーバーライドして、セル値を編集コントロールに転送できます。
コントロールは DataGridView 編集コントロール ApplyCellStyleToEditingControl メソッドを呼び出し、セルの現在のスタイルを渡します。 このメソッドを実装して、セルの外観と一致するように編集コントロールの外観を初期化できます。
コントロールは DataGridView 、編集コントロール PrepareEditingControlForEdit メソッドを呼び出します。 このメソッドを実装して、コントロール値の選択など、編集コントロールに対して最終的な調整を行うことができます。
実装IDataGridViewEditingControlの詳細については、「方法: Windows フォーム DataGridView セルでコントロールをホストする」を参照してください。
編集コントロールをホストせずに値を指定するためのユーザー インターフェイス (UI) を提供するセルの種類 DataGridViewCheckBoxCell は、インターフェイスを IDataGridViewEditingCell 実装します。 この場合の UI は、セルが編集モードであるかどうかに関係なく表示されます。
その他のセルの種類 (UI など DataGridViewButtonCell) は提供されますが、ユーザーが指定した値は格納しません。 この場合、セルの種類は編集コントロールを実装 IDataGridViewEditingCell またはホストしません。
プロパティ
| EditingControlDataGridView |
セルを格納する DataGridView を取得または設定します。 |
| EditingControlFormattedValue |
エディターによって変更されるセルの書式設定された値を取得または設定します。 |
| EditingControlRowIndex |
ホストしているセルの親行のインデックスを取得または設定します。 |
| EditingControlValueChanged |
編集コントロールの値と、そのコントロールをホストしているセルの値とが異なるかどうかを示す値を取得または設定します。 |
| EditingPanelCursor |
マウス ポインターが編集コントロールの上ではなく、EditingPanel の上にあるときに使用されるカーソルを取得します。 |
| RepositionEditingControlOnValueChange |
値が変更されるたびに、セルの内容の位置を変更する必要があるかどうかを示す値を取得または設定します。 |
メソッド
| ApplyCellStyleToEditingControl(DataGridViewCellStyle) |
指定されたセル スタイルと矛盾しないように、コントロールのユーザー インターフェイス (UI) を変更します。 |
| EditingControlWantsInputKey(Keys, Boolean) |
指定されたキーが、編集コントロールによって処理される通常の入力キーか、DataGridView によって処理される特殊なキーであるかを確認します。 |
| GetEditingControlFormattedValue(DataGridViewDataErrorContexts) |
セルの書式設定された値を取得します。 |
| PrepareEditingControlForEdit(Boolean) |
現在選択されているセルの編集を準備します。 |