XMLInstructions

A collection of XML instructions.

Methods

XMLInstructionadd (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 Integer	The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long Integer. (Optional)
withProperties	Object	Initial values for properties of the new XMLInstruction (Optional)

XMLInstructionanyItem ()
Returns any XMLInstruction in the collection.

number count ()
Displays the number of elements in the XMLInstruction.

Array of XMLInstructioneveryItem ()
Returns every XMLInstruction in the collection.

XMLInstructionfirstItem ()
Returns the first XMLInstruction in the collection.

XMLInstructionitem (index:
any)
Returns the XMLInstruction with the specified index or name.

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

XMLInstructionitemByID (id:
number)
Returns the XMLInstruction with the specified ID.

Parameter	Type	Description
id	number	The ID.

XMLInstructionitemByName (name:
string)
Returns the XMLInstruction with the specified name.

Parameter	Type	Description
name	string	The name.

Array of XMLInstructionitemByRange (from:
any, to:
any)
Returns the XMLInstructions within the specified range.

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

XMLInstructionlastItem ()
Returns the last XMLInstruction in the collection.

XMLInstructionmiddleItem ()
Returns the middle XMLInstruction in the collection.

XMLInstructionnextItem (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.

XMLInstructionpreviousItem (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