K4 InDesign Javascript API Documentation

LayoutPDFs

A collection of PDF files.

Instance Properties

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

Methods

anyItem(
)
  → PDF
count(
)
  → number
everyItem(
)
  → PDF
firstItem(
)
  → PDF
item(
index)
  → PDF
itemByID(
id)
  → PDF
itemByName(
name)
  → PDF
itemByRange(
from, to)
  → PDF
lastItem(
)
  → PDF
middleItem(
)
  → PDF
nextItem(
obj)
  → PDF
previousItem(
obj)
  → PDF
toSource(
)
  → string
anyItem(
)
  → PDF
Returns any PDF in the collection.
count(
)
  → number
Displays the number of elements in the PDF.
everyItem(
)
  → PDF
Returns every PDF in the collection.
firstItem(
)
  → PDF
Returns the first PDF in the collection.
item(
index)
  → PDF
Returns the PDF with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → PDF
Returns the PDF with the specified ID.
id number The ID.
itemByName(
name)
  → PDF
Returns the PDF with the specified name.
name string The name.
itemByRange(
from, to)
  → PDF
Returns the PDFs within the specified range.
from The PDF, index, or name at the beginning of the range. Can accept: PDF, Long Integer or String.
to The PDF, index, or name at the end of the range. Can accept: PDF, Long Integer or String.
lastItem(
)
  → PDF
Returns the last PDF in the collection.
middleItem(
)
  → PDF
Returns the middle PDF in the collection.
nextItem(
obj)
  → PDF
Returns the PDF whose index follows the specified PDF in the collection.
obj PDF The PDF whose index comes before the desired PDF.
previousItem(
obj)
  → PDF
Returns the PDF with the index previous to the specified index.
obj PDF The index of the PDF that follows the desired PDF.
toSource(
)
  → string
Generates a string which, if executed, will return the PDF.