Page History

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

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 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 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 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 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.

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

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 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 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 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 Row (tr)

Table Cell (td)
XMLList

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

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 Row (tr)

Table Cell (td)
XMLList

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

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 Row (tr)

Table Cell (td)
Boolean

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

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 Row (tr)

Table Cell (td)
Object

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

Table Row (tr)

Table Cell (td)
XMLList

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

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 Row (tr)

Table Cell (td)
XMLList

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

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 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 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 Row (tr)

Table Cell (td)
Boolean

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

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 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 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 Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
String

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

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 Row (tr)

Table Cell (td)
Namespace

Table Cell (td)
namespace() If no argument is passed to the method then it returns the namespace associated with the qualified name of this XML object.

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 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 Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
XML

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

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 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 Row (tr)

Table Cell (td)
XMLList

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

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 Row (tr)

Table Cell (td)
Boolean

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

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 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 Row (tr)

Table Cell (td)
XML

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

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 Row (tr)

Table Cell (td)
void

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

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 Row (tr)

Table Cell (td)
void

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

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 Row (tr)

Table Cell (td)
Object

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

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 Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
XML

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

...

id	property
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

...

id	ignoreComments

Table Row (tr)

id	name

Table Cell (td)
ignoreComments

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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

...

class	lastDetailRow

...

id	ignoreProcessingInstructions

Table Row (tr)

id	name

Table Cell (td)
ignoreProcessingInstructions

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

If set to true, then processing instructions are ignored when constructing new XML objects.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

...

class	lastDetailRow

...

id	ignoreWhitespace

Table Row (tr)

id	name

Table Cell (td)
ignoreWhitespace

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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

...

class	lastDetailRow

...

id	prettyIndent

Table Row (tr)

id	name

Table Cell (td)
prettyIndent

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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

...

class	lastDetailRow

...

id	prettyPrinting

Table Row (tr)

id	name

Table Cell (td)
prettyPrinting

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

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

...

class	lastDetailRow

...

id	function
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

...

id	addNamespace-String

Table Row (tr)

id	name

Table Cell (td)
addNamespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

addNamespace

Span
(namespaceToAdd)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} namespaceToAdd

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.addNamespace(namespaceToAdd)

...

class	lastDetailRow

...

id	appendChild-XML

Table Row (tr)

id	name

Table Cell (td)
appendChild

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

appendChild

Span
(childToAppend)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{XML} childToAppend

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.appendChild(childToAppend)

...

class	lastDetailRow

...

id	attribute-String

Table Row (tr)

id	name

Table Cell (td)
attribute

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

attribute

Span
(attributeName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} attributeName

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.attribute(attributeName)

...

class	lastDetailRow

...

id	attributes

Table Row (tr)

id	name

Table Cell (td)
attributes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

attributes

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an XMLList with the attributes of this XML object which are in no namespace.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.attributes()

...

class	lastDetailRow

...

id	child-String

Table Row (tr)

id	name

Table Cell (td)
child

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

child

Span
(propertyName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an XMLList with children matching the property name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} propertyName

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.child(childPropertyName)

...

class	lastDetailRow

...

id	childIndex

Table Row (tr)

id	name

Table Cell (td)
childIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

childIndex

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.childIndex()

...

class	lastDetailRow

...

id	children

Table Row (tr)

id	name

Table Cell (td)
children

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

children

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an XMLList with the child nodes of this XML object.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.children()

...

class	lastDetailRow

...

id	comments

Table Row (tr)

id	name

Table Cell (td)
comments

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

comments

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an XMLList with the comment nodes which are children of this XML object.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.comments()

...

class	lastDetailRow

...

id	contains-Object

Table Row (tr)

id	name

Table Cell (td)
contains

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

contains

Span
(value)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} value

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.contains(value)

...

class	lastDetailRow

...

id	copy

Table Row (tr)

id	name

Table Cell (td)
copy

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

copy

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.copy()

...

class	lastDetailRow

...

id	defaultSettings

Table Row (tr)

id	name

Table Cell (td)
defaultSettings

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

defaultSettings

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an object containing the default XML settings.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.defaultSettings()

...

class	lastDetailRow

...

id	descendants

Table Row (tr)

id	name

Table Cell (td)
descendants

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

descendants

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an XMLList with the descendants matching the passed name argument or with all descendants
if no argument is passed.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.descendants([name])

...

class	lastDetailRow

...

id	descendants-String

Table Row (tr)

id	name

Table Cell (td)
descendants

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

descendants

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.descendants([name])

...

class	lastDetailRow

