K4 InDesign Javascript API Documentation

LayoutSnippets

A collection of IDML snippets.

Instance Properties

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

Methods

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