Propriedade IVsDataSource.DisplayName

Artigo
05/17/2015

Obtém o nome para exibição de fonte de dados de DDEX.

Namespace: Microsoft.VisualStudio.Data.Core
Assembly: Microsoft.VisualStudio.Data.Core (em Microsoft.VisualStudio.Data.Core.dll)

Sintaxe

'Declaração
ReadOnly Property DisplayName As String

string DisplayName { get; }

property String^ DisplayName {
    String^ get ();
}

abstract DisplayName : string with get

function get DisplayName () : String

Valor de propriedade

Tipo: String
O nome para exibição de fonte de dados de DDEX.

Comentários

O nome para exibição de uma fonte de dados de DDEX é uma cadeia de caracteres localizada que pode ser exibida por clientes de DDEX aos usuários finais. Um exemplo disso ocorre na caixa de diálogo Escolher Fonte de Dados de conexão de dados, onde uma fonte de dados e o provedor de DDEX são selecionados pelo usuário.

Esta propriedade determina o nome para exibição chamando o método GetProperty , passando o provedor de suporte padrão (se houver) e o parâmetro DisplayName, para recuperar uma identificação do recurso de cadeia de caracteres Se isso falhar, a propriedade começa apenas iterar através de provedores de suporte, ver cada um para a mesma propriedade até que um valor não-nulo é retornado. Chama o método de GetString para recuperar a cadeia de caracteres localizada que está associada com a identificação do recurso Se nenhum recurso existe, o valor da propriedade de IVsDataSource.Name é retornado.

Um valor de exemplo para essa propriedade pode ser “Microsoft SQL Server”.

Exemplos

O código a seguir demonstra a implementação de propriedade de DisplayName . Como as cadeias de caracteres localizados são fornecidas por provedores de suporte, determina um provedor de suporte apropriado para usar com base no provedor padrão e/ou que os provedores fornecem valores para a propriedade de DisplayName . Então defina isso para a cadeia de caracteres encontrada real usando a API de provedor de DDEX.

using System;
using System.Data;
using System.Data.Common;
using Microsoft.VisualStudio.Data.Core;

public class DDEX_IVsDataSourceExample2
{
    public static string GetSourceDisplayName(
        IServiceProvider serviceProvider,
        IVsDataSource dataSource)
    {
        string displayName = null;
        string resourceId = null;
        Guid provider = dataSource.DefaultProvider;
        if (provider != Guid.Empty)
        {
            resourceId = dataSource.GetProperty(provider, "DisplayName") as string;
        }
        if (resourceId == null)
        {
            foreach (Guid providerId in dataSource.GetProviders())
            {
                resourceId = dataSource.GetProperty(
                    providerId, "DisplayName") as string;
                if (resourceId != null)
                {
                    provider = providerId;
                    break;
                }
            }
        }
        if (provider != Guid.Empty && resourceId != null)
        {
            IVsDataProviderManager providerManager = serviceProvider.GetService(
                typeof(IVsDataProviderManager)) as IVsDataProviderManager;
            IVsDataProvider dataProvider = providerManager.Providers[provider];
            displayName = dataProvider.GetString(resourceId);
        }
        return displayName;
    }
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.

Consulte também

Referência

IVsDataSource Interface

Namespace Microsoft.VisualStudio.Data.Core

Partilhar via