Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

Creating XML objects

from a string

Code Block
var myXml = new XML('<test level="1"><test2 level="2">A value</test2></test>');

using XML object notation

Code Block
var myXml = <test level="1"> <test2 level="2">A value</test2> </test>;

using JavaScript variables

Code Block
var myValue = 'hello, some value!'; var myXml = <test level="1"> <test2 level="2">{myValue}</test2> </test>;

Accessing the XML

General

Code Block
var myXml = new XML('<test level="1"><test2 level="2">A value</test2></test>'); application.output(myXml.test2); //outputs 'A value'

A specific index on subnodes

Code Block
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]); //outputs 'Another value'

XML in Action!

Video

	http://www.servoy.com/docs/servoy_4/tutorials/qv_javascript_XML/JS_XML.swf
	http://www.servoy.com/docs/servoy_4/tutorials/qv_javascript_XML/JS_XML.swf

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#ignoreComments If set to true, then comments in the XML are ignored when constructing new XML objects.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#ignoreProcessingInstructions If set to true, then processing instructions are ignored when constructing new XML objects.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#ignoreWhitespace If set to true, then whitespace in the XML is ignored when constructing new XML objects.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#prettyIndent The amount of positions used when indenting child nodes are relative to their parent if prettyPrinting is enabled.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#prettyPrinting If set to true, then toString() and toXMLString() methods will normalize the output to achieve a uniform appearance.

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (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.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#appendChild(childToAppend) Appends a new child at the end of this XML object's properties, the changed XML object is then returned.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (td)
#attribute(attributeName) Takes a single argument with the attribute name and returns an XMLList with attributes matching the argument.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (td)
#attributes() Returns an XMLList with the attributes of this XML object which are in no namespace.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (td)
#child(propertyName) Returns an XMLList with children matching the property name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (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.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (td)
#children() Returns an XMLList with the child nodes of this XML object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (td)
#comments() Returns an XMLList with the comment nodes which are children of this XML object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#contains(value) Calling xmlObject.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#copy() Returns a deep copy of the XML object it is called on where the internal parent property is set to null

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#defaultSettings() Returns an object containing the default XML settings.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (td)
#descendants([name]) Returns an XMLList with the descendants matching the passed name argument or with all descendants if no argument is passed.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (td)
#elements([name]) Takes one optional argument, the name of elements you are looking for, and returns an XMLList with all matching child elements.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#hasComplexContent() Returns false for XML objects of node kind 'text', 'attribute', 'comment', and 'processing-instruction'.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#hasOwnProperty(propertyName) Returns true if the XML object the method is called on has a property of that name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#hasSimpleContent() Returns true for XML objects of node kind text or attribute.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
#inScopeNamespaces() Returns an array of Namespace objects representing the namespace that are in scope for this XML object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#insertChildAfter(childToInserAfter, childToInsert) Takes two arguments, an existing child to insert after and the new child to be inserted.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#insertChildBefore(childToInsertBefore, childToInsert) Takes two arguments, an existing child to insert before and the new child to be inserted.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#length() This always returns 1.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#localName() returns the local name part if the XML object has a name.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
QName

Table Cell (td)
#name() Returns the qualified name (a QName object) of the XML object it is called

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Namespace

Table Cell (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.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Array

Table Cell (td)
#namespaceDeclarations() Returns an array with the namespace declarations associated with the XML object it is called on.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#nodeKind() Returns a string denoting the kind of node this XML object represents.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#normalize() Returns this XML object after normalizing all text content.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#parent() Returns the parent XML object of this XML object or null if there is no parent.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#prependChild(childToPrepend) Iinserts the given value as the first child of the XML object and returns the XML object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (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.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#propertyIsEnumerable(propertyName) Returns true if the property name is '0' and false otherwise.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (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.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#replace(propertyName, replacementValue) Takes two arguments, the property name of the property / properties to be replaced, and the value to replace the properties.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#setChildren(value) Replaces all children of the XML object with this value.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setLocalName(name) Changes the local name of this XML object to the name passed in.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setName(name) Replaces the name of this XML object with the name passed in.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setNamespace(namespace) Changes the namespace associated with the name of this XML object to the new namespace.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#setSettings([settings]) Allows the global XML settings to be adjusted or restored to their default values.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#settings() Returns an object containing the global XML settings.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XMLList

Table Cell (td)
#text() Returns an XMLList with all the children of this XML object that represent text nodes.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#toString() Returns a convenient string value of this XML object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#toXMLString() Returns a string with the serialized XML markup for this XML object.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
XML

Table Cell (td)
#valueOf() The method simply returns the XML object it is called on.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

Table Body (tbody)

id	ignoreComments
class	node

Table Row (tr)

id	name

Table Cell (td)
ignoreComments

Table Row (tr)

id	des

Table Cell (td)
If set to true, then comments in the XML are ignored when constructing new XML objects.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	ignoreProcessingInstructions
class	node

Table Row (tr)

id	name

Table Cell (td)
ignoreProcessingInstructions

Table Row (tr)

id	des

Table Cell (td)
If set to true, then processing instructions are ignored when constructing new XML objects.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

XML.ignoreProcessingInstructions=false;
var xmlElement = <publishing><?process author="yes"?><author type="leadership">John C. Maxwell</author></publishing>;
application.output(" Element = "+ xmlElement.toXMLString());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	ignoreWhitespace
class	node

Table Row (tr)

id	name

Table Cell (td)
ignoreWhitespace

Table Row (tr)

id	des

Table Cell (td)
If set to true, then whitespace in the XML is ignored when constructing new XML objects.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

XML.ignoreWhitespace = false;
 var xmlElement =
 <publishing>
 	<author>John C. Maxwell</author>
 </publishing>;
 application.output(xmlElement.toString());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	prettyIndent
class	node

Table Row (tr)

id	name

Table Cell (td)
prettyIndent

Table Row (tr)

id	des

Table Cell (td)
The amount of positions used when indenting child nodes are relative to their parent if prettyPrinting is enabled.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	prettyPrinting
class	node

Table Row (tr)

id	name

Table Cell (td)
prettyPrinting

Table Row (tr)

id	des

Table Cell (td)
If set to true, then toString() and toXMLString() methods will normalize the output to achieve a uniform appearance.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	addNamespace
class	node

Table Row (tr)

id	name

Table Cell (td)
addNamespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

addNamespace

Span

style	float: left;
id	iets

(namespaceToAdd)

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} namespaceToAdd

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.addNamespace(namespaceToAdd)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	appendChild
class	node

Table Row (tr)

id	name

Table Cell (td)
appendChild

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

appendChild

Span

style	float: left;
id	iets

(childToAppend)

Table Row (tr)

id	des

Table Cell (td)
Appends a new child at the end of this XML object's properties, the changed XML object is then returned.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {XML} childToAppend

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.appendChild(childToAppend)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	attribute
class	node

Table Row (tr)

id	name

Table Cell (td)
attribute

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

attribute

Span

style	float: left;
id	iets

(attributeName)

Table Row (tr)

id	des

Table Cell (td)
Takes a single argument with the attribute name and returns an XMLList with attributes matching the argument.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} attributeName

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.attribute(attributeName)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	attributes
class	node

