Partager via


ViewFilter.GetDataTipText, méthode

Les retours texte sur l'étendue donnée qui peut être montrée dans une info-bulle.

Espace de noms :  Microsoft.VisualStudio.Package
Assemblys :   Microsoft.VisualStudio.Package.LanguageService (dans Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (dans Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (dans Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (dans Microsoft.VisualStudio.Package.LanguageService.11.0.dll)

Syntaxe

'Déclaration
Public Overridable Function GetDataTipText ( _
    aspan As TextSpan(), _
    <OutAttribute> ByRef textValue As String _
) As Integer
public virtual int GetDataTipText(
    TextSpan[] aspan,
    out string textValue
)

Paramètres

  • aspan
    Type : array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]
    [in, out] objet d'Un TextSpan spécifiant l'emplacement dans code pour obtenir des informations sur et des retours l'étendue indiquant l'étendue de l'identificateur ou de l'expression que que le texte représente.Cette étendue retournée indique la zone qu'qu'un curseur de la souris peut être dans alors que l'info-bulle est fermée.
  • textValue
    Type : System.String%
    [] retourne une chaîne à afficher dans une info-bulle.Cette chaîne est valide uniquement si code de réussite est retourné.

Valeur de retour

Type : System.Int32
Si réussi, retours S_OK ; sinon, retours code d'erreur.Étant donné que cette méthode peut commencer une opération d'analyse d'arrière-plan, code d'erreur ordinaire qui peut être retourné est E_PENDING si l'arrière-plan analysent n'a pas encore fini.

Implémentations

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

Remarques

Cette méthode est appelée pour fournir une info-bulle pour une plage sélectionnée de code.Si cette méthode retourne E_PENDING, cette méthode est appelée de nouveau à une date ultérieure.Cette méthode doit également prendre en compte si un débogueur exécute, dans ce cas, le texte retourné en général représente la valeur de l'étendue sélectionnée de code comme indiqué par le débogueur.Par exemple, si le curseur se trouve sur d'une variable, le débogueur évalue la variable pour obtenir une valeur qui doit être affichée.

Cette méthode est une implémentation de la méthode d'GetDataTipText sur l'interface d'IVsTextViewFilter.

La méthode de base ne fait rien si la propriété d'EnableQuickInfo retourne false ou qu'il existe une opération d'analyse actuellement en cours.Sinon, cette méthode commence un arrière-plan pour analyser avec la raison QuickInfo ou retourne le résultat d'un précédent analysent.Si le texte peut être retourné, la méthode de base retourne code de réussite TIP_S_ONLYIFNOMARKER, pour indiquer le texte peut être affichée mais le texte de toutes les marques d'erreurs au même emplacement ont la priorité.

Sécurité .NET Framework

Voir aussi

Référence

ViewFilter Classe

Microsoft.VisualStudio.Package, espace de noms