Export (0) Print
Expand All
Expand Minimize

DesignerTransactionCloseEventHandler Delegate

Represents the method that handles the TransactionClosed and TransactionClosing events of a designer.

[Visual Basic]
<Serializable>
<ComVisible(True)>
Public Delegate Sub DesignerTransactionCloseEventHandler( _
   ByVal sender As Object, _
   ByVal e As DesignerTransactionCloseEventArgs _
)
[C#]
[Serializable]
[ComVisible(true)]
public delegate void DesignerTransactionCloseEventHandler(
   object sender,
   DesignerTransactionCloseEventArgs e
);
[C++]
[Serializable]
[ComVisible(true)]
public __gc __delegate void DesignerTransactionCloseEventHandler(
   Object* sender,
   DesignerTransactionCloseEventArgs* e
);

[JScript] In JScript, you can use the delegates in the .NET Framework, but you cannot define your own.

Parameters [Visual Basic, C#, C++]

The declaration of your event handler must have the same parameters as the DesignerTransactionCloseEventHandler delegate declaration.

Remarks

When you create a DesignerTransactionCloseEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see Events and Delegates.

Example

[Visual Basic, C#, C++] The following example demonstrates registering a DesignerTransactionCloseEventHandler and handling the TransactionClosing and TransactionClosed events.

[Visual Basic] 
Public Sub LinkDesignerTransactionCloseEvent(ByVal host As IDesignerHost)
    ' Registers an event handler for the designer TransactionClosing 
    ' and TransactionClosed events.
    AddHandler host.TransactionClosing, AddressOf Me.OnTransactionClose
    AddHandler host.TransactionClosed, AddressOf Me.OnTransactionClose
End Sub

Private Sub OnTransactionClose(ByVal sender As Object, ByVal e As DesignerTransactionCloseEventArgs)
    ' Displays transaction close information on the console.           
    If e.TransactionCommitted Then
        Console.WriteLine("Transaction has been committed.")
    Else
        Console.WriteLine("Transaction has not yet been committed.")
    End If
End Sub

[C#] 
public void LinkDesignerTransactionCloseEvent(IDesignerHost host)
{                       
    // Registers an event handler for the designer TransactionClosing and TransactionClosed events.
    host.TransactionClosing += new DesignerTransactionCloseEventHandler(this.OnTransactionClose);
    host.TransactionClosed += new DesignerTransactionCloseEventHandler(this.OnTransactionClose);
}

private void OnTransactionClose(object sender, DesignerTransactionCloseEventArgs e)
{
    // Displays transaction close information on the console.           
    if( e.TransactionCommitted )            
        Console.WriteLine("Transaction has been committed.");
    else
        Console.WriteLine("Transaction has not yet been committed.");
}

[C++] 
public:

    void LinkDesignerTransactionCloseEvent(IDesignerHost* host)
    {
        // Registers an event handler for the designer TransactionClosing and TransactionClosed events.
        host->TransactionClosing +=
            new DesignerTransactionCloseEventHandler(this, &DesignerTransactionCloseEventHandlerExample::OnTransactionClose);
        host->TransactionClosed +=
            new DesignerTransactionCloseEventHandler(this, &DesignerTransactionCloseEventHandlerExample::OnTransactionClose);
    }

private:

    void OnTransactionClose(Object* /*sender*/, DesignerTransactionCloseEventArgs* e)
    {
        // Displays transaction close information on the console.
        if( e->TransactionCommitted )
            Console::WriteLine(S"Transaction has been committed.");
        else
            Console::WriteLine(S"Transaction has not yet been committed.");
    }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.ComponentModel.Design

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Assembly: System (in System.dll)

See Also

System.ComponentModel.Design Namespace | IDesignerHost

Show:
© 2014 Microsoft