Adobe InDesign CS5 (7.0) Object Model JS: CellStyleGroups

InDesign CS5

Class

CellStyleGroups

 A collection of cell style groups.

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

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

ParameterTypeDescription
indexnumberThe index.

CellStyleGroup add ([withProperties: Object])
Creates a new CellStyleGroup.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new CellStyleGroup (Optional)

CellStyleGroup anyItem ()
Returns any CellStyleGroup in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromCellStyleGroup
Long Integer
String
The CellStyleGroup, index, or name at the beginning of the range. Can accept: CellStyleGroup, Long Integer or String.
toCellStyleGroup
Long Integer
String
The CellStyleGroup, index, or name at the end of the range. Can accept: CellStyleGroup, Long Integer or String.

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

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

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

ParameterTypeDescription
objCellStyleGroupThe CellStyleGroup whose index comes before the desired CellStyleGroup.

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

ParameterTypeDescription
objCellStyleGroupThe index of the CellStyleGroup that follows the desired CellStyleGroup.

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

Element of

Application.cellStyleGroups

CellStyleGroup.cellStyleGroups

Document.cellStyleGroups

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