ConnectionConsumerAttribute.DisplayName Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the friendly name of the consumer connection point.
public:
virtual property System::String ^ DisplayName { System::String ^ get(); };public virtual string DisplayName { get; }member this.DisplayName : stringPublic Overridable ReadOnly Property DisplayName As StringProperty Value
A string containing a friendly display name for the consumer connection point.
Examples
The following code example demonstrates using the DisplayName property, 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. The value of the parameter will become the value of the DisplayName property. For the full code required to run the code example, see the ConnectionConsumerAttribute class overview.
[ConnectionConsumer("Row")]
public void SetConnectionInterface(IWebPartRow provider)
{
_provider = provider;
}
<ConnectionConsumer("Row")> _
Public Sub SetConnectionInterface(ByVal provider As IWebPartRow)
_provider = provider
End Sub
End Class
Remarks
This property is the friendly name of a consumer connection point. Its value can be set declaratively, when you add the displayName parameter to a ConnectionConsumerAttribute metadata element on a callback method. It can also be set programmatically by a derived class, by using the protected DisplayNameValue property.
When you are searching through a connection point collection, you should use the ID property, because the ID property must be unique, but the DisplayName property need not be.
The DisplayName property of a consumer connection point is displayed to users when a ConnectionsZone control is on the page, the connection user interface (UI) is open, and the users are in a view where they are allowed to select connection points to establish a connection.
