ClassificationTypeProviderBase Class

public abstract class ClassificationTypeProviderBase

protected ClassificationTypeProviderBase(IHighlightingStyleRegistry? targetRegistry = null)

Parameter	Type	Description
targetRegistry	IHighlightingStyleRegistry	The IHighlightingStyleRegistry to use when registering classification types and highlighting styles.

protected IHighlightingStyleColorPalette DefaultDarkColors { get; }

Property Value

IHighlightingStyleColorPalette

See Also

• CreateDarkColorPalette()

protected IHighlightingStyleColorPalette DefaultLightColors { get; }

Property Value

IHighlightingStyleColorPalette

See Also

• CreateLightColorPalette()

public IHighlightingStyleRegistry TargetRegistry { get; }

Property Value

IHighlightingStyleRegistry

protected virtual IHighlightingStyleColorPalette CreateDarkColorPalette()

Returns

IHighlightingStyleColorPalette:

An IHighlightingStyleColorPalette instance representing the dark color palette.

Remarks

The default implementation of this method returns an empty DarkHighlightingStyleColorPalette instance, with the intention of the colors in the light color palette being adapted to dark colors automatically. Override this method to use specific dark colors instead of adapted colors.

protected abstract IHighlightingStyleColorPalette CreateLightColorPalette()

Returns

IHighlightingStyleColorPalette:

An IHighlightingStyleColorPalette instance representing the light color palette.

protected IClassificationType GetOrRegisterClassificationType(IClassificationType classificationType, bool isForegroundEditable = false, bool isBackgroundEditable = false, bool isBorderEditable = false, LineKind borderLineKind = LineKind.None, HighlightingStyleBorderCornerKind borderCornerKind = HighlightingStyleBorderCornerKind.Square, bool isBoldEditable = false, bool? isBold = null, bool isItalicEditable = false, bool? isItalic = null, LineKind underlineKind = LineKind.None, bool backgroundSpansVirtualSpace = false)

Parameter	Type	Description
classificationType	IClassificationType	The IClassificationType to register if no classification type with the same key is already registered.
isForegroundEditable	bool	Whether the foreground is editable.
isBackgroundEditable	bool	Whether the background is editable.
isBorderEditable	bool	Whether the border is editable.
borderLineKind	LineKind	The border line kind.
borderCornerKind	HighlightingStyleBorderCornerKind	The border corner kind.
isBoldEditable	bool	Whether the bold state is editable.
isBold	bool?	Whether the text should render in bold.
isItalicEditable	bool	Whether the italic state is editable.
isItalic	bool?	Whether the text should render in italic.
underlineKind	LineKind	The kind of underline.
backgroundSpansVirtualSpace	bool	Whether the background spans to the right edge of the editor view.

Returns

IClassificationType:

The IClassificationType registered in the TargetRegistry.

protected IClassificationType GetOrRegisterTextClassificationType(IClassificationType classificationType, bool? isBold = null, bool? isItalic = null, bool backgroundSpansVirtualSpace = false)

Parameter	Type	Description
classificationType	IClassificationType	The IClassificationType to register if no classification type with the same key is already registered.
isBold	bool?	Whether the text should render in bold.
isItalic	bool?	Whether the text should render in italic.
backgroundSpansVirtualSpace	bool	Whether the background spans to the right edge of the editor view.

Returns

IClassificationType:

The IClassificationType registered in the TargetRegistry.

Remarks

Text-related classification types support editing their foreground, background, bold, and italic properties.

public abstract IEnumerable<IClassificationType> RegisterAll()

Returns

IEnumerable<IClassificationType>:

The collection of IClassificationType objects that were registered.