Adobe InCopy CS5 (7.0) Object Model JS: LinkMetadata

InCopy CS5

Class

LinkMetadata

 MetaData properties for the link source file. Base Class: Preference

QuickLinks

addEventListener, countContainer, getElements, getProperty, removeEventListener, toSource, toSpecifier

Hierarchy

Link
Preference
LinkMetadata
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
authorstring readonlyThe author of the document.
copyrightInfoURLstring readonlyThe URL of the file that contains the linked copyright statement.
copyrightNoticestring readonlyThe text to use as a copyright notice.
copyrightStatusCopyrightStatus:
CopyrightStatus.UNKNOWN
CopyrightStatus.YES
CopyrightStatus.NO
readonlyThe copyright status of the document.
creationDateDate readonlyThe creation date of the document.
creatorstring readonlyThe name of the application used to create the document.
descriptionstring readonlyThe description of the LinkMetadata.
documentTitlestring readonlyThe title of the document.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
formatstring readonlyThe format of the document.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
jobNamestring readonlyThe job name.
keywords Array of string readonlyThe list of keywords associated with the document.
modificationDateDate readonlyThe most recent modification date of the document.
parentLink readonlyThe parent of the LinkMetadata (a Link).
propertiesObject r/wA property that allows setting of several properties at the same time.
serverURLstring readonlyThe location of the document on the asset management server.

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)

number countContainer (namespace: string, path: string)
Counts the number of items in the container.

ParameterTypeDescription
namespacestringThe namespace of the container.
pathstringThe path to the container.

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

string getProperty (namespace: string, path: string)
Gets the XMP property value associated with the specified path.

ParameterTypeDescription
namespacestringThe namespace of the property.
pathstringThe specified path.

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)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Link.linkXmp

Return

Array of LinkMetadata LinkMetadata.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index