Source.GetTipText(IVsHiddenRegion, String[]) Method

Definition

Namespace:

Microsoft.VisualStudio.Package

Assembly:

Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:

Microsoft.VisualStudio.Package.LanguageService.15.0 v17.11.40262

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

public:
 virtual int GetTipText(Microsoft::VisualStudio::TextManager::Interop::IVsHiddenRegion ^ region, cli::array <System::String ^> ^ result);

public:
 virtual int GetTipText(Microsoft::VisualStudio::TextManager::Interop::IVsHiddenRegion ^ region, Platform::Array <Platform::String ^> ^ result);

 virtual int GetTipText(Microsoft::VisualStudio::TextManager::Interop::IVsHiddenRegion const & region, std::Array <std::wstring const &> const & result);

public virtual int GetTipText (Microsoft.VisualStudio.TextManager.Interop.IVsHiddenRegion region, string[] result);

abstract member GetTipText : Microsoft.VisualStudio.TextManager.Interop.IVsHiddenRegion * string[] -> int
override this.GetTipText : Microsoft.VisualStudio.TextManager.Interop.IVsHiddenRegion * string[] -> int

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

Parameters

region

IVsHiddenRegion

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

result

String[]

[out] Returns the text from the hidden region.

Returns

Int32

If successful, returns S_OK; otherwise, returns an error code.

Implements

GetTipText(IVsHiddenRegion, 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 in a Legacy Language Service for more information about hidden regions.