IVsHiddenTextClient::MakeBaseSpanVisible Method (IVsHiddenRegion^, array<TextSpan>^)

Visual Studio 2015

Called when a particular hidden region needs to be displayed.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

C++

int MakeBaseSpanVisible(
	IVsHiddenRegion^ pHidReg,
	array<TextSpan>^ pBaseSpan
)

Parameters

pHidReg: Type: Microsoft.VisualStudio.TextManager.Interop::IVsHiddenRegion^
[in] Pointer to a hidden region object, IVsHiddenRegion

pBaseSpan: Type: array<Microsoft.VisualStudio.TextManager.Interop::TextSpan>^
[in] Pointer to a base span object. For more information, see TextSpan .

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

C++

HRESULT IVsHiddenTextClient::MakeBaseSpanVisible(
   [in] IVsHiddenRegion *pHidReg, 
   [in] TextSpan *pBaseSpan
);

This method is called when the text within a hidden region should be exposed. If the user does something that requires a piece of hidden text to be visible (for example, Goto line command, debugger stepping, find in files hit, and so on) then the environment calls this method for regions that the hidden text manager cannot automatically make visible. In the current implementation this will only happen for concealed regions; collapsible regions will be automatically expanded.

Note
When this method is called, the client must expose the text in the specified hidden region. The client must either destroy the hidden region by calling Invalidate or reset the hidden region's range so that it no longer includes the required text. It is acceptable to add or remove other regions when this method is called.