Source.GetTipText Method

Gets the text in the given hidden region to be used in a tool tip.

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)

Syntax

'Declaration
Public Overridable Function GetTipText ( _
    region As IVsHiddenRegion, _
    result As String() _
) As Integer

public virtual int GetTipText(
    IVsHiddenRegion region,
    string[] result
)

public:
virtual int GetTipText(
    IVsHiddenRegion^ region, 
    array<String^>^ result
)

abstract GetTipText : 
        region:IVsHiddenRegion * 
        result:string[] -> int  
override GetTipText : 
        region:IVsHiddenRegion * 
        result:string[] -> int

public function GetTipText(
    region : IVsHiddenRegion, 
    result : String[]
) : int

Parameters

• region
  Type: Microsoft.VisualStudio.TextManager.Interop.IVsHiddenRegion

  The IVsHiddenRegion object from which to obtain the text to display.

• result
  Type: array<String[]

  [out] Returns the text from the hidden region.

Return Value

Type: Int32
If successful, returns S_OK; otherwise, returns an error code.

Implements

IVsHiddenTextClient.GetTipText(IVsHiddenRegion, array<String[])

Remarks

This method is called whenever a user holds the mouse cursor over a hidden text region that is collapsed. The resulting tool tip shows the text that is hidden.

This method is an implementation of the method GetTipText on the IVsHiddenTextClient interface.

The base method gets the span from the given hidden region and returns the text from the source encompassed by the span.

See Outlining (Managed Package Framework) for more information about hidden regions.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Source Class

Microsoft.VisualStudio.Package Namespace

Other Resources

Outlining (Managed Package Framework)