Edit

ProviderConnectionPoint.GetObject(Control) Method

  • Reference

Definition

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

Invokes the callback method in a provider control that gets an interface instance to return to consumers.

public:
 virtual System::Object ^ GetObject(System::Web::UI::Control ^ control);
public virtual object GetObject (System.Web.UI.Control control);
abstract member GetObject : System.Web.UI.Control -> obj
override this.GetObject : System.Web.UI.Control -> obj
Public Overridable Function GetObject (control As Control) As Object

Parameters

control
Control

The control acting as the provider in a Web Parts connection.

Returns

Object

An Object that is an instance of the interface a provider returns to consumers to establish a connection.

Exceptions

ArgumentNullException

control is null.

Remarks

This method returns an object from the provider control that is an instance of the interface used to establish a connection. The type of the object will be the type of the implemented interface. For example, two interfaces that are implemented for connections in the Web Parts control set are IWebPartField and IWebPartRow. When the GetObject method is called on a ProviderConnectionPoint object, if the associated provider implements one of these interfaces, the returned object will be of the same type.

The GetObject method is called by WebPartConnection objects when a connection is being activated. This is a critical step that actually initiates a connection and begins the process that enables two controls to share data.

The consumer control in a connection must be able to work with the same type of interface as the provider. If it does not, the controls are incompatible and a WebPartTransformer object must be used to establish a connection.

Applies to