K4 InDesign Javascript API Documentation

LibrariesLibrary

An object library.

Instance Properties

Name Description Access
assets Assets A collection of object library assets. read-only
associatedPanel Panel The associated panel. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
filePath File The full path to the file. read-only
fullName File The full path to the Library, including the name of the Library. read-only
index number The index of the Library within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
name string The name of the Library. read-only
parent Application The parent of the Library (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
close(
)
getElements(
)
  → Library
removeEventListener(
eventType, handler ​[, captures])
  → bool
store(
using ​[, withProperties])
  → Asset
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)
close(
)
Closes the Library.
getElements(
)
  → Library
Resolves the object specifier, creating an array of object references.
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)
store(
using ​[, withProperties])
  → Asset
Stores the specified object in the library.
using The page item(s) to store. Can accept: Array of PageItems, Movies, Sounds, Graphics or XMLElements.
withProperties Object Initial values for properties of the new Library (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Library.
toSpecifier(
)
  → string
Retrieves the object specifier.