Edit

Share via


WebPartConnectionsCancelEventArgs Class

Definition

Provides data for the WebPartsConnecting and WebPartsDisconnecting events.

public ref class WebPartConnectionsCancelEventArgs : System::ComponentModel::CancelEventArgs
public class WebPartConnectionsCancelEventArgs : System.ComponentModel.CancelEventArgs
type WebPartConnectionsCancelEventArgs = class
    inherit CancelEventArgs
Public Class WebPartConnectionsCancelEventArgs
Inherits CancelEventArgs
Inheritance
WebPartConnectionsCancelEventArgs

Remarks

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.

Constructors

WebPartConnectionsCancelEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartConnection)

Initializes a new instance of the WebPartConnectionsCancelEventArgs class with the specified connection.

WebPartConnectionsCancelEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)

Initializes a new instance of the WebPartConnectionsCancelEventArgs class without a specified connection.

Properties

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

Equals(Object)

Determines whether the specified object is equal to the current object.

(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)

Applies to