XmlElement | xmlcreate

Represents an XML element.

A sample XML element is structured as follows, where {name} is the name of the element:

<{name} attname="attvalue">
    <subelem/>
    <?pitarget picontent?>
    text
</{name}></pre>

The {name} value is a property of the node, while the attributes and children of the element (such as other elements, processing instructions, and text) are children of this node.

XmlElement nodes can have an unlimited number of XmlAttribute, XmlCdata, XmlCharRef, XmlComment, XmlElement, XmlEntityRef, XmlProcInst, or XmlCharData nodes as children.

Hierarchy

XmlNode
- XmlElement

Index

Constructors

constructor

Properties

Accessors

name
parent

Methods

Constructors

constructor

new XmlElement(name: string): XmlElement

Overrides XmlNode.constructor
- Defined in nodes/XmlElement.ts:53
Initializes a new instance of the XmlElement class.

Parameters
- name: string
  
  The name of the element.
Returns XmlElement

Properties

Protected _children

_children: XmlNode[]

Private _name

_name: string

Accessors

name

get name(): string
set name(name: string): void

- Defined in nodes/XmlElement.ts:70
Gets the name of the element.

Returns string

The name of the element.
- Defined in nodes/XmlElement.ts:79
Sets the name of the element.

Parameters
- name: string
  
  The name of the element.
Returns void

The name of the element.

parent

get parent(): XmlNode | undefined

Inherited from XmlNode.parent
- Defined in nodes/XmlNode.ts:44
Gets the parent of this node.

Returns XmlNode | undefined

The parent of this node.

Methods

attribute

attribute(name: string, value: string | XmlNode | Array<string | XmlNode>, index?: number): XmlAttribute

- Defined in nodes/XmlElement.ts:102
Inserts an new attribute at the specified index. If no index is specified, the node is inserted at the end of this node's children.

Parameters
- name: string
  
  The name of the attribute.
- value: string | XmlNode | Array<string | XmlNode>
  
  The value of the attribute. Strings are converted to XmlAttributeText nodes.
- Optional index: number
  
  The index at which the node should be inserted. If no index is specified, the node is inserted at the end of this node's children.
Returns XmlAttribute

The newly created attribute.

attributes

attributes(): XmlAttribute[]

- Defined in nodes/XmlElement.ts:128
Returns an array containing all of the children of this node that are instances of XmlAttribute.

Returns XmlAttribute[]

An array containing all of the children of this node that are instances of XmlAttribute.

cdata

cdata(content: string, index?: number): XmlCdata

- Defined in nodes/XmlElement.ts:144
Inserts a new CDATA section at the specified index. If no index is specified, the node is inserted at the end of this node's children.

Parameters
- content: string
  
  The data of the CDATA section.
- Optional index: number
  
  The index at which the node should be inserted. If no index is specified, the node is inserted at the end of this node's children.
Returns XmlCdata

The newly created CDATA section.

charData

charData(charData: string, index?: number): XmlCharData

- Defined in nodes/XmlElement.ts:161
Inserts some character data at the specified index. If no index is specified, the node is inserted at the end of this node's children.

Parameters
- charData: string
  
  Character data.
- Optional index: number
  
  The index at which the node should be inserted. If no index is specified, the node is inserted at the end of this node's children.
Returns XmlCharData

The newly created text node.

charRef

charRef(char: string, hex?: boolean, index?: number): XmlCharRef

- Defined in nodes/XmlElement.ts:180
Inserts a new character reference at the specified index. If no index is specified, the node is inserted at the end of this node's children.

Parameters
- char: string
  
  The character to represent using the reference.
- Optional hex: boolean
  
  Whether to use the hexadecimal or decimal representation for the reference. If left undefined, decimal is the default.
- Optional index: number
  
  The index at which the node should be inserted. If no index is specified, the node is inserted at the end of this node's children.
Returns XmlCharRef

The newly created character reference.

children

children(): XmlNode[]

Inherited from XmlNode.children
- Defined in nodes/XmlNode.ts:56
Gets this node's children.

Throws an exception if this node cannot have any children. Consult the appropriate subclass documentation for more details.

Returns XmlNode[]

This node's children.

comment

comment(content: string, index?: number): XmlComment

- Defined in nodes/XmlElement.ts:197
Inserts a new comment at the specified index. If no index is specified, the node is inserted at the end of this node's children.

Parameters
- content: string
  
  The data of the comment.
- Optional index: number
  
  The index at which the node should be inserted. If no index is specified, the node is inserted at the end of this node's children.
Returns XmlComment

The newly created comment.

element

element(name: string, index?: number): XmlElement

- Defined in nodes/XmlElement.ts:214
Inserts a new element at the specified index. If no index is specified, the node is inserted at the end of this node's children.

Parameters
- name: string
  
  The name of the element.
- Optional index: number
  
  The index at which the node should be inserted. If no index is specified, the node is inserted at the end of this node's children.
Returns XmlElement

The newly created element.

entityRef

