IVsHiddenTextSession.AddHiddenRegions Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Adds a new hidden region to the text buffer.

public:
 int AddHiddenRegions(System::UInt32 dwUpdateFlags, int cRegions, cli::array <Microsoft::VisualStudio::TextManager::Interop::NewHiddenRegion> ^ rgHidReg, cli::array <Microsoft::VisualStudio::TextManager::Interop::IVsEnumHiddenRegions ^> ^ ppEnum);

int AddHiddenRegions(unsigned int dwUpdateFlags, int cRegions, std::Array <Microsoft::VisualStudio::TextManager::Interop::NewHiddenRegion> const & rgHidReg, std::Array <Microsoft::VisualStudio::TextManager::Interop::IVsEnumHiddenRegions const &> const & ppEnum);

public int AddHiddenRegions (uint dwUpdateFlags, int cRegions, Microsoft.VisualStudio.TextManager.Interop.NewHiddenRegion[] rgHidReg, Microsoft.VisualStudio.TextManager.Interop.IVsEnumHiddenRegions[] ppEnum);

abstract member AddHiddenRegions : uint32 * int * Microsoft.VisualStudio.TextManager.Interop.NewHiddenRegion[] * Microsoft.VisualStudio.TextManager.Interop.IVsEnumHiddenRegions[] -> int

Public Function AddHiddenRegions (dwUpdateFlags As UInteger, cRegions As Integer, rgHidReg As NewHiddenRegion(), ppEnum As IVsEnumHiddenRegions()) As Integer

Parameters

dwUpdateFlags

UInt32

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

cRegions

Int32

[in] Number of hidden regions to add to the text buffer.

rgHidReg

NewHiddenRegion[]

[in, size_is (cRegions)] Caller-allocated array of outlining regions to add. For more information, see NewHiddenRegion.

ppEnum

IVsEnumHiddenRegions[]

[out] Pointer to an IVsEnumHiddenRegions object that can be used to enumerate the hidden regions in the text buffer.

Returns

Int32

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

Remarks

COM Signature

From textmgr.idl:

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