Table Row (tr)

id	name

Table Cell (td)
attributes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

attributes

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns an XMLList with the attributes of this XML object which are in no namespace.

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.attributes()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	child
class	node

Table Row (tr)

id	name

Table Cell (td)
child

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

child

Span

style	float: left;
id	iets

(propertyName)

Table Row (tr)

id	des

Table Cell (td)
Returns an XMLList with children matching the property name.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} propertyName

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.child(childPropertyName)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	childIndex
class	node

Table Row (tr)

id	name

Table Cell (td)
childIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

childIndex

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.childIndex()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	children
class	node

Table Row (tr)

id	name

Table Cell (td)
children

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

children

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns an XMLList with the child nodes of this XML object.

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.children()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	comments
class	node

Table Row (tr)

id	name

Table Cell (td)
comments

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

comments

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns an XMLList with the comment nodes which are children of this XML object.

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.comments()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	contains
class	node

Table Row (tr)

id	name

Table Cell (td)
contains

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

contains

Span

style	float: left;
id	iets

(value)

Table Row (tr)

id	des

Table Cell (td)
Calling xmlObject.contains(value) yields the same result as the equality comparison xmlObject == value

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Object} value

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.contains(value)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	copy
class	node

Table Row (tr)

id	name

Table Cell (td)
copy

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

copy

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns a deep copy of the XML object it is called on where the internal parent property is set to null

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.copy()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	defaultSettings
class	node

Table Row (tr)

id	name

Table Cell (td)
defaultSettings

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Object

Span

style	float: left; font-weight: bold;
id	iets

defaultSettings

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns an object containing the default XML settings.

Table Row (tr)

id	ret

Table Cell (td)
Returns Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.defaultSettings()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	descendants
class	node

Table Row (tr)

id	name

Table Cell (td)
descendants

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

descendants

Span

style	float: left;
id	iets

([name])

Table Row (tr)

id	des