entityRef(entity: string, index?: number): XmlEntityRef

- Defined in nodes/XmlElement.ts:231
Inserts a new entity reference at the specified index. If no index is specified, the node is inserted at the end of this node's children.

Parameters
- entity: string
  
  The entity to be referenced.
- Optional index: number
  
  The index at which the node should be inserted. If no index is specified, the node is inserted at the end of this node's children.
Returns XmlEntityRef

The newly created entity reference.

insertChild

insertChild(node: XmlNode, index?: number): XmlNode | undefined

Overrides XmlNode.insertChild
- Defined in nodes/XmlElement.ts:255
Inserts the specified node into this node's children at the specified index. The node is not inserted if it is already present. If this node already has a parent, it is removed from that parent.

Note that only XmlAttribute, XmlCdata, XmlCharRef, XmlComment, XmlElement, XmlEntityRef, XmlProcInst, or XmlCharData nodes can be inserted; otherwise, an exception will be thrown.

Parameters
- node: XmlNode
  
  The node to insert.
- Optional index: number
  
  The index at which to insert the node. Nodes at or after the index are shifted to the right. If no index is specified, the node is inserted at the end.
Returns XmlNode | undefined

The node inserted into this node's children, or undefined if no node was inserted.

next(): XmlNode | undefined

Inherited from XmlNode.next
- Defined in nodes/XmlNode.ts:108
Gets the node that follows this one, or undefined if no such node exists or if this node has no parent.

Returns XmlNode | undefined

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

prev(): XmlNode | undefined

Inherited from XmlNode.prev
- Defined in nodes/XmlNode.ts:127
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 | undefined

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

procInst

procInst(target: string, content?: string, index?: number): XmlProcInst

- Defined in nodes/XmlElement.ts:299
Inserts a new processing instruction at the specified index. If no index is specified, the node is inserted at the end of this node's children.

Parameters
- target: string
  
  The target of the processing instruction.
- Optional content: string
  
  The data of the processing instruction, or undefined if there is no target.
- Optional index: number
  
  The index at which the node should be inserted. If no index is specified, the node is inserted at the end of this node's children.
Returns XmlProcInst

The newly created processing instruction.

remove

remove(): XmlNode | undefined

Inherited from XmlNode.remove
- Defined in nodes/XmlNode.ts:142
Removes this node from its parent if this node has a parent.

Returns XmlNode | undefined

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

removeChild

removeChild(node: XmlNode): boolean

Inherited from XmlNode.removeChild
- Defined in nodes/XmlNode.ts:162
Removes the specified node from this node's children.

Throws an exception if this node cannot have any children, or if the specified node cannot be removed. Consult the appropriate subclass documentation for more details.

Parameters
- node: XmlNode
  
  The node to remove.
Returns boolean

Whether a node was removed.

removeChildAtIndex

removeChildAtIndex(index: number): XmlNode

Inherited from XmlNode.removeChildAtIndex
- Defined in nodes/XmlNode.ts:187
Removes the node at the specified index from this node's children.

Throws an exception if this node cannot have any children, or if the node at the specified index cannot be removed. Consult the appropriate subclass documentation for more details.

Parameters
- index: number
  
  The index at which the node to be removed is located.
Returns XmlNode

The node that was removed.

toString

toString(options?: IStringOptions): string

Overrides XmlNode.toString
- Defined in nodes/XmlElement.ts:314
Returns an XML string representation of this node.

Parameters
- Default value options: IStringOptions = {}
  
  Formatting options for the string representation.
Returns string

An XML string representation of this node.

top

top(): XmlNode

Inherited from XmlNode.top
- Defined in nodes/XmlNode.ts:217
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

up(): XmlNode | undefined

Inherited from XmlNode.up
- Defined in nodes/XmlNode.ts:228
Gets the parent of this node.

Returns XmlNode | undefined

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

Returns XmlElement

Properties

Protected _children

Private _name

Accessors

name

Returns string

Parameters

name: string

Returns void

parent

Returns XmlNode | undefined

Methods

attribute

Parameters

name: string

value: string | XmlNode | Array<string | XmlNode>

Optional index: number

Returns XmlAttribute

attributes

Returns XmlAttribute[]

cdata

Parameters

content: string

Optional index: number

Returns XmlCdata

charData

Parameters

charData: string

Optional index: number

Returns XmlCharData

charRef

Parameters

char: string

Optional hex: boolean

Optional index: number

Returns XmlCharRef

children

Returns XmlNode[]

comment

Parameters

content: string

Optional index: number

Returns XmlComment

element

Parameters

name: string

Optional index: number

Returns XmlElement

entityRef

Parameters

entity: string

Optional index: number

Returns XmlEntityRef

insertChild

Parameters

node: XmlNode

Optional index: number

Returns XmlNode | undefined

next

Returns XmlNode | undefined

prev

Returns XmlNode | undefined

procInst

Parameters

target: string

Optional content: string

Optional index: number

Returns XmlProcInst

remove