EditorFormatDefinition Class

Definition

Namespace:

Microsoft.VisualStudio.Text.Classification

Assembly:

Microsoft.VisualStudio.Text.UI.Wpf.dll

Package:

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

Provides format information for a particular item.

public ref class EditorFormatDefinition abstract

[Windows::Foundation::Metadata::WebHostHidden]
public ref class EditorFormatDefinition abstract

[Windows::Foundation::Metadata::WebHostHidden]
class EditorFormatDefinition abstract

public abstract class EditorFormatDefinition

type EditorFormatDefinition = class

Public MustInherit Class EditorFormatDefinition

Inheritance

Object

EditorFormatDefinition

Derived

Microsoft.VisualStudio.Text.Classification.ClassificationFormatDefinition

Microsoft.VisualStudio.Text.Classification.MarkerFormatDefinition

Remarks

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

Exporters must provide the attribute NameAttribute. The attributes OrderAttribute, UserVisibleAttribute may be provided optionally.

Consumers of this attribute may optionally ignore the foreground formatting information, the background information, or both.

It's recommended that exporters of this class prefix the NameAttribute with a unique string (e.g. their package name) to reduce the chance of conflict with another similarly named export.

Constructors

EditorFormatDefinition()

Initializes a new instance of EditorFormatDefinition.

Fields

BackgroundBrushId	Defines the string used to look up the background brush value in the ResourceDictionary.
BackgroundColorId	Defines the string used to look up the background color value in the ResourceDictionary.
ForegroundBrushId	Defines the string used to look up the foreground brush value in the ResourceDictionary.
ForegroundColorId	Defines the string used to look up the foreground color value in the ResourceDictionary.

Properties

BackgroundBrush	Gets or sets the background brush for this item.
BackgroundColor	Gets or sets the background color for this item.
BackgroundCustomizable	Determines whether the background of this format is customizable.
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.
ForegroundBrush	Gets or sets the foreground brush for this item.
ForegroundColor	Gets or sets the foreground color for this item.
ForegroundCustomizable	Determines whether the foreground of this format is customizable.

Methods

CreateResourceDictionary()	Creates a ResourceDictionary from this definition.
CreateResourceDictionaryFromDefinition()	Creates a ResourceDictionary from this definition.