Formatter Class

Formats XML syntax trees/documents using XmlFormattingOptions.

public static class Formatter

Remarks

Each element whose content is only elements, comments and processing instructions gets each child on its own line, indented one level deeper. Text is never changed: an element that contains text or CDATA, its descendants, and elements under xml:space="preserve" are written as they are.

Example

var tree = XmlSyntaxTree.ParseText("<root><item/></root>");
var formatted = Formatter.Format(tree);
Assert.Equal("<root>\n  <item />\n</root>", formatted.ToFullString());

Properties

NameDescription
AnnotationMarks the nodes this formatter produced, so a later pass can find them again.

Annotation

Formatter.cs

Marks the nodes this formatter produced, so a later pass can find them again.

public static SyntaxAnnotation Annotation { get; }

Property value

SyntaxAnnotation

Methods

NameDescription
Format(XmlDocumentSyntax)
Format(XmlDocumentSyntax, XmlFormattingOptions?)
Format(XmlSyntaxTree)

Format overloads

Format(XmlDocumentSyntax)

Formatter.cs
public static XmlDocumentSyntax Format(XmlDocumentSyntax document)
Parameters
document XmlDocumentSyntax
Returns

XmlDocumentSyntax

No documentation is available.

Format(XmlDocumentSyntax, XmlFormattingOptions?)

Formatter.cs
public static XmlDocumentSyntax Format(XmlDocumentSyntax document, XmlFormattingOptions? options)

No documentation is available.

Format(XmlSyntaxTree)

Formatter.cs
public static XmlDocumentSyntax Format(XmlSyntaxTree syntaxTree)
Parameters
syntaxTree XmlSyntaxTree
Returns

XmlDocumentSyntax

No documentation is available.