ClassificationFormatDefinition Class
Provides classification format information for a particular classification type.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Text.Classification.EditorFormatDefinition
Microsoft.VisualStudio.Text.Classification.ClassificationFormatDefinition
Namespace: Microsoft.VisualStudio.Text.Classification
Assembly: Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)
Syntax
'Déclaration
Public MustInherit Class ClassificationFormatDefinition _
Inherits EditorFormatDefinition
public abstract class ClassificationFormatDefinition : EditorFormatDefinition
public ref class ClassificationFormatDefinition abstract : public EditorFormatDefinition
[<AbstractClass>]
type ClassificationFormatDefinition =
class
inherit EditorFormatDefinition
end
public abstract class ClassificationFormatDefinition extends EditorFormatDefinition
The ClassificationFormatDefinition type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
ClassificationFormatDefinition | Initializes a new instance of ClassificationFormatDefinition. |
Top
Properties
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.) |
![]() |
BackgroundOpacity | Gets or sets the opacity of the background. |
![]() |
CultureInfo | Gets or sets the CultureInfo for this classification format. |
![]() |
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.) |
![]() |
FontHintingSize | Gets or sets the font hinting size for this classification format. |
![]() |
FontRenderingSize | Gets or sets the font rendering size for this classification format. |
![]() |
FontTypeface | Gets or sets the Typeface for this classification format. |
![]() |
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.) |
![]() |
ForegroundOpacity | Gets or sets the opacity of the foreground. |
![]() |
IsBold | Determines whether the text should be bold. |
![]() |
IsItalic | Determines whether the text should be italic. |
![]() |
TextDecorations | Gets or sets the TextDecorationCollection for this classification format. |
![]() |
TextEffects | Gets or sets the the TextEffectCollection for this classification format. |
Top
Methods
Name | Description | |
---|---|---|
![]() |
CreateResourceDictionary | Creates a ResourceDictionary from this definition. (Inherited from EditorFormatDefinition.) |
![]() |
CreateResourceDictionaryFromDefinition | Creates a ResourceDictionary using this definition. (Overrides EditorFormatDefinition.CreateResourceDictionaryFromDefinition().) |
![]() |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() |
GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Fields
Name | Description | |
---|---|---|
![]() ![]() |
BackgroundOpacityId | Defines the string used to look up the background opacity value in the ResourceDictionary. |
![]() ![]() |
CultureInfoId | Defines the string used to look up the CultureInfo value in the ResourceDictionary. |
![]() ![]() |
DefaultBackgroundOpacity | Defines the default opacity used for the background color/brush if no BackgroundOpacityId entities are defined. |
![]() ![]() |
FontHintingSizeId | Defines the string used to look up the font hinting size value in the ResourceDictionary. |
![]() ![]() |
FontRenderingSizeId | Defines the string used to look up the font rendering size value in the ResourceDictionary. |
![]() ![]() |
ForegroundOpacityId | Defines the string used to look up the foreground opacity value in the ResourceDictionary. |
![]() ![]() |
IsBoldId | Defines the string used to look up the bold value in the ResourceDictionary. |
![]() ![]() |
IsItalicId | Defines the string used to look up the italic value in the ResourceDictionary. |
![]() ![]() |
TextDecorationsId | Defines the string used to look up the text decorations value in the ResourceDictionary. |
![]() ![]() |
TextEffectsId | Defines the string used look up the text effects value in the ResourceDictionary. |
![]() ![]() |
TypefaceId | Defines the string used o look up the typeface value in the ResourceDictionary. |
Top
Remarks
This is a MEF component part, and should be exported as: [Export(typeof(EditorFormatDefinition))]
Exporters must provide the attributes ClassificationTypeAttribute and NameAttribute. The attributes OrderAttribute, DisplayNameAttribute, and UserVisibleAttribute are optional.
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.