K4 InDesign Javascript API Documentation

BookBooks

A collection of books.

Instance Properties

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

Methods

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