Export (0) Print
Expand All

IVsTextStreamMarker Interface

Provides access to and manipulates the position of a text marker in the text buffer. This interface has methods to retrieve of change one-dimensional, streaming coordinates.

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

public interface IVsTextStreamMarker : IVsTextMarker

The IVsTextStreamMarker type exposes the following members.

Public methodDrawGlyphDraws a glyph in the widget margin given a display context and bounding rectangle.
Public methodExecMarkerCommandExecutes a text marker command against a marker.
Public methodGetBehaviorReturns a text marker behavior set by the SetBehavior method.
Public methodGetCurrentSpanReturns current position information of the marker in the text stream.
Public methodGetMarkerCommandInfoReturns text marker command information.
Public methodGetPriorityIndexReturns the text marker priority index, with the highest value getting the topmost placement.
Public methodGetStreamBufferProvides access to the associated text buffer.
Public methodGetTipTextReturns the text to display in a tip for the marker type.
Public methodGetTypeReturns a text marker type.
Public methodGetVisualStyleReturns the visual style of a marker type.
Public methodInvalidatePrevents a text marker from appearing in the user interface.
Public methodResetSpanResets the position and extent of the text marker.
Public methodSetBehaviorSets the behavior of a text marker.
Public methodSetTypeSets a text marker type.
Public methodSetVisualStyleSets the visual style of a marker type.
Public methodUnadviseClientUnadvises the client, if there is one.

This interface represents the marker itself. The marker is created by calling the CreateStreamMarker method. The IVsTextStreamMarker interface differs from IVsTextLineMarker in that it uses one-dimensional linear coordinates rather two-dimensional [line, index] coordinates. However, IVsTextLineMarker and IVsTextStreamMarker are both implemented by the same underlying object and you can call the QueryInterface method between them.

A marker floats over the text region specified when it is created. If the text is deleted, the marker is deleted. If the text grows or shrinks, the marker grows or shrinks accordingly.

Notes to Implementers

Implemented by the text marker.

Notes to Callers

Called by VSPackages (or any text buffer client).

© 2014 Microsoft