XMLElements

A collection of XML elements.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

XMLElement [] (index:Number)

Returns the XMLElement with the specified index.

Parameter	Type	Description
index	Number	The index.

XMLElement add (markupTag:Varies String XMLTag, xmlContent:Varies Graphic Movie PageItem Sound Story Table Text Cell, withProperties:Object)

Creates a new XML element.

Parameter	Type	Description
markupTag	String XMLTag	The XML tag used to identify the element. Can accept: String or XMLTag.
xmlContent	Graphic Movie PageItem Sound Story Table Text Cell	The content to be marked up. Can accept: Text, Story, PageItem, Movie, Sound, Graphic, Table or Cell. (Optional)
withProperties	Object	Initial values for properties of the new XMLElement (Optional)

Parameter

Type

Description

markupTag

String

XMLTag

The XML tag used to identify the element. Can accept: String or XMLTag.

xmlContent

The content to be marked up. Can accept: Text, Story, PageItem, Movie, Sound, Graphic, Table or Cell. (Optional)

withProperties

Object

Initial values for properties of the new XMLElement (Optional)

XMLElement anyItem ()

Returns any XMLElement in the collection.

Number count ()

Displays the number of elements in the XMLElement.

XMLElement everyItem ()

Returns every XMLElement in the collection.

XMLElement firstItem ()

Returns the first XMLElement in the collection.

XMLElement item (index:Varies LongInteger String)

Returns the XMLElement with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

XMLElement itemByID (id:Number)

Returns the XMLElement with the specified ID.

Parameter	Type	Description
id	Number	The ID.

XMLElement itemByRange (from:Varies LongInteger XMLElement String, to:Varies LongInteger XMLElement String)

Returns the XMLElements within the specified range.

Parameter	Type	Description
from	LongInteger XMLElement String	The XMLElement, index, or name at the beginning of the range. Can accept: XMLElement, Long Integer or String.
to	LongInteger XMLElement String	The XMLElement, index, or name at the end of the range. Can accept: XMLElement, Long Integer or String.

Parameter

Type

Description

from

LongInteger

XMLElement

String

The XMLElement, index, or name at the beginning of the range. Can accept: XMLElement, Long Integer or String.

LongInteger

XMLElement

String

The XMLElement, index, or name at the end of the range. Can accept: XMLElement, Long Integer or String.

XMLElement lastItem ()

Returns the last XMLElement in the collection.

XMLElement middleItem ()

Returns the middle XMLElement in the collection.

XMLElement nextItem (obj:XMLElement)

Returns the XMLElement whose index follows the specified XMLElement in the collection.

Parameter	Type	Description
obj	XMLElement	The XMLElement whose index comes before the desired XMLElement.

XMLElement previousItem (obj:XMLElement)

Returns the XMLElement with the index previous to the specified index.

Parameter	Type	Description
obj	XMLElement	The index of the XMLElement that follows the desired XMLElement.

String toSource ()

Generates a string which, if executed, will return the XMLElement.

Object of

Document.xmlElements

XMLElement.xmlElements