class
HtmlEscapeMode

HTML escape modes.

Allows specifying a mode for HTML escaping that depend on the context where the escaped result is going to be used. The relevant contexts are:

  • as text content of an HTML element.
  • as value of a (single- or double-) quoted attribute value.

All modes require escaping of & (ampersand) characters, and may enable escaping of more characters.

Custom escape modes can be created using the HtmlEscapeMode.HtmlEscapeMode constructor.

Constants

HtmlEscapeMode UNKNOWN = const HtmlEscapeMode._('unknown', true, true, true, true)
const
Default escaping mode which escape all characters.
HtmlEscapeMode ATTRIBUTE = const HtmlEscapeMode._('attribute', true, true, false, false)
const
Escaping mode for text going into double-quoted HTML attribute values.
HtmlEscapeMode SQ_ATTRIBUTE = const HtmlEscapeMode._('attribute', true, false, true, false)
const
Escaping mode for text going into single-quoted HTML attribute values.
HtmlEscapeMode ELEMENT = const HtmlEscapeMode._('element', true, false, false, false)
const
Escaping mode for text going into HTML element content.

Properties

bool escapeLtGt
read-only
Whether to escape '<' and '>'.
bool escapeQuot
read-only
Whether to escape '"' (quote).
bool escapeApos
read-only
Whether to escape "'" (apostrophe).
bool escapeSlash
read-only
Whether to escape "/" (forward slash, solidus).

Constructors

HtmlEscapeMode({String name: "custom", bool escapeLtGt: false, bool escapeQuot: false, bool escapeApos: false, bool escapeSlash: false})
const
Create a custom escaping mode.

Methods

toString() → String
Returns a string representation of this object.