ConnectionProviderAttribute.DisplayName Propriedade

Definição

Namespace:

System.Web.UI.WebControls.WebParts

Assembly:

System.Web.dll

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

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 provedor.

Exemplos

O exemplo de código a seguir demonstra o uso da DisplayName propriedade , mostrando como declarar o ConnectionProviderAttribute elemento de metadados em um método de retorno de chamada em um controle de provedor. 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 ConnectionProviderAttribute classe.

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

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

End Function 'GetConnectionInterface

Comentários

Essa propriedade é o nome amigável de um ponto de conexão do provedor. Seu valor pode ser definido declarativamente, quando você adiciona o displayName parâmetro a um ConnectionProviderAttribute 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 provedor é exibida aos usuários quando um ConnectionsZone controle está na página, a interface do usuário da conexão está aberta e os usuários estão em uma exibição em que têm permissão para selecionar pontos de conexão para estabelecer uma conexão.

Confira também

• DisplayName
• DisplayNameValue