ViewFilter.GetDataTipText(TextSpan[], String) Метод

Определение

Возвращает текст о заданном диапазоне, который может отображаться в подсказке.

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

Параметры

aspan
TextSpan[]

[in, out] Объект TextSpan, указывающий расположение в коде для получения сведений и возвращающий диапазон, указывающий область идентификатора или выражения, которое представлено текстом. Этот возвращаемый диапазон указывает область, где может быть курсор мыши до появления всплывающая подсказка.

textValue
String

[out] Возвращает строку для отображения в подсказке. Эта строка допустима, только если код успеха возвращен.

Возвращаемое значение

Int32

Возвращает значение S_OK, если выполнение прошло успешно; в противном случае возвращает код ошибки. Поскольку этот метод может инициировать фоновую операция синтаксический анализ, типичный код ошибки, который могут возвратить — E_PENDING если фоновый анализ еще не завершился.

Реализации

Комментарии

Этот метод вызывается, чтобы предоставить всплывающую подсказку для выбранного фрагмента кода. Если этот метод возвращает E_PENDING , этот метод вызывается снова в дальнейшем. Этот метод также должен учитывать, выполняется ли отладчик. в этом случае возвращаемый текст обычно представляет значение выбранного фрагмента кода, сообщаемое отладчиком. Например, если курсор находится над переменной, отладчик вычисляет переменную, чтобы получить отображаемое значение.

Этот метод является реализацией GetDataTipText метода в IVsTextViewFilter интерфейсе.

Базовый метод не выполняет никаких действий, если EnableQuickInfo свойство возвращает значение false или в данный момент выполняется операция анализа. В противном случае этот метод либо запускает фоновый анализ по причине, QuickInfo либо возвращает результат предыдущего синтаксического анализа. Если текст может быть возвращен, базовый метод возвращает код успешного выполнения TIP_S_ONLYIFNOMARKER , чтобы указать, что текст может быть отображен, а текст из всех маркеров ошибок в том же расположении имеет приоритет.

Применяется к