.NET Framework Class Library
CurrencyManager..::.EndCurrentEdit Method

Updated: April 2009

Ends the current edit operation.

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

Visual Basic (Declaration)
Public Overrides Sub EndCurrentEdit
Visual Basic (Usage)
Dim instance As CurrencyManager

instance.EndCurrentEdit()
C#
public override void EndCurrentEdit()
Visual C++
public:
virtual void EndCurrentEdit() override
JScript
public override function EndCurrentEdit()
Remarks

This method is supported only if the objects contained by the data source implement the IEditableObject or ICancelAddNew interfaces.

NoteNote:

This property was designed to be used by complex data-bound controls, such as the DataGridView control. Unless you are creating a control that requires this same functionality, you should not use this method. Instead, if the data source is either a DataView or DataTable, use the EndEdit method of the DataRowView class.

Examples

The following code example demonstrates how to use the EndCurrentEdit method.

Visual Basic
 Private Sub dataGrid1_KeyUp _
(ByVal sender As Object, ByVal e As System.Windows.Forms.KeyEventArgs)
     If e.KeyCode = Keys.Enter Then
         ' Enter key pressed.
         Dim gridCurrencyManager As CurrencyManager = _
         CType(Me.BindingContext(dataGrid1.DataSource, _
         dataGrid1.DataMember), CurrencyManager)
         gridCurrencyManager.EndCurrentEdit()
         MessageBox.Show("End Edit")
     End If
 End Sub 'dataGrid1_KeyUp
C#
private void dataGrid1_KeyUp
(object sender, System.Windows.Forms.KeyEventArgs e) {
    if(e.KeyCode == Keys.Enter) {
        // Enter key pressed.
        CurrencyManager gridCurrencyManager = 
        (CurrencyManager)this.BindingContext
        [dataGrid1.DataSource, dataGrid1.DataMember];
        gridCurrencyManager.EndCurrentEdit();
        MessageBox.Show("End Edit");
    }
}
Visual C++
private:
   void dataGrid1_KeyUp( Object^ /*sender*/, System::Windows::Forms::KeyEventArgs^ e )
   {
      if ( e->KeyCode == Keys::Enter )
      {

         // Enter key pressed.
         CurrencyManager^ gridCurrencyManager = dynamic_cast<CurrencyManager^>(this->BindingContext[dataGrid1->DataSource, dataGrid1->DataMember]);
         gridCurrencyManager->EndCurrentEdit();
         MessageBox::Show( "End Edit" );
      }
   }
JScript
protected function dataGrid1_KeyUp
(sender, e : System.Windows.Forms.KeyEventArgs) {
    if(e.KeyCode == Keys.Enter) {
        // Enter key pressed.
        var gridCurrencyManager : CurrencyManager = 
        CurrencyManager(this.BindingContext
        [dataGrid1.DataSource, dataGrid1.DataMember]);
        gridCurrencyManager.EndCurrentEdit();
        MessageBox.Show("End Edit");
    }
}
Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
See Also

Reference

Change History

Date

History

Reason

April 2009

Removed incorrect "to cancel edit" text from the Note in the Remarks section.

Content bug fix.

Tags :


Community Content

Tom Dykstra - MSFT
Mistake in the documentation

In the note above the line "This property was designed to be used by complex data-bound controls, such as the DataGridView control, to cancel edits." is incorrect. EndCurrentEdit commits the edit, CancelCurrentEdit() cancels it.

This will be fixed in the next release of the documentation.

Tags : contentbug

Page view tracker