MarkerFormatDefinition Class

 

Provides coloring information for text markers.

Namespace:   Microsoft.VisualStudio.Text.Classification
Assembly:  Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)

System.Object
  Microsoft.VisualStudio.Text.Classification.EditorFormatDefinition
    Microsoft.VisualStudio.Text.Classification.MarkerFormatDefinition

public abstract class MarkerFormatDefinition : EditorFormatDefinition

NameDescription
System_CAPS_protmethodMarkerFormatDefinition()

Initializes a new instance of MarkerFormatDefinition.

NameDescription
System_CAPS_pubpropertyBackgroundBrush

Gets or sets the background brush for this item.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyBackgroundColor

Gets or sets the background color for this item.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyBackgroundCustomizable

Determines whether the background of this format is customizable.(Inherited from EditorFormatDefinition.)

System_CAPS_protpropertyBorder

The pen is used to draw the border of the text marker.

System_CAPS_pubpropertyDisplayName

Defines the string used when displaying this format definition to the user. This property is used only if the UserVisibleAttribute is set to true on this object's export.(Inherited from EditorFormatDefinition.)

System_CAPS_protpropertyFill

The brush is used to paint the inner body of the text marker.

System_CAPS_pubpropertyForegroundBrush

Gets or sets the foreground brush for this item.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyForegroundColor

Gets or sets the foreground color for this item.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyForegroundCustomizable

Determines whether the foreground of this format is customizable.(Inherited from EditorFormatDefinition.)

System_CAPS_protpropertyZOrder

Represents the Z-order of the marker when it is drawn on the text marker adornment layer.

NameDescription
System_CAPS_pubmethodCreateResourceDictionary()

Creates a ResourceDictionary from this definition.(Inherited from EditorFormatDefinition.)

System_CAPS_protmethodCreateResourceDictionaryFromDefinition()
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticBorderId

The string used to look up the border pen value in the ResourceDictionary.

System_CAPS_pubfieldSystem_CAPS_staticFillId

The string used to lookup the fill brush value in the ResourceDictionary.

System_CAPS_pubfieldSystem_CAPS_staticZOrderId

The string used to lookup the z-order value in the ResourceDictionary.

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.

For an example of creating a marker format definition, see Walkthrough: Highlighting Text.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: