The page reference for an index topic.
Go to Property Listing | Method Listing
extractLabel, getElements, insertLabel, remove, toSource, toSpecifier
CharacterStyle, Number, Object, PageReferenceType, ParagraphStyle, String, Text,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The unique ID of the PageReference. |
||
|
readonly |
The index of the PageReference within its containing object. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The character style applied to page numbers. |
||
|
LongInteger |
read/write |
The paragraph style or number of paragraphs or pages that defines the last page in a page range. Note: Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. . Can return: ParagraphStyle or Long Integer. |
|
|
read/write |
Options for index page references. |
||
|
readonly |
The parent of the PageReference (a Topic). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
The hyperlinked text or insertion point. |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
PageReference getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined remove ()
Deletes the PageReference.
String toSource ()
Generates a string which, if executed, will return the PageReference.
String toSpecifier ()
Retrieves the object specifier.