ConnectionProviderAttribute.DisplayName Eigenschaft

  • Referenz

Definition

Namespace:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Ruft den angezeigten Namen des Anbieterverbindungspunkts ab.

public:
 virtual property System::String ^ DisplayName { System::String ^ get(); };
public virtual string DisplayName { get; }
member this.DisplayName : string
Public Overridable ReadOnly Property DisplayName As String

Eigenschaftswert

String

Eine Zeichenfolge, die einen Anzeigenamen für den Anbieterverbindungspunkt enthält.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der DisplayName Eigenschaft veranschaulicht, indem gezeigt wird, wie das ConnectionProviderAttribute Metadatenelement in einer Rückrufmethode in einem Anbietersteuerelement deklariert wird. Beachten Sie, dass die einfachste Überladung des Konstruktors verwendet wird; nur der displayName Parameterwert wird angegeben. Der Wert des Parameters wird der Wert der DisplayName Eigenschaft. Für den vollständigen Code, der zum Ausführen des Codebeispiels erforderlich ist, finden Sie in der ConnectionProviderAttribute Klassenübersicht.

[ConnectionProvider("Row")]
public IWebPartRow GetConnectionInterface()
{
    return new RowProviderWebPart();
}

<ConnectionProvider("Row")> _
Public Function GetConnectionInterface() As IWebPartRow
    Return New RowProviderWebPart()

End Function 'GetConnectionInterface

Hinweise

Diese Eigenschaft ist der Anzeigename eines Anbieterverbindungspunkts. Der Wert kann deklarativ festgelegt werden, wenn Sie den displayName Parameter zu einem ConnectionProviderAttribute Metadatenelement einer Rückrufmethode hinzufügen. Sie kann auch programmgesteuert von einer abgeleiteten Klasse mithilfe der geschützten DisplayNameValue Eigenschaft festgelegt werden.

Wenn Sie eine Verbindungspunktsammlung durchsuchen, sollten Sie die ID Eigenschaft verwenden, da die ID-Eigenschaft eindeutig sein muss, die DisplayName Eigenschaft jedoch nicht sein muss.

Die DisplayName Eigenschaft eines Anbieterverbindungspunkts wird Benutzern angezeigt, wenn sich ein ConnectionsZone Steuerelement auf der Seite befindet, die Benutzeroberfläche für die Verbindung geöffnet ist, und die Benutzer befinden sich in einer Ansicht, in der sie Verbindungspunkte auswählen können, um eine Verbindung herzustellen.

Gilt für

Siehe auch