MarkerFormatDefinition Class

Provides coloring information for text markers.

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

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

'Declaration
Public MustInherit Class MarkerFormatDefinition _
	Inherits EditorFormatDefinition

The MarkerFormatDefinition type exposes the following members.

  NameDescription
Protected methodMarkerFormatDefinitionInitializes a new instance of MarkerFormatDefinition.
Top

  NameDescription
Public propertyBackgroundBrushGets or sets the background brush for this item. (Inherited from EditorFormatDefinition.)
Public propertyBackgroundColorGets or sets the background color for this item. (Inherited from EditorFormatDefinition.)
Public propertyBackgroundCustomizableDetermines whether the background of this format is customizable. (Inherited from EditorFormatDefinition.)
Protected propertyBorderThe pen is used to draw the border of the text marker.
Public propertyDisplayNameDefines 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.)
Protected propertyFillThe brush is used to paint the inner body of the text marker.
Public propertyForegroundBrushGets or sets the foreground brush for this item. (Inherited from EditorFormatDefinition.)
Public propertyForegroundColorGets or sets the foreground color for this item. (Inherited from EditorFormatDefinition.)
Public propertyForegroundCustomizableDetermines whether the foreground of this format is customizable. (Inherited from EditorFormatDefinition.)
Protected propertyZOrderRepresents the Z-order of the marker when it is drawn on the text marker adornment layer.
Top

  NameDescription
Public methodCreateResourceDictionaryCreates a ResourceDictionary from this definition. (Inherited from EditorFormatDefinition.)
Protected methodCreateResourceDictionaryFromDefinitionCreates a ResourceDictionary using this definition. (Overrides EditorFormatDefinition.CreateResourceDictionaryFromDefinition.)
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberBorderIdThe string used to look up the border pen value in the ResourceDictionary.
Public fieldStatic memberFillIdThe string used to lookup the fill brush value in the ResourceDictionary.
Public fieldStatic memberZOrderIdThe string used to lookup the z-order value in the ResourceDictionary.
Top

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft