Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 29
Next »
Unknown macro: {div}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.
Enter additional information related to this 'class' inside the {div} macro with 'id=description'
Unknown macro: {div} Creating XML objects
from a string
var myXml = new XML('<test level="1"><test2 level="2">A value</test2></test>');
using XML object notation
var myXml =
<test level="1">
<test2 level="2">A value</test2>
</test>;
using JavaScript variables
var myValue = 'hello, some value!';
var myXml =
<test level="1">
<test2 level="2">{myValue}</test2>
</test>;
Accessing the XML
General
var myXml = new XML('<test level="1"><test2 level="2">A value</test2></test>');
application.output(myXml.test2.toString()); //outputs 'A value'
A specific index on subnodes
var myXml = new XML('<test level="1"><test2 level="2">A value</test2><test2 level="2">Another value</test2></test>');
application.output(myXml.test2[1].toXMLString()); //outputs '<test2 level="2">Another value</test2>'
XML in Action!
Unknown macro: {table}
{column:width=80px|padding=0px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Property Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} ignoreComments
If set to true, then comments in the XML are ignored when constructing new XML objects.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} ignoreProcessingInstructions
If set to true, then processing instructions are ignored when constructing new XML objects.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} ignoreWhitespace
If set to true, then whitespace in the XML is ignored when constructing new XML objects.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} prettyIndent
The amount of positions used when indenting child nodes are relative to their parent
if prettyPrinting is enabled.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} prettyPrinting
If set to true, then toString() and toXMLString() methods will normalize the output
to achieve a uniform appearance.
Unknown macro: {table}
{column:width=80px|padding=0px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Method Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} addNamespace(namespaceToAdd)
Takes one argument which can be a string with a namespace URI or a Namespace object and adds the
argument to the in scope namespaces of this XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} appendChild(childToAppend)
Appends a new child at the end of this XML object's properties, the changed XML object is then returned.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} attribute(attributeName)
Takes a single argument with the attribute name and returns an XMLList with attributes
matching the argument.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} attributes()
Returns an XMLList with the attributes of this XML object which are in no namespace.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} child(propertyName)
Returns an XMLList with children matching the property name.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} childIndex()
If the XML object has no parent then the special number NaN is returned, otherwise the ordinal
position the object has in the context of its parent is returned.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} children()
Returns an XMLList with the child nodes of this XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} comments()
Returns an XMLList with the comment nodes which are children of this XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} contains(value)
Calling xmlObject.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} copy()
Returns a deep copy of the XML object it is called on where the internal parent property is set to null
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} defaultSettings()
Returns an object containing the default XML settings.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} descendants()
Returns an XMLList with the descendants matching the passed name argument or with all descendants
if no argument is passed.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} descendants(name)
Returns an XMLList with the descendants matching the passed name argument or with all descendants
if no argument is passed.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} elements()
Takes one optional argument, the name of elements you are looking for, and returns an XMLList with
all matching child elements.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} elements(name)
Takes one optional argument, the name of elements you are looking for, and returns an XMLList with
all matching child elements.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} hasComplexContent()
Returns false for XML objects of node kind 'text', 'attribute', 'comment', and 'processing-instruction'.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} hasOwnProperty(propertyName)
Returns true if the XML object the method is called on has a property of that name.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} hasSimpleContent()
Returns true for XML objects of node kind text or attribute.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Array
Unknown macro: {td} inScopeNamespaces()
Returns an array of Namespace objects representing the namespace that are in scope for this XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} insertChildAfter(childToInserAfter, childToInsert)
Takes two arguments, an existing child to insert after and the new child to be inserted.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} insertChildBefore(childToInsertBefore, childToInsert)
Takes two arguments, an existing child to insert before and the new child to be inserted.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} length()
This always returns 1.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} localName()
returns the local name part if the XML object has a name.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} QName
Unknown macro: {td} name()
Returns the qualified name (a QName object) of the XML object it is called
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} namespace()
If no argument is passed to the method then it returns the namespace associated with the qualified
name of this XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} namespace(prefix)
If no argument is passed to the method then it returns the namespace associated with the qualified
name of this XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Array
Unknown macro: {td} namespaceDeclarations()
Returns an array with the namespace declarations associated with the XML object it is called on.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} nodeKind()
Returns a string denoting the kind of node this XML object represents.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} normalize()
Returns this XML object after normalizing all text content.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} parent()
Returns the parent XML object of this XML object or null if there is no parent.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} prependChild(childToPrepend)
Iinserts the given value as the first child of the XML object and returns the XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} processingInstructions()
If no argument is passed in then the method returns an XMLList with all the children of the XML
object which are processing instructions.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} processingInstructions(name)
If no argument is passed in then the method returns an XMLList with all the children of the XML
object which are processing instructions.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} propertyIsEnumerable(propertyName)
Returns true if the property name is '0' and false otherwise.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} removeNamespace(namespace)
Removes the namespace from the in scope namespaces of this XML object if the namespace
is not used for the qualified name of the object or its attributes.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} replace(propertyName, replacementValue)
Takes two arguments, the property name of the property / properties to be replaced, and the
value to replace the properties.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setChildren(value)
Replaces all children of the XML object with this value.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setLocalName(name)
Changes the local name of this XML object to the name passed in.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setName(name)
Replaces the name of this XML object with the name passed in.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setNamespace(namespace)
Changes the namespace associated with the name of this XML object to the new namespace.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setSettings()
Allows the global XML settings to be adjusted or restored to their default values.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setSettings(settings)
Allows the global XML settings to be adjusted or restored to their default values.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} settings()
Returns an object containing the global XML settings.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} text()
Returns an XMLList with all the children of this XML object that represent text nodes.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} toString()
Returns a convenient string value of this XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} toXMLString()
Returns a string with the serialized XML markup for this XML object.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} valueOf()
The method simply returns the XML object it is called on.
Unknown macro: {table}
{column:width=100%|padding=0px}{column}
Unknown macro: {tr} Unknown macro: {th} Property Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} ignoreComments
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If set to true, then comments in the XML are ignored when constructing new XML objects.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var element = <foo><!-- my comment --><bar/></foo>;
application.output(element.comments().length());
application.output(element.toXMLString());
XML.ignoreComments = false;
element = <foo><!-- my comment --><bar/></foo>;
application.output(element.comments().length());
application.output(element.toXMLString());
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} ignoreProcessingInstructions
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If set to true, then processing instructions are ignored when constructing new XML objects.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
XML.ignoreProcessingInstructions=false;
var xmlElement = <publishing><?process author="yes"?><author type="leadership">John C. Maxwell</author></publishing>;
application.output(" Element = "+ xmlElement.toXMLString());
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} ignoreWhitespace
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If set to true, then whitespace in the XML is ignored when constructing new XML objects.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
XML.ignoreWhitespace = false;
var xmlElement =
<publishing>
<author>John C. Maxwell</author>
</publishing>;
application.output(xmlElement.toString());
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} prettyIndent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} The amount of positions used when indenting child nodes are relative to their parent
if prettyPrinting is enabled.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var xmlElement = <publishing><author>Tom DeMarco</author><author>Roger S. Pressman</author></publishing>;
application.output(xmlElement.toXMLString());
XML.prettyPrinting = true;
XML.prettyIndent = 4;
xmlElement = <publishing><author>Tom DeMarco</author><author>Roger S. Pressman</author></publishing>;
application.output(xmlElement.toXMLString());
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} prettyPrinting
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If set to true, then toString() and toXMLString() methods will normalize the output
to achieve a uniform appearance.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var xmlElement = <publishing><author>Tom DeMarco</author><author>Roger S. Pressman</author></publishing>;
application.output(xmlElement.toXMLString());
XML.prettyPrinting = true;
XML.prettyIndent = 4;
xmlElement = <publishing><author>Tom DeMarco</author><author>Roger S. Pressman</author></publishing>;
application.output(xmlElement.toXMLString());
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {table}
{column:width=100%|padding=0px}{column}
Unknown macro: {tr} Unknown macro: {th} Method Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} addNamespace
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} addNamespace
Unknown macro: {span} (namespaceToAdd)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Takes one argument which can be a string with a namespace URI or a Namespace object and adds the
argument to the in scope namespaces of this XML object.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} namespaceToAdd
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.addNamespace(namespaceToAdd)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} appendChild
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} appendChild
Unknown macro: {span} (childToAppend)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Appends a new child at the end of this XML object's properties, the changed XML object is then returned.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {XML} childToAppend
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.appendChild(childToAppend)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} attribute
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} attribute
Unknown macro: {span} (attributeName)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Takes a single argument with the attribute name and returns an XMLList with attributes
matching the argument.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} attributeName
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.attribute(attributeName)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} attributes
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} attributes
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an XMLList with the attributes of this XML object which are in no namespace.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} child
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} child
Unknown macro: {span} (propertyName)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an XMLList with children matching the property name.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} propertyName
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.child(childPropertyName)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} childIndex
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} childIndex
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If the XML object has no parent then the special number NaN is returned, otherwise the ordinal
position the object has in the context of its parent is returned.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} children
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} children
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an XMLList with the child nodes of this XML object.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} comments
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} comments
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an XMLList with the comment nodes which are children of this XML object.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} contains
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} contains
Unknown macro: {span} (value)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Calling xmlObject.contains(value) yields the same result as the equality comparison xmlObject == value
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {Object} value
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} copy
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns a deep copy of the XML object it is called on where the internal parent property is set to null
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} defaultSettings
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} defaultSettings
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an object containing the default XML settings.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} descendants
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} descendants
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an XMLList with the descendants matching the passed name argument or with all descendants
if no argument is passed.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} descendants
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} descendants
Unknown macro: {span} (name)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an XMLList with the descendants matching the passed name argument or with all descendants
if no argument is passed.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} name
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} elements
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} elements
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Takes one optional argument, the name of elements you are looking for, and returns an XMLList with
all matching child elements.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} elements
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} elements
Unknown macro: {span} (name)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Takes one optional argument, the name of elements you are looking for, and returns an XMLList with
all matching child elements.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} name
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} hasComplexContent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} hasComplexContent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns false for XML objects of node kind 'text', 'attribute', 'comment', and 'processing-instruction'.
For objects of kind 'element' it checks whether the element has at least one child element.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} hasOwnProperty
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} hasOwnProperty
Unknown macro: {span} (propertyName)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns true if the XML object the method is called on has a property of that name.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} propertyName
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.hasOwnProperty(propertyName)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} hasSimpleContent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} hasSimpleContent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns true for XML objects of node kind text or attribute. For XML objects of node kind
element it returns true if the element has no child elements and false otherwise.
For other node kinds (comment, processing instruction) the method always returns false.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} inScopeNamespaces
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} Array
Unknown macro: {span} inScopeNamespaces
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an array of Namespace objects representing the namespace that are in scope for this XML object.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} Array
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} insertChildAfter
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} insertChildAfter
Unknown macro: {span} (childToInserAfter, childToInsert)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Takes two arguments, an existing child to insert after and the new child to be inserted.
If the first argument is null then the second argument is inserted as the first child of this XML.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {XML} childToInserAfter
{XML} childToInsert
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.insertChildAfter(childToInsertAfter, childToInsert)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} insertChildBefore
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} insertChildBefore
Unknown macro: {span} (childToInsertBefore, childToInsert)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Takes two arguments, an existing child to insert before and the new child to be inserted.
If the first argument is null then the child is inserted as the last child.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {XML} childToInsertBefore
{XML} childToInsert
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.insertChildBefore(childToInsertBefore, childToInsert)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} length
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} length
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} This always returns 1. This is done to blur the distinction between an XML object and an XMLList
containing exactly one value.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} localName
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} localName
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} returns the local name part if the XML object has a name.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} QName
Unknown macro: {span} name
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns the qualified name (a QName object) of the XML object it is called
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} QName
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} namespace
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} namespace
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If no argument is passed to the method then it returns the namespace associated with the qualified
name of this XML object. If a prefix is passed to the method then it looks for a matching namespace
in the in scope namespace of this XML object and returns it when found, otherwise undefined is returned.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} namespace
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} namespace
Unknown macro: {span} (prefix)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If no argument is passed to the method then it returns the namespace associated with the qualified
name of this XML object. If a prefix is passed to the method then it looks for a matching namespace
in the in scope namespace of this XML object and returns it when found, otherwise undefined is returned.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} prefix
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} namespaceDeclarations
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} Array
Unknown macro: {span} namespaceDeclarations
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an array with the namespace declarations associated with the XML object it is called on.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} Array
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.namespaceDeclarations()
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} nodeKind
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} nodeKind
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns a string denoting the kind of node this XML object represents. Possible values: 'element',
'attribute', 'text', 'comment', 'processing-instruction'.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} normalize
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} normalize
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns this XML object after normalizing all text content.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} parent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} parent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns the parent XML object of this XML object or null if there is no parent.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} prependChild
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} prependChild
Unknown macro: {span} (childToPrepend)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Iinserts the given value as the first child of the XML object and returns the XML object.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {XML} childToPrepend
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.prependChild(childToPrepend)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} processingInstructions
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} processingInstructions
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If no argument is passed in then the method returns an XMLList with all the children of the XML
object which are processing instructions. If an argument is passed in then the method returns an
XMLList with all children of the XML object which are processing instructions where the name
matches the argument.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.processingInstructions([name])
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} processingInstructions
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} processingInstructions
Unknown macro: {span} (name)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} If no argument is passed in then the method returns an XMLList with all the children of the XML
object which are processing instructions. If an argument is passed in then the method returns an
XMLList with all children of the XML object which are processing instructions where the name
matches the argument.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} name
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.processingInstructions([name])
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} propertyIsEnumerable
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} propertyIsEnumerable
Unknown macro: {span} (propertyName)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns true if the property name is '0' and false otherwise.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} propertyName
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.propertyIsEnumerable(propertyName)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} removeNamespace
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} removeNamespace
Unknown macro: {span} (namespace)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Removes the namespace from the in scope namespaces of this XML object if the namespace
is not used for the qualified name of the object or its attributes.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.removeNamespace(namespace)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} replace
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} replace
Unknown macro: {span} (propertyName, replacementValue)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Takes two arguments, the property name of the property / properties to be replaced, and the
value to replace the properties.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} propertyName
{XML} replacementValue
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.replace(propertyName, replacementValue)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setChildren
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} setChildren
Unknown macro: {span} (value)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Replaces all children of the XML object with this value. The method returns the XML object it
is called on.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {Object} value
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setLocalName
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setLocalName
Unknown macro: {span} (name)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Changes the local name of this XML object to the name passed in.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} name
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setName
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setName
Unknown macro: {span} (name)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Replaces the name of this XML object with the name passed in.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} name
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setNamespace
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setNamespace
Unknown macro: {span} (namespace)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Changes the namespace associated with the name of this XML object to the new namespace.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.setNamespace(namespace)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setSettings
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setSettings
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Allows the global XML settings to be adjusted or restored to their default values.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.setSettings(settings)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setSettings
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setSettings
Unknown macro: {span} (settings)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Allows the global XML settings to be adjusted or restored to their default values.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {Object} settings – The new settings that should be applied globally to the XML object.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {div} void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
xml.setSettings(settings)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} settings
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} settings
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an object containing the global XML settings.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} text
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns an XMLList with all the children of this XML object that represent text nodes.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} toString
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} toString
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns a convenient string value of this XML object.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} toXMLString
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} toXMLString
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Returns a string with the serialized XML markup for this XML object. XML.prettyPrinting
and XML.prettyIndent settings affect the returned string.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} valueOf
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} XML
Unknown macro: {span} valueOf
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} The method simply returns the XML object it is called on.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {tr} Unknown macro: {td}