IVsHiddenTextSession::AddHiddenRegions Method (UInt32, Int32, array<NewHiddenRegion>^, array<IVsEnumHiddenRegions^>^)

Visual Studio 2015

Adds a new hidden region to the text buffer.

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

Syntax

C++

int AddHiddenRegions(
	unsigned int dwUpdateFlags,
	int cRegions,
	array<NewHiddenRegion>^ rgHidReg,
	array<IVsEnumHiddenRegions^>^ ppEnum
)

Parameters

dwUpdateFlags: Type: System::UInt32
[in] Specifies whether the hidden region is added to the Undo/Redo stack. For more information, see CHANGE_HIDDEN_REGION_FLAGS

cRegions: Type: System::Int32
[in] Number of hidden regions to add to the text buffer.

rgHidReg: Type: array<Microsoft.VisualStudio.TextManager.Interop::NewHiddenRegion>^
[in, size_is (cRegions)] Caller-allocated array of outlining regions to add. For more information, see NewHiddenRegion.

ppEnum: Type: array<Microsoft.VisualStudio.TextManager.Interop::IVsEnumHiddenRegions^>^
[out] Pointer to an IVsEnumHiddenRegions object that can be used to enumerate the hidden regions in the text buffer.

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 IVsHiddenTextSession::AddHiddenRegions(
   [in] DWORD dwUpdateFlags, 
   [in] long cRegions, 
   [in, size_is(cRegions)] NewHiddenRegion *rgHidReg, 
   [out] IVsEnumHiddenRegions **ppEnum
);

Call AddHiddenRegions to add a new outline or hidden region to the specified span of text.

When you create a new region using this method, you can specify whether the region can participate in Undo/Redo (dwUpdateFlags parameter), and the number of regions to create.
Additionally, in the rgHidReg parameter, you can specify properties of the region including the type (hidden or outlining), the behavior (editor- or client-controlled), the state (expanded or collapsed), the banner text shown when the region is collapsed, and you can additionally identify a specific cookie that you can use to reference hidden regions or a specific type in methods such as EnumHiddenRegions