Adobe InDesign CS5 Server (7.0) Object Model JS: KinsokuTables

InDesign Server CS5

Class

KinsokuTables

 A collection of kinsoku tables.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

KinsokuTable add (name: string[, withProperties: Object])
Creates a new kinsoku table.

ParameterTypeDescription
namestringThe name of the new kinsoku table.
withPropertiesObjectInitial values for properties of the new KinsokuTable (Optional)

KinsokuTable anyItem ()
Returns any KinsokuTable in the collection.

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

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

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

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

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

KinsokuTable itemByID (id: number)
Returns the KinsokuTable with the specified ID.

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromKinsokuTable
Long Integer
String
The KinsokuTable, index, or name at the beginning of the range. Can accept: KinsokuTable, Long Integer or String.
toKinsokuTable
Long Integer
String
The KinsokuTable, index, or name at the end of the range. Can accept: KinsokuTable, Long Integer or String.

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

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

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

ParameterTypeDescription
objKinsokuTableThe KinsokuTable whose index comes before the desired KinsokuTable.

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

ParameterTypeDescription
objKinsokuTableThe index of the KinsokuTable that follows the desired KinsokuTable.

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

Element of

Application.kinsokuTables

Document.kinsokuTables

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