IDesignerHost.CreateTransaction Method (String)

Creates a DesignerTransaction that can encapsulate event sequences to improve performance and enable undo and redo support functionality, using the specified transaction description.

[Visual Basic]
Function CreateTransaction( _
   ByVal description As String _
) As DesignerTransaction
[C#]
DesignerTransaction CreateTransaction(
   string description
);
[C++]
DesignerTransaction* CreateTransaction(
   String* description
);
[JScript]
function CreateTransaction(
   description : String
) : DesignerTransaction;

Parameters

description

A title or description for the newly created transaction.

Return Value

A new DesignerTransaction. When you have completed the steps in your transaction, you should call Commit on this object.

Remarks

This method creates a DesignerTransaction that can be used to encapsulate a series of operations. Designer transactions can improve performance, reduce flicker caused by multiple updates during a process of operations, and enable most operations to be undone.

Lengthy operations that involve multiple components can raise many events. These events can cause side effects, such as flicker or degraded performance. When operating on multiple components at one time, or setting multiple properties on a single component, you can improve performance by performing these changes within a transaction. Some operations handle the TransactionOpening and TransactionClosed events and perform work only when a transaction is not in progress. For more information on using transactions, see the documentation for DesignerTransaction.

Requirements

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

See Also

IDesignerHost Interface | IDesignerHost Members | System.ComponentModel.Design Namespace | IDesignerHost.CreateTransaction Overload List