ConnectionConsumerAttribute.DisplayName Eigenschaft

  • Referenz

Definition

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

Ruft den angezeigten Namen des Consumer-Verbindungspunkts 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 Consumer-Verbindungspunkt enthält.

Beispiele

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

[ConnectionConsumer("Row")]
public void SetConnectionInterface(IWebPartRow provider) 
{
    _provider = provider;
}

    <ConnectionConsumer("Row")> _
    Public Sub SetConnectionInterface(ByVal provider As IWebPartRow)
        _provider = provider

    End Sub
End Class

Hinweise

Diese Eigenschaft ist der Anzeigename eines Verbraucherverbindungspunkts. Der Wert kann deklarativ festgelegt werden, wenn Sie dem displayName Parameter ein Metadatenelement auf einer ConnectionConsumerAttribute Rückrufmethode hinzufügen. Sie kann auch programmgesteuert durch eine abgeleitete Klasse mithilfe der geschützten DisplayNameValue Eigenschaft festgelegt werden.

Wenn Sie durch eine Verbindungspunktsammlung suchen, sollten Sie die Eigenschaft verwenden, da die ID ID-Eigenschaft eindeutig sein muss, aber die DisplayName Eigenschaft muss nicht sein.

Die DisplayName Eigenschaft eines Verbraucherverbindungspunkts wird Benutzern angezeigt, wenn sich ein ConnectionsZone Steuerelement auf der Seite befindet, die Benutzeroberfläche der 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