ConnectionConsumerAttribute Constructor (String^)

 

Initializes a new instance of the ConnectionConsumerAttribute class, specifying a display name for the consumer connection point.

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

public:
ConnectionConsumerAttribute(
	String^ displayName
)

Parameters

displayName
Type: System::String^

A string that contains a friendly name for the consumer connection point to display in the user interface (UI).

Exception Condition
ArgumentNullException

displayName is null.

This constructor creates an instance of the attribute that is used with a method of a Web Parts control acting as a consumer. This method becomes the connection point between the provider and the consumer. Typically, the way you use this constructor is to declare a ConnectionConsumerAttribute metadata element on a method that you want to designate as a callback method in a consumer control.

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 following code example demonstrates using the ConnectionConsumerAttribute class, by showing how to declare the ConnectionConsumerAttribute metadata element on a callback method in a consumer control. Note that the simplest overload of the constructor is used; only the displayName parameter value is supplied. For the full code required to run the code example, see the ConnectionConsumerAttribute class overview.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: