ConnectionConsumerAttribute.DisplayName Propriété

Définition

Obtient le nom convivial du point de connexion consommateur.

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

Valeur de propriété

String

Chaîne qui contient un nom complet convivial pour le point de connexion consommateur.

Exemples

L’exemple de code suivant illustre l’utilisation de la DisplayName propriété, en montrant comment déclarer l’élément ConnectionConsumerAttribute de métadonnées sur une méthode de rappel dans un contrôle consommateur. Notez que la surcharge la plus simple du constructeur est utilisée ; seule la valeur du displayName paramètre est fournie. La valeur du paramètre devient la valeur de la DisplayName propriété. Pour obtenir le code complet requis pour exécuter l’exemple de code, consultez la vue d’ensemble de la ConnectionConsumerAttribute classe.

[ConnectionConsumer("Row")]
public void SetConnectionInterface(IWebPartRow provider) 
{
    _provider = provider;
}
    <ConnectionConsumer("Row")> _
    Public Sub SetConnectionInterface(ByVal provider As IWebPartRow)
        _provider = provider

    End Sub
End Class

Remarques

Cette propriété est le nom convivial d’un point de connexion consommateur. Sa valeur peut être définie de manière déclarative lorsque vous ajoutez le displayName paramètre à un ConnectionConsumerAttribute élément de métadonnées sur une méthode de rappel. Elle peut également être définie par programmation par une classe dérivée, à l’aide de la propriété protégée DisplayNameValue .

Lorsque vous effectuez une recherche dans une collection de points de connexion, vous devez utiliser la ID propriété, car la propriété ID doit être unique, mais la DisplayName propriété n’a pas besoin d’être.

La DisplayName propriété d’un point de connexion consommateur est affichée aux utilisateurs lorsqu’un ConnectionsZone contrôle se trouve sur la page, l’interface utilisateur de connexion est ouverte et les utilisateurs sont dans une vue où ils sont autorisés à sélectionner des points de connexion pour établir une connexion.

S’applique à

Voir aussi