Table Cell (td)
Returns an XMLList with the descendants matching the passed name argument or with all descendants if no argument is passed.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} [name]

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.descendants([name])

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	elements
class	node

Table Row (tr)

id	name

Table Cell (td)
elements

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

elements

Span

style	float: left;
id	iets

([name])

Table Row (tr)

id	des

Table Cell (td)
Takes one optional argument, the name of elements you are looking for, and returns an XMLList with all matching child elements.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} [name]

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.elements([name])

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	hasComplexContent
class	node

Table Row (tr)

id	name

Table Cell (td)
hasComplexContent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

hasComplexContent

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.hasComplexContent()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	hasOwnProperty
class	node

Table Row (tr)

id	name

Table Cell (td)
hasOwnProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

hasOwnProperty

Span

style	float: left;
id	iets

(propertyName)

Table Row (tr)

id	des

Table Cell (td)
Returns true if the XML object the method is called on has a property of that name.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} propertyName

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.hasOwnProperty(propertyName)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	hasSimpleContent
class	node

Table Row (tr)

id	name

Table Cell (td)
hasSimpleContent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

hasSimpleContent

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.hasSimpleContent()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	inScopeNamespaces
class	node

Table Row (tr)

id	name

Table Cell (td)
inScopeNamespaces

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Array

Span

style	float: left; font-weight: bold;
id	iets

inScopeNamespaces

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns an array of Namespace objects representing the namespace that are in scope for this XML object.

Table Row (tr)

id	ret

Table Cell (td)
Returns Array

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.inScopeNamespaces()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	insertChildAfter
class	node

Table Row (tr)

id	name

Table Cell (td)
insertChildAfter

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

insertChildAfter

Span

style	float: left;
id	iets

(childToInserAfter, childToInsert)

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {XML} childToInserAfter {XML} childToInsert

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.insertChildAfter(childToInsertAfter, childToInsert)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	insertChildBefore
class	node

Table Row (tr)

id	name

Table Cell (td)
insertChildBefore

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

insertChildBefore

Span

style	float: left;
id	iets

(childToInsertBefore, childToInsert)

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {XML} childToInsertBefore {XML} childToInsert

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.insertChildBefore(childToInsertBefore, childToInsert)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	length
class	node

Table Row (tr)

id	name

Table Cell (td)
length

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

length

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
This always returns 1. This is done to blur the distinction between an XML object and an XMLList containing exactly one value.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.length()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	localName
class	node

Table Row (tr)

id	name

Table Cell (td)
localName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

localName

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
returns the local name part if the XML object has a name.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.localName()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name
class	node

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

QName

Span

style	float: left; font-weight: bold;
id	iets

name

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the qualified name (a QName object) of the XML object it is called

Table Row (tr)

id	ret

Table Cell (td)
Returns QName

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.name()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	namespace
class	node

Table Row (tr)

id	name

Table Cell (td)
namespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Namespace

Span

style	float: left; font-weight: bold;
id	iets

namespace

Span

style	float: left;
id	iets

([prefix])

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} [prefix]

Table Row (tr)

id	ret

Table Cell (td)
Returns Namespace

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.namespace([prefix])

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	namespaceDeclarations
class	node

Table Row (tr)

id	name

Table Cell (td)
namespaceDeclarations

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Array

Span

style	float: left; font-weight: bold;
id	iets

namespaceDeclarations

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns an array with the namespace declarations associated with the XML object it is called on.

Table Row (tr)

id	ret

Table Cell (td)
Returns Array

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.namespaceDeclarations()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	nodeKind
class	node

Table Row (tr)

id	name

Table Cell (td)
nodeKind

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

nodeKind

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns a string denoting the kind of node this XML object represents. Possible values: 'element', 'attribute', 'text', 'comment', 'processing-instruction'.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.nodeKind()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	normalize
class	node

Table Row (tr)

id	name

Table Cell (td)
normalize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

normalize

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns this XML object after normalizing all text content.

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.normalize()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	parent
class	node

Table Row (tr)

id	name

Table Cell (td)
parent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

parent

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the parent XML object of this XML object or null if there is no parent.

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.parent()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	prependChild
class	node

Table Row (tr)

id	name

Table Cell (td)
prependChild

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

prependChild

Span

style	float: left;
id	iets

(childToPrepend)

Table Row (tr)

id	des

Table Cell (td)
Iinserts the given value as the first child of the XML object and returns the XML object.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {XML} childToPrepend

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.prependChild(childToPrepend)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	processingInstructions
class	node

Table Row (tr)

id	name

Table Cell (td)
processingInstructions

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

processingInstructions

Span

style	float: left;
id	iets

