DataMergeTextPlaceholders

A collection of data merge text placeholders.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

DataMergeTextPlaceholder [] (index:Number)

Returns the DataMergeTextPlaceholder with the specified index.

Parameter

Type

Description

index

Number

The index.

DataMergeTextPlaceholder add (parentStory:Story, storyOffset:Varies InsertionPoint LongInteger, field:DataMergeField, withProperties:Object)

Creates a data merge text placeholder.

Parameter

Type

Description

parentStory

Story

The story in which to insert the placeholder.

storyOffset

InsertionPoint

LongInteger

The position within the story at which to insert the placeholder, specified as an offset number or an insertion point. Can accept: InsertionPoint or Long Integer.

field

DataMergeField

The field to insert.

withProperties

Object

Initial values for properties of the new DataMergeTextPlaceholder (Optional)

DataMergeTextPlaceholder anyItem ()

Returns any DataMergeTextPlaceholder in the collection.

Number count ()

Displays the number of elements in the DataMergeTextPlaceholder.

DataMergeTextPlaceholder everyItem ()

Returns every DataMergeTextPlaceholder in the collection.

DataMergeTextPlaceholder firstItem ()

Returns the first DataMergeTextPlaceholder in the collection.

DataMergeTextPlaceholder item (index:Varies LongInteger String)

Returns the DataMergeTextPlaceholder with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

DataMergeTextPlaceholder itemByRange (from:Varies DataMergeTextPlaceholder LongInteger String, to:Varies DataMergeTextPlaceholder LongInteger String)

Returns the DataMergeTextPlaceholders within the specified range.

Parameter

Type

Description

from

DataMergeTextPlaceholder

LongInteger

String

The DataMergeTextPlaceholder, index, or name at the beginning of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String.

to

DataMergeTextPlaceholder

LongInteger

String

The DataMergeTextPlaceholder, index, or name at the end of the range. Can accept: DataMergeTextPlaceholder, Long Integer or String.

DataMergeTextPlaceholder lastItem ()

Returns the last DataMergeTextPlaceholder in the collection.

DataMergeTextPlaceholder middleItem ()

Returns the middle DataMergeTextPlaceholder in the collection.

DataMergeTextPlaceholder nextItem (obj:DataMergeTextPlaceholder)

Returns the DataMergeTextPlaceholder whose index follows the specified DataMergeTextPlaceholder in the collection.

Parameter

Type

Description

obj

DataMergeTextPlaceholder

The DataMergeTextPlaceholder whose index comes before the desired DataMergeTextPlaceholder.

DataMergeTextPlaceholder previousItem (obj:DataMergeTextPlaceholder)

Returns the DataMergeTextPlaceholder with the index previous to the specified index.

Parameter

Type

Description

obj

DataMergeTextPlaceholder

The index of the DataMergeTextPlaceholder that follows the desired DataMergeTextPlaceholder.

String toSource ()

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

Object of

Document.dataMergeTextPlaceholders