Class

Link

 A link to a placed file.

QuickLinks

addEventListener, checkIn, copyLink, editOriginal, extractLabel, getElements, goToSource, insertLabel, relink, removeEventListener, revealInBridge, revealInSystem, show, toSource, toSpecifier, unembed, unlink, update

Hierarchy

Graphic | Movie | Sound | Story
Link
Event | EventListener | LinkMetadata | MutationEvent | Preference

Properties

PropertyTypeAccessDescription
assetIDstring readonlyThe asset ID of the linked object.
assetURLstring readonlyThe asset URL of the linked object.
dateDate readonlyThe date and time the Link was created.
editedbool readonlyIf true, indicates the linked object has been edited in the current document but the source file has not been updated.
editingStateEditingState:
EditingState.EDITING_UNKNOWN
EditingState.EDITING_NOWHERE
EditingState.EDITING_REMOTELY
EditingState.EDITING_LOCALLY
EditingState.EDITING_LOCALLY_LOCKED
EditingState.EDITING_CONFLICT
readonlyThe Version Cue editing state of the file.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
filePathFile
string
readonlyThe file path (colon delimited on the Mac OS). Can also accept: File.
idnumber readonlyThe unique ID of the Link.
indexnumber readonlyThe index of the link in the links collection.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
linkTypestring readonlyThe file type of the linked object.
linkXmpLinkMetadata readonlyXMP data for the link source file.
linksLinks readonlyA collection of links.
namestring readonlyThe name of the Link.
neededbool readonlyIf true, indicates a link to a full-resolution version of the source file is needed. If false, indicates the object is embedded.
parentGraphic
Movie
Sound
Story
readonlyThe linked object. Can return: Story, Graphic, Movie or Sound.
preferencesPreferences readonlyA collection of preferences objects.
propertiesObject r/wA property that allows setting of several properties at the same time.
sizenumber readonlyThe size of the Link file.
statusLinkStatus:
LinkStatus.NORMAL
LinkStatus.LINK_OUT_OF_DATE
LinkStatus.LINK_MISSING
LinkStatus.LINK_EMBEDDED
LinkStatus.LINK_INACCESSIBLE
readonlyThe status of the link.
versionStateVersionState:
VersionState.VERSION_UNKNOWN
VersionState.PROJECT_FILE_NEWER
VersionState.LOCAL_PROJECT_MATCH
VersionState.LOCAL_NEWER
VersionState.VERSION_CONFLICT
VersionState.NO_RESOURCE
readonlyThe Version Cue version state of the file.

Class

PropertyTypeAccessDescription
AFTER_ATTRIBUTE_CHANGEDstring readonlyDispatched when the value of a property changes on this Link. This event bubbles. This event is not cancelable. (default: afterAttributeChanged)
AFTER_DELETEstring readonlyDispatched after a Link is deleted. This event bubbles. This event is not cancelable. (default: afterDelete)
AFTER_EMBEDstring readonlyDispatched after a Link is embedded. This event bubbles. This event is not cancelable. (default: afterEmbed)
AFTER_MOVEstring readonlyDispatched after a Link is relocated from one object to another. This event bubbles. This event is not cancelable. (default: afterMove)
AFTER_NEWstring readonlyDispatched after a Link is created. This event bubbles. This event is not cancelable. (default: afterNew)
AFTER_UNEMBEDstring readonlyDispatched after a Link is unembedded. This event bubbles. This event is not cancelable. (default: afterUnembed)
AFTER_UPDATEstring readonlyDispatched after a Link is updated. This event bubbles. This event is not cancelable. (default: afterUpdate)
BEFORE_DELETEstring readonlyDispatched before a Link is deleted. This event bubbles. This event is cancelable. (default: beforeDelete)
BEFORE_EMBEDstring readonlyDispatched before a Link is embedded. This event bubbles. This event is cancelable. (default: beforeEmbed)
BEFORE_MOVEstring readonlyDispatched before a Link is relocated from one object to another. This event bubbles. This event is cancelable. (default: beforeMove)
BEFORE_UNEMBEDstring readonlyDispatched before a Link is unembedded. This event bubbles. This event is cancelable. (default: beforeUnembed)
BEFORE_UPDATEstring readonlyDispatched before a Link is updated. This event bubbles. This event is cancelable. (default: beforeUpdate)

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)

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

ParameterTypeDescription
versionCommentsstringThe comment for this version (Optional)
forceSaveboolForcibly save a version (Optional) (default: false)

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

ParameterTypeDescription
toFileThe file or folder to which to copy the file.
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf 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.

ParameterTypeDescription
keystringThe key.

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

void goToSource ()
Opens the source file of the link in InDesign for SharedContent links.

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

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

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

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 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.

ParameterTypeDescription
toFileThe folder to which to copy the unembedded file. (Optional)
versionCommentsstringThe comment for this version. (Optional)
forceSaveboolIf true, forcibly saves a version. (Optional) (default: false)

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

Link update ()
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:

Link Links.nextItem (obj: Link)

Link Links.previousItem (obj: Link)

Return

Array of Link Link.getElements ()

Link Link.update ()

Link Links.[] (index: number)

Link Links.anyItem ()

Array of Link Links.everyItem ()

Link Links.firstItem ()

Link Links.item (index: varies)

Link Links.itemByID (id: number)

Link Links.itemByName (name: string)

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

Link Links.lastItem ()

Link Links.middleItem ()

Link Links.nextItem (obj: Link)

Link Links.previousItem (obj: Link)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index