Adobe InDesign CS2 (4.0) Object Model JS: TableStyles

InDesign CS2

Class

TableStyles

 All table styles

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

TableStyle add (name: string[, basedOn: string=[No table style]][, headerRows: number=0][, footerRows: number=0])
Used to add a new table style

ParameterTypeDescription
namestringThe table style name
basedOnstringThe table style to copy from (Optional) (default: [No table style])
headerRowsnumberThe number of header rows for the style (Optional) (default: 0)
footerRowsnumberThe number of footer rows for the style (Optional) (default: 0)

TableStyle anyItem ()
Returns any TableStyle in the collection.

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

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

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

TableStyle item (index: any)
Returns the TableStyle with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

Array of TableStyle itemByRange (from: any, to: any)
Returns the TableStyles within the specified range.

ParameterTypeDescription
fromLong
String
TableStyle
The TableStyle, index, or name at the beginning of the range. Can accept: TableStyle, Long or String.
toLong
String
TableStyle
The TableStyle, index, or name at the end of the range. Can accept: TableStyle, Long or String.

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

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

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

ParameterTypeDescription
objTableStyleThe TableStyle whose index comes before the desired TableStyle.

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

ParameterTypeDescription
objTableStyleThe index of the TableStyle that follows the desired TableStyle.

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

Element of

Application.tableStyles

Document.tableStyles

Jongware, 27-Jun-2010 v3.0.3dContents :: Index