K4 InDesign Javascript API Documentation

XMLXMLInstructions

A collection of XML instructions.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
target ​[, data], storyOffset ​[, withProperties])
  → XMLInstruction
anyItem(
)
  → XMLInstruction
count(
)
  → number
everyItem(
)
  → XMLInstruction
firstItem(
)
  → XMLInstruction
item(
index)
  → XMLInstruction
itemByID(
id)
  → XMLInstruction
itemByRange(
from, to)
  → XMLInstruction
lastItem(
)
  → XMLInstruction
middleItem(
)
  → XMLInstruction
nextItem(
obj)
  → XMLInstruction
previousItem(
obj)
  → XMLInstruction
toSource(
)
  → string
add(
target ​[, data=""], storyOffset ​[, withProperties])
  → 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. (Optional)
storyOffset 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)
anyItem(
)
  → XMLInstruction
Returns any XMLInstruction in the collection.
count(
)
  → number
Displays the number of elements in the XMLInstruction.
everyItem(
)
  → XMLInstruction
Returns every XMLInstruction in the collection.
firstItem(
)
  → XMLInstruction
Returns the first XMLInstruction in the collection.
item(
index)
  → XMLInstruction
Returns the XMLInstruction with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → XMLInstruction
Returns the XMLInstruction with the specified ID.
id number The ID.
itemByRange(
from, to)
  → XMLInstruction
Returns the XMLInstructions within the specified range.
from The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long Integer or String.
to The XMLInstruction, index, or name at the end of the range. Can accept: XMLInstruction, Long Integer or String.
lastItem(
)
  → XMLInstruction
Returns the last XMLInstruction in the collection.
middleItem(
)
  → XMLInstruction
Returns the middle XMLInstruction in the collection.
nextItem(
obj)
  → XMLInstruction
Returns the XMLInstruction whose index follows the specified XMLInstruction in the collection.
obj XMLInstruction The XMLInstruction whose index comes before the desired XMLInstruction.
previousItem(
obj)
  → XMLInstruction
Returns the XMLInstruction with the index previous to the specified index.
obj XMLInstruction The index of the XMLInstruction that follows the desired XMLInstruction.
toSource(
)
  → string
Generates a string which, if executed, will return the XMLInstruction.