IVsTextLineMarker Interface

  • Article

Provides access to and manipulates the positioning of a text marker within a buffer. This interface has methods to retrieve or change two-dimensional coordinates.

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

Syntax

'Declaration
<GuidAttribute("31E2DCA7-CCFF-4E09-B433-17C739CF69AD")> _
<InterfaceTypeAttribute()> _
Public Interface IVsTextLineMarker _
    Inherits IVsTextMarker

[GuidAttribute("31E2DCA7-CCFF-4E09-B433-17C739CF69AD")]
[InterfaceTypeAttribute()]
public interface IVsTextLineMarker : IVsTextMarker

[GuidAttribute(L"31E2DCA7-CCFF-4E09-B433-17C739CF69AD")]
[InterfaceTypeAttribute()]
public interface class IVsTextLineMarker : IVsTextMarker

[<GuidAttribute("31E2DCA7-CCFF-4E09-B433-17C739CF69AD")>]
[<InterfaceTypeAttribute()>]
type IVsTextLineMarker =  
    interface 
        interface IVsTextMarker 
    end

public interface IVsTextLineMarker extends IVsTextMarker

The IVsTextLineMarker 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 against a text marker.
Public method GetBehavior Returns a text marker behavior set by the SetBehavior method.
Public method GetCurrentSpan Returns the current position of the text marker.
Public method GetLineBuffer Provides access to an associated text buffer.
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 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 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 CreateLineMarker method. The IVsTextLineMarker interface differs from IVsTextStreamMarker in that it uses two-dimensional [line, index] coordinates rather one-dimensional linear coordinates. However, IVsTextLineMarker and IVsTextStreamMarker are both implemented by the same underlying object and you can call the IUnknown::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 Visual Studio text markers.

Notes to Callers

Called by VSPackages (or any text buffer client).

See Also

Reference

Microsoft.VisualStudio.TextManager.Interop Namespace