ClassificationFormatDefinition Class

 

Provides classification format information for a particular classification type.

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

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

public abstract class ClassificationFormatDefinition : EditorFormatDefinition

NameDescription
System_CAPS_protmethodClassificationFormatDefinition()

Initializes a new instance of ClassificationFormatDefinition.

NameDescription
System_CAPS_pubpropertyBackgroundBrush

Gets or sets the background brush for this item.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyBackgroundColor

Gets or sets the background color for this item.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyBackgroundCustomizable

Determines whether the background of this format is customizable.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyBackgroundOpacity

Gets or sets the opacity of the background.

System_CAPS_pubpropertyCultureInfo

Gets or sets the CultureInfo for this classification format.

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

System_CAPS_pubpropertyFontHintingSize

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

System_CAPS_pubpropertyFontRenderingSize

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

System_CAPS_pubpropertyFontTypeface

Gets or sets the Typeface for this classification format.

System_CAPS_pubpropertyForegroundBrush

Gets or sets the foreground brush for this item.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyForegroundColor

Gets or sets the foreground color for this item.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyForegroundCustomizable

Determines whether the foreground of this format is customizable.(Inherited from EditorFormatDefinition.)

System_CAPS_pubpropertyForegroundOpacity

Gets or sets the opacity of the foreground.

System_CAPS_pubpropertyIsBold

Determines whether the text should be bold.

System_CAPS_pubpropertyIsItalic

Determines whether the text should be italic.

System_CAPS_pubpropertyTextDecorations

Gets or sets the TextDecorationCollection for this classification format.

System_CAPS_pubpropertyTextEffects

Gets or sets the the TextEffectCollection for this classification format.

NameDescription
System_CAPS_pubmethodCreateResourceDictionary()

Creates a ResourceDictionary from this definition.(Inherited from EditorFormatDefinition.)

System_CAPS_protmethodCreateResourceDictionaryFromDefinition()
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_staticBackgroundOpacityId

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

System_CAPS_pubfieldSystem_CAPS_staticCultureInfoId

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

System_CAPS_pubfieldSystem_CAPS_staticDefaultBackgroundOpacity

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

System_CAPS_pubfieldSystem_CAPS_staticDefaultHighContrastBackgroundOpacity

System_CAPS_pubfieldSystem_CAPS_staticFontHintingSizeId

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

System_CAPS_pubfieldSystem_CAPS_staticFontRenderingSizeId

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

System_CAPS_pubfieldSystem_CAPS_staticForegroundOpacityId

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

System_CAPS_pubfieldSystem_CAPS_staticIsBoldId

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

System_CAPS_pubfieldSystem_CAPS_staticIsItalicId

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

System_CAPS_pubfieldSystem_CAPS_staticTextDecorationsId

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

System_CAPS_pubfieldSystem_CAPS_staticTextEffectsId

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

System_CAPS_pubfieldSystem_CAPS_staticTypefaceId

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

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.

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: