IVsHiddenRegion Interface

 

Manages the hidden region.

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

[InterfaceTypeAttribute(1)]
[GuidAttribute("41E57382-63F9-48E6-9DBD-163D2B14D41B")]
public interface IVsHiddenRegion

NameDescription
System_CAPS_pubmethodGetBanner(String)

Returns the banner for the hidden region.

System_CAPS_pubmethodGetBaseBuffer(IVsTextLines)

Provides a pointer to the text buffer from the hidden region.

System_CAPS_pubmethodGetBehavior(UInt32)

Returns the hidden region behavior, that is, client-controlled or editor-controlled.

System_CAPS_pubmethodGetClientData(UInt32)

Returns the client data for the hidden region.

System_CAPS_pubmethodGetSpan(TextSpan[])

Returns the text span of the hidden region in the text buffer.

System_CAPS_pubmethodGetState(UInt32)

Returns the state of the hidden region.

System_CAPS_pubmethodGetType(Int32)

Returns the hidden region type (that is, concealed or collapsible).

System_CAPS_pubmethodInvalidate(UInt32)

Removes the hidden region and exposes the hidden text in the normal view.

System_CAPS_pubmethodIsValid()

Determines whether the hidden region is valid.

System_CAPS_pubmethodSetBanner(String)

Sets the banner for the hidden region.

System_CAPS_pubmethodSetClientData(UInt32)

Sets the client data for the hidden region.

System_CAPS_pubmethodSetSpan(TextSpan[])

Sets the text span of the hidden region in the text buffer.

System_CAPS_pubmethodSetState(UInt32, UInt32)

Sets the state of the hidden region.

This interface represents a part of the buffer that has been hidden. Using the IVsHiddenRegion interface, you can move a hidden region, change its state (for example, collapsed or expanded), or remove it.

Notes to Callers:

Call this interface to manage the properties of a hidden region. The environment provides a pointer to IVsHiddenRegion in calls to your hidden text client (IVsHiddenTextClient object). You can only specify a hidden text client if you create a new hidden text session (CreateHiddenTextSession).

Return to top
Show: