Link
A link to a placed file.
Class
Read Only
String AFTER_NEW = afterNew
Dispatched after a Link is created. This event bubbles. This event is not cancelable.
Read Only
String BEFORE_DELETE = beforeDelete
Dispatched before a Link is deleted. This event bubbles. This event is cancelable.
Read Only
String AFTER_DELETE = afterDelete
Dispatched after a Link is deleted. This event bubbles. This event is not cancelable.
Read Only
String BEFORE_UPDATE = beforeUpdate
Dispatched before a Link is updated. This event bubbles. This event is cancelable.
Read Only
String AFTER_UPDATE = afterUpdate
Dispatched after a Link is updated. This event bubbles. This event is not cancelable.
Read Only
String BEFORE_EMBED = beforeEmbed
Dispatched before a Link is embedded. This event bubbles. This event is cancelable.
Read Only
String AFTER_EMBED = afterEmbed
Dispatched after a Link is embedded. This event bubbles. This event is not cancelable.
Read Only
String BEFORE_UNEMBED = beforeUnembed
Dispatched before a Link is unembedded. This event bubbles. This event is cancelable.
Read Only
String AFTER_UNEMBED = afterUnembed
Dispatched after a Link is unembedded. This event bubbles. This event is not cancelable.
Read Only
String BEFORE_MOVE = beforeMove
Dispatched before a Link is relocated from one object to another. This event bubbles. This event is cancelable.
Read Only
String AFTER_MOVE = afterMove
Dispatched after a Link is relocated from one object to another. This event bubbles. This event is not cancelable.
Read Only
String AFTER_ATTRIBUTE_CHANGED = afterAttributeChanged
Dispatched when the value of a property changes on this Link. This event bubbles. This event is not cancelable.
Instance
Read Only
VersionState versionState
The Version Cue version state of the file.
Read Only
EditingState editingState
The Version Cue editing state of the file.
Read Only
LinkMetadata linkXmp
XMP data for the link source file.
Read Only
Number index
The index of the link in the links collection.
Read Only
Mixed parent
The linked object. Can return: Story, Graphic, Movie or Sound.
Read Only
String assetURL
The asset URL of the linked object.
Read Only
String assetID
The asset ID of the linked object.
Read Only
Boolean edited
If true, indicates the linked object has been edited in the current document but the source file has not been updated.
Read Only
String name
The name of the Link.
Read Only
Boolean needed
If true, indicates a link to a full-resolution version of the source file is needed. If false, indicates the object is embedded.
Read Only
LinkStatus status
The status of the link.
Read Only
String linkType
The file type of the linked object.
Read Only
Date date
The date and time the Link was created.
Read Only
Number size
The size of the Link file.
Read Only
LinkResourceRenditionType renditionData
The rendition data of the link resource.
Read Only
String linkResourceURI
The URI of the linked resource.
Read Only
String filePath
The file path (colon delimited on the Mac OS). Can also accept: File.
Read Only
Number id
The unique ID of the Link.
Read Only
Boolean isValid
Returns true if the object specifier resolves to valid objects.
Read Only
Events events
A collection of events.
Read Only
EventListeners eventListeners
A collection of event listeners.
Read Only
Preferences preferences
A collection of preferences objects.
Read Only
Links links
A collection of links.
String label
A property that can be set to any string.
Object properties
A property that allows setting of several properties at the same time.
Methods
checkIn( String versionComments, Boolean forceSave )
Check in to Version Cue.
Parameters
Type Name Description
relink( Mixed to )
Points the link to a new source file.
Parameters
Type Name Description
unlink()
Embeds the source file in the document.
Link update()
Updates the link if the source file has been changed.
unembed( File to, String versionComments, Boolean forceSave )
Unembeds the source file. If no folder is specified, creates a link to the original source file; if a folder is specified, copies the file to the folder and creates a link to the copied file.
Parameters
Type Name Description
replaceWithOriginal()
Experimental: Download the original asset and replace FPO with it.
relinkTextFragmentLink( String linkResourceURI, String name )
Experimental: Relink the text fragment link to a new uri
Parameters
Type Name Description
reinitLink( String linkResourceURI )
Experimental: Reinitialize the link to a new uri
Parameters
Type Name Description
editOriginal()
Opens the source file of the link in the default editor for the source file type.
show()
Selects the link.
revealInSystem()
Opens the file system to the folder that contains the source file of the link, and selects the file.
revealInBridge()
Opens Adobe Bridge and selects the source file of the link.
copyLink( File to, String versionComments, Boolean forceSave )
Copies the link file to the specified location.
Parameters
Type Name Description
goToSource()
Opens the source file of the link in InDesign for SharedContent links.
insertLabel( String key, String value )
Sets the label to the value associated with the specified key.
Parameters
Type Name Description
String extractLabel( String key )
Gets the label value associated with the specified key.
Parameters
Type Name Description
String toSource()
Generates a string which, if executed, will return the Link.
Link getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description
Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description