Adobe InDesign CS6 (8.0) Object Model JS: Library

InDesign CS6

previous page next page

Class

Library

An object library.

QuickLinks

addEventListener, close, getElements, removeEventListener, store, toSource, toSpecifier

Hierarchy

Application

Library

Asset | Event | EventListener | MutationEvent

Properties

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

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void close ()
Closes the Library.

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Asset store (using: Array of varies[, withProperties: Object])
Stores the specified object in the library.

Parameter	Type	Description
using	Array of : Array of PageItems Graphics Movies Sounds XMLElements	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)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Asset.parent

LibraryPanel.associatedLibrary

Used in:

Asset Button.store (using: Library[, withProperties: Object])

Asset CheckBox.store (using: Library[, withProperties: Object])

Asset ComboBox.store (using: Library[, withProperties: Object])

Asset EPS.store (using: Library[, withProperties: Object])

Asset EPSText.store (using: Library[, withProperties: Object])

Asset FormField.store (using: Library[, withProperties: Object])

Asset Graphic.store (using: Library[, withProperties: Object])

Asset GraphicLine.store (using: Library[, withProperties: Object])

Asset Group.store (using: Library[, withProperties: Object])

Asset HtmlItem.store (using: Library[, withProperties: Object])

Asset Image.store (using: Library[, withProperties: Object])

Asset ImportedPage.store (using: Library[, withProperties: Object])

Library Libraries.nextItem (obj: Library)

Library Libraries.previousItem (obj: Library)

Asset ListBox.store (using: Library[, withProperties: Object])

Asset MediaItem.store (using: Library[, withProperties: Object])

Asset Movie.store (using: Library[, withProperties: Object])

Asset MultiStateObject.store (using: Library[, withProperties: Object])

Asset Oval.store (using: Library[, withProperties: Object])

Asset PDF.store (using: Library[, withProperties: Object])

Asset PICT.store (using: Library[, withProperties: Object])

Asset PageItem.store (using: Library[, withProperties: Object])

Asset Polygon.store (using: Library[, withProperties: Object])

Asset RadioButton.store (using: Library[, withProperties: Object])

Asset Rectangle.store (using: Library[, withProperties: Object])

Asset SignatureField.store (using: Library[, withProperties: Object])

Asset Sound.store (using: Library[, withProperties: Object])

Asset SplineItem.store (using: Library[, withProperties: Object])

Asset TextBox.store (using: Library[, withProperties: Object])

Asset TextFrame.store (using: Library[, withProperties: Object])

Asset WMF.store (using: Library[, withProperties: Object])

Asset XMLElement.store (using: Library[, withProperties: Object])

Return

Library Libraries.[] (index: number)

Library Libraries.add (fullName: File[, withProperties: Object])

Library Libraries.anyItem ()

Array of Library Libraries.everyItem ()

Library Libraries.firstItem ()

Library Libraries.item (index: varies)

Library Libraries.itemByName (name: string)

Array of Library Libraries.itemByRange (from: varies, to: varies)

Library Libraries.lastItem ()

Library Libraries.middleItem ()

Library Libraries.nextItem (obj: Library)

Library Libraries.previousItem (obj: Library)

Array of Library Library.getElements ()

Jongware, 28-Apr-2012 v3.0.3h

Contents :: Index

previous page start next page