Class XmlDocumentType

A document type declaration within an XML document.

Example

<!DOCTYPE kittens [
  <!ELEMENT kittens (#PCDATA)>
]>

Hierarchy (view full)

Constructors

constructor

Properties

end internalSubset name parent publicId start systemId TYPE_CDATA TYPE_COMMENT TYPE_DOCUMENT TYPE_DOCUMENT_TYPE TYPE_ELEMENT TYPE_PROCESSING_INSTRUCTION TYPE_TEXT TYPE_XML_DECLARATION

Accessors

document isRootNode preserveWhitespace type

Methods

toJSON

Constructors

constructor

Properties

end

end: number = -1

Ending byte offset of this node in the original XML string, or -1 if the offset is unknown.

internalSubset

internalSubset: null | string

Internal subset of this document type declaration, or null if no internal subset was present.

name

name: string

Name of the root element described by this document type declaration.

parent

parent: null | XmlElement | XmlDocument = null

Parent node of this node, or null if this node has no parent.

publicId

publicId: null | string

Public identifier of the external subset of this document type declaration, or null if no public identifier was present.

start

start: number = -1

Starting byte offset of this node in the original XML string, or -1 if the offset is unknown.

systemId

systemId: null | string

System identifier of the external subset of this document type declaration, or null if no system identifier was present.

Static ReadonlyTYPE_CDATA

TYPE_CDATA: "cdata" = 'cdata'

Type value for an XmlCdata node.

Static ReadonlyTYPE_COMMENT

TYPE_COMMENT: "comment" = 'comment'

Type value for an XmlComment node.

Static ReadonlyTYPE_DOCUMENT

TYPE_DOCUMENT: "document" = 'document'

Type value for an XmlDocument node.

Static ReadonlyTYPE_DOCUMENT_TYPE

TYPE_DOCUMENT_TYPE: "doctype" = 'doctype'

Type value for an XmlDocumentType node.

Static ReadonlyTYPE_ELEMENT

TYPE_ELEMENT: "element" = 'element'

Type value for an XmlElement node.

Static ReadonlyTYPE_PROCESSING_INSTRUCTION

TYPE_PROCESSING_INSTRUCTION: "pi" = 'pi'

Type value for an XmlProcessingInstruction node.

Static ReadonlyTYPE_TEXT

TYPE_TEXT: "text" = 'text'

Type value for an XmlText node.

Static ReadonlyTYPE_XML_DECLARATION

TYPE_XML_DECLARATION: "xmldecl" = 'xmldecl'

Type value for an XmlDeclaration node.

Accessors

document

isRootNode

  • get isRootNode(): boolean

  • Whether this node is the root node of the document (also known as the document element).

    Returns boolean

preserveWhitespace

  • get preserveWhitespace(): boolean

  • Whether whitespace should be preserved in the content of this element and its children.

    This is influenced by the value of the special xml:space attribute, and will be true for any node whose xml:space attribute is set to "preserve". If a node has no such attribute, it will inherit the value of the nearest ancestor that does (if any).

    Returns boolean

    See

    https://www.w3.org/TR/2008/REC-xml-20081126/#sec-white-space

type

  • get type(): string

  • Type of this node.

    The value of this property is a string that matches one of the static TYPE_* properties on the XmlNode class (e.g. TYPE_ELEMENT, TYPE_TEXT, etc.).

    The XmlNode class itself is a base class and doesn't have its own type name.

    Returns string

Methods

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods