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.



Method Summary
XMLList
attribute(attributeName)
It calls the method attribute of each object in this XMLList and returns the results in order
in an XMLList.
XMLList
attributes()
Calls the method attributes of each object in this XMLList and returns an XMLList with
the results in order.
XMLList
child(propertyName)
Calls the method child of each XML object in this XMLList object to return an XMLList
with the matching children in order.
XMLList
children()
Returns an XMLList with the children of all XML objects in this XMLList.
XMLList
comments()
Returns an XMLList with all the comment child nodes of XML objects in this XMLList in order.
Boolean
contains(value)
Returns true if there is (at least) one XML object in the list that compares equal to the value
XMLList
copy()
Returns a deep copy of the XMLList it is called on.
XMLList
descendants()
Returns an XMLList with all of the matching descendants of all XML objects.
XMLList
descendants(name)
Returns an XMLList with all of the matching descendants of all XML objects.
XMLList
elements(name)
Returns an XMLList with the matching element children of all XML objects in this XMLList.
Boolean
hasComplexContent()
Returns true if the XMLList contains exactly one XML object which has complex content or if
the XMLList contains several XML objects.
Boolean
hasOwnProperty(propertyName)
Returns true if the XMLList object has a property of that name and false otherwise.
Boolean
hasSimpleContent()
Returns true if the XMLList is empty or contains exactly one XML object which has simple
content or contains no elements at all.
Number
length()
Returns the number of XML objects this XMLList contains.
XMLList
normalize()
Returns the XMLList object it is called on after joining adjacent text nodes
and removing empty text nodes.
XML
parent()
Returns the common parent of all XML objects in this XMLList if all those objects
have the same parent.
XMLList
processingInstructions()
Returns an XMLList with all the matching processing instruction child nodes of all
XML objects in this XMLList.
XMLList
processingInstructions(name)
Returns an XMLList with all the matching processing instruction child nodes of all
XML objects in this XMLList.
Boolean
propertyIsEnumerable(propertyName)
Returns true if the property name converted to a number is greater than or equal to
0 and less than the length of this XMLList.
XMLList
text()
Returns an XMLList containing all the text child nodes of all the XML objects contained in this XMLList.
String
toString()
Returns a string representation of the XMLList
String
toXMLString()
Returns the concatenation of toXMLString called on each XML object.
XMLList
valueOf()
Simply returns the XMLList object it is called on.



Method Details

attribute

XMLList
attribute
(attributeName)
It calls the method attribute of each object in this XMLList and returns the results in order
in an XMLList.

Parameters

{String} attributeName

Returns

XMLList

Sample

xmlList.attribute(attributeName)
 

attributes

XMLList
attributes
()
Calls the method attributes of each object in this XMLList and returns an XMLList with
the results in order.

Returns

XMLList

Sample

xmlList.attributes()
 

child

XMLList
child
(propertyName)
Calls the method child of each XML object in this XMLList object to return an XMLList
with the matching children in order.

Parameters

{String} propertyName

Returns

XMLList

Sample

xmlList.child(propertyName)
 

children

XMLList
children
()
Returns an XMLList with the children of all XML objects in this XMLList.

Returns

XMLList

Sample

xmlList.children()
 

comments

XMLList
comments
()
Returns an XMLList with all the comment child nodes of XML objects in this XMLList in order.

Returns

XMLList

Sample

xmlList.comments()
 

contains

Boolean
contains
(value)
Returns true if there is (at least) one XML object in the list that compares equal to the value

Parameters

{Object} value

Returns

Boolean

Sample

xmlList.contains(value)
 

copy

XMLList
copy
()
Returns a deep copy of the XMLList it is called on.

Returns

XMLList

Sample

xmlList.copy()
 

descendants

XMLList
descendants
()
Returns an XMLList with all of the matching descendants of all XML objects.

Returns

XMLList

Sample

xmlList.descendants([name])
 

descendants

XMLList
descendants
(name)
Returns an XMLList with all of the matching descendants of all XML objects.

Parameters

{String} name

Returns

XMLList

Sample

xmlList.descendants([name])
 

elements

XMLList
elements
(name)
Returns an XMLList with the matching element children of all XML objects in this XMLList.

Parameters

{String} name

Returns

XMLList

Sample

xmlList.elements([name])
 

hasComplexContent

Boolean
hasComplexContent
()
Returns true if the XMLList contains exactly one XML object which has complex content or if
the XMLList contains several XML objects.

Returns

Boolean

Sample

xmlList.hasComplexContent()
 

hasOwnProperty

Boolean
hasOwnProperty
(propertyName)
Returns true if the XMLList object has a property of that name and false otherwise.

Parameters

{String} propertyName

Returns

Boolean

Sample

xmlList.hasOwnProperty(propertyName)
 

hasSimpleContent

Boolean
hasSimpleContent
()
Returns true if the XMLList is empty or contains exactly one XML object which has simple
content or contains no elements at all.

Returns

Boolean

Sample

xmlList.hasSimpleContent()
 

length

Number
length
()
Returns the number of XML objects this XMLList contains.

Returns

Number

Sample

xmlList.length()
 

normalize

XMLList
normalize
()
Returns the XMLList object it is called on after joining adjacent text nodes
and removing empty text nodes.

Returns

XMLList

Sample

xmlList.normalize()
 

parent

XML
parent
()
Returns the common parent of all XML objects in this XMLList if all those objects
have the same parent.

Returns

XML

Sample

xmlList.parent()
 

processingInstructions

XMLList
processingInstructions
()
Returns an XMLList with all the matching processing instruction child nodes of all
XML objects in this XMLList.

Returns

XMLList

Sample

xmlList.processingInstructions([name])
 

processingInstructions

XMLList
processingInstructions
(name)
Returns an XMLList with all the matching processing instruction child nodes of all
XML objects in this XMLList.

Parameters

{String} name

Returns

XMLList

Sample

xmlList.processingInstructions([name])
 

propertyIsEnumerable

Boolean
propertyIsEnumerable
(propertyName)
Returns true if the property name converted to a number is greater than or equal to
0 and less than the length of this XMLList.

Parameters

{String} propertyName

Returns

Boolean

Sample

xmlList.propertyIsEnumerable(propertyName)
 

text

XMLList
text
()
Returns an XMLList containing all the text child nodes of all the XML objects contained in this XMLList.

Returns

XMLList

Sample

xmlList.text()
 

toString

String
toString
()
Returns a string representation of the XMLList

Returns

String

Sample

xmlList.toString()
 

toXMLString

String
toXMLString
()
Returns the concatenation of toXMLString called on each XML object. The result for each XML
object is put on a separate line if XML.prettyPrinting is true.

Returns

String

Sample

xmlList.toXMLString()
 

valueOf

XMLList
valueOf
()
Simply returns the XMLList object it is called on.

Returns

XMLList

Sample

xmlList.valueOf()