...

id	elements

Table Row (tr)

id	name

Table Cell (td)
elements

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

elements

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.elements([name])

...

class	lastDetailRow

...

id	elements-String

Table Row (tr)

id	name

Table Cell (td)
elements

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

elements

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.elements([name])

...

class	lastDetailRow

...

id	hasComplexContent

Table Row (tr)

id	name

Table Cell (td)
hasComplexContent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

hasComplexContent

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.hasComplexContent()

...

class	lastDetailRow

...

id	hasOwnProperty-String

Table Row (tr)

id	name

Table Cell (td)
hasOwnProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

hasOwnProperty

Span
(propertyName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} propertyName

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.hasOwnProperty(propertyName)

...

class	lastDetailRow

...

id	hasSimpleContent

Table Row (tr)

id	name

Table Cell (td)
hasSimpleContent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

hasSimpleContent

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.hasSimpleContent()

...

class	lastDetailRow

...

id	inScopeNamespaces

Table Row (tr)

id	name

Table Cell (td)
inScopeNamespaces

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Array

Span

style	font-weight: bold;

inScopeNamespaces

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

Array

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.inScopeNamespaces()

...

class	lastDetailRow

...

id	insertChildAfter-XML_XML

Table Row (tr)

id	name

Table Cell (td)
insertChildAfter

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

insertChildAfter

Span
(childToInserAfter, childToInsert)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{XML} childToInserAfter
{XML} childToInsert

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.insertChildAfter(childToInsertAfter, childToInsert)

...

class	lastDetailRow

...

id	insertChildBefore-XML_XML

Table Row (tr)

id	name

Table Cell (td)
insertChildBefore

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

insertChildBefore

Span
(childToInsertBefore, childToInsert)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{XML} childToInsertBefore
{XML} childToInsert

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.insertChildBefore(childToInsertBefore, childToInsert)

...

class	lastDetailRow

...

id	length

Table Row (tr)

id	name

Table Cell (td)
length

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

length

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.length()

...

class	lastDetailRow

...

id	localName

Table Row (tr)

id	name

Table Cell (td)
localName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

localName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

returns the local name part if the XML object has a name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.localName()

...

class	lastDetailRow

...

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QName

Span

style	font-weight: bold;

name

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QName

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.name()

...

class	lastDetailRow

...

id	namespace

Table Row (tr)

id	name

Table Cell (td)
namespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Namespace

Span

style	font-weight: bold;

namespace

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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	ret

Table Cell (td)

Returns

Div

class	sIndent

Namespace

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.namespace([prefix])

...

class	lastDetailRow

...

id	namespace-String

Table Row (tr)

id	name

Table Cell (td)
namespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Namespace

Span

style	font-weight: bold;

namespace

Span
(prefix)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} prefix

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Namespace

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.namespace([prefix])

...

class	lastDetailRow

...

id	namespaceDeclarations

Table Row (tr)

id	name

Table Cell (td)
namespaceDeclarations

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Array

Span

style	font-weight: bold;

namespaceDeclarations

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

Array

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.namespaceDeclarations()

...

class	lastDetailRow

...

id	nodeKind

Table Row (tr)

id	name

Table Cell (td)
nodeKind

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

nodeKind

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.nodeKind()

...

class	lastDetailRow

...

id	normalize

Table Row (tr)

id	name

Table Cell (td)
normalize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

normalize

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns this XML object after normalizing all text content.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.normalize()

...

class	lastDetailRow

...

id	parent

Table Row (tr)

id	name

Table Cell (td)
parent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

parent

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.parent()

...

class	lastDetailRow

...

id	prependChild-XML

Table Row (tr)

id	name

Table Cell (td)
prependChild

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

prependChild

Span
(childToPrepend)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{XML} childToPrepend

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.prependChild(childToPrepend)

...

class	lastDetailRow

...

id	processingInstructions

Table Row (tr)

id	name

Table Cell (td)
processingInstructions

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

processingInstructions

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.processingInstructions([name])

...

class	lastDetailRow

...

id	processingInstructions-String

Table Row (tr)

id	name

Table Cell (td)
processingInstructions

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

processingInstructions

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.processingInstructions([name])

...

class	lastDetailRow

...

id	propertyIsEnumerable-String

Table Row (tr)

id	name

Table Cell (td)
propertyIsEnumerable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

propertyIsEnumerable

Span
(propertyName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the property name is '0' and false otherwise.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} propertyName

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.propertyIsEnumerable(propertyName)

...

class	lastDetailRow

...

id	removeNamespace-Namespace

