Adobe InDesign CS5 (7.0) Object Model JS: XmlStories

InDesign CS5

Class

XmlStories

 A collection of xml stories.

QuickLinks

[], 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

XmlStory [] (index: number)
Returns the XmlStory with the specified index.

ParameterTypeDescription
indexnumberThe index.

XmlStory anyItem ()
Returns any XmlStory in the collection.

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

Array of XmlStory everyItem ()
Returns every XmlStory in the collection.

XmlStory firstItem ()
Returns the first XmlStory in the collection.

XmlStory item (index: varies)
Returns the XmlStory with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

Array of XmlStory itemByRange (from: varies, to: varies)
Returns the XmlStories within the specified range.

ParameterTypeDescription
fromLong Integer
String
XmlStory
The XmlStory, index, or name at the beginning of the range. Can accept: XmlStory, Long Integer or String.
toLong Integer
String
XmlStory
The XmlStory, index, or name at the end of the range. Can accept: XmlStory, Long Integer or String.

XmlStory lastItem ()
Returns the last XmlStory in the collection.

XmlStory middleItem ()
Returns the middle XmlStory in the collection.

XmlStory nextItem (obj: XmlStory)
Returns the XmlStory whose index follows the specified XmlStory in the collection.

ParameterTypeDescription
objXmlStoryThe XmlStory whose index comes before the desired XmlStory.

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

ParameterTypeDescription
objXmlStoryThe index of the XmlStory that follows the desired XmlStory.

string toSource ()
Generates a string which, if executed, will return the XmlStory.

Element of

Document.xmlStories

Jongware, 20-Jun-2010 v3.0.3dContents :: Index