IVsPackageDefinedTextMarkerType Interface

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.TextManager.Interop
Assembly:
Microsoft.VisualStudio.TextManager.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll

Describes how a custom marker type behaves and appears to the user.

public interface class IVsPackageDefinedTextMarkerType
public interface class IVsPackageDefinedTextMarkerType
__interface IVsPackageDefinedTextMarkerType
[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("C70F1528-1A66-403F-AD42-F60F9D413E05")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsPackageDefinedTextMarkerType
[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.Guid("C70F1528-1A66-403F-AD42-F60F9D413E05")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsPackageDefinedTextMarkerType
[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("C70F1528-1A66-403F-AD42-F60F9D413E05")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsPackageDefinedTextMarkerType = interface
[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.Guid("C70F1528-1A66-403F-AD42-F60F9D413E05")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsPackageDefinedTextMarkerType = interface
Public Interface IVsPackageDefinedTextMarkerType
Attributes
ComConversionLossAttribute GuidAttribute InterfaceTypeAttribute

Remarks

Implement this interface to provide a custom marker type. You must also implement IVsMergeableUIItem at the same time. In some cases, an exception can occur when a class implements IVsPackageDefinedTextMarkerType without also implementing IVsMergeableUIItem.

This interface allows you to specify marker behavior for a custom marker type. You can still change certain marker attributes using the IVsTextMarker interface (SetBehavior), SetVisualStyle, and so on) as well as by supplying an IVsTextMarkerClient when you create a marker.

Implement IVsPackageDefinedTextMarkerType to describe how a given marker behaves and appears to the user. The environment calls the methods of IVsPackageDefinedTextMarkerType when the user starts the IDE for the first time, then in the Tools / Options / Environment / Fonts and Colors dialog clicks the Use Defaults button.

Methods

DrawGlyphWithColors(IntPtr, RECT[], Int32, IVsTextMarkerColorSet, UInt32, Int32)

Draws a glyph in the given display context and bounding rectangle using the provided colors.
GetBehaviorFlags(UInt32)

Controls how the marker tracks text when edits occur.
GetDefaultColors(COLORINDEX[], COLORINDEX[])

Returns the default foreground and background colors for a marker.
GetDefaultFontFlags(UInt32)

Specifies additional modifications to text appearance determined by the marker.
GetDefaultLineStyle(COLORINDEX[], LINESTYLE[])

Returns the default line attributes for a custom marker type.
GetPriorityIndex(Int32)

Returns the priority index for the custom marker type, with the highest priority value receiving the topmost placement.
GetVisualStyle(UInt32)

Returns the appearance, location, and coloring of a custom marker type as a bit filed.

Applies to