IDataGridViewEditingControl Antarmuka
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Menentukan fungsionalitas umum untuk kontrol yang dihosting dalam sel dari DataGridView.
public interface class IDataGridViewEditingControl
public interface IDataGridViewEditingControl
type IDataGridViewEditingControl = interface
Public Interface IDataGridViewEditingControl
- Turunan
Contoh
Contoh kode berikut menyediakan implementasi antarmuka ini yang berasal dari DateTimePicker. Contoh ini adalah bagian dari contoh yang lebih besar yang tersedia di Cara: Kontrol Host di 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
Keterangan
Antarmuka ini diimplementasikan oleh kontrol, seperti DataGridViewComboBoxEditingControl dan DataGridViewTextBoxEditingControl, yang dihosting oleh sel yang DataGridView sesuai, seperti DataGridViewComboBoxCell dan DataGridViewTextBoxCell, ketika mereka berada dalam mode edit.
Jenis sel yang dapat menghosting kontrol pengeditan mengatur propertinya EditType ke yang Type mewakili jenis kontrol pengeditan. Saat sel memasuki mode edit, langkah-langkah berikut dilakukan:
Kontrol DataGridView membuat instans jenis kontrol pengeditan.
DataGridView Kontrol memanggil metode selInitializeEditingControl. Anda dapat mengambil alih metode ini untuk mentransfer nilai sel ke kontrol pengeditan.
DataGridView Kontrol memanggil metode kontrol ApplyCellStyleToEditingControl pengeditan dan meneruskan gaya sel saat ini. Anda dapat menerapkan metode ini untuk menginisialisasi tampilan kontrol pengeditan sehingga cocok dengan tampilan sel.
DataGridView Kontrol memanggil metode kontrol PrepareEditingControlForEdit pengeditan. Anda dapat menerapkan metode ini untuk membuat penyesuaian akhir pada kontrol pengeditan, seperti memilih nilai kontrol.
Untuk informasi selengkapnya tentang menerapkan IDataGridViewEditingControl, lihat Cara: Kontrol Host di Windows Forms DataGridView Cells.
Jenis sel seperti DataGridViewCheckBoxCell yang menyediakan antarmuka pengguna (UI) untuk menentukan nilai tanpa menghosting kontrol pengeditan mengimplementasikan IDataGridViewEditingCell antarmuka. UI dalam hal ini ditampilkan terlepas dari apakah sel berada dalam mode edit.
Jenis sel lain, seperti DataGridViewButtonCell, menyediakan UI tetapi tidak menyimpan nilai yang ditentukan pengguna. Dalam hal ini, tipe sel tidak mengimplementasikan IDataGridViewEditingCell atau menghosting kontrol pengeditan.
Properti
| Nama | Deskripsi |
|---|---|
| EditingControlDataGridView |
Mendapatkan atau mengatur DataGridView yang berisi sel. |
| EditingControlFormattedValue |
Mendapatkan atau mengatur nilai sel yang diformat yang sedang dimodifikasi oleh editor. |
| EditingControlRowIndex |
Mendapatkan atau mengatur indeks baris induk sel hosting. |
| EditingControlValueChanged |
Mendapatkan atau menetapkan nilai yang menunjukkan apakah nilai kontrol pengeditan berbeda dari nilai sel hosting. |
| EditingPanelCursor |
Mendapatkan kursor yang digunakan ketika penunjuk mouse di atas EditingPanel tetapi tidak melalui kontrol pengeditan. |
| RepositionEditingControlOnValueChange |
Mendapatkan atau menetapkan nilai yang menunjukkan apakah konten sel perlu direposisi setiap kali nilai berubah. |
Metode
| Nama | Deskripsi |
|---|---|
| ApplyCellStyleToEditingControl(DataGridViewCellStyle) |
Mengubah antarmuka pengguna (UI) kontrol agar konsisten dengan gaya sel yang ditentukan. |
| EditingControlWantsInputKey(Keys, Boolean) |
Menentukan apakah kunci yang ditentukan adalah kunci input reguler yang harus diproses oleh kontrol pengeditan atau kunci khusus yang harus diproses DataGridView . |
| GetEditingControlFormattedValue(DataGridViewDataErrorContexts) |
Mengambil nilai sel yang diformat. |
| PrepareEditingControlForEdit(Boolean) |
Menyiapkan sel yang saat ini dipilih untuk pengeditan. |