BuildingBlocks
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
BuildingBlock [] (index:
number)
Returns the BuildingBlock with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
BuildingBlock add (blockType:
BuildingBlockTypes[, appliedCharacterStyle:
CharacterStyle][, customText:
string][, withProperties:
Object])
Creates a new cross reference building block.
| Parameter | Type | Description |
|---|---|---|
| blockType | BuildingBlockTypes: BuildingBlockTypes.CUSTOM_STRING_BUILDING_BLOCK BuildingBlockTypes.FILE_NAME_BUILDING_BLOCK BuildingBlockTypes.CHAPTER_NUMBER_BUILDING_BLOCK BuildingBlockTypes.PAGE_NUMBER_BUILDING_BLOCK BuildingBlockTypes.FULL_PARAGRAPH_BUILDING_BLOCK BuildingBlockTypes.PARAGRAPH_NUMBER_BUILDING_BLOCK BuildingBlockTypes.PARAGRAPH_TEXT_BUILDING_BLOCK BuildingBlockTypes.BOOKMARK_NAME_BUILDING_BLOCK | 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) |
BuildingBlock anyItem ()
Returns any BuildingBlock in the collection.
number count ()
Displays the number of elements in the BuildingBlock.
Array of BuildingBlock everyItem ()
Returns every BuildingBlock in the collection.
BuildingBlock firstItem ()
Returns the first BuildingBlock in the collection.
BuildingBlock item (index:
any)
Returns the BuildingBlock with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
BuildingBlock itemByName (name:
string)
Returns the BuildingBlock with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of BuildingBlock itemByRange (from:
any, to:
any)
Returns the BuildingBlocks within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | BuildingBlock Long Integer String | The BuildingBlock, index, or name at the beginning of the range. Can accept: BuildingBlock, Long Integer or String. |
| to | BuildingBlock Long Integer String | The BuildingBlock, index, or name at the end of the range. Can accept: BuildingBlock, Long Integer or String. |
BuildingBlock lastItem ()
Returns the last BuildingBlock in the collection.
BuildingBlock middleItem ()
Returns the middle BuildingBlock in the collection.
BuildingBlock nextItem (obj:
BuildingBlock)
Returns the BuildingBlock whose index follows the specified BuildingBlock in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | BuildingBlock | The BuildingBlock whose index comes before the desired BuildingBlock. |
BuildingBlock previousItem (obj:
BuildingBlock)
Returns the BuildingBlock with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | BuildingBlock | The index of the BuildingBlock that follows the desired BuildingBlock. |
string toSource ()
Generates a string which, if executed, will return the BuildingBlock.
Element of
CrossReferenceFormat.buildingBlocks
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |