Skip to main content

HighlightStyle Enum

Definition​

Assembly:Avalonia.Controls.Documents
Package:Avalonia.Controls.Documents

Defines the visual style of a highlight.

public enum HighlightStyle

Inheritance: Enum -> HighlightStyle

Fields​

NameDescription
BackgroundBackground color highlight (like selection).
BorderBorder around text. For drawing a layer cannot express with these styles, override Avalonia.Controls.Documents.Primitives.Highlighting.HighlightLayerBase.RenderRegion(Avalonia.Media.DrawingContext,Avalonia.Controls.Documents.Primitives.ITextView,Avalonia.Controls.Documents.Primitives.Highlighting.HighlightRegion).
CustomA style the layer draws itself. Nothing in the built-in layers reads it: a layer that renders its own decoration does so whatever this says.
DottedUnderlineDotted underline (like grammar suggestions).
StrikethroughStrikethrough (like deleted text in diff).
UnderlineRichUnderline (solid, like spell check).
WavyUnderlineWavy underline (like spell check errors).

Background Field​

Background color highlight (like selection).

public Avalonia.Controls.Documents.Primitives.Highlighting.HighlightStyle Background

Border Field​

Border around text. For drawing a layer cannot express with these styles, override Avalonia.Controls.Documents.Primitives.Highlighting.HighlightLayerBase.RenderRegion(Avalonia.Media.DrawingContext,Avalonia.Controls.Documents.Primitives.ITextView,Avalonia.Controls.Documents.Primitives.Highlighting.HighlightRegion).

public Avalonia.Controls.Documents.Primitives.Highlighting.HighlightStyle Border

Custom Field​

A style the layer draws itself. Nothing in the built-in layers reads it: a layer that renders its own decoration does so whatever this says.

public Avalonia.Controls.Documents.Primitives.Highlighting.HighlightStyle Custom

DottedUnderline Field​

Dotted underline (like grammar suggestions).

public Avalonia.Controls.Documents.Primitives.Highlighting.HighlightStyle DottedUnderline

Strikethrough Field​

Strikethrough (like deleted text in diff).

public Avalonia.Controls.Documents.Primitives.Highlighting.HighlightStyle Strikethrough

Underline Field​

RichUnderline (solid, like spell check).

public Avalonia.Controls.Documents.Primitives.Highlighting.HighlightStyle Underline

WavyUnderline Field​

Wavy underline (like spell check errors).

public Avalonia.Controls.Documents.Primitives.Highlighting.HighlightStyle WavyUnderline