This documentation is archived and is not being maintained.

ConnectionConsumerAttribute Constructor (String, String, Type)

Initializes a new instance of the ConnectionConsumerAttribute class, specifying a display name, an ID, and a specific type of connection point object to use for the consumer connection point.

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

public:
ConnectionConsumerAttribute(
	String^ displayName, 
	String^ id, 
	Type^ connectionPointType
)

Parameters

displayName
Type: System::String
A string that contains a friendly name for the consumer connection point to display in the user interface (UI).
id
Type: System::String
The ID, a unique string value assigned to the consumer connection point.
connectionPointType
Type: System::Type
A Type that derives from ConsumerConnectionPoint, and that you want to specify as the type of connection point object to use with a specific callback method.

ExceptionCondition
ArgumentNullException

displayName, id, or connectionPointType is nullptr.

ArgumentException

connectionPointType is not valid.

The displayName parameter is a friendly name of the consumer connection point that is used by the ConnectionsZone control to represent a consumer's connection point in the UI.

The id parameter is used to specify the ID for the consumer connection point associated with the specific callback method. A control can have multiple connection points, but the id for each must be unique. Therefore, this overload of the constructor is useful if you have multiple callback methods in your consumer control.

The connectionPointType parameter must be a Type derived from ConsumerConnectionPoint. If this parameter is specified, the Type is used to create the connection point instead of the standard ConsumerConnectionPoint class provided with the Web Parts control set.

.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: