CurrencyManager.CancelCurrentEdit Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Cancels the current edit operation.
public:
override void CancelCurrentEdit();public override void CancelCurrentEdit ();override this.CancelCurrentEdit : unit -> unitPublic Overrides Sub CancelCurrentEdit ()Examples
The following code example uses the CancelCurrentEdit when the user presses the ESC key.
private:
void dataGrid1_KeyUp( Object^ /*sender*/, System::Windows::Forms::KeyEventArgs^ e )
{
if ( e->KeyCode == System::Windows::Forms::Keys::Escape )
{
// Escape key pressed.
CurrencyManager^ gridCurrencyManager = dynamic_cast<CurrencyManager^>(this->BindingContext[dataGrid1->DataSource, dataGrid1->DataMember]);
gridCurrencyManager->CancelCurrentEdit();
MessageBox::Show( "Escape!" );
}
}
private void dataGrid1_KeyUp
(object sender, System.Windows.Forms.KeyEventArgs e)
{
if(e.KeyCode == System.Windows.Forms.Keys.Escape){
// Escape key pressed.
CurrencyManager gridCurrencyManager =
(CurrencyManager)this.BindingContext[dataGrid1.DataSource, dataGrid1.DataMember];
gridCurrencyManager.CancelCurrentEdit();
MessageBox.Show("Escape!");
}
}
Private Sub dataGrid1_KeyUp(ByVal sender As Object, _
ByVal e As System.Windows.Forms.KeyEventArgs)
If e.KeyCode = System.Windows.Forms.Keys.Escape Then
' Escape key pressed.
Dim gridCurrencyManager As CurrencyManager = _
CType(Me.BindingContext(dataGrid1.DataSource, _
dataGrid1.DataMember), CurrencyManager)
gridCurrencyManager.CancelCurrentEdit()
MessageBox.Show("Escape!")
End If
End Sub
Remarks
This method is supported only if the objects contained by the data source implement the IEditableObject interface. If the objects contained within the data source do not implement the IEditableObject interface, changes made to the data will not be discarded.
Note
This property was designed to be used by complex data-bound controls, such as the DataGrid control, to cancel edits. For example, when the user presses the ESC key, the CancelCurrentEdit method is called on the CurrencyManager for the DataGrid. Unless you are creating a control that requires this same functionality, you should not use this method. Instead, use the CancelEdit method of the DataRowView class.
