K4 InDesign Javascript API Documentation

DatamergeDataMergeQrcodePlaceholders

A collection of data merge QR code placeholders.

Instance Properties

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

Methods

add(
placeholder, field ​[, withProperties])
  → DataMergeQrcodePlaceholder
anyItem(
)
  → DataMergeQrcodePlaceholder
count(
)
  → number
everyItem(
)
  → DataMergeQrcodePlaceholder
firstItem(
)
  → DataMergeQrcodePlaceholder
item(
index)
  → DataMergeQrcodePlaceholder
itemByRange(
from, to)
  → DataMergeQrcodePlaceholder
lastItem(
)
  → DataMergeQrcodePlaceholder
middleItem(
)
  → DataMergeQrcodePlaceholder
nextItem(
obj)
  → DataMergeQrcodePlaceholder
previousItem(
obj)
  → DataMergeQrcodePlaceholder
toSource(
)
  → string
add(
placeholder, field ​[, withProperties])
  → DataMergeQrcodePlaceholder
Creates a data merge QR code placeholder.
placeholder PageItem The page item on which to place the placeholder.
field DataMergeField The data merge field to insert.
withProperties Object Initial values for properties of the new DataMergeQrcodePlaceholder (Optional)
anyItem(
)
  → DataMergeQrcodePlaceholder
Returns any DataMergeQrcodePlaceholder in the collection.
count(
)
  → number
Displays the number of elements in the DataMergeQrcodePlaceholder.
everyItem(
)
  → DataMergeQrcodePlaceholder
Returns every DataMergeQrcodePlaceholder in the collection.
firstItem(
)
  → DataMergeQrcodePlaceholder
Returns the first DataMergeQrcodePlaceholder in the collection.
item(
index)
  → DataMergeQrcodePlaceholder
Returns the DataMergeQrcodePlaceholder with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → DataMergeQrcodePlaceholder
Returns the DataMergeQrcodePlaceholders within the specified range.
from The DataMergeQrcodePlaceholder, index, or name at the beginning of the range. Can accept: DataMergeQrcodePlaceholder, Long Integer or String.
to The DataMergeQrcodePlaceholder, index, or name at the end of the range. Can accept: DataMergeQrcodePlaceholder, Long Integer or String.
lastItem(
)
  → DataMergeQrcodePlaceholder
Returns the last DataMergeQrcodePlaceholder in the collection.
middleItem(
)
  → DataMergeQrcodePlaceholder
Returns the middle DataMergeQrcodePlaceholder in the collection.
nextItem(
obj)
  → DataMergeQrcodePlaceholder
Returns the DataMergeQrcodePlaceholder whose index follows the specified DataMergeQrcodePlaceholder in the collection.
obj DataMergeQrcodePlaceholder The DataMergeQrcodePlaceholder whose index comes before the desired DataMergeQrcodePlaceholder.
previousItem(
obj)
  → DataMergeQrcodePlaceholder
Returns the DataMergeQrcodePlaceholder with the index previous to the specified index.
obj DataMergeQrcodePlaceholder The index of the DataMergeQrcodePlaceholder that follows the desired DataMergeQrcodePlaceholder.
toSource(
)
  → string
Generates a string which, if executed, will return the DataMergeQrcodePlaceholder.