IVsHiddenTextClient Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides notification of changes to a newly created hidden text session.

public interface class IVsHiddenTextClient

public interface class IVsHiddenTextClient

__interface IVsHiddenTextClient

[System.Runtime.InteropServices.Guid("CA3F0E7F-CFA6-444E-A3FE-7B3DFAD6E5E4")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsHiddenTextClient

[System.Runtime.InteropServices.Guid("CA3F0E7F-CFA6-444E-A3FE-7B3DFAD6E5E4")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsHiddenTextClient

[<System.Runtime.InteropServices.Guid("CA3F0E7F-CFA6-444E-A3FE-7B3DFAD6E5E4")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsHiddenTextClient = interface

[<System.Runtime.InteropServices.Guid("CA3F0E7F-CFA6-444E-A3FE-7B3DFAD6E5E4")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsHiddenTextClient = interface

Public Interface IVsHiddenTextClient

Derived: Microsoft.VisualStudio.Package.Source

Attributes: GuidAttribute InterfaceTypeAttribute

Remarks

If you create your own hidden text session, then you can implement IVsHiddenTextClient. This interface provides notification when the user expands and collapses hidden text regions, and so on. This allows you to implement specific actions for your language service in response to user action.

Notes to Implementers

Implement this interface to receive notification of user actions that affect hidden text regions within the text buffer. If a hidden text session already exists for the text buffer, that is, a call to GetHiddenTextSession(Object, IVsHiddenTextSession) returns a pointer to IVsHiddenTextSession, then you cannot specify a hidden text client.

However, if a hidden text session does not exist for the text buffer, then you can pass in a pointer to your hidden text client when you create a new hidden text session by calling CreateHiddenTextSession(UInt32, Object, IVsHiddenTextClient, IVsHiddenTextSession).

Methods

ExecMarkerCommand(IVsHiddenRegion, Int32)	Executes a text marker command against a marker.
GetMarkerCommandInfo(IVsHiddenRegion, Int32, String[], UInt32[])	Returns marker command information.
GetTipText(IVsHiddenRegion, String[])	Signals that the user has hovered the mouse over a collapsed hidden text region.
MakeBaseSpanVisible(IVsHiddenRegion, TextSpan[])	Called when a particular hidden region needs to be displayed.
OnBeforeSessionEnd()	Called before the hidden text session is terminated.
OnHiddenRegionChange(IVsHiddenRegion, HIDDEN_REGION_EVENT, Int32)	Called when the user expands or collapses a hidden region.

Applies to