This documentation is archived and is not being maintained.

ControlDesigner::InvokeTransactedChange Method (IComponent, TransactedChangeCallback, Object, String, MemberDescriptor)

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.

Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)

public:
static void InvokeTransactedChange(
	IComponent^ component, 
	TransactedChangeCallback^ callback, 
	Object^ context, 
	String^ description, 
	MemberDescriptor^ member
)

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.

member
Type: System.ComponentModel::MemberDescriptor

A MemberDescriptor object (typically, either an EventDescriptor or a PropertyDescriptor object) that describes the member of the associated control that is being invoked as part of the transaction.

ExceptionCondition
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 to the specified member (property or method) of the associated control and, if the change is not canceled by the design host, invokes the specified callback using the specified context as the argument, and then notifies the design host that the change has completed.

If the design host or associated control throws a static Canceled exception field of a CheckoutException exception, the transaction is canceled without invoking callback.

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.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: