InDesign2026
API 21.5.1.73
Collection of XMLInstruction

XMLInstructions

A collection of XML instructions.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

→ XMLInstruction

Returns the XMLInstruction with the specified index.

index Number The index.
→ XMLInstruction

Creates a new XML processing instruction.

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

Returns any XMLInstruction in the collection.

→ Number

Displays the number of elements in the XMLInstruction.

→ XMLInstruction[]

Returns every XMLInstruction in the collection.

→ XMLInstruction

Returns the first XMLInstruction in the collection.

→ XMLInstruction

Returns the XMLInstruction with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
→ XMLInstruction

Returns the XMLInstruction with the specified ID.

id Number The ID.
→ XMLInstruction[]

Returns the XMLInstructions within the specified range.

from LongInteger | XMLInstruction | String The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long Integer or String.
to LongInteger | XMLInstruction | String The XMLInstruction, index, or name at the end of the range. Can accept: XMLInstruction, Long Integer or String.
→ XMLInstruction

Returns the last XMLInstruction in the collection.

→ XMLInstruction

Returns the middle XMLInstruction in the collection.

→ XMLInstruction

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

obj XMLInstruction The XMLInstruction whose index comes before the desired XMLInstruction.
→ XMLInstruction

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

obj XMLInstruction The index of the XMLInstruction that follows the desired XMLInstruction.
→ String

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

Object of 2

Properties elsewhere that hold a XMLInstructions.