ClassificationFormatDefinition Class

Definition

Provides classification format information for a particular classification type.

public ref class ClassificationFormatDefinition abstract : Microsoft::VisualStudio::Text::Classification::EditorFormatDefinition
[Windows::Foundation::Metadata::WebHostHidden]
public ref class ClassificationFormatDefinition abstract : Microsoft::VisualStudio::Text::Classification::EditorFormatDefinition
[Windows::Foundation::Metadata::WebHostHidden]
class ClassificationFormatDefinition abstract : Microsoft::VisualStudio::Text::Classification::EditorFormatDefinition
public abstract class ClassificationFormatDefinition : Microsoft.VisualStudio.Text.Classification.EditorFormatDefinition
type ClassificationFormatDefinition = class
    inherit EditorFormatDefinition
Public MustInherit Class ClassificationFormatDefinition
Inherits EditorFormatDefinition
Inheritance
ClassificationFormatDefinition

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 may be provided optionally.

Constructors

ClassificationFormatDefinition()

Initializes a new instance of ClassificationFormatDefinition.

Fields

BackgroundBrushId

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

(Inherited from EditorFormatDefinition)
BackgroundColorId

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

(Inherited from EditorFormatDefinition)
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.

DefaultHighContrastBackgroundOpacity

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

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.

ForegroundBrushId

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

(Inherited from EditorFormatDefinition)
ForegroundColorId

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

(Inherited from EditorFormatDefinition)
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.

Properties

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.

Methods

CreateResourceDictionary()

Creates a ResourceDictionary from this definition.

(Inherited from EditorFormatDefinition)
CreateResourceDictionaryFromDefinition()

Creates a ResourceDictionary using this definition.

Applies to