Adobe InDesign CS3 (5.0) Object Model JS: CellStyleGroup

InDesign CS3

Class

CellStyleGroup

 A cell style group.

QuickLinks

duplicate, extractLabel, getElements, insertLabel, move, remove, toSource, toSpecifier

Hierarchy

Application | CellStyleGroup | Document
CellStyleGroup
CellStyle | CellStyleGroup

Properties

PropertyTypeAccessDescription
allCellStyles Array of CellStyle readonlyAll Cell styles
cellStyleGroupsCellStyleGroups readonlyA collection of cell style groups.
cellStylesCellStyles readonlyA collection of cell styles.
idnumber readonlyThe unique ID of the CellStyleGroup.
indexnumber readonlyThe index of the CellStyleGroup within its containing object.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the CellStyleGroup.
parentApplicationCellStyleGroup
Document
readonlyThe parent of the CellStyleGroup (a Document, Application or CellStyleGroup).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

CellStyleGroup duplicate ()
Duplicates the CellStyleGroup.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

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

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

CellStyleGroup move (to: LocationOptions[, reference: any])
Moves the style to the specified location.

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceApplication
CellStyle
CellStyleGroup
CharacterStyle
CharacterStyleGroup
Document
ParagraphStyle
ParagraphStyleGroup
TableStyle
TableStyleGroup
The reference object. Note: Required when the to parameter specifies before or after. Can accept: ParagraphStyle, ParagraphStyleGroup, CharacterStyle, CharacterStyleGroup, CellStyle, CellStyleGroup, TableStyle, TableStyleGroup, Document or Application. (Optional)

void remove ([replacingWith: any])
Deletes the style.

ParameterTypeDescription
replacingWithCharacterStyle
ParagraphStyle
The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (Optional)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

CellStyle.parent

CellStyleGroup.parent

Used in:

CellStyle CellStyle.move (to: LocationOptions[, reference: any])

CellStyleGroup CellStyleGroup.move (to: LocationOptions[, reference: any])

array of CellStyleGroup CellStyleGroups.itemByRange (from: any, to: any)

CellStyleGroup CellStyleGroups.nextItem (obj: CellStyleGroup)

CellStyleGroup CellStyleGroups.previousItem (obj: CellStyleGroup)

CharacterStyle CharacterStyle.move (to: LocationOptions[, reference: any])

CharacterStyleGroup CharacterStyleGroup.move (to: LocationOptions[, reference: any])

ParagraphStyle ParagraphStyle.move (to: LocationOptions[, reference: any])

ParagraphStyleGroup ParagraphStyleGroup.move (to: LocationOptions[, reference: any])

TableStyle TableStyle.move (to: LocationOptions[, reference: any])

TableStyleGroup TableStyleGroup.move (to: LocationOptions[, reference: any])

Return

CellStyleGroup CellStyleGroup.duplicate ()

Array of CellStyleGroup CellStyleGroup.getElements ()

CellStyleGroup CellStyleGroup.move (to: LocationOptions[, reference: any])

CellStyleGroup CellStyleGroups.add ([withProperties: Object])

CellStyleGroup CellStyleGroups.anyItem ()

Array of CellStyleGroup CellStyleGroups.everyItem ()

CellStyleGroup CellStyleGroups.firstItem ()

CellStyleGroup CellStyleGroups.item (index: any)

CellStyleGroup CellStyleGroups.itemByID (id: number)

CellStyleGroup CellStyleGroups.itemByName (name: string)

Array of CellStyleGroup CellStyleGroups.itemByRange (from: any, to: any)

CellStyleGroup CellStyleGroups.lastItem ()

CellStyleGroup CellStyleGroups.middleItem ()

CellStyleGroup CellStyleGroups.nextItem (obj: CellStyleGroup)

CellStyleGroup CellStyleGroups.previousItem (obj: CellStyleGroup)

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