Options
All
  • Public
  • Public/Protected
  • All
Menu

Class XmlText

Represents text in an XML document.

This text may only consist of character data, not markup. Restricted characters, such as the ampersand (&) and the opening angle bracket (<) are all automatically escaped.

To create an character reference or entity reference, you should use XmlCharRef or XmlEntityRef respectively instead.

XmlText nodes cannot have any children.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new XmlText(text: string): XmlText

  • Initializes a new instance of the XmlText class.

    Parameters

    • text: string

      Arbitrary character data.

    Returns XmlText

Properties

Protected _children

_children: XmlNode[]

Private _text

_text: string

Accessors

parent

  • Gets the parent of this node.

    Returns XmlNode

    The parent of this node.

text

  • get text(): string
  • set text(text: string): void

  • Gets the text associated with this node.

    Returns string

    The text associated with this node.

  • Sets the text associated with this node.

    Parameters

    • text: string

      Arbitrary character data.

    Returns void

    The text associated with this node.

Methods

children

insertChild

next

  • Gets the node that follows this one, or undefined if no such node exists or if this node has no parent.

    Returns XmlNode

    The node that follows this one, or undefined if no such node exists or if this node has no parent.

prev

  • Gets the node that is previous to this one, or undefined if no such node exists or if this node has no parent.

    Returns XmlNode

    The node that is previous to this one, or undefined if no such node exists or if this node has no parent.

remove

  • Removes this node from its parent if this node has a parent.

    Returns XmlNode

    This node's parent, or undefined if it has no parent.

removeChild

  • removeChild(node: XmlNode): boolean

  • Throws an exception since XmlText nodes cannot have any children.

    Parameters

    Returns boolean

removeChildAtIndex

  • removeChildAtIndex(index: number): XmlNode

toString

  • Returns an XML string representation of this node.

    Parameters

    Returns string

    An XML string representation of this node.

top

  • Returns the root node of the current hierarchy. If this node has no parent, this node itself is returned.

    Returns XmlNode

    The root node of the current hierarchy.

up

  • Gets the parent of this node.

    Returns XmlNode

    The parent of this node.

Generated using TypeDoc