Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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 ()
public void CancelCurrentEdit ()
public override function 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.

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!");
   }
}


protected void dataGrid1_KeyUp( Object sender, 
    System.Windows.Forms.KeyEventArgs e)
{
    if (e.get_KeyCode().Equals(System.Windows.Forms.Keys.Escape)) {
        // Escape key pressed.
        CurrencyManager gridCurrencyManager = 
            (CurrencyManager)(this.get_BindingContext().
            get_Item(dataGrid1.get_DataSource(),
            dataGrid1.get_DataMember()));
        gridCurrencyManager.CancelCurrentEdit();
        MessageBox.Show("Escape!");
    }
} //dataGrid1_KeyUp

protected function dataGrid1_KeyUp
(sender, e : System.Windows.Forms.KeyEventArgs)
{
   if(e.KeyCode == System.Windows.Forms.Keys.Escape){
      // Escape key pressed.
      var gridCurrencyManager : CurrencyManager  = 
      CurrencyManager(this.BindingContext[dataGrid1.DataSource, dataGrid1.DataMember]);
      gridCurrencyManager.CancelCurrentEdit();
      MessageBox.Show("Escape!");
   }
}


Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.