WebPartConnectionsEventArgs Class

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides the event data for the WebPartsConnected and WebPartsDisconnected events of the WebPartManager control.

public ref class WebPartConnectionsEventArgs : EventArgs

public class WebPartConnectionsEventArgs : EventArgs

type WebPartConnectionsEventArgs = class
    inherit EventArgs

Public Class WebPartConnectionsEventArgs
Inherits EventArgs

Inheritance: Object

EventArgs
WebPartConnectionsEventArgs

Remarks

Using the capabilities of the Web Parts control set, it is possible to create a connection between two WebPart or other server controls, with one control acting as the provider, and the other acting as the consumer of data. To form a connection, the two controls must reside in a zone that inherits from the WebPartZoneBase class (such as the WebPartZone control), and they must be designed correctly to share data through a common interface. For details about Web Parts connections, see WebPartConnection and Web Parts Connections Overview.

The WebPartConnectionsEventArgs class passes event data to methods that use the WebPartConnectionsEventHandler delegate to handle events. There are two such connection-related methods that raise events and use the WebPartConnectionsEventArgs class to provide event data. Both are members of the WebPartManager control. The OnWebPartsConnected method raises the WebPartsConnected event after two server controls have successfully connected, and the OnWebPartsDisconnected method raises the WebPartsDisconnected event after two server controls have been disconnected.

Developers can create custom event handler methods for the WebPartsConnected and WebPartsDisconnected events, and in those methods, they can use the WebPartConnectionsEventArgs class to access details of a connection. For example, a developer can declare the OnWebPartsConnected attribute on the <asp:webpartmanager> element, and assign to it a custom method name that will handle the event. In the custom handler method, developers can access the details of a connection by using the WebPartConnectionsEventArgs object that is passed to the method as a parameter.

The WebPartConnectionsEventArgs class has two overloads of the constructor. The WebPartConnectionsEventArgs.WebPartConnectionsEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint) constructor is the default; it initializes the property values for the class. The WebPartConnectionsEventArgs.WebPartConnectionsEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartConnection) constructor calls the parameterless constructor, and then it also initializes the Connection property.

The WebPartConnectionsEventArgs class has several properties, all of which refer to the essential aspects of a Web Parts connection. The Connection property refers to the associated WebPartConnection object that represents the entire connection. The Provider property references a WebPart or other server control acting as the provider in the connection, and the Consumer property references a WebPart or server control acting as the consumer. The ProviderConnectionPoint property references the connection's ProviderConnectionPoint object, while the ConsumerConnectionPoint property references the ConsumerConnectionPoint object.

Constructors

WebPartConnectionsEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartConnection)	Initializes a new instance of the class using the specified WebPartConnection object.
WebPartConnectionsEventArgs(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)	Initializes a new instance of the WebPartConnectionsEventArgs class without requiring a WebPartConnection object.

Properties

Connection	Gets the WebPartConnection object of the current connection.
Consumer	Gets the WebPart control that is acting as the consumer in the connection.
ConsumerConnectionPoint	Gets the ConsumerConnectionPoint object of the current connection.
Provider	Gets the WebPart control that is acting as the provider in the connection.
ProviderConnectionPoint	Gets the ProviderConnectionPoint object of the current 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

แชร์ผ่าน