Adobe InCopy CS6 (8.0) Object Model JS: HyperlinkPageItemSource

InCopy CS6

Class

HyperlinkPageItemSource

 A hyperlinked page item.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, showSource, toSource, toSpecifier

Hierarchy

Document
HyperlinkPageItemSource
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
hiddenbool readonlyIf true, the hyperlink is hidden.
idnumber readonlyThe unique ID of the HyperlinkPageItemSource.
indexnumber readonlyThe index of the HyperlinkPageItemSource within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the HyperlinkPageItemSource.
parentDocument readonlyThe parent of the HyperlinkPageItemSource (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
sourcePageItemPageItem r/wThe hyperlinked page item.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of HyperlinkPageItemSource getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the HyperlinkPageItemSource.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

void showSource ()
Jumps to the hyperlink source.

string toSource ()
Generates a string which, if executed, will return the HyperlinkPageItemSource.

string toSpecifier ()
Retrieves the object specifier.

Element of

Hyperlink.source

Used in:

HyperlinkPageItemSource HyperlinkPageItemSources.nextItem (obj: HyperlinkPageItemSource)

HyperlinkPageItemSource HyperlinkPageItemSources.previousItem (obj: HyperlinkPageItemSource)

Return

Array of HyperlinkPageItemSource HyperlinkPageItemSource.getElements ()

HyperlinkPageItemSource HyperlinkPageItemSources.[] (index: number)

HyperlinkPageItemSource HyperlinkPageItemSources.add (source: PageItem[, withProperties: Object])

HyperlinkPageItemSource HyperlinkPageItemSources.anyItem ()

Array of HyperlinkPageItemSource HyperlinkPageItemSources.everyItem ()

HyperlinkPageItemSource HyperlinkPageItemSources.firstItem ()

HyperlinkPageItemSource HyperlinkPageItemSources.item (index: varies)

HyperlinkPageItemSource HyperlinkPageItemSources.itemByID (id: number)

HyperlinkPageItemSource HyperlinkPageItemSources.itemByName (name: string)

Array of HyperlinkPageItemSource HyperlinkPageItemSources.itemByRange (from: varies, to: varies)

HyperlinkPageItemSource HyperlinkPageItemSources.lastItem ()

HyperlinkPageItemSource HyperlinkPageItemSources.middleItem ()

HyperlinkPageItemSource HyperlinkPageItemSources.nextItem (obj: HyperlinkPageItemSource)

HyperlinkPageItemSource HyperlinkPageItemSources.previousItem (obj: HyperlinkPageItemSource)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index