Object

Link

A link to a placed file.

Hierarchy

Link

2 preference objects

Properties

Type	Access	Description
String	readonly	The asset ID of the linked object.
String	readonly	The asset URL of the linked object.
Date	readonly	The date and time the Link was created.
Boolean	readonly	If true, indicates the linked object has been edited in the current document but the source file has not been updated.
EditingState	readonly	The Version Cue editing state of the file.
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
String \| File	readonly	The file path (colon delimited on the Mac OS). Can also accept: File.
Number	readonly	The unique ID of the Link.
Number	readonly	The index of the link in the links collection.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
String	readonly	The URI of the linked resource.
String	readonly	The file type of the linked object.
LinkMetadata	readonly	XMP data for the link source file.
Links<Link>	readonly	A collection of links.
String	readonly	The name of the Link.
Boolean	readonly	If true, indicates a link to a full-resolution version of the source file is needed. If false, indicates the object is embedded.
Graphic \| Movie \| Story \| Sound	readonly	The linked object. Can return: Story, Graphic, Movie or Sound.
Preferences<Preference>	readonly	A collection of preferences objects.
Object	read/write	A property that allows setting of several properties at the same time.
LinkResourceRenditionType	readonly	The rendition data of the link resource.
Number	readonly	The size of the Link file.
LinkStatus	readonly	The status of the link.
VersionState	readonly	The Version Cue version state of the file.

Events

Name	Description
	Dispatched when the value of a property changes on this Link. This event bubbles. This event is not cancelable.
	Dispatched after a Link is deleted. This event bubbles. This event is not cancelable.
	Dispatched after a Link is embedded. This event bubbles. This event is not cancelable.
	Dispatched after a Link is relocated from one object to another. This event bubbles. This event is not cancelable.
	Dispatched after a Link is created. This event bubbles. This event is not cancelable.
	Dispatched after a Link is unembedded. This event bubbles. This event is not cancelable.
	Dispatched after a Link is updated. This event bubbles. This event is not cancelable.
	Dispatched before a Link is deleted. This event bubbles. This event is cancelable.
	Dispatched before a Link is embedded. This event bubbles. This event is cancelable.
	Dispatched before a Link is relocated from one object to another. This event bubbles. This event is cancelable.
	Dispatched before a Link is unembedded. This event bubbles. This event is cancelable.
	Dispatched before a Link is updated. This event bubbles. This event is cancelable.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ void

Check in to Version Cue.

versionComments? String The comment for this version

forceSave? Boolean Forcibly save a version

→ void

Copies the link file to the specified location.

to File The file or folder to which to copy the file.

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ void

Opens the source file of the link in the default editor for the source file type.

→ String

Gets the label value associated with the specified key.

key String The key.

→ Link[]

Resolves the object specifier, creating an array of object references.

→ void

Opens the source file of the link in InDesign for SharedContent links.

→ void

Sets the label to the value associated with the specified key.

key String The key.

value String The value.

→ void

Experimental: Reinitialize the link to a new uri

linkResourceURI String Resource URI to relink.

→ void

Points the link to a new source file.

to File | String The full path name of the new source file. Can accept: File or String.

→ void

Experimental: Relink the text fragment link to a new uri

linkResourceURI String Resource URI to relink to.

name? String The tag name for the key.

→ Boolean

Removes the event listener.

eventType String The registered event type.

handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ void

Experimental: Download the original asset and replace FPO with it.

→ void

Opens Adobe Bridge and selects the source file of the link.

→ void

Opens the file system to the folder that contains the source file of the link, and selects the file.

→ void

Selects the link.

→ String

Generates a string which, if executed, will return the Link.

→ String

Retrieves the object specifier.

→ void

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.

to? File The folder to which to copy the unembedded file.

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ void

Embeds the source file in the document.

→ Link

Updates the link if the source file has been changed.