An object that can contain a data merge text field.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| field | DataMergeField | readonly | The data merge field to insert in the placeholder. For information, see data merge text placeholder and data merge image placeholder. |
| index | number | readonly | The index of the DataMergeTextPlaceholder within its containing object. |
| length | number | readonly | The number of DataMergeTextPlaceholders in the collection. |
| parent | Document | readonly | The parent of the DataMergeTextPlaceholder (a Document). |
| parentStory | Story | readonly | The story that contains the DataMergeTextPlaceholder. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| storyOffset | InsertionPoint | readonly | The location of the DataMergeTextPlaceholder in the parent story. |
Methods
Array of DataMergeTextPlaceholdergetElements ()
Resolves the object specifier, creating an array of object references.
string toSource ()
Generates a string which, if executed, will return the DataMergeTextPlaceholder.
string toSpecifier ()
Retrieves the object specifier.
Used in:
DataMergeTextPlaceholders.previousItem (
obj:
DataMergeTextPlaceholder )
DataMergeTextPlaceholders.nextItem (
obj:
DataMergeTextPlaceholder )
Returned by:
Array of DataMergeTextPlaceholder DataMergeTextPlaceholder .getElements (
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.add (
parentStory:
Story, storyOffset:
any, field:
DataMergeField[, withProperties:
Object]
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.anyItem (
)
Array of DataMergeTextPlaceholder DataMergeTextPlaceholders.everyItem (
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.firstItem (
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.item (
index:
any
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.itemByName (
name:
string
)
Array of DataMergeTextPlaceholder DataMergeTextPlaceholders.itemByRange (
from:
any, to:
any
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.lastItem (
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.middleItem (
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.nextItem (
obj:
DataMergeTextPlaceholder
)
DataMergeTextPlaceholder DataMergeTextPlaceholders.previousItem (
obj:
DataMergeTextPlaceholder
)