IVsTextStreamMarker Interface

Definition

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.

public interface class IVsTextStreamMarker : Microsoft::VisualStudio::TextManager::Interop::IVsTextMarker
public interface class IVsTextStreamMarker : Microsoft::VisualStudio::TextManager::Interop::IVsTextMarker
__interface IVsTextStreamMarker : Microsoft::VisualStudio::TextManager::Interop::IVsTextMarker
[System.Runtime.InteropServices.Guid("10D17872-91BA-4D65-80CC-E5FC3222AC82")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsTextStreamMarker : Microsoft.VisualStudio.TextManager.Interop.IVsTextMarker
[System.Runtime.InteropServices.Guid("10D17872-91BA-4D65-80CC-E5FC3222AC82")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsTextStreamMarker : Microsoft.VisualStudio.TextManager.Interop.IVsTextMarker
[<System.Runtime.InteropServices.Guid("10D17872-91BA-4D65-80CC-E5FC3222AC82")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsTextStreamMarker = interface
    interface IVsTextMarker
[<System.Runtime.InteropServices.Guid("10D17872-91BA-4D65-80CC-E5FC3222AC82")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsTextStreamMarker = interface
    interface IVsTextMarker
Public Interface IVsTextStreamMarker
Implements IVsTextMarker
Attributes
Implements

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

Methods

DrawGlyph(IntPtr, RECT[])

Draws a glyph in the widget margin given a display context and bounding rectangle.

ExecMarkerCommand(Int32)

Executes a text marker command against a marker.

GetBehavior(UInt32)

Returns a text marker behavior set by the SetBehavior(UInt32) method.

GetCurrentSpan(Int32, Int32)

Returns current position information of the marker in the text stream.

GetMarkerCommandInfo(Int32, String[], UInt32[])

Returns text marker command information.

GetPriorityIndex(Int32)

Returns the text marker priority index, with the highest value getting the topmost placement.

GetStreamBuffer(IVsTextStream)

Provides access to the associated text buffer.

GetTipText(String[])

Returns the text to display in a tip for the marker type.

GetType(Int32)

Returns a text marker type.

GetVisualStyle(UInt32)

Returns the visual style of a marker type.

Invalidate()

Prevents a text marker from appearing in the user interface.

ResetSpan(Int32, Int32)

Resets the position and extent of the text marker.

SetBehavior(UInt32)

Sets the behavior of a text marker.

SetType(Int32)

Sets a text marker type.

SetVisualStyle(UInt32)

Sets the visual style of a marker type.

UnadviseClient()

Unadvises the client, if there is one.

Applies to