K4 InDesign Javascript API Documentation

HyperlinksBuildingBlock

A cross reference building block object.

Instance Properties

Name Description Access
appliedCharacterStyle CharacterStyle Character style to be applied to the building block. read-write
appliedDelimiter string Delimiter character for paragraph text and full paragraph building blocks. It is ignored for other types of building blocks. read-write
blockType BuildingBlockTypes Type of the building block. read-write
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. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
includeDelimiter bool If true, the source generated for the building block includes the delimiter. It is ignored if no delimiter is specified on the building block. read-write
index number The index of the BuildingBlock within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent CrossReferenceFormat The parent of the BuildingBlock (a CrossReferenceFormat). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → BuildingBlock
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → BuildingBlock
Resolves the object specifier, creating an array of object references.
remove(
)
Deletes the BuildingBlock.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the BuildingBlock.
toSpecifier(
)
  → string
Retrieves the object specifier.