WebPartManager.ConnectWebParts Method (WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartTransformer)

 
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.

Creates a connection between two WebPart or GenericWebPart controls using the references to the controls, their specified ConnectionPoint objects, and a WebPartTransformer object.

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

public virtual WebPartConnection ConnectWebParts(
	WebPart provider,
	ProviderConnectionPoint providerConnectionPoint,
	WebPart consumer,
	ConsumerConnectionPoint consumerConnectionPoint,
	WebPartTransformer transformer
)

Parameters

provider
Type: System.Web.UI.WebControls.WebParts.WebPart

A WebPart that has the role of furnishing data to another connected control.

providerConnectionPoint
Type: System.Web.UI.WebControls.WebParts.ProviderConnectionPoint

A public method in provider that is marked with a ConnectionProvider metadata attribute, and serves as a callback method for the connection.

consumer
Type: System.Web.UI.WebControls.WebParts.WebPart

A WebPart that has the role of receiving data from provider or transformer, and then processing or displaying it.

consumerConnectionPoint
Type: System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint

A public method in consumer that is marked with a ConnectionConsumer metadata attribute, and connects with providerConnectionPoint to receive the data for the connection.

transformer
Type: System.Web.UI.WebControls.WebParts.WebPartTransformer

A WebPartTransformer that enables a connection between two controls by converting the data from provider to a format that consumer can process.

Return Value

Type: System.Web.UI.WebControls.WebParts.WebPartConnection

A WebPartConnection that contains the information about the provider, consumer, and transformer needed for a connection.

Exception Condition
InvalidOperationException

Connections have already been activated in PreRender.

This overload is used to connect controls when their connection points are incompatible. The incompatibility occurs when consumer implements a different interface than provider as its connection point. The transformer converts the data into a type that can be understood by consumer.

.NET Framework
Available since 2.0
Return to top
Show: