EditorFormatDefinition Class

 

Provides format information for a particular item.

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


public abstract class EditorFormatDefinition

NameDescription
System_CAPS_protmethodEditorFormatDefinition()

Initializes a new instance of EditorFormatDefinition.

NameDescription
System_CAPS_pubpropertyBackgroundBrush

Gets or sets the background brush for this item.

System_CAPS_pubpropertyBackgroundColor

Gets or sets the background color for this item.

System_CAPS_pubpropertyBackgroundCustomizable

Determines whether the background of this format is customizable.

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.

System_CAPS_pubpropertyForegroundBrush

Gets or sets the foreground brush for this item.

System_CAPS_pubpropertyForegroundColor

Gets or sets the foreground color for this item.

System_CAPS_pubpropertyForegroundCustomizable

Determines whether the foreground of this format is customizable.

NameDescription
System_CAPS_pubmethodCreateResourceDictionary()

Creates a ResourceDictionary from this definition.

System_CAPS_protmethodCreateResourceDictionaryFromDefinition()

Creates a ResourceDictionary from this definition.

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_staticBackgroundBrushId

Defines the string used to look up the background brush value in the ResourceDictionary.

System_CAPS_pubfieldSystem_CAPS_staticBackgroundColorId

Defines the string used to look up the background color value in the ResourceDictionary.

System_CAPS_pubfieldSystem_CAPS_staticForegroundBrushId

Defines the string used to look up the foreground brush value in the ResourceDictionary.

System_CAPS_pubfieldSystem_CAPS_staticForegroundColorId

Defines the string used to look up the foreground color value in the ResourceDictionary.

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

[Export(typeof(EditorFormatDefinition))] 

Exporters must provide a NameAttribute. The attributes OrderAttribute, T:Microsoft.VisualStudio.Text.Classification.DisplayNameAttribute and UserVisibleAttribute are optional.

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

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: