ControlDesigner::InvokeTransactedChange Method (IComponent, TransactedChangeCallback, Object, String)
Wraps a series of changes into a transaction, using the specified parameters that can be rolled back as a unit with the undo functionality of the design host.
Assembly: System.Design (in System.Design.dll)
public: static void InvokeTransactedChange( IComponent^ component, TransactedChangeCallback^ callback, Object^ context, String^ description )
Parameters
- component
- Type: System.ComponentModel::IComponent
The control associated with the control designer.
- callback
- Type: System.Web.UI.Design::TransactedChangeCallback
A TransactedChangeCallback object representing a function to call in the control designer as part of the transaction.
- context
- Type: System::Object
An object that contains the argument for callback.
- description
- Type: System::String
A description of the effect of allowing the transaction to complete, which is used by the design host to give the user an opportunity to cancel the transaction.
| Exception | Condition |
|---|---|
| ArgumentNullException | component is nullptr. -or- callback is nullptr. |
The implementation of the InvokeTransactedChange method notifies the design host, which is determined by the Site property of component, that a change is occurring in the associated control and, if the change is not canceled by the design host, invokes the specified callback using the specified context, and then notifies the design host that the change has completed.
If the design host or the associated control throws a static Canceled exception field of a CheckoutException exception, the transaction is canceled without invoking callback.
The following code example demonstrates how to create a simple composite control with a Label and a TextBox control, together with properties to set the label text, and also the Text, Width, and BackColor properties of the TextBox control. An associated control designer class creates three DesignerActionMethodItem commands, each of which sets two properties on the control. By using the InvokeTransactedChange method, you can use the undo functionality of the design host, such as Visual Studio 2005, to roll back each completed transaction as a unit.
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
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
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.