This documentation is archived and is not being maintained.

ConsumerConnectionPoint::SetObject Method

Invokes the callback method in a consumer control and retrieves the interface instance from a provider control.

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

public:
virtual void SetObject(
	Control^ control, 
	Object^ data
)

Parameters

control
Type: System.Web.UI::Control
The consumer control associated with a consumer connection point.
data
Type: System::Object
The interface instance returned from a provider control.

ExceptionCondition
ArgumentNullException

control is nullptr.

This method receives an interface instance from a provider that contains data for the consumer control.

The SetObject method is called by WebPartConnection objects when a connection is being activated. This is a critical step that is part of initiating a connection and enabling 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: