AuthoringScope.GetDataTipText(Int32, Int32, TextSpan) Méthode

Définition

Retourne une chaîne à utiliser pour une info-bulle à l'emplacement spécifié.

public:
 abstract System::String ^ GetDataTipText(int line, int col, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::TextSpan % span);
public:
 abstract Platform::String ^ GetDataTipText(int line, int col, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::TextSpan &  span);
 abstract std::wstring GetDataTipText(int line, int col, [Runtime::InteropServices::Out] Microsoft::VisualStudio::TextManager::Interop::TextSpan & span);
public abstract string GetDataTipText (int line, int col, out Microsoft.VisualStudio.TextManager.Interop.TextSpan span);
abstract member GetDataTipText : int * int * TextSpan -> string
Public MustOverride Function GetDataTipText (line As Integer, col As Integer, ByRef span As TextSpan) As String

Paramètres

line
Int32

[in] Ligne de la source à examiner pour une info-bulle.

col
Int32

[in] Offset dans le paramètre line à examiner pour une info-bulle.

span
TextSpan

TextSpan qui décrit la zone sur laquelle le curseur peut être placé avant que l'info-bulle ne soit fermée.

Retours

String

En cas de réussite, retourne une chaîne contenant le texte de l'info-bulle ; sinon, retourne une valeur Null.

Remarques

Cette méthode doit être implémentée dans une classe dérivée de la AuthoringScope classe.

Cette méthode retourne une chaîne à utiliser comme info-bulle lorsque l’utilisateur sélectionne Info Express avec le signe insertion positionné ou maintient le curseur sur un morceau de code intéressant. Cette méthode est généralement appelée après l’exécution d’une analyse avec la raison QuickInfo . Une fois l’analyse terminée, le texte retourné par cette méthode est affiché dans une info-bulle.

Dans l’implémentation de Managed package Framework (MPF) par défaut, la GetDataTipText méthode de la ViewFilter classe est appelée lorsque l’utilisateur maintient le curseur sur un point suffisamment long pour déclencher un événement d’info-bulle. Si EnableQuickInfo retourne la valeur true, GetDataTipText commence une analyse en arrière-plan si aucune donnée n’est encore disponible. Sinon, la GetDataTipText méthode appelle la ViewFilter méthode de classe, GetFullDataTipText qui recherche une session de débogage active et si le débogage est actif, le texte retourné par le débogueur pour une info-bulle est ajouté au texte retourné par la GetDataTipText méthode.

Cette méthode est également appelée lorsque l’utilisateur sélectionne Info Express. Dans ce cas, l’implémentation MPF par défaut appelle la ViewFilter méthode de classe HandleQuickInfo qui, à son tour, appelle la Source méthode de classe, <xref:Microsoft.VisualStudio.Package.Source.OnSyncQuickInfo%2A> , qui à son tour exécute la demande d’analyse avec la raison QuickInfo . La GetDataTipText méthode est ensuite appelée pour récupérer le texte de données qui est ensuite ajouté à tout texte retourné à partir d’une session de débogage active et enfin affiché.

S’applique à