| Application / Document | |
A link to a placed file.
Go to Property Listing | Method Listing
addEventListener, checkIn, copyLink, editOriginal, extractLabel, getElements, goToSource, insertLabel, reinitLink, relink, relinkTextFragmentLink, removeEventListener, replaceWithOriginal, revealInBridge, revealInSystem, show, toSource, toSpecifier, unembed, unlink, update
Boolean, Date, EditingState, EventListeners, Events, File, LinkMetadata, LinkResourceRenditionType, LinkStatus, Links, Number, Object, Preferences, String, VersionState
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The asset ID of the linked object. |
||
|
readonly |
The asset URL of the linked object. |
||
|
readonly |
The date and time the Link was created. |
||
|
readonly |
If true, indicates the linked object has been edited in the current document but the source file has not been updated. |
||
|
readonly |
The Version Cue editing state of the file. |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
The file path (colon delimited on the Mac OS). Can also accept: File. |
||
|
readonly |
The unique ID of the Link. |
||
|
readonly |
The index of the link in the links collection. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
readonly |
The URI of the linked resource. |
||
|
readonly |
The file type of the linked object. |
||
|
readonly |
XMP data for the link source file. |
||
|
readonly |
A collection of links. |
||
|
readonly |
The name of the Link. |
||
|
readonly |
If true, indicates a link to a full-resolution version of the source file is needed. If false, indicates the object is embedded. |
||
|
readonly |
The linked object. Can return: Story, Graphic, Movie or Sound. |
||
|
readonly |
A collection of preferences objects. |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
The rendition data of the link resource. |
||
|
readonly |
The size of the Link file. |
||
|
readonly |
The status of the link. |
||
|
readonly |
The Version Cue version state of the file. |
|
Name |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
Dispatched when the value of a property changes on this Link. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched after a Link is deleted. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched after a Link is embedded. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched after a Link is relocated from one object to another. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched after a Link is created. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched after a Link is unembedded. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched after a Link is updated. This event bubbles. This event is not cancelable. |
||
|
readonly |
Dispatched before a Link is deleted. This event bubbles. This event is cancelable. |
||
|
readonly |
Dispatched before a Link is embedded. This event bubbles. This event is cancelable. |
||
|
readonly |
Dispatched before a Link is relocated from one object to another. This event bubbles. This event is cancelable. |
||
|
readonly |
Dispatched before a Link is unembedded. This event bubbles. This event is cancelable. |
||
|
readonly |
Dispatched before a Link is updated. This event bubbles. This event is cancelable. |
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined checkIn (versionComments:String, [forceSave:Boolean=Boolean])
Check in to Version Cue.
|
Parameter |
Type |
Description |
|---|---|---|
|
versionComments |
The comment for this version (Optional) |
|
|
forceSave |
Forcibly save a version (Optional) (default: false) |
undefined copyLink (to:File, versionComments:String, [forceSave:Boolean=Boolean])
Copies the link file to the specified location.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The file or folder to which to copy the file. |
|
|
versionComments |
The comment for this version. (Optional) |
|
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
undefined 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 |
The key. |
Link getElements ()
Resolves the object specifier, creating an array of object references.
undefined goToSource ()
Opens the source file of the link in InDesign for SharedContent links.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined reinitLink (linkResourceURI:String)
Experimental: Reinitialize the link to a new uri
|
Parameter |
Type |
Description |
|---|---|---|
|
linkResourceURI |
Resource URI to relink. |
undefined relink (to:Varies File String)
Points the link to a new source file.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The full path name of the new source file. Can accept: File or String. |
undefined relinkTextFragmentLink (linkResourceURI:String, name:String)
Experimental: Relink the text fragment link to a new uri
|
Parameter |
Type |
Description |
|---|---|---|
|
linkResourceURI |
Resource URI to relink to. |
|
|
name |
The tag name for the key. (Optional) |
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined replaceWithOriginal ()
Experimental: Download the original asset and replace FPO with it.
undefined revealInBridge ()
Opens Adobe Bridge and selects the source file of the link.
undefined revealInSystem ()
Opens the file system to the folder that contains the source file of the link, and selects the file.
undefined show ()
Selects the link.
String toSource ()
Generates a string which, if executed, will return the Link.
String toSpecifier ()
Retrieves the object specifier.
undefined unembed (to:File, versionComments:String, [forceSave:Boolean=Boolean])
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 |
The folder to which to copy the unembedded file. (Optional) |
|
|
versionComments |
The comment for this version. (Optional) |
|
|
forceSave |
If true, forcibly saves a version. (Optional) (default: false) |
undefined unlink ()
Embeds the source file in the document.
Link update ()
Updates the link if the source file has been changed.
Event.parent
EventListener.parent
LinkMetadata.parent
MutationEvent.parent
Preference.parent
Movie.itemLink
Sound.itemLink
Image.itemLink
EPS.itemLink
PDF.itemLink
WMF.itemLink
PICT.itemLink
Graphic.itemLink
ImportedPage.itemLink
Story.itemLink
XmlStory.itemLink