InDesign Server2025
API 20.5.0.49
Object

BuildingBlock

A cross reference building block object.

Hierarchy

CrossReferenceFormat

BuildingBlock

Properties

NameType AccessDescription
CharacterStyle read/write Character style to be applied to the building block.
String read/write Delimiter character for paragraph text and full paragraph building blocks. It is ignored for other types of building blocks.
BuildingBlockTypes
read/write Type of the building block.
String read/write Building block custom text. Currently this is only useful in custom string building block. It is ignored for other types of building blocks.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, the source generated for the building block includes the delimiter. It is ignored if no delimiter is specified on the building block.
Number readonly The index of the BuildingBlock within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
CrossReferenceFormat readonly The parent of the BuildingBlock (a CrossReferenceFormat).
Object read/write A property that allows setting of several properties at the same time.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
BuildingBlock[]

Resolves the object specifier, creating an array of object references.

void

Deletes the BuildingBlock.

Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
String

Generates a string which, if executed, will return the BuildingBlock.

String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a BuildingBlock.

Parameter of 3

Method parameters that accept a BuildingBlock.

Return 12

Methods that return a BuildingBlock.