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.

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

DesignerTransaction CreateTransaction(
	string description
)

Parameters

description
Type: System.String

A title or description for the newly created transaction.

Return Value

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

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.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft