Adobe InDesign CS2 (4.0) Object Model JS: XMLInstructions

InDesign CS2

Class

XMLInstructions

 A collection of XML instructions.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

XMLInstruction add (target: string[, data: string=][, storyOffset: any][, withProperties: Object])
Creates a new XML processing instruction.

ParameterTypeDescription
targetstringA name that identifies the processing instruction to an application reading the exported XML file.
datastringA value that tells the application what to do with the processing instruction identified in the target. (Optional) (default: )
storyOffsetInsertionPoint
Long
The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long. (Optional)
withPropertiesObjectInitial 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.

ParameterTypeDescription
indexLong
String
The index or name. Can accept: Long or String.

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong
String
XMLInstruction
The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long or String.
toLong
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.

ParameterTypeDescription
objXMLInstructionThe XMLInstruction whose index comes before the desired XMLInstruction.

XMLInstruction previousItem (obj: XMLInstruction)
Returns the XMLInstruction with the index previous to the specified index.

ParameterTypeDescription
objXMLInstructionThe 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.3dContents :: Index