Share via


IVsTextMarkerClient Interface

Provides callbacks to the Visual Studio environment and other processes used to manipulate a text marker.

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

Syntax

'Declaration
<GuidAttribute("B1938F1B-D7A9-42F8-9960-D009027B3D2E")> _
<InterfaceTypeAttribute()> _
Public Interface IVsTextMarkerClient
[GuidAttribute("B1938F1B-D7A9-42F8-9960-D009027B3D2E")]
[InterfaceTypeAttribute()]
public interface IVsTextMarkerClient
[GuidAttribute(L"B1938F1B-D7A9-42F8-9960-D009027B3D2E")]
[InterfaceTypeAttribute()]
public interface class IVsTextMarkerClient
[<GuidAttribute("B1938F1B-D7A9-42F8-9960-D009027B3D2E")>]
[<InterfaceTypeAttribute()>]
type IVsTextMarkerClient =  interface end
public interface IVsTextMarkerClient

The IVsTextMarkerClient type exposes the following members.

Methods

  Name Description
Public method ExecMarkerCommand Executes a command on a specific marker within the text buffer.
Public method GetMarkerCommandInfo Queries the marker for the command information.
Public method GetTipText Returns the tip text for the text marker when the mouse hovers over the marker.
Public method MarkerInvalidated Called when the text associated with a marker is deleted by a user action.
Public method OnAfterMarkerChange Signals that the marker position has changed.
Public method OnAfterSpanReload Signals that the text under the marker has been altered but the marker has not been deleted.
Public method OnBeforeBufferClose Sends notification that the text buffer is about to close.
Public method OnBufferSave Determines whether the buffer was saved to a different name.

Top

Remarks

When creating a marker using either M:Microsoft.VisualStudio.TextManager.Interop.IVsTextLines.CreateLineMarker(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,Microsoft.VisualStudio.TextManager.Interop.IVsTextMarkerClient,Microsoft.VisualStudio.TextManager.Interop.IVsTextLineMarker[]) or CreateStreamMarker, you can provide a pointer to your implementation of IVsTextMarkerClient to be informed of changes to the newly-created marker. This allows you to provide enhanced marker behavior, such as tip text and command execution. You can also use this notification to produce a custom context menu over the marker by implementing the GetMarkerCommandInfo and ExecMarkerCommand methods.

Notes to Implementers

Implement this interface to be informed of changes to an individual marker.

Notes to Callers

Called by the text buffer when changes to a marker occur.

See Also

Reference

Microsoft.VisualStudio.TextManager.Interop Namespace