HighlightingStyle Class

public class HighlightingStyle : ObservableObjectBase, IHighlightingStyle

public HighlightingStyle()

public HighlightingStyle(Color? foreground)

Parameter	Type	Description
foreground	Color?	The foreground Color of the highlighting style.

public HighlightingStyle(Color? foreground, Color? background)

Parameter	Type	Description
foreground	Color?	The foreground Color of the highlighting style.
background	Color?	The background Color of the highlighting style.

public HighlightingStyle(Color? foreground, Color? background, bool? bold, bool? italic, LineKind underlineKind)

Parameter	Type	Description
foreground	Color?	The foreground Color of the highlighting style.
background	Color?	The background Color of the highlighting style.
bold	bool?	A nullable bool indicating whether the highlighting style uses boldface.
italic	bool?	A nullable bool indicating whether the highlighting style uses italics.
underlineKind	LineKind	A LineKind indicating the underline kind.

public HighlightingStyle(Color? foreground, Color? background, bool? bold, bool? italic, LineKind underlineKind, bool backgroundSpansVirtualSpace)

Parameter	Type	Description
foreground	Color?	The foreground Color of the highlighting style.
background	Color?	The background Color of the highlighting style.
bold	bool?	A nullable bool indicating whether the highlighting style uses boldface.
italic	bool?	A nullable bool indicating whether the highlighting style uses italics.
underlineKind	LineKind	A LineKind indicating the underline kind.
backgroundSpansVirtualSpace	bool	Whether the background should span virtual space when the styled range includes a line terminator.

public Color? Background { get; set; }

Property Value

Color?:

A nullable Color indicating the background color of the highlighting style.

public bool BackgroundSpansVirtualSpace { get; set; }

Property Value

bool:

A bool indicating whether the background should span virtual space when the styled range includes a line terminator.

public bool? Bold { get; set; }

Property Value

bool?:

A nullable bool indicating whether the highlighting style uses boldface.

public Color? BorderColor { get; set; }

Property Value

Color?:

A nullable Color indicating the border color of the highlighting style.

public HighlightingStyleBorderCornerKind BorderCornerKind { get; set; }

Property Value

HighlightingStyleBorderCornerKind:

A HighlightingStyleBorderCornerKind indicating the kind of border corners. The default value is Square.

public LineKind BorderKind { get; set; }

Property Value

LineKind:

A LineKind indicating the kind of border to use. The default value is None.

public string FontFamilyName { get; set; }

Property Value

string:

The name of the font family to use for drawing text with the highlighting style.

public float FontSize { get; set; }

Property Value

float:

The size of the font to use for drawing text with the highlighting style. Specify 0 to use a default value, which is the default property value.

public Color? Foreground { get; set; }

Property Value

Color?:

A nullable Color indicating the foreground color of the highlighting style.

public bool HasBackground { get; }

Property Value

bool:

true if the highlighting style has a background; otherwise, false.

public bool HasBorder { get; }

Property Value

bool:

true if the highlighting style has a border; otherwise, false.

public bool HasDefaultFormatting { get; }

Property Value

bool:

true if the highlighting style contains all default values for formatting properties; otherwise, false.

public bool HasFontChange { get; }

Property Value

bool:

true if the highlighting style contains a font-related change; otherwise, false.

public bool HasStrikethrough { get; }

Property Value

bool:

true if the highlighting style has a strike-through; otherwise, false.

public bool HasUnderline { get; }

Property Value

bool:

true if the highlighting style has an underline; otherwise, false.

public bool IsBackgroundEditable { get; set; }

Property Value

bool:

true if the Background property is editable in an options dialog; otherwise, false. The default value is true.

public bool IsBoldEditable { get; set; }

Property Value

bool:

true if the Bold property is editable in an options dialog; otherwise, false. The default value is true.

public bool IsBorderEditable { get; set; }

Property Value

bool:

true if the BorderColor and related properties are editable in an options dialog; otherwise, false. The default value is false.

public bool IsForegroundEditable { get; set; }

Property Value

bool:

true if the Foreground property is editable in an options dialog; otherwise, false. The default value is true.

public bool IsItalicEditable { get; set; }

Property Value

bool:

true if the Italic property is editable in an options dialog; otherwise, false. The default value is true.

public bool? Italic { get; set; }

Property Value

bool?:

A nullable bool indicating whether the highlighting style uses italics.

public Color? StrikethroughColor { get; set; }

Property Value

Color?:

A nullable Color indicating the strike-through color of the highlighting style.

public LineKind StrikethroughKind { get; set; }

Property Value

LineKind:

A LineKind indicating the kind of strike-through to use. The default value is None.

public TextLineWeight StrikethroughWeight { get; set; }

Property Value

TextLineWeight:

A TextLineWeight indicating the strike-through line weight to use. The default value is Single.

public object Tag { get; set; }

Property Value

object:

An object that contains user-defined data about the object. The default is null.

Remarks

Any type derived from the object class can be assigned to this property.

public Color? UnderlineColor { get; set; }

Property Value

Color?:

A nullable Color indicating the underline color of the highlighting style.

public LineKind UnderlineKind { get; set; }

Property Value

LineKind:

A LineKind indicating the kind of underline to use. The default value is None.

public TextLineWeight UnderlineWeight { get; set; }

Property Value

TextLineWeight:

A TextLineWeight indicating the underlining line weight to use. The default value is Single.

public override string ToString()

Returns

string:

A String that represents the current Object.