Link

A link to a placed file.

Properties

Property	Type	Access	Description
assetEtag	string	readonly	The asset etag of the linked object.
assetID	string	readonly	The asset ID of the linked object.
assetURL	string	readonly	The asset URL of the linked object.
date	Date	readonly	The date and time the Link was created.
edited	bool	readonly	If true, indicates the linked object has been edited in the current document but the source file has not been updated.
editingState	EditingState : EDITING_UNKNOWN EDITING_NOWHERE EDITING_REMOTELY EDITING_LOCALLY EDITING_LOCALLY_LOCKED EDITING_CONFLICT	readonly	The Version Cue editing state of the file.
filePath	string	readonly	The file path (a colon delimited path for Mac). Can also accept: File.
id	number	readonly	The unique ID of the Link.
index	number	readonly	The index of the link in the links collection.
label	string	r/w	A property that can be set to any string.
linkType	string	readonly	The file type of the linked object.
linkXmp	LinkMetadata	readonly	XMP data for the link source file.
name	string	readonly	The name of the Link.
needed	bool	readonly	If true, indicates a link to a full-resolution version of the source file is needed. If false, indicates the object is embedded.
parent	any	readonly	The linked object. Can return: Story, Graphic, Movie or Sound.
properties	Object	r/w	A property that allows setting of several properties at the same time.
size	number	readonly	The size of the Link file.
status	LinkStatus : NORMAL LINK_OUT_OF_DATE LINK_MISSING LINK_EMBEDDED	readonly	The status of the link.
stockState	LinkStockState : LINK_IS_NOT_STOCK LINK_IS_STOCK_COMP LINK_IS_STOCK_HIGH_RESOLUTION	readonly	The stock state of the source file image.
versionState	VersionState : VERSION_UNKNOWN PROJECT_FILE_NEWER LOCAL_PROJECT_MATCH LOCAL_NEWER VERSION_CONFLICT NO_RESOURCE	readonly	The Version Cue version state of the file.

Methods

void checkIn ([versionComments:
string][, forceSave:
bool=false ])
Check in to Version Cue.

Parameter	Type	Description
versionComments	string	The comment for this version (Optional)
forceSave	bool	Forcibly save a version (Optional) (default: false )

void copyLink (to:
File[, versionComments:
string][, forceSave:
bool=false ])
Copies the link file to the specified location.

Parameter	Type	Description
to	File	The file or folder to which to copy the file.
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false )

void editOriginal ()
Opens the source file of the link in the default editor for the source file type.

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

Parameter	Type	Description
key	string	The key.

Array of LinkgetElements ()
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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void relink (to:
File)
Points the link to a new source file.

Parameter	Type	Description
to	File	The full path name of the new source file.

void revealInBridge ()
Opens Adobe Bridge and selects the source file of the link.

void revealInSystem ()
Opens the file system to the folder that contains the source file of the link, and selects the file.

void show ()
Selects the link.

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

string toSpecifier ()
Retrieves the object specifier.

void unembed ([to:
File][, versionComments:
string][, forceSave:
bool=false ])
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.

Parameter	Type	Description
to	File	The folder to which to copy the unembedded file. (Optional)
versionComments	string	The comment for this version. (Optional)
forceSave	bool	If true, forcibly saves a version. (Optional) (default: false )

void unlink ()
Embeds the source file in the document.

Linkupdate ()
Updates the link if the source file has been changed.

Element of:

EPS.itemLink
Graphic.itemLink
Image.itemLink
ImportedPage.itemLink
LinkMetadata.parent
Movie.itemLink
PDF.itemLink
PICT.itemLink
Sound.itemLink
Story.itemLink
WMF.itemLink
XmlStory.itemLink

Used in:

Links.previousItem (

obj:
Link )

Links.nextItem (

obj:
Link )

Returned by:

Array of Link Link .getElements (

)

Link Link .update (

)

Link Links.anyItem (

)

Array of Link Links.everyItem (

)

Link Links.firstItem (

)

Link Links.item (
index:
any
)

Link Links.itemByID (
id:
number
)

Link Links.itemByName (
name:
string
)

Array of Link Links.itemByRange (
from:
any, to:
any
)

Link Links.lastItem (

)

Link Links.middleItem (

)

Link Links.nextItem (
obj:
Link
)

Link Links.previousItem (
obj:
Link
)