ClassificationFormatDefinition ClassificationFormatDefinition ClassificationFormatDefinition Class

Definition

Provides classification format information for a particular classification type.

public abstract class ClassificationFormatDefinition : Microsoft.VisualStudio.Text.Classification.EditorFormatDefinition
type ClassificationFormatDefinition = class
    inherit EditorFormatDefinition
Public MustInherit Class ClassificationFormatDefinition
Inherits EditorFormatDefinition
Inheritance
ClassificationFormatDefinitionClassificationFormatDefinitionClassificationFormatDefinition

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.

Constructors

ClassificationFormatDefinition() ClassificationFormatDefinition() ClassificationFormatDefinition()

Initializes a new instance of ClassificationFormatDefinition.

Fields

BackgroundBrushId BackgroundBrushId BackgroundBrushId

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

(Inherited from EditorFormatDefinition)
BackgroundColorId BackgroundColorId BackgroundColorId

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

(Inherited from EditorFormatDefinition)
BackgroundOpacityId BackgroundOpacityId BackgroundOpacityId

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

CultureInfoId CultureInfoId CultureInfoId

Defines the string used to look up the CultureInfo value in the ResourceDictionary.

DefaultBackgroundOpacity DefaultBackgroundOpacity DefaultBackgroundOpacity

Defines the default opacity used for the background color/brush if no BackgroundOpacityId entities are defined.

DefaultHighContrastBackgroundOpacity DefaultHighContrastBackgroundOpacity DefaultHighContrastBackgroundOpacity

Defines the default opacity used for the background color/brush in high contrast themes.

FontHintingSizeId FontHintingSizeId FontHintingSizeId

Defines the string used to look up the font hinting size value in the ResourceDictionary.

FontRenderingSizeId FontRenderingSizeId FontRenderingSizeId

Defines the string used to look up the font rendering size value in the ResourceDictionary.

ForegroundBrushId ForegroundBrushId ForegroundBrushId

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

(Inherited from EditorFormatDefinition)
ForegroundColorId ForegroundColorId ForegroundColorId

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

(Inherited from EditorFormatDefinition)
ForegroundOpacityId ForegroundOpacityId ForegroundOpacityId

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

IsBoldId IsBoldId IsBoldId

Defines the string used to look up the bold value in the ResourceDictionary.

IsItalicId IsItalicId IsItalicId

Defines the string used to look up the italic value in the ResourceDictionary.

TextDecorationsId TextDecorationsId TextDecorationsId

Defines the string used to look up the text decorations value in the ResourceDictionary.

TextEffectsId TextEffectsId TextEffectsId

Defines the string used look up the text effects value in the ResourceDictionary.

TypefaceId TypefaceId TypefaceId

Defines the string used o look up the typeface value in the ResourceDictionary.

Properties

BackgroundBrush BackgroundBrush BackgroundBrush

Gets or sets the background brush for this item.

(Inherited from EditorFormatDefinition)
BackgroundColor BackgroundColor BackgroundColor

Gets or sets the background color for this item.

(Inherited from EditorFormatDefinition)
BackgroundCustomizable BackgroundCustomizable BackgroundCustomizable

Determines whether the background of this format is customizable.

(Inherited from EditorFormatDefinition)
BackgroundOpacity BackgroundOpacity BackgroundOpacity

Gets or sets the opacity of the background.

CultureInfo CultureInfo CultureInfo

Gets or sets the CultureInfo for this classification format.

DisplayName DisplayName 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 FontHintingSize FontHintingSize

Gets or sets the font hinting size for this classification format.

FontRenderingSize FontRenderingSize FontRenderingSize

Gets or sets the font rendering size for this classification format.

FontTypeface FontTypeface FontTypeface

Gets or sets the Typeface for this classification format.

ForegroundBrush ForegroundBrush ForegroundBrush

Gets or sets the foreground brush for this item.

(Inherited from EditorFormatDefinition)
ForegroundColor ForegroundColor ForegroundColor

Gets or sets the foreground color for this item.

(Inherited from EditorFormatDefinition)
ForegroundCustomizable ForegroundCustomizable ForegroundCustomizable

Determines whether the foreground of this format is customizable.

(Inherited from EditorFormatDefinition)
ForegroundOpacity ForegroundOpacity ForegroundOpacity

Gets or sets the opacity of the foreground.

IsBold IsBold IsBold

Determines whether the text should be bold.

IsItalic IsItalic IsItalic

Determines whether the text should be italic.

TextDecorations TextDecorations TextDecorations

Gets or sets the TextDecorationCollection for this classification format.

TextEffects TextEffects TextEffects

Gets or sets the the TextEffectCollection for this classification format.

Methods

CreateResourceDictionary() CreateResourceDictionary() CreateResourceDictionary()

Creates a ResourceDictionary from this definition.

(Inherited from EditorFormatDefinition)
CreateResourceDictionaryFromDefinition() CreateResourceDictionaryFromDefinition() CreateResourceDictionaryFromDefinition()

Creates a ResourceDictionary using this definition.

Extension Methods

FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestor<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestor<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>) FindAncestorOrSelf<TElementType>(TElementType, Func<TElementType,TElementType>, Func<TElementType,Boolean>)
FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>) FindAncestorOrSelf<TAncestorType,TElementType>(TElementType, Func<TElementType,TElementType>)
IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>) IsAncestorOf<TElementType>(TElementType, TElementType, Func<TElementType,TElementType>)

Microsoft internal use only.

Applies to