May 06, 2024 16:49 Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients SampleSupported 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
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
XML.ignoreProcessingInstructions=false;
var xmlElement = <publishing><?process author="yes"?><author type="leadership">John C. Maxwell</author></publishing>;
application.output(" Element = "+ xmlElement.toXMLString());
ignoreWhitespace
XML.ignoreWhitespace = false;
var xmlElement =
<publishing>
<author>John C. Maxwell</author>
</publishing>;
application.output(xmlElement.toString());
prettyIndent
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
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)
String
namespaceToAdd
xml.addNamespace(namespaceToAdd)
appendChild(childToAppend)
XML
childToAppend
xml.appendChild(childToAppend)
attribute(attributeName)
String
attributeName
xml.attribute(attributeName)
attributes()
xml.attributes()
child(propertyName)
String
propertyName
xml.child(childPropertyName)
childIndex()
xml.childIndex()
children()
xml.children()
comments()
xml.comments()
contains(value)
Object
value
xml.contains(value)
copy()
xml.copy()
defaultSettings()
xml.defaultSettings()
descendants()
xml.descendants([name])
descendants(name)
String
name
xml.descendants([name])
elements()
xml.elements([name])
elements(name)
String
name
xml.elements([name])
hasComplexContent()
xml.hasComplexContent()
hasOwnProperty(propertyName)
String
propertyName
xml.hasOwnProperty(propertyName)
hasSimpleContent()
xml.hasSimpleContent()
inScopeNamespaces()
xml.inScopeNamespaces()
insertChildAfter(childToInserAfter, childToInsert)
XML
childToInserAfter
XML
childToInsert
xml.insertChildAfter(childToInsertAfter, childToInsert)
insertChildBefore(childToInsertBefore, childToInsert)
XML
childToInsertBefore
XML
childToInsert
xml.insertChildBefore(childToInsertBefore, childToInsert)
length()
xml.length()
localName()
xml.localName()
name()
xml.name()
namespace()
xml.namespace([prefix])
namespace(prefix)
String
prefix
xml.namespace([prefix])
namespaceDeclarations()
xml.namespaceDeclarations()
nodeKind()
xml.nodeKind()
normalize()
xml.normalize()
parent()
xml.parent()
prependChild(childToPrepend)
XML
childToPrepend
xml.prependChild(childToPrepend)
processingInstructions()
xml.processingInstructions([name])
processingInstructions(name)
String
name
xml.processingInstructions([name])
propertyIsEnumerable(propertyName)
String
propertyName
xml.propertyIsEnumerable(propertyName)
removeNamespace(namespace)
Namespace
namespace
xml.removeNamespace(namespace)
replace(propertyName, replacementValue)
String
propertyName
XML
replacementValue
xml.replace(propertyName, replacementValue)
setChildren(value)
Object
value
xml.setChildren(value)
setLocalName(name)
String
name
xml.setLocalName(name)
setName(name)
String
name
xml.setName(name)
setNamespace(namespace)
Namespace
namespace
xml.setNamespace(namespace)
setSettings()
xml.setSettings(settings)
setSettings(settings)
Object
settings
The new settings that should be applied globally to the XML object.
xml.setSettings(settings)
settings()
xml.settings()
text()
xml.text()
toString()
xml.toString()
toXMLString()
xml.toXMLString()
valueOf()
xml.valueOf()