Table Row (tr)

id	name

Table Cell (td)
removeNamespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

removeNamespace

Span
(namespace)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{Namespace} namespace

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.removeNamespace(namespace)

...

class	lastDetailRow

...

id	replace-String_XML

Table Row (tr)

id	name

Table Cell (td)
replace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

replace

Span
(propertyName, replacementValue)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{String} propertyName
{XML} replacementValue

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.replace(propertyName, replacementValue)

...

class	lastDetailRow

...

id	setChildren-Object

Table Row (tr)

id	name

Table Cell (td)
setChildren

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

setChildren

Span
(value)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

{Object} value

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setChildren(value)

...

class	lastDetailRow

...

id	setLocalName-String

Table Row (tr)

id	name

Table Cell (td)
setLocalName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setLocalName

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Changes the local name of this XML object to the name passed in.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setLocalName(name)

...

class	lastDetailRow

...

id	setName-String

Table Row (tr)

id	name

Table Cell (td)
setName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setName

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Replaces the name of this XML object with the name passed in.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setName(name)

...

class	lastDetailRow

...

id	setNamespace-Namespace

Table Row (tr)

id	name

Table Cell (td)
setNamespace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setNamespace

Span
(namespace)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Changes the namespace associated with the name of this XML object to the new namespace.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Namespace} namespace

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setNamespace(namespace)

...

class	lastDetailRow

...

id	setSettings

Table Row (tr)

id	name

Table Cell (td)
setSettings

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setSettings

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Allows the global XML settings to be adjusted or restored to their default values.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setSettings(settings)

...

class	lastDetailRow

...

id	setSettings-Object

Table Row (tr)

id	name

Table Cell (td)
setSettings

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setSettings

Span
(settings)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Allows the global XML settings to be adjusted or restored to their default values.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} settings - The new settings that should be applied globally to the XML object.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.setSettings(settings)

...

class	lastDetailRow

...

id	settings

Table Row (tr)

id	name

Table Cell (td)
settings

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

settings

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an object containing the global XML settings.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.settings()

...

class	lastDetailRow

...

id	text

Table Row (tr)

id	name

Table Cell (td)
text

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XMLList

Span

style	font-weight: bold;

text

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an XMLList with all the children of this XML object that represent text nodes.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XMLList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.text()

...

class	lastDetailRow

...

id	toString

Table Row (tr)

id	name

Table Cell (td)
toString

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

toString

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a convenient string value of this XML object.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.toString()

...

class	lastDetailRow

...

id	toXMLString

Table Row (tr)

id	name

Table Cell (td)
toXMLString

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

toXMLString

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.toXMLString()

...

class	lastDetailRow

...

id	valueOf

Table Row (tr)

id	name

Table Cell (td)
valueOf

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

XML

Span

style	font-weight: bold;

valueOf

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method simply returns the XML object it is called on.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

XML

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

xml.valueOf()

...

class	lastDetailRow

...

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'

Divcache

styleindex	display:none

...

id	description

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.toString()); //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].toXMLString()); //outputs '<test2 level="2">Another value</test2>'

XML in Action!

...

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Property SummaryIf set to true, then comments in the XML are ignored when constructing new XML objects.If set to true, then processing instructions are ignored when constructing new XML objects.If set to true, then whitespace in the XML is ignored when constructing new XML objects.The amount of positions used when indenting child nodes are relative to their parent if prettyPrinting is enabled.If set to true, then toString() and toXMLString() methods will normalize the output to achieve a uniform appearance.

