K4 InDesign Javascript API Documentation

BasicsDocuments

A collection of documents.

Instance Properties

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

Methods

add(
[showingWindow] ​[, documentPreset] ​[, withProperties])
  → Document
anyItem(
)
  → Document
count(
)
  → number
everyItem(
)
  → Document
firstItem(
)
  → Document
item(
index)
  → Document
itemByID(
id)
  → Document
itemByName(
name)
  → Document
itemByRange(
from, to)
  → Document
lastItem(
)
  → Document
middleItem(
)
  → Document
nextItem(
obj)
  → Document
previousItem(
obj)
  → Document
toSource(
)
  → string
add(
[showingWindow=true] ​[, documentPreset] ​[, withProperties])
  → Document
Creates a new document.
showingWindow bool If true, displays the document. (Optional)
documentPreset DocumentPreset The document preset to use. (Optional)
withProperties Object Initial values for properties of the new Document (Optional)
anyItem(
)
  → Document
Returns any Document in the collection.
count(
)
  → number
Displays the number of elements in the Document.
everyItem(
)
  → Document
Returns every Document in the collection.
firstItem(
)
  → Document
Returns the first Document in the collection.
item(
index)
  → Document
Returns the Document with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → Document
Returns the Document with the specified ID.
id number The ID.
itemByName(
name)
  → Document
Returns the Document with the specified name.
name string The name.
itemByRange(
from, to)
  → Document
Returns the Documents within the specified range.
from The Document, index, or name at the beginning of the range. Can accept: Document, Long Integer or String.
to The Document, index, or name at the end of the range. Can accept: Document, Long Integer or String.
lastItem(
)
  → Document
Returns the last Document in the collection.
middleItem(
)
  → Document
Returns the middle Document in the collection.
nextItem(
obj)
  → Document
Returns the Document whose index follows the specified Document in the collection.
obj Document The Document whose index comes before the desired Document.
previousItem(
obj)
  → Document
Returns the Document with the index previous to the specified index.
obj Document The index of the Document that follows the desired Document.
toSource(
)
  → string
Generates a string which, if executed, will return the Document.