DataMergeTextPlaceholders
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
DataMergeTextPlaceholder add (parentStory:
Story, storyOffset:
any, 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.
Array
of DataMergeTextPlaceholder everyItem ()
Returns every DataMergeTextPlaceholder in the collection.
DataMergeTextPlaceholder firstItem ()
Returns the first DataMergeTextPlaceholder in the collection.
DataMergeTextPlaceholder item (index:
any)
Returns the DataMergeTextPlaceholder with the specified index or name.
| 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. |
Array
of DataMergeTextPlaceholder itemByRange (from:
any, to:
any)
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. |
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.
Element of
Document.dataMergeTextPlaceholders
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |