Partilhar via


ConnectionConsumerAttribute.DisplayName Propriedade

Definição

Obtém o nome amigável do ponto de conexão de consumidor.

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

Valor da propriedade

String

Uma cadeia de caracteres que contém um nome de exibição amigável para o ponto de conexão do consumidor.

Exemplos

O exemplo de código a seguir demonstra o uso da DisplayName propriedade, mostrando como declarar o ConnectionConsumerAttribute elemento de metadados em um método de retorno de chamada em um controle de consumidor. Observe que a sobrecarga mais simples do construtor é usada; apenas o valor do displayName parâmetro é fornecido. O valor do parâmetro se tornará o valor da DisplayName propriedade. Para obter o código completo necessário para executar o exemplo de código, consulte a visão geral da 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

Comentários

Essa propriedade é o nome amigável de um ponto de conexão do consumidor. Seu valor pode ser definido declarativamente, quando você adiciona o displayName parâmetro a um ConnectionConsumerAttribute elemento de metadados em um método de retorno de chamada. Ele também pode ser definido programaticamente por uma classe derivada usando a propriedade protegida DisplayNameValue .

Ao pesquisar por meio de uma coleção de pontos de conexão, você deve usar a ID propriedade, pois a propriedade ID deve ser exclusiva, mas a DisplayName propriedade não precisa ser.

A DisplayName propriedade de um ponto de conexão do consumidor é exibida aos usuários quando um ConnectionsZone controle está na página, a interface do usuário (interface do usuário) de conexão está aberta e os usuários têm permissão para selecionar pontos de conexão para estabelecer uma conexão.

Aplica-se a

Confira também