DesignerTransactionCloseEventHandler Delegate

 

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

Namespace:   System.ComponentModel.Design
Assembly:  System (in System.dll)

[ComVisibleAttribute(true)]
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public delegate void DesignerTransactionCloseEventHandler(
	object sender,
	DesignerTransactionCloseEventArgs e
)

Parameters

sender
Type: System.Object

The source of the event.

e
Type: System.ComponentModel.Design.DesignerTransactionCloseEventArgs

A DesignerTransactionCloseEventArgs that contains the event data.

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 NIB: Events and Delegates.

The following example demonstrates registering a DesignerTransactionCloseEventHandler and handling the TransactionClosing and TransactionClosed events.

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

.NET Framework
Available since 1.1
Return to top
Show: