K4 InDesign Javascript API Documentation

HyperlinksBuildingBlocks

A collection of cross reference building blocks.

Instance Properties

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

Methods

add(
blockType ​[, appliedCharacterStyle] ​[, customText] ​[, withProperties])
  → BuildingBlock
anyItem(
)
  → BuildingBlock
count(
)
  → number
everyItem(
)
  → BuildingBlock
firstItem(
)
  → BuildingBlock
item(
index)
  → BuildingBlock
itemByRange(
from, to)
  → BuildingBlock
lastItem(
)
  → BuildingBlock
middleItem(
)
  → BuildingBlock
nextItem(
obj)
  → BuildingBlock
previousItem(
obj)
  → BuildingBlock
toSource(
)
  → string
add(
blockType ​[, appliedCharacterStyle] ​[, customText] ​[, withProperties])
  → BuildingBlock
Creates a new cross reference building block.
blockType BuildingBlockTypes Type of the building block.
appliedCharacterStyle CharacterStyle Character style to be applied to the building block. (Optional)
customText string Building block custom text. Currently this is only useful in custom string building block. It is ignored for other types of building blocks. (Optional)
withProperties Object Initial values for properties of the new BuildingBlock (Optional)
anyItem(
)
  → BuildingBlock
Returns any BuildingBlock in the collection.
count(
)
  → number
Displays the number of elements in the BuildingBlock.
everyItem(
)
  → BuildingBlock
Returns every BuildingBlock in the collection.
firstItem(
)
  → BuildingBlock
Returns the first BuildingBlock in the collection.
item(
index)
  → BuildingBlock
Returns the BuildingBlock with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
  → BuildingBlock
Returns the BuildingBlocks within the specified range.
from The BuildingBlock, index, or name at the beginning of the range. Can accept: BuildingBlock, Long Integer or String.
to The BuildingBlock, index, or name at the end of the range. Can accept: BuildingBlock, Long Integer or String.
lastItem(
)
  → BuildingBlock
Returns the last BuildingBlock in the collection.
middleItem(
)
  → BuildingBlock
Returns the middle BuildingBlock in the collection.
nextItem(
obj)
  → BuildingBlock
Returns the BuildingBlock whose index follows the specified BuildingBlock in the collection.
obj BuildingBlock The BuildingBlock whose index comes before the desired BuildingBlock.
previousItem(
obj)
  → BuildingBlock
Returns the BuildingBlock with the index previous to the specified index.
obj BuildingBlock The index of the BuildingBlock that follows the desired BuildingBlock.
toSource(
)
  → string
Generates a string which, if executed, will return the BuildingBlock.