Share via


IVsHiddenTextClient Interface

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

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

Syntax

'Declaration
<GuidAttribute("CA3F0E7F-CFA6-444E-A3FE-7B3DFAD6E5E4")> _
<InterfaceTypeAttribute()> _
Public Interface IVsHiddenTextClient
[GuidAttribute("CA3F0E7F-CFA6-444E-A3FE-7B3DFAD6E5E4")]
[InterfaceTypeAttribute()]
public interface IVsHiddenTextClient
[GuidAttribute(L"CA3F0E7F-CFA6-444E-A3FE-7B3DFAD6E5E4")]
[InterfaceTypeAttribute()]
public interface class IVsHiddenTextClient
[<GuidAttribute("CA3F0E7F-CFA6-444E-A3FE-7B3DFAD6E5E4")>]
[<InterfaceTypeAttribute()>]
type IVsHiddenTextClient =  interface end
public interface IVsHiddenTextClient

The IVsHiddenTextClient type exposes the following members.

Methods

  Name Description
Public method ExecMarkerCommand Executes a text marker command against a marker.
Public method GetMarkerCommandInfo Returns marker command information.
Public method GetTipText Signals that the user has hovered the mouse over a collapsed hidden text region.
Public method MakeBaseSpanVisible Called when a particular hidden region needs to be displayed.
Public method OnBeforeSessionEnd Called before the hidden text session is terminated.
Public method OnHiddenRegionChange Called when the user expands or collapses a hidden region.

Top

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 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.

See Also

Reference

Microsoft.VisualStudio.TextManager.Interop Namespace