servoy sSummary12%30%58%height: 30px;3Methods SummaryTakes 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.Appends a new child at the end of this XML object's properties, the changed XML object is then returned.Takes a single argument with the attribute name and returns an XMLList with attributes matching the argument.Returns an XMLList with the attributes of this XML object which are in no namespace.Returns an XMLList with children matching the property name.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.Returns an XMLList with the child nodes of this XML object.Returns an XMLList with the comment nodes which are children of this XML object.Calling xmlObject.Returns a deep copy of the XML object it is called on where the internal parent property is set to nullReturns an object containing the default XML settings.Returns an XMLList with the descendants matching the passed name argument or with all descendants if no argument is passed.Returns an XMLList with the descendants matching the passed name argument or with all descendants if no argument is passed.Takes one optional argument, the name of elements you are looking for, and returns an XMLList with all matching child elements.Takes one optional argument, the name of elements you are looking for, and returns an XMLList with all matching child elements.Returns false for XML objects of node kind 'text', 'attribute', 'comment', and 'processing-instruction'.Returns true if the XML object the method is called on has a property of that name.Returns true for XML objects of node kind text or attribute.Returns an array of Namespace objects representing the namespace that are in scope for this XML object.Takes two arguments, an existing child to insert after and the new child to be inserted.Takes two arguments, an existing child to insert before and the new child to be inserted.This always returns 1.returns the local name part if the XML object has a name.Returns the qualified name (a QName object) of the XML object it is calledIf no argument is passed to the method then it returns the namespace associated with the qualified name of this XML object.If no argument is passed to the method then it returns the namespace associated with the qualified name of this XML object.Returns an array with the namespace declarations associated with the XML object it is called on.Returns a string denoting the kind of node this XML object represents.Returns this XML object after normalizing all text content.Returns the parent XML object of this XML object or null if there is no parent.Iinserts the given value as the first child of the XML object and returns the XML object.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 no argument is passed in then the method returns an XMLList with all the children of the XML object which are processing instructions.Returns true if the property name is '0' and false otherwise.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.Takes two arguments, the property name of the property / properties to be replaced, and the value to replace the properties.Replaces all children of the XML object with this value.voidChanges the local name of this XML object to the name passed in.voidReplaces the name of this XML object with the name passed in.voidChanges the namespace associated with the name of this XML object to the new namespace.voidAllows the global XML settings to be adjusted or restored to their default values.voidAllows the global XML settings to be adjusted or restored to their default values.Returns an object containing the global XML settings.Returns an XMLList with all the children of this XML object that represent text nodes.Returns a convenient string value of this XML object.Returns a string with the serialized XML markup for this XML object.The method simply returns the XML object it is called on.

propertyservoy sDetail2100%height:30px2Property DetailsignoreCommentsname

ignoreComments

des

sIndent

If set to true, then comments in the XML are ignored when constructing new XML objects.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ignoreProcessingInstructions

name

ignoreProcessingInstructions

des

sIndent

If set to true, then processing instructions are ignored when constructing new XML objects.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

ignoreWhitespace

name

ignoreWhitespace

des

sIndent

If set to true, then whitespace in the XML is ignored when constructing new XML objects.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

prettyIndent

name

prettyIndent

des

sIndent

The amount of positions used when indenting child nodes are relative to their parent
if prettyPrinting is enabled.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

prettyPrinting

name

prettyPrinting

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsaddNamespacename

addNamespace(namespaceToAdd)

des

sIndent

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.

prs

Parameters

sIndent

namespaceToAdd

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

appendChild

name

appendChild(childToAppend)

des

sIndent

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

prs

Parameters

sIndent

childToAppend

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

attribute

name

attribute(attributeName)

des

sIndent

Takes a single argument with the attribute name and returns an XMLList with attributes 
matching the argument.

prs

Parameters

sIndent

attributeName

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

attributes

name

attributes()

des

sIndent

Returns an XMLList with the attributes of this XML object which are in no namespace.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

child

name

child(propertyName)

des

sIndent

Returns an XMLList with children matching the property name.

prs

Parameters

sIndent

propertyName

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

childIndex

name

childIndex()

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

children

name

children()

des

sIndent

Returns an XMLList with the child nodes of this XML object.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

comments

name

comments()

des

sIndent

Returns an XMLList with the comment nodes which are children of this XML object.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

contains

name

contains(value)

des

sIndent

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

prs

Parameters

sIndent

value

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

copy

name

copy()

des

sIndent

Returns a deep copy of the XML object it is called on where the internal parent property is set to null

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

defaultSettings

name

defaultSettings()

des

sIndent

Returns an object containing the default XML settings.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

descendants

name

descendants()

des

sIndent

Returns an XMLList with the descendants matching the passed name argument or with all descendants 
if no argument is passed.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

descendants

name

descendants(name)

des

sIndent

Returns an XMLList with the descendants matching the passed name argument or with all descendants 
if no argument is passed.

prs

Parameters

sIndent

name

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

elements

name

elements()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

elements

name

elements(name)

des

sIndent

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

prs

Parameters

sIndent

name

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

hasComplexContent

name

hasComplexContent()

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

hasOwnProperty

name

hasOwnProperty(propertyName)

des

sIndent

Returns true if the XML object the method is called on has a property of that name.

prs

Parameters

sIndent

propertyName

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

hasSimpleContent

name

hasSimpleContent()

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

inScopeNamespaces

name

inScopeNamespaces()

des

sIndent

Returns an array of Namespace objects representing the namespace that are in scope for this XML object.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

insertChildAfter

name

