In This Article

IHighlightingStyle Interface

Represents the base requirements for a highlighting style that is applied to a span of text.

public interface IHighlightingStyle

Properties

Background

The background color of the highlighting style, if any.

Color? Background { get; set; }

Property Value

Color?

See Also

BackgroundSpansVirtualSpace

Indicates whether the background should span virtual space when the styled range includes a line terminator.

bool BackgroundSpansVirtualSpace { get; set; }

Property Value

bool

See Also

Bold

Indicates whether the highlighting style uses boldface.

bool? Bold { get; set; }

Property Value

bool?

See Also

BorderColor

The border color of the highlighting style, if any.

Color? BorderColor { get; set; }

Property Value

Color?

See Also

BorderCornerKind

A HighlightingStyleBorderCornerKind value indicating the kind of border corners.

HighlightingStyleBorderCornerKind BorderCornerKind { get; set; }

Property Value

HighlightingStyleBorderCornerKind:

The default value is Square.

See Also

BorderKind

A LineKind indicating the kind of border to use.

LineKind BorderKind { get; set; }

Property Value

LineKind:

The default value is None.

See Also

FontFamilyName

The name of the font family to use for drawing text with the highlighting style, or null to use the default.

string? FontFamilyName { get; set; }

Property Value

string

See Also

FontSize

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

float FontSize { get; set; }

Property Value

float:

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

See Also

Foreground

The foreground color of the highlighting style, if any.

Color? Foreground { get; set; }

Property Value

Color?

See Also

HasBackground

Indicates whether the highlighting style has a background.

bool HasBackground { get; }

Property Value

bool:

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

See Also

HasBorder

Indicates whether the highlighting style has a border.

bool HasBorder { get; }

Property Value

bool:

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

See Also

HasDefaultFormatting

Indicates whether the highlighting style contains all default values for formatting properties.

bool HasDefaultFormatting { get; }

Property Value

bool:

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

See Also

HasFontChange

Indicates whether the highlighting style contains a font-related change.

bool HasFontChange { get; }

Property Value

bool:

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

See Also

HasStrikethrough

Indicates whether the highlighting style has a strike-through.

bool HasStrikethrough { get; }

Property Value

bool:

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

See Also

HasUnderline

Indicates whether the highlighting style has an underline.

bool HasUnderline { get; }

Property Value

bool:

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

See Also

IsBackgroundEditable

Indicates whether the Background property is editable in an options dialog.

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.

See Also

IsBoldEditable

Indicates whether the Bold property is editable in an options dialog.

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.

See Also

IsBorderEditable

Indicates whether the BorderColor and related properties are editable in an options dialog.

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.

See Also

IsForegroundEditable

Indicates whether the Foreground property is editable in an options dialog.

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.

See Also

IsItalicEditable

Indicates whether the Italic property is editable in an options dialog.

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.

See Also

Italic

Indicates whether the highlighting style uses italics.

bool? Italic { get; set; }

Property Value

bool?

See Also

StrikethroughColor

The strike-through color of the highlighting style, if any.

Color? StrikethroughColor { get; set; }

Property Value

Color?

See Also

StrikethroughKind

A LineKind indicating the kind of strike-through to use.

LineKind StrikethroughKind { get; set; }

Property Value

LineKind:

The default value is None.

See Also

StrikethroughWeight

A TextLineWeight indicating the strike-through line weight to use.

TextLineWeight StrikethroughWeight { get; set; }

Property Value

TextLineWeight:

The default value is Single.

See Also

Tag

The object that contains user-defined data about the object, if any.

object? Tag { get; set; }

Property Value

object

See Also

UnderlineColor

The underline color of the highlighting style, if any.

Color? UnderlineColor { get; set; }

Property Value

Color?

See Also

UnderlineKind

A LineKind indicating the kind of underline to use.

LineKind UnderlineKind { get; set; }

Property Value

LineKind:

The default value is None.

See Also

UnderlineWeight

A TextLineWeight indicating the underlining line weight to use.

TextLineWeight UnderlineWeight { get; set; }

Property Value

TextLineWeight:

The default value is Single.

See Also

Extension Methods

See Also