ClassificationFormatDefinition Class

Provides classification format information for a particular classification type.

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)

public abstract class ClassificationFormatDefinition : EditorFormatDefinition

The ClassificationFormatDefinition type exposes the following members.

  NameDescription
Protected methodClassificationFormatDefinitionInitializes a new instance of ClassificationFormatDefinition.
Top

  NameDescription
Public propertyBackgroundBrushGets or sets the background brush for this item. (Inherited from EditorFormatDefinition.)
Public propertyBackgroundColorGets or sets the background color for this item. (Inherited from EditorFormatDefinition.)
Public propertyBackgroundCustomizableDetermines whether the background of this format is customizable. (Inherited from EditorFormatDefinition.)
Public propertyBackgroundOpacityGets or sets the opacity of the background.
Public propertyCultureInfoGets or sets the CultureInfo for this classification format.
Public propertyDisplayNameDefines 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.)
Public propertyFontHintingSizeGets or sets the font hinting size for this classification format.
Public propertyFontRenderingSizeGets or sets the font rendering size for this classification format.
Public propertyFontTypefaceGets or sets the Typeface for this classification format.
Public propertyForegroundBrushGets or sets the foreground brush for this item. (Inherited from EditorFormatDefinition.)
Public propertyForegroundColorGets or sets the foreground color for this item. (Inherited from EditorFormatDefinition.)
Public propertyForegroundCustomizableDetermines whether the foreground of this format is customizable. (Inherited from EditorFormatDefinition.)
Public propertyForegroundOpacityGets or sets the opacity of the foreground.
Public propertyIsBoldDetermines whether the text should be bold.
Public propertyIsItalicDetermines whether the text should be italic.
Public propertyTextDecorationsGets or sets the TextDecorationCollection for this classification format.
Public propertyTextEffectsGets or sets the the TextEffectCollection for this classification format.
Top

  NameDescription
Public methodCreateResourceDictionaryCreates a ResourceDictionary from this definition. (Inherited from EditorFormatDefinition.)
Protected methodCreateResourceDictionaryFromDefinitionCreates a ResourceDictionary using this definition. (Overrides EditorFormatDefinition.CreateResourceDictionaryFromDefinition().)
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberBackgroundOpacityIdDefines the string used to look up the background opacity value in the ResourceDictionary.
Public fieldStatic memberCultureInfoIdDefines the string used to look up the CultureInfo value in the ResourceDictionary.
Public fieldStatic memberDefaultBackgroundOpacityDefines the default opacity used for the background color/brush if no BackgroundOpacityId entities are defined.
Public fieldStatic memberDefaultHighContrastBackgroundOpacity
Public fieldStatic memberFontHintingSizeIdDefines the string used to look up the font hinting size value in the ResourceDictionary.
Public fieldStatic memberFontRenderingSizeIdDefines the string used to look up the font rendering size value in the ResourceDictionary.
Public fieldStatic memberForegroundOpacityIdDefines the string used to look up the foreground opacity value in the ResourceDictionary.
Public fieldStatic memberIsBoldIdDefines the string used to look up the bold value in the ResourceDictionary.
Public fieldStatic memberIsItalicIdDefines the string used to look up the italic value in the ResourceDictionary.
Public fieldStatic memberTextDecorationsIdDefines the string used to look up the text decorations value in the ResourceDictionary.
Public fieldStatic memberTextEffectsIdDefines the string used look up the text effects value in the ResourceDictionary.
Public fieldStatic memberTypefaceIdDefines the string used o look up the typeface value in the ResourceDictionary.
Top

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft