K4 InDesign Javascript API Documentation

LinksLinkMetadata

MetaData properties for the link source file.

Extends

Instance Properties

Name Description Access
author string The author of the document. read-only
copyrightInfoURL string The URL of the file that contains the linked copyright statement. read-only
copyrightNotice string The text to use as a copyright notice. read-only
copyrightStatus CopyrightStatus The copyright status of the document. read-only
creationDate Date The creation date of the document. read-only
creator string The name of the application used to create the document. read-only
description string The description of the LinkMetadata. read-only
documentTitle string The title of the document. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
format string The format of the document. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
jobName string The job name. read-only
keywords string The list of keywords associated with the document. read-only
modificationDate Date The most recent modification date of the document. read-only
parent Link The parent of the LinkMetadata (a Link). read-only
properties Object A property that allows setting of several properties at the same time. read-write
serverURL string The location of the document on the asset management server. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
countContainer(
namespace, path)
  → number
getElements(
)
  → LinkMetadata
getProperty(
namespace, path)
  → string
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
countContainer(
namespace, path)
  → number
Counts the number of items in the container.
namespace string The namespace of the container.
path string The path to the container.
getElements(
)
  → LinkMetadata
Resolves the object specifier, creating an array of object references.
getProperty(
namespace, path)
  → string
Gets the XMP property value associated with the specified path.
namespace string The namespace of the property.
path string The specified path.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the LinkMetadata.
toSpecifier(
)
  → string
Retrieves the object specifier.