Adobe InDesign CS6 (8.0) Object Model JS: Libraries

InDesign CS6

Class

Libraries

 A collection of object libraries.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Library [] (index: number)
Returns the Library with the specified index.

ParameterTypeDescription
indexnumberThe index.

Library add (fullName: File[, withProperties: Object])
Creates a new object libary.

ParameterTypeDescription
fullNameFileThe library's path and file name.
withPropertiesObjectInitial values for properties of the new Library (Optional)

Library anyItem ()
Returns any Library in the collection.

number count ()
Displays the number of elements in the Library.

Array of Library everyItem ()
Returns every Library in the collection.

Library firstItem ()
Returns the first Library in the collection.

Library item (index: varies)
Returns the Library with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Library itemByName (name: string)
Returns the Library with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Library itemByRange (from: varies, to: varies)
Returns the Libraries within the specified range.

ParameterTypeDescription
fromLibrary
Long Integer
String
The Library, index, or name at the beginning of the range. Can accept: Library, Long Integer or String.
toLibrary
Long Integer
String
The Library, index, or name at the end of the range. Can accept: Library, Long Integer or String.

Library lastItem ()
Returns the last Library in the collection.

Library middleItem ()
Returns the middle Library in the collection.

Library nextItem (obj: Library)
Returns the Library whose index follows the specified Library in the collection.

ParameterTypeDescription
objLibraryThe Library whose index comes before the desired Library.

Library previousItem (obj: Library)
Returns the Library with the index previous to the specified index.

ParameterTypeDescription
objLibraryThe index of the Library that follows the desired Library.

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

Element of

Application.libraries

Jongware, 28-Apr-2012 v3.0.3hContents :: Index