WebPartConnectionsCancelEventArgs Class

.NET Framework (current version)

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

Provides data for the WebPartsConnecting and WebPartsDisconnecting events.

Namespace: System.Web.UI.WebControls.WebParts
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System.Object
System.EventArgs
System.ComponentModel.CancelEventArgs
System.Web.UI.WebControls.WebParts.WebPartConnectionsCancelEventArgs

Syntax

C++

public class WebPartConnectionsCancelEventArgs : CancelEventArgs

Constructors

	Name	Description
	WebPartConnectionsCancelEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)	Initializes a new instance of the WebPartConnectionsCancelEventArgs class without a specified connection.
	WebPartConnectionsCancelEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartConnection)	Initializes a new instance of the WebPartConnectionsCancelEventArgs class with the specified connection.

Properties

	Name	Description
	Cancel	Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.)
	Connection	Gets the Web Parts connection involved in the event.
	Consumer	Gets the Web Parts control acting as the consumer in the connection.
	ConsumerConnectionPoint	Gets the connection point that consumes data in the Web Parts connection.
	Provider	Gets the Web Parts control acting as the provider in the connection.
	ProviderConnectionPoint	Gets the connection point that provides data in the Web Parts connection.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

The WebPartsConnecting event is raised by the OnWebPartsConnecting method, and it indicates that the connection process has begun (for example, a user has selected a control and clicked a connect verb), but is not yet completed. The event provides an opportunity to cancel a connection before it is complete. If the connection is successfully completed, this event is followed by the WebPartsConnected event.

The WebPartsDisconnecting event is raised by the OnWebPartsDisconnecting method, and it indicates that a user has clicked a disconnect verb, or the DisconnectWebParts method has otherwise been called. The event provides an opportunity to cancel the process of ending a connection before it is complete. If the connection is ended successfully, this event is followed by the WebPartsDisconnected event.

The WebPartConnectionsCancelEventArgs class contains information about the WebPartsConnecting and WebPartsDisconnecting events. It provides access to the Web Parts controls that are being connected or disconnected.

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.