ViewFilter.GetDataTipText(TextSpan[], String) Método

Definição

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

public:
 virtual int GetDataTipText(cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ aspan, [Runtime::InteropServices::Out] System::String ^ % textValue);
 virtual int GetDataTipText(std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & aspan, [Runtime::InteropServices::Out] std::wstring const & & textValue);
public virtual int GetDataTipText (Microsoft.VisualStudio.TextManager.Interop.TextSpan[] aspan, out string textValue);
abstract member GetDataTipText : Microsoft.VisualStudio.TextManager.Interop.TextSpan[] * string -> int
override this.GetDataTipText : Microsoft.VisualStudio.TextManager.Interop.TextSpan[] * string -> int
Public Overridable Function GetDataTipText (aspan As TextSpan(), ByRef textValue As String) As Integer

Parâmetros

aspan
TextSpan[]

[entrada, saída] Um TextSpan objeto que especifica o local no código para obter informações e retorna o intervalo indicando a extensão do identificador ou expressão que o texto representa. Esse intervalo retornado indica a área com que um cursor do mouse pode estar antes que a dica de ferramenta seja ignorada.

textValue
String

fora Retorna uma cadeia de caracteres a ser exibida em uma dica de ferramenta. Essa cadeia de caracteres será válida somente se um código de êxito for retornado.

Retornos

Int32

Se bem-sucedido, retorna S_OK ; caso contrário, retorna um código de erro. Como esse método pode iniciar uma operação de análise em segundo plano, um código de erro típico que pode ser retornado é E_PENDING se a análise em segundo plano ainda não tiver sido concluída.

Implementações

Comentários

Esse método é chamado para fornecer uma dica de ferramenta para um trecho de código selecionado. Se esse método retornar E_PENDING , esse método será chamado novamente mais tarde. Esse método também deve levar em conta se um depurador está em execução; nesse caso, o texto retornado normalmente representa o valor do trecho de código selecionado, conforme relatado pelo depurador. Por exemplo, se o cursor estiver sobre uma variável, o depurador avaliará a variável para obter um valor a ser exibido.

Esse método é uma implementação do GetDataTipText método na IVsTextViewFilter interface.

O método base não fará nada se a EnableQuickInfo Propriedade retornar false ou se houver uma operação de análise atualmente em andamento. Caso contrário, esse método inicia uma análise em segundo plano com o motivo QuickInfo ou retorna o resultado de uma análise anterior. Se o texto puder ser retornado, o método base retornará o código de êxito TIP_S_ONLYIFNOMARKER para indicar que o texto pode ser exibido, mas o texto de quaisquer marcadores de erro no mesmo local terá precedência.

Aplica-se a