MarkerFormatDefinition Class

Definition

Namespace:

Microsoft.VisualStudio.Text.Classification

Assembly:

Microsoft.VisualStudio.Text.UI.Wpf.dll

Package:

Microsoft.VisualStudio.Text.UI.Wpf v17.12.215

Provides coloring information for text markers.

public ref class MarkerFormatDefinition abstract : Microsoft::VisualStudio::Text::Classification::EditorFormatDefinition

[Windows::Foundation::Metadata::WebHostHidden]
public ref class MarkerFormatDefinition abstract : Microsoft::VisualStudio::Text::Classification::EditorFormatDefinition

[Windows::Foundation::Metadata::WebHostHidden]
class MarkerFormatDefinition abstract : Microsoft::VisualStudio::Text::Classification::EditorFormatDefinition

public abstract class MarkerFormatDefinition : Microsoft.VisualStudio.Text.Classification.EditorFormatDefinition

type MarkerFormatDefinition = class
    inherit EditorFormatDefinition

Public MustInherit Class MarkerFormatDefinition
Inherits EditorFormatDefinition

Inheritance

Object

EditorFormatDefinition

MarkerFormatDefinition

Examples

[Export(typeof(EditorFormatDefinition))]
[Name("MarkerFormatDefinition/RedMarker")]
[UserVisible(true)]
private VisualStudioRedMarker : MarkerFormatDefinition
{
    VisualStudioRedMarker() 
    {
        this.BackgroundColor = Colors.Red;
        this.ForegroundColor = Colors.Blue;
        this.DisplayName = "Red Marker"; //this value should be localized
        this.ZOrder = 5;
    }
}

Remarks

This is a MEF component part, and should be exported as: [Export(typeof(EditorFormatDefinition))]

Exporters must provide the attribute NameAttribute.

The MarkerFormatDefinition is consumed by the default visual manager for the TextMarkerTag. The Type property should correspond to the NameAttribute of this export so that the desired color can be correctly loaded for the text marker.

If you wish your MarkerFormatDefinition to interact with Visual Studio, then set the UserVisibleAttribute on your export to true and make sure you set BackgroundColor and ForegroundColor. The foreground brush will be used to draw the border and the background brush will be used to draw the fill.

Constructors

MarkerFormatDefinition()

Initializes a new instance of MarkerFormatDefinition.

Fields

BackgroundBrushId	Defines the string used to look up the background brush value in the ResourceDictionary. (Inherited from EditorFormatDefinition)
BackgroundColorId	Defines the string used to look up the background color value in the ResourceDictionary. (Inherited from EditorFormatDefinition)
BorderId	Defines the string used to look up the border pen value in the ResourceDictionary.
FillId	Defines the string used to lookup the fill brush value in the ResourceDictionary.
ForegroundBrushId	Defines the string used to look up the foreground brush value in the ResourceDictionary. (Inherited from EditorFormatDefinition)
ForegroundColorId	Defines the string used to look up the foreground color value in the ResourceDictionary. (Inherited from EditorFormatDefinition)
ZOrderId	Defines the string used to lookup the z-order value in the ResourceDictionary.

Properties

BackgroundBrush	Gets or sets the background brush for this item. (Inherited from EditorFormatDefinition)
BackgroundColor	Gets or sets the background color for this item. (Inherited from EditorFormatDefinition)
BackgroundCustomizable	Determines whether the background of this format is customizable. (Inherited from EditorFormatDefinition)
Border	The pen is used to draw the border of the text marker.
DisplayName	Defines the string used when displaying this format definition to the user. This property is only used if the UserVisibleAttribute is set to true on this object's export. (Inherited from EditorFormatDefinition)
Fill	The brush is used to paint the inner body of the text marker.
ForegroundBrush	Gets or sets the foreground brush for this item. (Inherited from EditorFormatDefinition)
ForegroundColor	Gets or sets the foreground color for this item. (Inherited from EditorFormatDefinition)
ForegroundCustomizable	Determines whether the foreground of this format is customizable. (Inherited from EditorFormatDefinition)
ZOrder	The Z-Order is used as the Z-Order of the marker when it's drawn on the text marker adornment layer. This property can be used to specify in which order multiple markers should be drawn when they all overlap the same span of text.

Methods

CreateResourceDictionary()	Creates a ResourceDictionary from this definition. (Inherited from EditorFormatDefinition)
CreateResourceDictionaryFromDefinition()	Creates a ResourceDictionary using this definition.