HighlightingStyleRegistry Class

public class HighlightingStyleRegistry : IHighlightingStyleRegistry, IClassificationTypeRegistry, IEnumerable<IClassificationType>, IEnumerable<KeyValuePair<IClassificationType, IHighlightingStyle>>, IEnumerable

public HighlightingStyleRegistry()

public ICollection<IClassificationType> ClassificationTypes { get; }

Property Value

System.Collections.Generic.ICollection<IClassificationType>:

The collection of IClassificationType objects that have been registered.

public int Count { get; }

Property Value

System.Int32:

The number of entries in the registry.

public string Description { get; set; }

Property Value

System.String:

The description of the registry.

public ICollection<IHighlightingStyle> HighlightingStyles { get; }

Property Value

System.Collections.Generic.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 double UnusedRegionForegroundOpacity { get; set; }

Property Value

System.Double:

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

public IClassificationType GetClassificationType(string key)

Parameter	Type	Description
key	System.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

System.Collections.Generic.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	System.IO.Stream	The System.IO.Stream from which to import.

Returns

System.Boolean:

true if settings were imported; otherwise, false.

protected virtual void OnChanged(EventArgs e)

Parameter	Type	Description
e	System.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

System.Boolean:

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	System.Boolean	Whether to overwrite existing highlighting styles with the same IClassificationType.

Returns

System.Boolean:

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

System.Boolean:

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

public event EventHandler Changed

Event Type

System.EventHandler

IClassificationType IClassificationTypeRegistry.get_Item(string key)

Parameter	Type	Description
key	System.String

Returns

IClassificationType

IClassificationType IClassificationTypeRegistry.this[] { get; }

Parameter	Type	Description
key	System.String	The key of the IClassificationType to return.

Returns

IClassificationType:

The IClassificationType with the specified key.