IHighlightingStyleRegistry Interface
Provides the base requirements for a registry of IClassificationType to IHighlightingStyle mapping data.
public interface IHighlightingStyleRegistry : IClassificationTypeRegistry
Properties
ClassificationTypes
Gets the collection of IClassificationType objects that have been registered.
ICollection<IClassificationType> ClassificationTypes { get; }
Property Value
- ICollection<IClassificationType>:
The collection of IClassificationType objects that have been registered.
See Also
CurrentColorPalette
Gets or sets the current palette of colors available for use with IHighlightingStyle objects in the registry.
IHighlightingStyleColorPalette CurrentColorPalette { get; set; }
Property Value
Remarks
The value of this property is typically alternated between the LightColorPalette and DarkColorPalette but does not have to match either instance.
See Also
DarkColorPalette
Gets or sets the palette of colors available for use with IHighlightingStyle objects in the registry when a dark theme is active.
IHighlightingStyleColorPalette DarkColorPalette { get; set; }
Property Value
See Also
Description
Gets or sets the description of the registry.
HighlightingStyles
Gets the collection of IHighlightingStyle objects that have been registered.
ICollection<IHighlightingStyle> HighlightingStyles { get; }
Property Value
- ICollection<IHighlightingStyle>:
The collection of IHighlightingStyle objects that have been registered.
See Also
this[IClassificationType]
Gets the IHighlightingStyle registered with the specified IClassificationType.
[C#] In C#, this property is the indexer for the IHighlightingStyleRegistry
interface.
IHighlightingStyle this[IClassificationType classificationType] { get; }
Parameter | Type | Description |
---|---|---|
classificationType | IClassificationType | The IClassificationType for which to search. |
Property Value
- IHighlightingStyle:
The IHighlightingStyle registered with the specified IClassificationType.
See Also
LightColorPalette
Gets or sets the palette of colors available for use with IHighlightingStyle objects in the registry when a light theme is active.
IHighlightingStyleColorPalette LightColorPalette { get; set; }
Property Value
See Also
UnusedRegionForegroundOpacity
Gets or sets the opacity to use for unused region foregrounds.
double UnusedRegionForegroundOpacity { get; set; }
Property Value
- double:
The opacity to use for unused region foregrounds. The default value is
0.7
.
See Also
Methods
GetClassificationType(string)
Returns the IClassificationType, if any, that has been registered with the specified key.
IClassificationType GetClassificationType(string key)
Parameter | Type | Description |
---|---|---|
key | string | The key for which to search. |
Returns
- IClassificationType:
The IClassificationType, if any, that has been registered with the specified key.
See Also
ImportHighlightingStyles(Stream)
Imports style settings from the specified Stream, containing XML.
bool ImportHighlightingStyles(Stream stream)
Parameter | Type | Description |
---|---|---|
stream | Stream | The Stream from which to import. |
Returns
- bool:
true
if settings were imported; otherwise,false
.
See Also
Register(IClassificationType, IHighlightingStyle)
Attempts to adds an IHighlightingStyle for the specified IClassificationType into the registry, as long as there is no existing IHighlightingStyle registered with the same IClassificationType.
bool Register(IClassificationType classificationType, IHighlightingStyle style)
Parameter | Type | Description |
---|---|---|
classificationType | IClassificationType | The IClassificationType with which to register the IHighlightingStyle. |
style | IHighlightingStyle | The IHighlightingStyle to register. |
Returns
- bool:
true
if the IHighlightingStyle was added; otherwise,false
.
Remarks
This method only returns false
if there is already an IHighlightingStyle
registered with the same IClassificationType.
See Also
Register(IClassificationType, IHighlightingStyle, bool)
Adds an IHighlightingStyle into the registry, optionally overwriting any existing IHighlightingStyle registered with the same IClassificationType.
bool Register(IClassificationType classificationType, IHighlightingStyle style, bool overwriteExisting)
Parameter | Type | Description |
---|---|---|
classificationType | IClassificationType | The IClassificationType with which to register the IHighlightingStyle. |
style | IHighlightingStyle | The IHighlightingStyle to register. |
overwriteExisting | bool | Whether to overwrite existing highlighting styles with the same IClassificationType. |
Returns
- bool:
true
if the IHighlightingStyle was added; otherwise,false
.
Remarks
This method only returns false
if overwriteExisting
is false
and there
is already an IHighlightingStyle registered with the same IClassificationType.
See Also
Unregister(IClassificationType)
Removes a registry entry with the specified IClassificationType from the registry and removes the corresponding colors from the color palettes.
bool Unregister(IClassificationType classificationType)
Parameter | Type | Description |
---|---|---|
classificationType | IClassificationType | The IClassificationType to unregister. |
Returns
- bool:
true
if the registry entry was removed; otherwise,false
.
See Also
Unregister(IClassificationType, bool)
Removes a registry entry with the specified IClassificationType from the registry with the option to also clear the corresponding colors from the LightColorPalette and DarkColorPalette.
bool Unregister(IClassificationType classificationType, bool keepColorPalettes)
Parameter | Type | Description |
---|---|---|
classificationType | IClassificationType | The IClassificationType to unregister. |
keepColorPalettes | bool |
|
Returns
- bool:
true
if the registry entry was removed; otherwise,false
.
See Also
Events
Changed
Occurs after a change has occurred to the items in the registry.
Inherited Members
Extension Methods
- HighlightingStyleRegistryExtensions.ApplyColorPaletteToStyle(IHighlightingStyleRegistry, IClassificationType)
- HighlightingStyleRegistryExtensions.ApplyColorPaletteToStyle(IHighlightingStyleRegistry, IHighlightingStyle, string)