HighlightingStyleRegistry Class

public class HighlightingStyleRegistry : IHighlightingStyleRegistry, IClassificationTypeRegistry

public HighlightingStyleRegistry()

public ICollection<IClassificationType> ClassificationTypes { get; }

Property Value

ICollection<IClassificationType>:

The collection of IClassificationType objects that have been registered.

public int Count { get; }

Property Value

int:

The number of entries in the registry.

public IHighlightingStyleColorPalette CurrentColorPalette { get; set; }

Property Value

IHighlightingStyleColorPalette:

A IHighlightingStyleColorPalette object.

Remarks

The value of this property is typically alternated between the LightColorPalette and DarkColorPalette but does not have to match either instance.

public IHighlightingStyleColorPalette DarkColorPalette { get; set; }

Property Value

IHighlightingStyleColorPalette:

A IHighlightingStyleColorPalette object.

See Also

• LightColorPalette

public string Description { get; set; }

Property Value

string:

The description of the registry.

public ICollection<IHighlightingStyle> HighlightingStyles { get; }

Property Value

ICollection<IHighlightingStyle>:

The collection of IHighlightingStyle objects that have been registered.

public 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.

public IHighlightingStyleColorPalette LightColorPalette { get; set; }

Property Value

IHighlightingStyleColorPalette:

A IHighlightingStyleColorPalette object.

See Also

• DarkColorPalette

public double UnusedRegionForegroundOpacity { get; set; }

Property Value

double:

The opacity to use for unused region foregrounds. The default value is 0.7.

public 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.

public IEnumerator<KeyValuePair<IClassificationType, IHighlightingStyle>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<IClassificationType, IHighlightingStyle>>:

An IEnumerator object for the entire collection

Remarks

Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.

The enumerator does not have exclusive access to the collection.

When an enumerator is instantiated, it takes a snapshot of the current state of the collection. If changes are made to the collection, such as adding, modifying or deleting elements, the snapshot gets out of sync and the enumerator throws an InvalidOperationException. Two enumerators instantiated from the same collection at the same time can have different snapshots of the collection.

public bool ImportHighlightingStyles(Stream stream)

Parameter	Type	Description
stream	Stream	The Stream from which to import.

Returns

bool:

true if settings were imported; otherwise, false.

protected virtual void OnChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

public 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.

public 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.

public bool Unregister(IClassificationType classificationType)

Parameter	Type	Description
classificationType	IClassificationType	The IClassificationType to unregister.

Returns

bool:

true if the registry entry was removed; otherwise, false.

public bool Unregister(IClassificationType classificationType, bool keepColorPalettes)

Parameter	Type	Description
classificationType	IClassificationType	The IClassificationType to unregister.
keepColorPalettes	bool	true to keep the corresponding colors in the color palettes; otherwise false to remove them.

Returns

bool:

true if the registry entry was removed; otherwise, false.

public event EventHandler Changed

Event Type

EventHandler