ControlDesigner.InvokeTransactedChange Method (IServiceProvider, IComponent, TransactedChangeCallback, Object, String, MemberDescriptor)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 Shared Sub InvokeTransactedChange (
	serviceProvider As IServiceProvider,
	component As IComponent,
	callback As TransactedChangeCallback,
	context As Object,
	description As String,
	member As MemberDescriptor
)

Parameters

serviceProvider
Type: System.IServiceProvider

An IServiceProvider object representing the design host that provides control designer services for the associated control.

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.

Exception Condition
ArgumentNullException

component is null.

-or-

callback is null.

-or-

serviceProvider is null.

The implementation of the InvokeTransactedChange method notifies the design host, which is represented by serviceProvider, 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 the associated control throws a static Canceled exception field of a CheckoutException exception, the transaction is canceled without invoking callback.

For a code example, see InvokeTransactedChange.

.NET Framework
Available since 2.0
Return to top
Show: