K4 InDesign Javascript API Documentation

XMLXmlStories

A collection of xml stories.

Instance Properties

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

Methods

anyItem(
)
  → XmlStory
count(
)
  → number
everyItem(
)
  → XmlStory
firstItem(
)
  → XmlStory
item(
index)
  → XmlStory
itemByID(
id)
  → XmlStory
itemByName(
name)
  → XmlStory
itemByRange(
from, to)
  → XmlStory
lastItem(
)
  → XmlStory
middleItem(
)
  → XmlStory
nextItem(
obj)
  → XmlStory
previousItem(
obj)
  → XmlStory
toSource(
)
  → string
anyItem(
)
  → XmlStory
Returns any XmlStory in the collection.
count(
)
  → number
Displays the number of elements in the XmlStory.
everyItem(
)
  → XmlStory
Returns every XmlStory in the collection.
firstItem(
)
  → XmlStory
Returns the first XmlStory in the collection.
item(
index)
  → XmlStory
Returns the XmlStory with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → XmlStory
Returns the XmlStory with the specified ID.
id number The ID.
itemByName(
name)
  → XmlStory
Returns the XmlStory with the specified name.
name string The name.
itemByRange(
from, to)
  → XmlStory
Returns the XmlStories within the specified range.
from The XmlStory, index, or name at the beginning of the range. Can accept: XmlStory, Long Integer or String.
to The XmlStory, index, or name at the end of the range. Can accept: XmlStory, Long Integer or String.
lastItem(
)
  → XmlStory
Returns the last XmlStory in the collection.
middleItem(
)
  → XmlStory
Returns the middle XmlStory in the collection.
nextItem(
obj)
  → XmlStory
Returns the XmlStory whose index follows the specified XmlStory in the collection.
obj XmlStory The XmlStory whose index comes before the desired XmlStory.
previousItem(
obj)
  → XmlStory
Returns the XmlStory with the index previous to the specified index.
obj XmlStory The index of the XmlStory that follows the desired XmlStory.
toSource(
)
  → string
Generates a string which, if executed, will return the XmlStory.