([name])

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} [name]

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.processingInstructions([name])

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	propertyIsEnumerable
class	node

Table Row (tr)

id	name

Table Cell (td)
propertyIsEnumerable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

propertyIsEnumerable

Span

style	float: left;
id	iets

(propertyName)

Table Row (tr)

id	des

Table Cell (td)
Returns true if the property name is '0' and false otherwise.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} propertyName

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.propertyIsEnumerable(propertyName)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeNamespace
class	node

Table Row (tr)

id	name

Table Cell (td)
removeNamespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

removeNamespace

Span

style	float: left;
id	iets

(namespace)

Table Row (tr)

id	des

Table Cell (td)
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.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Namespace} namespace

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.removeNamespace(namespace)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	replace
class	node

Table Row (tr)

id	name

Table Cell (td)
replace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

replace

Span

style	float: left;
id	iets

(propertyName, replacementValue)

Table Row (tr)

id	des

Table Cell (td)
Takes two arguments, the property name of the property / properties to be replaced, and the value to replace the properties.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} propertyName {XML} replacementValue

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.replace(propertyName, replacementValue)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setChildren
class	node

Table Row (tr)

id	name

Table Cell (td)
setChildren

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

setChildren

Span

style	float: left;
id	iets

(value)

Table Row (tr)

id	des

Table Cell (td)
Replaces all children of the XML object with this value. The method returns the XML object it is called on.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Object} value

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setChildren(value)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setLocalName
class	node

Table Row (tr)

id	name

Table Cell (td)
setLocalName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setLocalName

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Changes the local name of this XML object to the name passed in.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setLocalName(name)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setName
class	node

Table Row (tr)

id	name

Table Cell (td)
setName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setName

Span

style	float: left;
id	iets

(name)

Table Row (tr)

id	des

Table Cell (td)
Replaces the name of this XML object with the name passed in.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} name

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setName(name)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setNamespace
class	node

Table Row (tr)

id	name

Table Cell (td)
setNamespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setNamespace

Span

style	float: left;
id	iets

(namespace)

Table Row (tr)

id	des

Table Cell (td)
Changes the namespace associated with the name of this XML object to the new namespace.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Namespace} namespace

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setNamespace(namespace)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setSettings
class	node

Table Row (tr)

id	name

Table Cell (td)
setSettings

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

setSettings

Span

style	float: left;
id	iets

([settings])

Table Row (tr)

id	des

Table Cell (td)
Allows the global XML settings to be adjusted or restored to their default values.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Object} [settings] – The new settings that should be applied globally to the XML object.

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setSettings(settings)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	settings
class	node

Table Row (tr)

id	name

Table Cell (td)
settings

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Object

Span

style	float: left; font-weight: bold;
id	iets

settings

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns an object containing the global XML settings.

Table Row (tr)

id	ret

Table Cell (td)
Returns Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.settings()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	text
class	node

Table Row (tr)

id	name

Table Cell (td)
text

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XMLList

Span

style	float: left; font-weight: bold;
id	iets

text

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns an XMLList with all the children of this XML object that represent text nodes.

Table Row (tr)

id	ret

Table Cell (td)
Returns XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.text()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	toString
class	node

Table Row (tr)

id	name

Table Cell (td)
toString

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

toString

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns a convenient string value of this XML object.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.toString()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	toXMLString
class	node

Table Row (tr)

id	name

Table Cell (td)
toXMLString

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

toXMLString

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns a string with the serialized XML markup for this XML object. XML.prettyPrinting and XML.prettyIndent settings affect the returned string.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.toXMLString()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	valueOf
class	node

Table Row (tr)

id	name

Table Cell (td)
valueOf

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

XML

Span

style	float: left; font-weight: bold;
id	iets

valueOf

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
The method simply returns the XML object it is called on.

Table Row (tr)

id	ret

Table Cell (td)
Returns XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.valueOf()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Page History

Versions Compared

Old Version 14

New Version Current

Key

Creating XML objects

Accessing the XML

XML in Action!

ignoreComments

ignoreProcessingInstructions

ignoreWhitespace

prettyIndent

prettyPrinting

addNamespace

appendChild

attribute

attributes

child

childIndex

children

comments

contains

copy

defaultSettings

descendants

elements

hasComplexContent

hasOwnProperty

hasSimpleContent

inScopeNamespaces

insertChildAfter

insertChildBefore

length

localName

name

namespace

namespaceDeclarations

nodeKind

normalize

parent

prependChild

processingInstructions

propertyIsEnumerable

removeNamespace

replace

setChildren

setLocalName

setName

setNamespace

setSettings

settings

text

toString

toXMLString

valueOf