Skip to end of metadata
Go to start of metadata

Refresh page Aug 10, 2019 11:34

Supported Clients
SmartClient WebClient NGClient

Property Summary
Boolean ignoreComments If set to true, then comments in the XML are ignored when constructing new XML objects.
Boolean ignoreProcessingInstructions If set to true, then processing instructions are ignored when constructing new XML objects.
Boolean ignoreWhitespace If set to true, then whitespace in the XML is ignored when constructing new XML objects.
Boolean prettyIndent The amount of positions used when indenting child nodes are relative to their parent if prettyPrinting is enabled.
Boolean prettyPrinting If set to true, then toString() and toXMLString() methods will normalize the output to achieve a uniform appearance.

Methods Summary
XML 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.
XML appendChild(childToAppend) Appends a new child at the end of this XML object's properties, the changed XML object is then returned.
XMLList attribute(attributeName) Takes a single argument with the attribute name and returns an XMLList with attributes matching the argument.
XMLList attributes() Returns an XMLList with the attributes of this XML object which are in no namespace.
XMLList child(propertyName) Returns an XMLList with children matching the property name.
Number 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.
XMLList children() Returns an XMLList with the child nodes of this XML object.
XMLList comments() Returns an XMLList with the comment nodes which are children of this XML object.
Boolean contains(value) Calling xmlObject.
XML copy() Returns a deep copy of the XML object it is called on where the internal parent property is set to null
Object defaultSettings() Returns an object containing the default XML settings.
XMLList descendants() Returns an XMLList with the descendants matching the passed name argument or with all descendants if no argument is passed.
XMLList descendants(name) Returns an XMLList with the descendants matching the passed name argument or with all descendants if no argument is passed.
XMLList elements() Takes one optional argument, the name of elements you are looking for, and returns an XMLList with all matching child elements.
XMLList elements(name) Takes one optional argument, the name of elements you are looking for, and returns an XMLList with all matching child elements.
Boolean hasComplexContent() Returns false for XML objects of node kind 'text', 'attribute', 'comment', and 'processing-instruction'.
Boolean hasOwnProperty(propertyName) Returns true if the XML object the method is called on has a property of that name.
Boolean hasSimpleContent() Returns true for XML objects of node kind text or attribute.
Array inScopeNamespaces() Returns an array of Namespace objects representing the namespace that are in scope for this XML object.
XML insertChildAfter(childToInserAfter, childToInsert) Takes two arguments, an existing child to insert after and the new child to be inserted.
XML insertChildBefore(childToInsertBefore, childToInsert) Takes two arguments, an existing child to insert before and the new child to be inserted.
Number length() This always returns 1.
String localName() returns the local name part if the XML object has a name.
QName name() Returns the qualified name (a QName object) of the XML object it is called
Namespace namespace() If no argument is passed to the method then it returns the namespace associated with the qualified name of this XML object.
Namespace namespace(prefix) If no argument is passed to the method then it returns the namespace associated with the qualified name of this XML object.
Array namespaceDeclarations() Returns an array with the namespace declarations associated with the XML object it is called on.
String nodeKind() Returns a string denoting the kind of node this XML object represents.
XML normalize() Returns this XML object after normalizing all text content.
XML parent() Returns the parent XML object of this XML object or null if there is no parent.
XML prependChild(childToPrepend) Iinserts the given value as the first child of the XML object and returns the XML object.
XMLList 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.
XMLList 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.
Boolean propertyIsEnumerable(propertyName) Returns true if the property name is '0' and false otherwise.
XML 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.
XML replace(propertyName, replacementValue) Takes two arguments, the property name of the property / properties to be replaced, and the value to replace the properties.
XML setChildren(value) Replaces all children of the XML object with this value.
void setLocalName(name) Changes the local name of this XML object to the name passed in.
void setName(name) Replaces the name of this XML object with the name passed in.
void setNamespace(namespace) Changes the namespace associated with the name of this XML object to the new namespace.
void setSettings() Allows the global XML settings to be adjusted or restored to their default values.
void setSettings(settings) Allows the global XML settings to be adjusted or restored to their default values.
Object settings() Returns an object containing the global XML settings.
XMLList text() Returns an XMLList with all the children of this XML object that represent text nodes.
String toString() Returns a convenient string value of this XML object.
String toXMLString() Returns a string with the serialized XML markup for this XML object.
XML valueOf() The method simply returns the XML object it is called on.

Property Details

ignoreComments

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

ignoreProcessingInstructions

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

ignoreWhitespace

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

prettyIndent

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

prettyPrinting

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

Methods Details

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.

Parameters

String namespaceToAdd ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.addNamespace(namespaceToAdd)

appendChild(childToAppend)

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

Parameters

XML childToAppend ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.appendChild(childToAppend)

attribute(attributeName)

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

Parameters

String attributeName ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.attribute(attributeName)

attributes()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.attributes()

child(propertyName)

Returns an XMLList with children matching the property name.

Parameters

String propertyName ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.child(childPropertyName)

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.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.childIndex()

children()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.children()

comments()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.comments()

contains(value)

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

Parameters

Object value ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.contains(value)

copy()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.copy()

defaultSettings()

Returns an object containing the default XML settings.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.defaultSettings()

descendants()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.descendants([name])

descendants(name)

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

Parameters

String name ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.descendants([name])

elements()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.elements([name])

elements(name)

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

Parameters

String name ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.elements([name])

hasComplexContent()

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.hasComplexContent()

hasOwnProperty(propertyName)

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

Parameters

String propertyName ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.hasOwnProperty(propertyName)

hasSimpleContent()

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.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.hasSimpleContent()

inScopeNamespaces()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.inScopeNamespaces()

insertChildAfter(childToInserAfter, childToInsert)

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.

Parameters

XML childToInserAfter ;
XML childToInsert ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.insertChildAfter(childToInsertAfter, childToInsert)

insertChildBefore(childToInsertBefore, childToInsert)

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.

Parameters

XML childToInsertBefore ;
XML childToInsert ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.insertChildBefore(childToInsertBefore, childToInsert)

length()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.length()

localName()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.localName()

name()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.name()

namespace()

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.namespace([prefix])

namespace(prefix)

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.

Parameters

String prefix ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.namespace([prefix])

namespaceDeclarations()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.namespaceDeclarations()

nodeKind()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.nodeKind()

normalize()

Returns this XML object after normalizing all text content.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.normalize()

parent()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.parent()

prependChild(childToPrepend)

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

Parameters

XML childToPrepend ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.prependChild(childToPrepend)

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.processingInstructions([name])

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

Parameters

String name ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.processingInstructions([name])

propertyIsEnumerable(propertyName)

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

Parameters

String propertyName ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.propertyIsEnumerable(propertyName)

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.

Parameters

Namespace namespace ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.removeNamespace(namespace)

replace(propertyName, replacementValue)

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

Parameters

String propertyName ;
XML replacementValue ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.replace(propertyName, replacementValue)

setChildren(value)

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

Parameters

Object value ;

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.setChildren(value)

setLocalName(name)

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

Parameters

String name ;

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.setLocalName(name)

setName(name)

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

Parameters

String name ;

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.setName(name)

setNamespace(namespace)

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

Parameters

Namespace namespace ;

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.setNamespace(namespace)

setSettings()

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.setSettings(settings)

setSettings(settings)

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

Parameters

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.setSettings(settings)

settings()

Returns an object containing the global XML settings.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.settings()

text()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.text()

toString()

Returns a convenient string value of this XML object.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.toString()

toXMLString()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.toXMLString()

valueOf()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

xml.valueOf()

  • No labels