CurrencyManager.CancelCurrentEdit Method ()

 

Cancels the current edit operation.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public override void CancelCurrentEdit()

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.

System_CAPS_noteNote

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.

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 = 
      (CurrencyManager)this.BindingContext[dataGrid1.DataSource, dataGrid1.DataMember];
      gridCurrencyManager.CancelCurrentEdit();
      MessageBox.Show("Escape!");
   }
}

.NET Framework
Available since 1.1
Return to top
Show: