IHighlightingStyle Interface
Represents the base requirements for a highlighting style that is applied to a span of text.
public interface IHighlightingStyle : INotifyPropertyChanged
Properties
Background
Gets or sets the background color of the highlighting style.
Color? Background { get; set; }
Property Value
BackgroundSpansVirtualSpace
Gets or sets a Boolean indicating whether the background should span virtual space when the styled range includes a line terminator.
bool BackgroundSpansVirtualSpace { get; set; }
Property Value
Bold
Gets or sets a nullable Boolean indicating whether the highlighting style uses boldface.
bool? Bold { get; set; }
Property Value
BorderColor
Gets or sets the border color of the highlighting style.
Color? BorderColor { get; set; }
Property Value
BorderCornerKind
Gets or sets a HighlightingStyleBorderCornerKind indicating the kind of border corners.
HighlightingStyleBorderCornerKind BorderCornerKind { get; set; }
Property Value
- HighlightingStyleBorderCornerKind:
A HighlightingStyleBorderCornerKind indicating the kind of border corners. The default value is
Square
.
BorderKind
Gets or sets a LineKind indicating the kind of border to use.
LineKind BorderKind { get; set; }
Property Value
FontFamilyName
Gets or sets the name of the font family to use for drawing text with the highlighting style.
string FontFamilyName { get; set; }
Property Value
- String:
The name of the font family to use for drawing text with the highlighting style.
FontSize
Gets or sets the size of the font to use for drawing text with the highlighting style.
float FontSize { get; set; }
Property Value
- Single:
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.
Foreground
Gets or sets the foreground color of the highlighting style.
Color? Foreground { get; set; }
Property Value
HasBackground
Gets whether the highlighting style contains has a background.
bool HasBackground { get; }
Property Value
- Boolean:
true
if the highlighting style contains has a background; otherwise,false
.
HasBorder
Gets whether the highlighting style has a border.
bool HasBorder { get; }
Property Value
- Boolean:
true
if the highlighting style has a border; otherwise,false
.
HasDefaultFormatting
Gets whether the highlighting style contains all default values for formatting properties.
bool HasDefaultFormatting { get; }
Property Value
- Boolean:
true
if the highlighting style contains all default values for formatting properties; otherwise,false
.
HasFontChange
Gets whether the highlighting style contains a font-related change.
bool HasFontChange { get; }
Property Value
- Boolean:
true
if the highlighting style contains a font-related change; otherwise,false
.
HasStrikethrough
Gets whether the highlighting style has a strike-through.
bool HasStrikethrough { get; }
Property Value
- Boolean:
true
if the highlighting style has a strike-through; otherwise,false
.
HasUnderline
Gets whether the highlighting style has an underline.
bool HasUnderline { get; }
Property Value
- Boolean:
true
if the highlighting style has an underline; otherwise,false
.
IsBackgroundEditable
Gets whether the Background property is editable in an options dialog.
bool IsBackgroundEditable { get; set; }
Property Value
- Boolean:
true
if the Background property is editable in an options dialog; otherwise,false
. The default value istrue
.
IsBoldEditable
Gets whether the Bold property is editable in an options dialog.
bool IsBoldEditable { get; set; }
Property Value
IsBorderEditable
Gets whether the BorderColor and related properties are editable in an options dialog.
bool IsBorderEditable { get; set; }
Property Value
- Boolean:
true
if the BorderColor and related properties are editable in an options dialog; otherwise,false
. The default value isfalse
.
IsForegroundEditable
Gets whether the Foreground property is editable in an options dialog.
bool IsForegroundEditable { get; set; }
Property Value
- Boolean:
true
if the Foreground property is editable in an options dialog; otherwise,false
. The default value istrue
.
IsItalicEditable
Gets whether the Italic property is editable in an options dialog.
bool IsItalicEditable { get; set; }
Property Value
Italic
Gets or sets a nullable Boolean indicating whether the highlighting style uses italics.
bool? Italic { get; set; }
Property Value
StrikethroughColor
Gets or sets the strike-through color of the highlighting style.
Color? StrikethroughColor { get; set; }
Property Value
StrikethroughKind
Gets or sets a LineKind indicating the kind of strike-through to use.
LineKind StrikethroughKind { get; set; }
Property Value
StrikethroughWeight
Gets or sets a TextLineWeight indicating the strike-through line weight to use.
TextLineWeight StrikethroughWeight { get; set; }
Property Value
- TextLineWeight:
A TextLineWeight indicating the strike-through line weight to use. The default value is
Single
.
Tag
Gets or sets the object that contains user-defined data about the object.
object Tag { get; set; }
Property Value
Remarks
Any type derived from the Object class can be assigned to this property.
UnderlineColor
Gets or sets the underline color of the highlighting style.
Color? UnderlineColor { get; set; }
Property Value
UnderlineKind
Gets or sets a LineKind indicating the kind of underline to use.
LineKind UnderlineKind { get; set; }
Property Value
UnderlineWeight
Gets or sets a TextLineWeight indicating the underlining line weight to use.
TextLineWeight UnderlineWeight { get; set; }
Property Value
- TextLineWeight:
A TextLineWeight indicating the underlining line weight to use. The default value is
Single
.