Class DocumentOutputSettings
A Document's output settings control the form of the text() and html() methods.
Inheritance
Namespace: Supremes.Nodes
Assembly: Supremes.dll
Syntax
public sealed class DocumentOutputSettings : object
Properties
Charset
Get or Set the document's current output charset,
which is used to control which characters are escaped
when generating HTML (via the Html
properties),
and which are kept intact.
Declaration
public Encoding Charset { get; set; }
Property Value
Type | Description |
---|---|
Encoding | the new charset to use |
Remarks
Where possible (when parsing from a URL or File), the document's output charset is automatically set to the input charset. Otherwise, it defaults to utf-8.
if you want to use fluent API, write using Supremes.Fluent;
.
See Also
EscapeMode
Get or Set the document's current HTML escape mode, which determines how characters are escaped when the output character set does not support a given character.
Declaration
public DocumentEscapeMode EscapeMode { get; set; }
Property Value
Type | Description |
---|---|
DocumentEscapeMode | the new escape mode to use |
Remarks
Base
, which provides a limited set of named HTML entities
and escapes other characters as numbered entities for maximum compatibility;
or Extended
, which uses the complete set of HTML named entities.
The default escape mode is Base
.
if you want to use fluent API, write using Supremes.Fluent;
.
See Also
IndentAmount
Get or Set the current tag indent amount, used when pretty printing.
Declaration
public int IndentAmount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | number of spaces to use for indenting each level. Must be >= 0 |
See Also
Outline
Get or Set if outline mode is enabled.
Declaration
public bool Outline { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | new outline setting |
Remarks
Default is false. If enabled, the HTML output methods will consider all tags as block.
if you want to use fluent API, write using Supremes.Fluent;
.
See Also
PrettyPrint
Get or Set if pretty printing is enabled.
Declaration
public bool PrettyPrint { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | new pretty print setting |
Remarks
Default is true. If disabled, the HTML output methods will not re-format the output, and the output will generally look like the input.
if you want to use fluent API, write using Supremes.Fluent;
.
See Also
Syntax
Get or Set the document's current output syntax.
Declaration
public DocumentSyntax Syntax { get; set; }
Property Value
Type | Description |
---|---|
DocumentSyntax | serialization syntax |
Remarks
Either Html
, with empty tags and boolean attributes (etc),
or Xml
, with self-closing tags.
if you want to use fluent API, write using Supremes.Fluent;
.