Adobe InDesign CS3 (5.0) Object Model JS: TableStyleGroup

InDesign CS3

Class

TableStyleGroup

 A table style group.

QuickLinks

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

Hierarchy

Application | Document | TableStyleGroup
TableStyleGroup
TableStyle | TableStyleGroup

Properties

PropertyTypeAccessDescription
allTableStyles Array of TableStyle readonlyAll Table styles
idnumber readonlyThe unique ID of the TableStyleGroup.
indexnumber readonlyThe index of the TableStyleGroup within its containing object.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the TableStyleGroup.
parentApplicationDocument
TableStyleGroup
readonlyThe parent of the TableStyleGroup (a Document, Application or TableStyleGroup).
propertiesObject r/wA property that allows setting of several properties at the same time.
tableStyleGroupsTableStyleGroups readonlyA collection of table style groups.
tableStylesTableStyles readonlyA collection of table styles.

Methods

Instances

TableStyleGroup duplicate ()
Duplicates the TableStyleGroup.

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

ParameterTypeDescription
keystringThe key.

Array of TableStyleGroup 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.

TableStyleGroup 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 TableStyleGroup.

string toSpecifier ()
Retrieves the object specifier.

Element of

TableStyle.parent

TableStyleGroup.parent

Used in:

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

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

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])

array of TableStyleGroup TableStyleGroups.itemByRange (from: any, to: any)

TableStyleGroup TableStyleGroups.nextItem (obj: TableStyleGroup)

TableStyleGroup TableStyleGroups.previousItem (obj: TableStyleGroup)

Return

TableStyleGroup TableStyleGroup.duplicate ()

Array of TableStyleGroup TableStyleGroup.getElements ()

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

TableStyleGroup TableStyleGroups.add ([withProperties: Object])

TableStyleGroup TableStyleGroups.anyItem ()

Array of TableStyleGroup TableStyleGroups.everyItem ()

TableStyleGroup TableStyleGroups.firstItem ()

TableStyleGroup TableStyleGroups.item (index: any)

TableStyleGroup TableStyleGroups.itemByID (id: number)

TableStyleGroup TableStyleGroups.itemByName (name: string)

Array of TableStyleGroup TableStyleGroups.itemByRange (from: any, to: any)

TableStyleGroup TableStyleGroups.lastItem ()

TableStyleGroup TableStyleGroups.middleItem ()

TableStyleGroup TableStyleGroups.nextItem (obj: TableStyleGroup)

TableStyleGroup TableStyleGroups.previousItem (obj: TableStyleGroup)

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