Share via


EditorFormatDefinition Class

Provides format information for a particular item.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public MustInherit Class EditorFormatDefinition
public abstract class EditorFormatDefinition
public ref class EditorFormatDefinition abstract
[<AbstractClass>]
type EditorFormatDefinition =  class end
public abstract class EditorFormatDefinition

The EditorFormatDefinition type exposes the following members.

Constructors

  Name Description
Protected method EditorFormatDefinition Initializes a new instance of EditorFormatDefinition.

Top

Properties

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

Top

Methods

  Name Description
Public method CreateResourceDictionary Creates a ResourceDictionary from this definition.
Protected method CreateResourceDictionaryFromDefinition Creates a ResourceDictionary from this definition.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

  Name Description
Public fieldStatic member BackgroundBrushId Defines the string used to look up the background brush value in the ResourceDictionary.
Public fieldStatic member BackgroundColorId Defines the string used to look up the background color value in the ResourceDictionary.
Public fieldStatic member ForegroundBrushId Defines the string used to look up the foreground brush value in the ResourceDictionary.
Public fieldStatic member ForegroundColorId Defines the string used to look up the foreground color value in the ResourceDictionary.

Top

Remarks

This is a MEF component part, and should be exported as:

[Export(typeof(EditorFormatDefinition))] 

Exporters must provide a NameAttribute. The attributes OrderAttribute, DisplayNameAttribute and UserVisibleAttribute are optional.

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

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.Text.Classification Namespace