Adobe InDesign CS6 (8.0) Object Model JS: BookContents

InDesign CS6

Class

BookContents

 A collection of book content objects.

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

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

ParameterTypeDescription
indexnumberThe index.

BookContent add (fullName: File[, at: number=-1][, withProperties: Object])
Creates a new book content object.

ParameterTypeDescription
fullNameFileThe full path name of the new book content object.
atnumberThe location of the book content object within the book. (Optional) (default: -1)
withPropertiesObjectInitial values for properties of the new BookContent (Optional)

BookContent anyItem ()
Returns any BookContent in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromBookContent
Long Integer
String
The BookContent, index, or name at the beginning of the range. Can accept: BookContent, Long Integer or String.
toBookContent
Long Integer
String
The BookContent, index, or name at the end of the range. Can accept: BookContent, Long Integer or String.

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

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

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

ParameterTypeDescription
objBookContentThe BookContent whose index comes before the desired BookContent.

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

ParameterTypeDescription
objBookContentThe index of the BookContent that follows the desired BookContent.

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

Element of

Book.bookContents

Jongware, 28-Apr-2012 v3.0.3hContents :: Index