Source::GetTipText Method (IVsHiddenRegion^, array<String^>^)

Visual Studio 2015

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

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

Syntax

C++

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

Parameters

region: Type: Microsoft.VisualStudio.TextManager.Interop::IVsHiddenRegion^
The IVsHiddenRegion object from which to obtain the text to display.

result: Type: array<System::String^>^
[out] Returns the text from the hidden region.

Return Value

Type: System::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.