Class
A collection of index page references. add, count
PageReferences
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
PageReference add (parentStory:
Story, storyOffset:
any[, pageReferenceType:
PageReferenceType=PageReferenceType.CURRENT_PAGE][, pageReferenceLimit:
any][, pageNumberStyleOverride:
CharacterStyle][, withProperties:
Object])
Create a new page reference
| Parameter | Type | Description |
|---|---|---|
| parentStory | Story | The parent story |
| storyOffset | InsertionPoint Long | Offset within the story. Can accept: InsertionPoint or Long. |
| pageReferenceType | PageReferenceType: PageReferenceType.CURRENT_PAGE PageReferenceType.TO_NEXT_STYLE_CHANGE PageReferenceType.TO_NEXT_USE_OF_STYLE PageReferenceType.TO_END_OF_STORY PageReferenceType.TO_END_OF_DOCUMENT PageReferenceType.TO_END_OF_SECTION PageReferenceType.FOR_NEXT_N_PARAGRAPHS PageReferenceType.FOR_NEXT_N_PAGES PageReferenceType.SUPPRESS_PAGE_NUMBERS | The type of page reference (Optional) (default: PageReferenceType.CURRENT_PAGE) |
| pageReferenceLimit | Long ParagraphStyle | The page range limit. Can accept: ParagraphStyle or Long. (Optional) |
| pageNumberStyleOverride | CharacterStyle | The style override for the page number (Optional) |
| withProperties | Object | Initial values for properties of the new PageReference (Optional) |
number count ()
Displays the number of elements in the PageReference.
Element of
Topic.pageReferences
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |