Método ViewFilter.GetDataTipText

Artigo
10/26/2012

Retorna o texto sobre o trecho fornecido que pode ser mostrado em uma dica de ferramenta.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService (em Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (em Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (em Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (em Microsoft.VisualStudio.Package.LanguageService.11.0.dll)

Sintaxe

'Declaração
Public Overridable Function GetDataTipText ( _
    aspan As TextSpan(), _
    <OutAttribute> ByRef textValue As String _
) As Integer

public virtual int GetDataTipText(
    TextSpan[] aspan,
    out string textValue
)

Parâmetros

aspan
Tipo: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]
[in, out] A TextSpan objeto especificando o local no código para obter informações sobre e retorna a extensão que indica a extensão do identificador ou o texto da expressão representa.Desse intervalo retornado indica a área em que o cursor do mouse pode estar em antes que a dica de ferramenta é descartada.

textValue
Tipo: System.String%
[out] Retorna uma seqüência de caracteres a ser exibido em uma dica de ferramenta.Essa seqüência de caracteres é válida somente se um código de êxito é retornado.

Valor de retorno

Tipo: System.Int32
Se bem-sucedida, retorna S_OK; Caso contrário, retorna um código de erro.Desde que esse método pode iniciar uma operação de análise do plano de fundo, um código de erro típica que pode ser retornado é E_PENDING se a análise do plano de fundo ainda não terminou.

Implementações

IVsTextViewFilter.GetDataTipText(array<TextSpan[], String%)

Comentários

Este método é chamado para fornecer uma dica de ferramenta para um intervalo selecionado de código.Se esse método retorna E_PENDING, este método é chamado novamente mais tarde.Esse método também deve levar em conta esteja executando um depurador, neste caso, o texto retornado normalmente representa o valor do período selecionado de código, conforme relatado pelo depurador.Por exemplo, se o cursor estiver sobre uma variável, o depurador avalia a variável para obter um valor que será exibido.

Este método é uma implementação da GetDataTipText método na IVsTextViewFilter interface.

O método base não faz nada se a EnableQuickInfo propriedade retornará false ou há uma operação de análise em andamento.Caso contrário, este método ou inicia uma análise do plano de fundo com o motivo QuickInfo ou retorna o resultado de uma análise anterior.Se o texto pode ser retornado, o método base retorna o código de sucesso TIP_S_ONLYIFNOMARKER, para indicar o texto pode ser exibido, mas o texto de marcadores de qualquer erro no mesmo local têm precedência.

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áveis.

Consulte também

Referência

ViewFilter Classe

Namespace Microsoft.VisualStudio.Package

Partilhar via