A collection of hyperlinks.
Go to Property Listing | Method Listing
add, count, item, itemByName, itemByID, itemByRange, firstItem, lastItem, middleItem, previousItem, nextItem, anyItem, everyItem, toSource, []
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
length |
readonly |
The number of objects in the collection. |
Hyperlink [] (index:Number)
Returns the Hyperlink with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Hyperlink add (hyperlinkSource:Varies, hyperlinkDestination:Varies, withProperties:Object)
Creates a new hyperlink.
|
Parameter |
Type |
Description |
|---|---|---|
|
hyperlinkSource |
Varies |
The hyperlinked object. Can accept: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource. |
|
hyperlinkDestination |
Varies |
The destination that the hyperlink points to. Can accept: Ordered array containing fileName:String, volumn:String, directoryId:Long Integer, dataLinkClassId:Long Integer, destinationUid:Long Integer, HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination. (Optional) |
|
withProperties |
Initial values for properties of the new Hyperlink (Optional) |
Hyperlink anyItem ()
Returns any Hyperlink in the collection.
Number count ()
Displays the number of elements in the Hyperlink.
Hyperlink everyItem ()
Returns every Hyperlink in the collection.
Hyperlink firstItem ()
Returns the first Hyperlink in the collection.
Hyperlink item (index:Varies)
Returns the Hyperlink with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
Varies |
The index or name. Can accept: Long Integer or String. |
Hyperlink itemByID (id:Number)
Returns the Hyperlink with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Hyperlink itemByName (name:String)
Returns the Hyperlink with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Hyperlink itemByRange (from:Varies, to:Varies)
Returns the Hyperlinks within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Varies |
The Hyperlink, index, or name at the beginning of the range. Can accept: Hyperlink, Long Integer or String. |
|
to |
Varies |
The Hyperlink, index, or name at the end of the range. Can accept: Hyperlink, Long Integer or String. |
Hyperlink lastItem ()
Returns the last Hyperlink in the collection.
Hyperlink middleItem ()
Returns the middle Hyperlink in the collection.
Hyperlink nextItem (obj:Hyperlink)
Returns the Hyperlink whose index follows the specified Hyperlink in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Hyperlink whose index comes before the desired Hyperlink. |
Hyperlink previousItem (obj:Hyperlink)
Returns the Hyperlink with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Hyperlink that follows the desired Hyperlink. |
String toSource ()
Generates a string which, if executed, will return the Hyperlink.
Document.hyperlinks