This documentation is archived and is not being maintained.

ProviderConnectionPoint.GetObject Method

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

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

public virtual Object GetObject(
	Control control
)

Parameters

control
Type: System.Web.UI.Control
The control acting as the provider in a Web Parts connection.

Return Value

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

ExceptionCondition
ArgumentNullException

control is null.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: