ConnectionProviderAttribute.DisplayName Property

Gets the friendly name of the provider connection point.

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

public virtual string DisplayName { get; }

Property Value

Type: System.String
A string containing a friendly display name for the provider connection point.

This property is the friendly name of a provider connection point. Its value can be set declaratively, when you add the displayName parameter to a ConnectionProviderAttribute 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 provider 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.

The following code example demonstrates using the DisplayName property, by showing how to declare the ConnectionProviderAttribute metadata element on a callback method in a provider 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 ConnectionProviderAttribute class overview.

        public IWebPartRow GetConnectionInterface()
            return new RowProviderWebPart();

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft