ViewFilter.GetDataTipText(TextSpan[], String) Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Gibt Text über die angegebene Spanne zurück, der in einer QuickInfo angezeigt werden kann.
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
Parameter
- aspan
- TextSpan[]
[in, out] Ein TextSpan-Objekt, das die Position im Code angibt, um Informationen darüber abzurufen, und gibt die Spanne zurück, die den Wertebereich des Bezeichners oder des Ausdrucks angibt, den der Text darstellt. Diese zurückgegebene Spanne gibt den Bereich an, in dem sich ein Mauscursor bewegen kann, bevor die QuickInfo geschlossen wird.
- textValue
- String
[out] Gibt eine Zeichenfolge zurück, die in einer QuickInfo angezeigt werden soll. Diese Zeichenfolge ist nur gültig, wenn ein Erfolgscode zurückgegeben wird.
Gibt zurück
Wenn die Ausführung erfolgreich ist, wird S_OK, andernfalls ein Fehlercode zurückgegeben. Da diese Methode einen Hintergrundanalysevorgang beginnen kann, ist ein typischer Fehlercode, der zurückgegeben werden kann, E_PENDING, wenn die Hintergrundanalyse noch nicht beendet wurde.
Implementiert
Hinweise
Diese Methode wird aufgerufen, um eine QuickInfo für eine ausgewählte Code Spanne bereitzustellen. Wenn diese Methode zurückgibt E_PENDING , wird diese Methode zu einem späteren Zeitpunkt erneut aufgerufen. Diese Methode sollte auch berücksichtigen, ob ein Debugger ausgeführt wird. in diesem Fall stellt der zurückgegebene Text in der Regel den Wert des ausgewählten Code Bereichs dar, der vom Debugger gemeldet wird. Wenn sich der Cursor z. b. über einer Variablen befindet, wertet der Debugger die Variable aus, um einen Wert zu erhalten, der angezeigt werden soll.
Diese Methode ist eine Implementierung der- GetDataTipText Methode für die- IVsTextViewFilter Schnittstelle.
Die Basis Methode führt keine Aktion aus, wenn die- EnableQuickInfo Eigenschaft zurückgegeben false wird oder gerade ein Analyse Vorgang ausgeführt wird. Andernfalls startet diese Methode entweder eine Hintergrundanalyse mit dem Grund QuickInfo oder gibt das Ergebnis einer vorherigen Analyse zurück. Wenn Text zurückgegeben werden kann, gibt die Basis Methode den Erfolgs Code zurück TIP_S_ONLYIFNOMARKER , um anzugeben, dass der Text angezeigt werden kann, aber Text aus beliebigen Fehlermarkierungen an derselben Position Vorrang hat.