IVsTextStreamMarker Interface

  • Article

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)

Syntax

'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("10D17872-91BA-4D65-80CC-E5FC3222AC82")> _
Public Interface IVsTextStreamMarker _
    Inherits IVsTextMarker

[InterfaceTypeAttribute()]
[GuidAttribute("10D17872-91BA-4D65-80CC-E5FC3222AC82")]
public interface IVsTextStreamMarker : IVsTextMarker

[InterfaceTypeAttribute()]
[GuidAttribute(L"10D17872-91BA-4D65-80CC-E5FC3222AC82")]
public interface class IVsTextStreamMarker : IVsTextMarker

[<InterfaceTypeAttribute()>]
[<GuidAttribute("10D17872-91BA-4D65-80CC-E5FC3222AC82")>]
type IVsTextStreamMarker =  
    interface
        interface IVsTextMarker
    end

public interface IVsTextStreamMarker extends IVsTextMarker

The IVsTextStreamMarker type exposes the following members.

Methods

  Name Description
Public method DrawGlyph Draws a glyph in the widget margin given a display context and bounding rectangle.
Public method ExecMarkerCommand Executes a text marker command against a marker.
Public method GetBehavior Returns a text marker behavior set by the SetBehavior method.
Public method GetCurrentSpan Returns current position information of the marker in the text stream.
Public method GetMarkerCommandInfo Returns text marker command information.
Public method GetPriorityIndex Returns the text marker priority index, with the highest value getting the topmost placement.
Public method GetStreamBuffer Provides access to the associated text buffer.
Public method GetTipText Returns the text to display in a tip for the marker type.
Public method GetType Returns a text marker type.
Public method GetVisualStyle Returns the visual style of a marker type.
Public method Invalidate Prevents a text marker from appearing in the user interface.
Public method ResetSpan Resets the position and extent of the text marker.
Public method SetBehavior Sets the behavior of a text marker.
Public method SetType Sets a text marker type.
Public method SetVisualStyle Sets the visual style of a marker type.
Public method UnadviseClient Unadvises the client, if there is one.

Top

Remarks

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

See Also

Reference

Microsoft.VisualStudio.TextManager.Interop Namespace