DataMergeTextPlaceholders

A collection of data merge text placeholders.

Go to Property Listing | Method Listing

Methods:

add, anyItem, count, everyItem, firstItem, item, itemByName, 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 add (parentStory:Story, storyOffset:Varies InsertionPoint Long, 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 Long	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.
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 Long String)

Returns the DataMergeTextPlaceholder with the specified index or name.

Parameter	Type	Description
index	Long String	The index or name. Can accept: Long or String.

Parameter

Type

Description

index

Long

String

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

DataMergeTextPlaceholder itemByName (name:String)

Returns the DataMergeTextPlaceholder with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the DataMergeTextPlaceholders within the specified range.

Parameter	Type	Description
from	DataMergeTextPlaceholder Long String	The DataMergeTextPlaceholder, index, or name at the beginning of the range. Can accept: DataMergeTextPlaceholder, Long or String.
to	DataMergeTextPlaceholder Long String	The DataMergeTextPlaceholder, index, or name at the end of the range. Can accept: DataMergeTextPlaceholder, Long or String.

Parameter

Type

Description

from

DataMergeTextPlaceholder

Long

String

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

DataMergeTextPlaceholder

Long

String

The DataMergeTextPlaceholder, index, or name at the end of the range. Can accept: DataMergeTextPlaceholder, Long 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