MarkerFormatDefinition Class
Provides coloring information for text markers.
Assembly: Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)
Microsoft.VisualStudio.Text.Classification.EditorFormatDefinition
Microsoft.VisualStudio.Text.Classification.MarkerFormatDefinition
| Name | Description | |
|---|---|---|
![]() | MarkerFormatDefinition() | Initializes a new instance of MarkerFormatDefinition. |
| Name | Description | |
|---|---|---|
![]() | 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 used only 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 | Represents the Z-order of the marker when it is drawn on the text marker adornment layer. |
| Name | Description | |
|---|---|---|
![]() | CreateResourceDictionary() | Creates a ResourceDictionary from this definition.(Inherited from EditorFormatDefinition.) |
![]() | CreateResourceDictionaryFromDefinition() | Creates a ResourceDictionary using this definition.(Overrides EditorFormatDefinition.CreateResourceDictionaryFromDefinition().) |
![]() | Equals(Object) | (Inherited from Object.) |
![]() | Finalize() | (Inherited from Object.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetType() | (Inherited from Object.) |
![]() | MemberwiseClone() | (Inherited from Object.) |
![]() | ToString() | (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | BorderId | The string used to look up the border pen value in the ResourceDictionary. |
![]() ![]() | FillId | The string used to lookup the fill brush value in the ResourceDictionary. |
![]() ![]() | ZOrderId | 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.





