HighlightingStyle Class

public class HighlightingStyle : ObservableObjectBase, IHighlightingStyle

public HighlightingStyle(Color? foreground = null, Color? background = null, bool? bold = null, bool? italic = null, LineKind underlineKind = LineKind.None, bool backgroundSpansVirtualSpace = false)

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

public Color? Background { get; set; }

Property Value

Color?

public bool BackgroundSpansVirtualSpace { get; set; }

Property Value

bool

public bool? Bold { get; set; }

Property Value

bool?

public Color? BorderColor { get; set; }

Property Value

Color?

public HighlightingStyleBorderCornerKind BorderCornerKind { get; set; }

Property Value

HighlightingStyleBorderCornerKind:

The default value is Square.

public LineKind BorderKind { get; set; }

Property Value

LineKind:

The default value is None.

public string? FontFamilyName { get; set; }

Property Value

string

[TypeConverter(typeof(FontSizeConverter))]
public float FontSize { get; set; }

Property Value

float:

Specify 0 to use a default value, which is the default property value.

public Color? Foreground { get; set; }

Property Value

Color?

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?

public Color? StrikethroughColor { get; set; }

Property Value

Color?

public LineKind StrikethroughKind { get; set; }

Property Value

LineKind:

The default value is None.

public TextLineWeight StrikethroughWeight { get; set; }

Property Value

TextLineWeight:

The default value is Single.

public object? Tag { get; set; }

Property Value

object

public Color? UnderlineColor { get; set; }

Property Value

Color?

public LineKind UnderlineKind { get; set; }

Property Value

LineKind:

The default value is None.

public TextLineWeight UnderlineWeight { get; set; }

Property Value

TextLineWeight:

The default value is Single.

public override string ToString()

Returns

string:

The string representation of this object.