XMLInstructions
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
XMLInstruction add (target:
string[, data:
string=][, storyOffset:
any][, withProperties:
Object])
Creates a new XML processing instruction.
| Parameter | Type | Description |
|---|---|---|
| target | string | A name that identifies the processing instruction to an application reading the exported XML file. |
| data | string | A value that tells the application what to do with the processing instruction identified in the target. (Optional) (default: ) |
| storyOffset | InsertionPoint Long | The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long. (Optional) |
| withProperties | Object | Initial values for properties of the new XMLInstruction (Optional) |
XMLInstruction anyItem ()
Returns any XMLInstruction in the collection.
number count ()
Displays the number of elements in the XMLInstruction.
Array
of XMLInstruction everyItem ()
Returns every XMLInstruction in the collection.
XMLInstruction firstItem ()
Returns the first XMLInstruction in the collection.
XMLInstruction item (index:
any)
Returns the XMLInstruction with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long String | The index or name. Can accept: Long or String. |
XMLInstruction itemByID (id:
number)
Returns the XMLInstruction with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
XMLInstruction itemByName (name:
string)
Returns the XMLInstruction with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of XMLInstruction itemByRange (from:
any, to:
any)
Returns the XMLInstructions within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long String XMLInstruction | The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long or String. |
| to | Long String XMLInstruction | The XMLInstruction, index, or name at the end of the range. Can accept: XMLInstruction, Long or String. |
XMLInstruction lastItem ()
Returns the last XMLInstruction in the collection.
XMLInstruction middleItem ()
Returns the middle XMLInstruction in the collection.
XMLInstruction nextItem (obj:
XMLInstruction)
Returns the XMLInstruction whose index follows the specified XMLInstruction in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | XMLInstruction | The XMLInstruction whose index comes before the desired XMLInstruction. |
XMLInstruction previousItem (obj:
XMLInstruction)
Returns the XMLInstruction with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | XMLInstruction | The index of the XMLInstruction that follows the desired XMLInstruction. |
string toSource ()
Generates a string which, if executed, will return the XMLInstruction.
Element of
Document.xmlInstructions
XMLElement.xmlInstructions
XMLItem.xmlInstructions
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |