Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail

IHighlightingStyle Interface

In This Article
Namespace:
ActiproSoftware.UI.WinForms.Controls.SyntaxEditor.Highlighting
Assembly:
ActiproSoftware.SyntaxEditor.WinForms.dll

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

public interface IHighlightingStyle

Properties

Background

Gets or sets the background color of the highlighting style.

Color? Background { get; set; }

Property Value

Color?:

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

See Also

BackgroundSpansVirtualSpace

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

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.

See Also

Bold

Gets or sets a nullable bool indicating whether the highlighting style uses boldface.

bool? Bold { get; set; }

Property Value

bool?:

A nullable bool indicating whether the highlighting style uses boldface.

See Also

BorderColor

Gets or sets the border color of the highlighting style.

Color? BorderColor { get; set; }

Property Value

Color?:

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

See Also

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.

See Also

BorderKind

Gets or sets a LineKind indicating the kind of border to use.

LineKind BorderKind { get; set; }

Property Value

LineKind:

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

See Also

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.

See Also

FontSize

Gets or sets the size of the font to use for drawing text with the highlighting style.

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.

See Also

Foreground

Gets or sets the foreground color of the highlighting style.

Color? Foreground { get; set; }

Property Value

Color?:

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

See Also

HasBackground

Gets 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

Gets 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

Gets 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

Gets 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

Gets 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

Gets 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

Gets 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

Gets 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

Gets 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

Gets 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

Gets 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

Gets or sets a nullable bool indicating whether the highlighting style uses italics.

bool? Italic { get; set; }

Property Value

bool?:

A nullable bool indicating whether the highlighting style uses italics.

See Also

StrikethroughColor

Gets or sets the strike-through color of the highlighting style.

Color? StrikethroughColor { get; set; }

Property Value

Color?:

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

See Also

StrikethroughKind

Gets or sets a LineKind indicating the kind of strike-through to use.

LineKind StrikethroughKind { get; set; }

Property Value

LineKind:

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

See Also

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.

See Also

Tag

Gets or sets the object that contains user-defined data about the object.

object Tag { get; set; }

Property Value

object:

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

Remarks

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

See Also

UnderlineColor

Gets or sets the underline color of the highlighting style.

Color? UnderlineColor { get; set; }

Property Value

Color?:

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

See Also

UnderlineKind

Gets or sets a LineKind indicating the kind of underline to use.

LineKind UnderlineKind { get; set; }

Property Value

LineKind:

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

See Also

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.

See Also

See Also