insertChildAfter(childToInserAfter, childToInsert)

des

sIndent

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.

prs

Parameters

sIndent

childToInserAfter

;

childToInsert

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

insertChildBefore

name

insertChildBefore(childToInsertBefore, childToInsert)

des

sIndent

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.

prs

Parameters

sIndent

childToInsertBefore

;

childToInsert

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

length

name

length()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

localName

name

localName()

des

sIndent

returns the local name part if the XML object has a name.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

name

name()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

namespace

name

namespace()

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

namespace

name

namespace(prefix)

des

sIndent

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.

prs

Parameters

sIndent

prefix

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

namespaceDeclarations

name

namespaceDeclarations()

des

sIndent

Returns an array with the namespace declarations associated with the XML object it is called on.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

nodeKind

name

nodeKind()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

normalize

name

normalize()

des

sIndent

Returns this XML object after normalizing all text content.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

parent

name

parent()

des

sIndent

Returns the parent XML object of this XML object or null if there is no parent.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

prependChild

name

prependChild(childToPrepend)

des

sIndent

Iinserts the given value as the first child of the XML object and returns the XML object.

prs

Parameters

sIndent

childToPrepend

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

processingInstructions

name

processingInstructions()

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

processingInstructions

name

processingInstructions(name)

des

sIndent

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.

prs

Parameters

sIndent

name

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

propertyIsEnumerable

name

propertyIsEnumerable(propertyName)

des

sIndent

Returns true if the property name is '0' and false otherwise.

prs

Parameters

sIndent

propertyName

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

removeNamespace

name

removeNamespace(namespace)

des

sIndent

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.

prs

Parameters

sIndent

namespace

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

replace

name

replace(propertyName, replacementValue)

des

sIndent

Takes two arguments, the property name of the property / properties to be replaced, and the 
value to replace the properties.

prs

Parameters

sIndent

propertyName

;

replacementValue

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setChildren

name

setChildren(value)

des

sIndent

Replaces all children of the XML object with this value. The method returns the XML object it 
is called on.

prs

Parameters

sIndent

value

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setLocalName

name

setLocalName(name)

des

sIndent

Changes the local name of this XML object to the name passed in.

prs

Parameters

sIndent

name

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setName

name

setName(name)

des

sIndent

Replaces the name of this XML object with the name passed in.

prs

Parameters

sIndent

name

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setNamespace

name

setNamespace(namespace)

des

sIndent

Changes the namespace associated with the name of this XML object to the new namespace.

prs

Parameters

sIndent

namespace

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setSettings

name

setSettings()

des

sIndent

Allows the global XML settings to be adjusted or restored to their default values.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setSettings

name

setSettings(settings)

des

sIndent

Allows the global XML settings to be adjusted or restored to their default values.

prs

Parameters

sIndent

settings

The new settings that should be applied globally to the XML object.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

settings

name

settings()

des

sIndent

Returns an object containing the global XML settings.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

text

name

text()

des

sIndent

Returns an XMLList with all the children of this XML object that represent text nodes.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

toString

name

toString()

des

sIndent

Returns a convenient string value of this XML object.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

toXMLString

name

toXMLString()

des

sIndent

Returns a string with the serialized XML markup for this XML object. XML.prettyPrinting 
and XML.prettyIndent settings affect the returned string.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

valueOf

name

valueOf()

des

sIndent

The method simply returns the XML object it is called on.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 31

New Version Current

Key

ignoreComments

ignoreProcessingInstructions

ignoreWhitespace

prettyIndent

prettyPrinting

addNamespace

appendChild

attribute

attributes

child

childIndex

children

comments

contains

copy

defaultSettings

descendants

descendants

elements

elements

hasComplexContent

hasOwnProperty

hasSimpleContent

inScopeNamespaces

insertChildAfter

insertChildBefore

length

localName

name

namespace

namespace

namespaceDeclarations

nodeKind

normalize

parent

prependChild

processingInstructions

processingInstructions

propertyIsEnumerable

removeNamespace

replace

setChildren

setLocalName

setName

setNamespace

setSettings

setSettings

settings

text

toString

toXMLString

valueOf

Creating XML objects

Accessing the XML

XML in Action!

ignoreComments

ignoreProcessingInstructions

ignoreWhitespace

prettyIndent

prettyPrinting

addNamespace(namespaceToAdd)

appendChild(childToAppend)

attribute(attributeName)

attributes()

child(propertyName)

childIndex()

children()

comments()

contains(value)

copy()

defaultSettings()

descendants()

descendants(name)

elements()