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.
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.
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.
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.
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.
replace(propertyName, replacementValue) Takes two arguments, the property name of the property / properties to be replaced, and the value to replace the properties.
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
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.
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
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.
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.
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 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.
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.
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.
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.
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.
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.
Returns a string denoting the kind of node this XML object represents. Possible values: 'element', 'attribute', 'text', 'comment', 'processing-instruction'.
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.
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.
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.
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.
Div
id
description
How to script XML
Code Block
language
js
title
Creating XML objects from a string
var myXml = new XML('<test level="1"><test2 level="2">A value</test2></test>');
Code Block
language
js
title
Creating XML objects using XML object notation
var myXml =
<test level="1">
<test2 level="2">A value</test2>
</test>;
Code Block
language
js
title
Using JavaScript variables inside XML
var myValue = 'hello, some value!';
var myXml =
<test level="1">
<test2 level="2">{myValue}</test2>
</test>;
Code Block
language
js
title
Accessing nodes in the XML
var myXml = new XML('<test level="1"><test2 level="2">A value</test2></test>');
application.output(myXml.test2.toString()); //outputs 'A value'
Code Block
language
js
title
Accessing a specific index on subnodes
var myXml = new XML('<test level="1"><test2 level="2">A value</test2><test2 level="2">Another value</test2></test>');
application.output(myXml.test2[1].toXMLString()); //outputs '<test2 level="2">Another value</test2>'
prettyPrinting If set to true, then toString() and toXMLString() methods will normalize the output to achieve a uniform appearance.
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientservoy 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
dessIndentIf set to true, then comments in the XML are ignored when constructing new XML objects.ret
dessIndentTakes 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
dessIndentAppends a new child at the end of this XML object's properties, the changed XML object is then returned.prs
Parameters
sIndentchildToAppend ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow attributename
attribute(attributeName)
dessIndentTakes a single argument with the attribute name and returns an XMLList with attributes matching the argument.prs
Parameters
sIndentattributeName ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow attributesname
attributes()
dessIndentReturns an XMLList with the attributes of this XML object which are in no namespace.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow childname
child(propertyName)
dessIndentReturns an XMLList with children matching the property name.prs
Parameters
sIndentpropertyName ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow childIndexname
childIndex()
dessIndentIf 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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow childrenname
children()
dessIndentReturns an XMLList with the child nodes of this XML object.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow commentsname
comments()
dessIndentReturns an XMLList with the comment nodes which are children of this XML object.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow containsname
contains(value)
dessIndentCalling xmlObject.contains(value) yields the same result as the equality comparison xmlObject == valueprs
Parameters
sIndentvalue ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow copyname
copy()
dessIndentReturns a deep copy of the XML object it is called on where the internal parent property is set to nullret
dessIndentReturns 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
dessIndentReturns 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
dessIndentTakes 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
dessIndentTakes 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
dessIndentThis always returns 1. This is done to blur the distinction between an XML object and an XMLList containing exactly one value.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow localNamename
localName()
dessIndentreturns the local name part if the XML object has a name.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow namename
name()
dessIndentReturns the qualified name (a QName object) of the XML object it is calledret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow namespacename
namespace()
dessIndentIf 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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow namespacename
namespace(prefix)
dessIndentIf 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
dessIndentReturns an array with the namespace declarations associated with the XML object it is called on.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow nodeKindname
nodeKind()
dessIndentReturns a string denoting the kind of node this XML object represents. Possible values: 'element', 'attribute', 'text', 'comment', 'processing-instruction'.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow normalizename
normalize()
dessIndentReturns this XML object after normalizing all text content.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow parentname
parent()
dessIndentReturns the parent XML object of this XML object or null if there is no parent.ret
dessIndentIf 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
dessIndentIf 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
dessIndentRemoves 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
sIndentnamespace ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow replacename
replace(propertyName, replacementValue)
dessIndentTakes two arguments, the property name of the property / properties to be replaced, and the value to replace the properties.prs
dessIndentReturns a string with the serialized XML markup for this XML object. XML.prettyPrinting and XML.prettyIndent settings affect the returned string.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow valueOfname
valueOf()
dessIndentThe method simply returns the XML object it is called on.