K4 InDesign Javascript API Documentation

BasicsLayoutWindows

A collection of layout windows.

Instance Properties

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

Methods

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