K4 InDesign Javascript API Documentation

BookBookContents

A collection of book content objects.

Instance Properties

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

Methods

add(
fullName ​[, at] ​[, withProperties])
  → BookContent
anyItem(
)
  → BookContent
count(
)
  → number
everyItem(
)
  → BookContent
firstItem(
)
  → BookContent
item(
index)
  → BookContent
itemByID(
id)
  → BookContent
itemByName(
name)
  → BookContent
itemByRange(
from, to)
  → BookContent
lastItem(
)
  → BookContent
middleItem(
)
  → BookContent
nextItem(
obj)
  → BookContent
previousItem(
obj)
  → BookContent
toSource(
)
  → string
add(
fullName ​[, at=-1] ​[, withProperties])
  → BookContent
Creates a new book content object.
fullName File The full path name of the new book content object.
at number The location of the book content object within the book. (Optional)
withProperties Object Initial values for properties of the new BookContent (Optional)
anyItem(
)
  → BookContent
Returns any BookContent in the collection.
count(
)
  → number
Displays the number of elements in the BookContent.
everyItem(
)
  → BookContent
Returns every BookContent in the collection.
firstItem(
)
  → BookContent
Returns the first BookContent in the collection.
item(
index)
  → BookContent
Returns the BookContent with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → BookContent
Returns the BookContent with the specified ID.
id number The ID.
itemByName(
name)
  → BookContent
Returns the BookContent with the specified name.
name string The name.
itemByRange(
from, to)
  → BookContent
Returns the BookContents within the specified range.
from The BookContent, index, or name at the beginning of the range. Can accept: BookContent, Long Integer or String.
to The BookContent, index, or name at the end of the range. Can accept: BookContent, Long Integer or String.
lastItem(
)
  → BookContent
Returns the last BookContent in the collection.
middleItem(
)
  → BookContent
Returns the middle BookContent in the collection.
nextItem(
obj)
  → BookContent
Returns the BookContent whose index follows the specified BookContent in the collection.
obj BookContent The BookContent whose index comes before the desired BookContent.
previousItem(
obj)
  → BookContent
Returns the BookContent with the index previous to the specified index.
obj BookContent The index of the BookContent that follows the desired BookContent.
toSource(
)
  → string
Generates a string which, if executed, will return the BookContent.