Adobe InCopy CS5.5 (7.5) Object Model JS: TableStyleGroup

InCopy CS5.5

Class

TableStyleGroup

 A table style group.

QuickLinks

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

Hierarchy

Application | Document | TableStyleGroup
TableStyleGroup
Event | EventListener | MutationEvent | TableStyle | TableStyleGroup

Properties

PropertyTypeAccessDescription
allTableStyles Array of TableStyle readonlyAll Table styles
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the TableStyleGroup.
indexnumber readonlyThe index of the TableStyleGroup within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
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 TableStyleGroup readonlyA collection of table style groups.
tableStylesTableStyles TableStyle readonlyA collection of table styles.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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: varies])
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: varies])
Deletes the style.

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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:

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

TableStyleGroup TableStyleGroups.[] (index: number)

TableStyleGroup TableStyleGroups.add ([withProperties: Object])

TableStyleGroup TableStyleGroups.anyItem ()

Array of TableStyleGroup TableStyleGroups.everyItem ()

TableStyleGroup TableStyleGroups.firstItem ()

TableStyleGroup TableStyleGroups.item (index: varies)

TableStyleGroup TableStyleGroups.itemByID (id: number)

TableStyleGroup TableStyleGroups.itemByName (name: string)

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

TableStyleGroup TableStyleGroups.lastItem ()

TableStyleGroup TableStyleGroups.middleItem ()

TableStyleGroup TableStyleGroups.nextItem (obj: TableStyleGroup)

TableStyleGroup TableStyleGroups.previousItem (obj: TableStyleGroup)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index