Display the source code in std/xml.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Class `std.xml.Document`

Class representing an XML document.


						
				class Document
				
  : Element
				;

Constructors

Name	Description
`this` (s)	Constructs a Document by parsing XML text.
`this` (tag)	Constructs a Document from a Tag.

Fields

Name	Type	Description
`epilog`	`string`	Contains all text which occurs after the root element. Defaults to the empty string
`prolog`	`string`	Contains all text which occurs before the root element. Defaults to <?xml version="1.0"?>
`cdatas`	`CData[]`	The element's CData items
`comments`	`Comment[]`	The element's comments
`elements`	`Element[]`	The element's child elements
`items`	`Item[]`	The element's items
`pis`	`ProcessingInstruction[]`	The element's processing instructions
`tag`	`Tag`	The start tag of the element
`texts`	`Text[]`	The element's text items

Properties

Name	Type	Description
`isEmptyXML`[get]	`bool`	Returns true if the item represents empty XML text

Methods

Name	Description
`opCmp` (o)	Compares two Documents
`opEquals` (o)	Compares two Documents for equality
`toHash` ()	Returns the hash of a Document
`toString` ()	Returns the string representation of a Document. (That is, the complete XML of a document).
`factory` (classname)	Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
`opCmp` (o)	Compares two Elements
`opCmp` (o)	Compare with another Object obj.
`opEquals` (o)	Test whether `this` is equal to `o`. The default implementation only compares by identity (using the `is` operator). Generally, overrides for `opEquals` should attempt to compare objects by their contents.
`opOpAssign` (item)	Append a text item to the interior of this element
`opOpAssign` (item)	Append a CData item to the interior of this element
`opOpAssign` (item)	Append a comment to the interior of this element
`opOpAssign` (item)	Append a processing instruction to the interior of this element
`opOpAssign` (item)	Append a complete element to the interior of this element
`pretty` (indent)	Returns an indented string representation of this item
`text` (mode)	Returns the decoded interior of an element.
`toHash` ()	Returns the hash of an Element
`toHash` ()	Compute hash function for Object.
`toString` ()	Convert Object to a human readable string.

Standards

XML 1.0

Authors

Janice Caron

License

Boost License 1.0.