K4 InDesign Javascript API Documentation

Interactive ElementsSignatureFields

A collection of signature fields.

Instance Properties

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

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → SignatureField
anyItem(
)
  → SignatureField
count(
)
  → number
everyItem(
)
  → SignatureField
firstItem(
)
  → SignatureField
item(
index)
  → SignatureField
itemByID(
id)
  → SignatureField
itemByName(
name)
  → SignatureField
itemByRange(
from, to)
  → SignatureField
lastItem(
)
  → SignatureField
middleItem(
)
  → SignatureField
nextItem(
obj)
  → SignatureField
previousItem(
obj)
  → SignatureField
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → SignatureField
Creates a new SignatureField
layer Layer The layer on which to create the SignatureField. (Optional)
at LocationOptions The location at which to insert the SignatureField relative to the reference object or within the container object. (Optional)
reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withProperties Object Initial values for properties of the new SignatureField (Optional)
anyItem(
)
  → SignatureField
Returns any SignatureField in the collection.
count(
)
  → number
Displays the number of elements in the SignatureField.
everyItem(
)
  → SignatureField
Returns every SignatureField in the collection.
firstItem(
)
  → SignatureField
Returns the first SignatureField in the collection.
item(
index)
  → SignatureField
Returns the SignatureField with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → SignatureField
Returns the SignatureField with the specified ID.
id number The ID.
itemByName(
name)
  → SignatureField
Returns the SignatureField with the specified name.
name string The name.
itemByRange(
from, to)
  → SignatureField
Returns the SignatureFields within the specified range.
from The SignatureField, index, or name at the beginning of the range. Can accept: SignatureField, Long Integer or String.
to The SignatureField, index, or name at the end of the range. Can accept: SignatureField, Long Integer or String.
lastItem(
)
  → SignatureField
Returns the last SignatureField in the collection.
middleItem(
)
  → SignatureField
Returns the middle SignatureField in the collection.
nextItem(
obj)
  → SignatureField
Returns the SignatureField whose index follows the specified SignatureField in the collection.
obj SignatureField The SignatureField whose index comes before the desired SignatureField.
previousItem(
obj)
  → SignatureField
Returns the SignatureField with the index previous to the specified index.
obj SignatureField The index of the SignatureField that follows the desired SignatureField.
toSource(
)
  → string
Generates a string which, if executed, will return the SignatureField.