ConsumerConnectionPoint.SetObject Method (Control, Object)

 
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.

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.

Exception Condition
ArgumentNullException

control is null.

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
Available since 2.0
Return to top
Show: