Adobe InCopy CS5 (7.0) Object Model JS: Link

InCopy CS5

previous page next page

Class

Link

A link to a placed file.

QuickLinks

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

Hierarchy

Graphic | Movie | Sound | Story

Link

Event | EventListener | LinkMetadata | MutationEvent | Preference

Properties

Property	Type	Access	Description
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: EditingState.EDITING_UNKNOWN EditingState.EDITING_NOWHERE EditingState.EDITING_REMOTELY EditingState.EDITING_LOCALLY EditingState.EDITING_LOCALLY_LOCKED EditingState.EDITING_CONFLICT	readonly	The Version Cue editing state of the file.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
filePath	string	readonly	The file path (colon delimited on the Mac OS). 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.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
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.
links	Links	readonly	A collection of links.
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	Graphic Movie Sound Story	readonly	The linked object. Can return: Story, Graphic, Movie or Sound.
preferences	Preferences	readonly	A collection of preferences objects.
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: LinkStatus.NORMAL LinkStatus.LINK_OUT_OF_DATE LinkStatus.LINK_MISSING LinkStatus.LINK_EMBEDDED LinkStatus.LINK_INACCESSIBLE	readonly	The status of the link.
versionState	VersionState: VersionState.VERSION_UNKNOWN VersionState.PROJECT_FILE_NEWER VersionState.LOCAL_PROJECT_MATCH VersionState.LOCAL_NEWER VersionState.VERSION_CONFLICT VersionState.NO_RESOURCE	readonly	The Version Cue version state of the file.

Class

Property	Type	Access	Description
AFTER_ATTRIBUTE_CHANGED	string	readonly	Dispatched when the value of a property changes on this Link. This event bubbles. This event is not cancelable. (default: afterAttributeChanged)
AFTER_DELETE	string	readonly	Dispatched after a Link is deleted. This event bubbles. This event is not cancelable. (default: afterDelete)
AFTER_EMBED	string	readonly	Dispatched after a Link is embedded. This event bubbles. This event is not cancelable. (default: afterEmbed)
AFTER_MOVE	string	readonly	Dispatched after a Link is relocated from one object to another. This event bubbles. This event is not cancelable. (default: afterMove)
AFTER_NEW	string	readonly	Dispatched after a Link is created. This event bubbles. This event is not cancelable. (default: afterNew)
AFTER_UNEMBED	string	readonly	Dispatched after a Link is unembedded. This event bubbles. This event is not cancelable. (default: afterUnembed)
AFTER_UPDATE	string	readonly	Dispatched after a Link is updated. This event bubbles. This event is not cancelable. (default: afterUpdate)
BEFORE_DELETE	string	readonly	Dispatched before a Link is deleted. This event bubbles. This event is cancelable. (default: beforeDelete)
BEFORE_EMBED	string	readonly	Dispatched before a Link is embedded. This event bubbles. This event is cancelable. (default: beforeEmbed)
BEFORE_MOVE	string	readonly	Dispatched before a Link is relocated from one object to another. This event bubbles. This event is cancelable. (default: beforeMove)
BEFORE_UNEMBED	string	readonly	Dispatched before a Link is unembedded. This event bubbles. This event is cancelable. (default: beforeUnembed)
BEFORE_UPDATE	string	readonly	Dispatched 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.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

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

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

Parameter	Type	Description
to	File 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.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

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)