HighlightingStyleColorPaletteBase Class

public abstract class HighlightingStyleColorPaletteBase : IHighlightingStyleColorPalette

public HighlightingStyleColorPaletteBase(string name)

Parameter	Type	Description
name	string	The name of the color palette.

Exceptions

Type	Condition
ArgumentNullException

public IEnumerable<string> Keys { get; }

Property Value

IEnumerable<string>

public string Name { get; }

Property Value

string

public void ClearAll()

public void ClearKey(string key)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.

public bool ContainsKey(string key)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.

Returns

bool:

true if at least one color is available for the given key; otherwise false.

public virtual Color? GetBackground(string key)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.

Returns

Color?:

The background color for the given key, or null if a color is not defined for the key.

public virtual Color? GetBorder(string key)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.

Returns

Color?:

The border color for the given key, or null if a color is not defined for the key.

public virtual Color? GetForeground(string key)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.

Returns

Color?:

The foreground color for the given key, or null if a color is not defined for the key.

public virtual Color? GetStrikethrough(string key)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.

Returns

Color?:

The strikethrough color for the given key, or null if a color is not defined for the key.

public virtual Color? GetUnderline(string key)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.

Returns

Color?:

The underline color for the given key, or null if a color is not defined for the key.

public bool SetBackground(string key, Color? color)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetBackground(string key, Color? color, bool overwriteExisting)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.
overwriteExisting	bool	true to overwrite any existing color already assigned for the same key; otherwise, false and the color will only be assigned if it is not currently assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetBorder(string key, Color? color)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetBorder(string key, Color? color, bool overwriteExisting)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.
overwriteExisting	bool	true to overwrite any existing color already assigned for the same key; otherwise, false and the color will only be assigned if it is not currently assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetForeground(string key, Color? color)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetForeground(string key, Color? color, bool overwriteExisting)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.
overwriteExisting	bool	true to overwrite any existing color already assigned for the same key; otherwise, false and the color will only be assigned if it is not currently assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetStrikethrough(string key, Color? color)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetStrikethrough(string key, Color? color, bool overwriteExisting)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.
overwriteExisting	bool	true to overwrite any existing color already assigned for the same key; otherwise, false and the color will only be assigned if it is not currently assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetUnderline(string key, Color? color)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.

Returns

bool:

true if the color was added; otherwise, false.

public bool SetUnderline(string key, Color? color, bool overwriteExisting)

Parameter	Type	Description
key	string	The key, which is typically matches an IClassificationType key.
color	Color?	The color to be assigned.
overwriteExisting	bool	true to overwrite any existing color already assigned for the same key; otherwise, false and the color will only be assigned if it is not currently assigned.

Returns

bool:

true if the color was added; otherwise, false.