ParagraphDestinations
See also ParagraphDestination.
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
ParagraphDestination [] (index:
number)
Returns the ParagraphDestination with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
ParagraphDestination add (destination:
Text[, withProperties:
Object])
Creates a new paragraph destination.
| Parameter | Type | Description |
|---|---|---|
| destination | Text | The text or insertion point inside the paragraph that the cross reference points to. The insertion point is always adjusted to the beginning of the paragraph. |
| withProperties | Object | Initial values for properties of the new ParagraphDestination (Optional) |
ParagraphDestination anyItem ()
Returns any ParagraphDestination in the collection.
number count ()
Displays the number of elements in the ParagraphDestination.
Array of ParagraphDestination everyItem ()
Returns every ParagraphDestination in the collection.
ParagraphDestination firstItem ()
Returns the first ParagraphDestination in the collection.
ParagraphDestination item (index:
varies)
Returns the ParagraphDestination with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
ParagraphDestination itemByID (id:
number)
Returns the ParagraphDestination with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
ParagraphDestination itemByName (name:
string)
Returns the ParagraphDestination with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of ParagraphDestination itemByRange (from:
varies, to:
varies)
Returns the ParagraphDestinations within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer ParagraphDestination String | The ParagraphDestination, index, or name at the beginning of the range. Can accept: ParagraphDestination, Long Integer or String. |
| to | Long Integer ParagraphDestination String | The ParagraphDestination, index, or name at the end of the range. Can accept: ParagraphDestination, Long Integer or String. |
ParagraphDestination lastItem ()
Returns the last ParagraphDestination in the collection.
ParagraphDestination middleItem ()
Returns the middle ParagraphDestination in the collection.
ParagraphDestination nextItem (obj:
ParagraphDestination)
Returns the ParagraphDestination whose index follows the specified ParagraphDestination in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | ParagraphDestination | The ParagraphDestination whose index comes before the desired ParagraphDestination. |
ParagraphDestination previousItem (obj:
ParagraphDestination)
Returns the ParagraphDestination with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | ParagraphDestination | The index of the ParagraphDestination that follows the desired ParagraphDestination. |
string toSource ()
Generates a string which, if executed, will return the ParagraphDestination.
Element of
Document.paragraphDestinations
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |