Link

A link to a placed file.

Methods:

editOriginal, extractLabel, insertLabel, relink, show, unembed, unlink, update

Objects:

Boolean, Date, File, LinkStatus, Number, Object, String,

Property Listing

Property

Type

Access

Description

assetEtag

String

readonly

The asset etag of the linked object.

assetID

Array of Strings

Array of Longs

readonly

The asset ID of the linked object. Can return: Array of Strings or Longs.

assetURL

String

readonly

The asset URL of the linked object.

date

Date

readonly

The date and time the Link was created.

edited

Boolean

readonly

If true, indicates the linked object has been edited in the current document but the source file has not been updated.

filePath

File

readonly

The full path to the file.

id

Number

readonly

The unique ID of the Link.

index

Number

readonly

The index of the link in the links collection.

label

String

read/write

A property that can be set to any string.

linkType

String

readonly

The file type of the linked object.

name

String

readonly

The name of the Link.

needed

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.

parent

 

readonly

The linked object. Can return: Story, Graphic, Movie or Sound.

properties

Object

read/write

A property that allows setting of several properties at the same time.

size

Number

readonly

Size of the file

status

LinkStatus

LinkStatus.LINK_EMBEDDED

LinkStatus.LINK_MISSING

LinkStatus.LINK_OUT_OF_DATE

LinkStatus.NORMAL

readonly

The status of the link.

Method Listing

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

String

The key.

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

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

undefined show ()

Selects the link.

undefined unembed (to:File)

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)

undefined unlink ()

Embeds the source file in the document.

Link update ()

Updates the link if the source file has been changed.

Object of

Movie.itemLink

Sound.itemLink

Image.itemLink

EPS.itemLink

PDF.itemLink

WMF.itemLink

PICT.itemLink

Graphic.itemLink

Story.itemLink

Return

Link.update()