IVsHiddenTextSession.AddHiddenRegions Method

Article
05/06/2010

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

'Déclaration
Function AddHiddenRegions ( _
    dwUpdateFlags As UInteger, _
    cRegions As Integer, _
    rgHidReg As NewHiddenRegion(), _
    <OutAttribute> ppEnum As IVsEnumHiddenRegions() _
) As Integer
'Utilisation
Dim instance As IVsHiddenTextSession
Dim dwUpdateFlags As UInteger
Dim cRegions As Integer
Dim rgHidReg As NewHiddenRegion()
Dim ppEnum As IVsEnumHiddenRegions()
Dim returnValue As Integer

returnValue = instance.AddHiddenRegions(dwUpdateFlags, _
    cRegions, rgHidReg, ppEnum)

int AddHiddenRegions(
    uint dwUpdateFlags,
    int cRegions,
    NewHiddenRegion[] rgHidReg,
    IVsEnumHiddenRegions[] ppEnum
)

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

abstract AddHiddenRegions : 
        dwUpdateFlags:uint32 * 
        cRegions:int * 
        rgHidReg:NewHiddenRegion[] * 
        ppEnum:IVsEnumHiddenRegions[] byref -> int

function AddHiddenRegions(
    dwUpdateFlags : uint, 
    cRegions : int, 
    rgHidReg : NewHiddenRegion[], 
    ppEnum : IVsEnumHiddenRegions[]
) : int

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:

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via