A collection of XML elements.
Methods
XMLElementadd (markupTag:
any[, xmlContent:
any][, 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 | Text Story PageItem Movie Sound Graphic Table 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) |
XMLElementanyItem ()
Returns any XMLElement in the collection.
number count ()
Displays the number of elements in the XMLElement.
Array of XMLElementeveryItem ()
Returns every XMLElement in the collection.
XMLElementfirstItem ()
Returns the first XMLElement in the collection.
XMLElementitem (index:
any)
Returns the XMLElement with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
XMLElementitemByID (id:
number)
Returns the XMLElement with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
XMLElementitemByName (name:
string)
Returns the XMLElement with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of XMLElementitemByRange (from:
any, to:
any)
Returns the XMLElements within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | XMLElement Long Integer String |
The XMLElement, index, or name at the beginning of the range. Can accept: XMLElement, Long Integer or String. |
| to | XMLElement Long Integer String |
The XMLElement, index, or name at the end of the range. Can accept: XMLElement, Long Integer or String. |
XMLElementlastItem ()
Returns the last XMLElement in the collection.
XMLElementmiddleItem ()
Returns the middle XMLElement in the collection.
XMLElementnextItem (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. |
XMLElementpreviousItem (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.
Element of:
Document.xmlElements
XMLElement.xmlElements
XMLItem.xmlElements