Adobe InCopy CS6 (8.0) Object Model JS: TableStyleGroup

previous page next page

Class

TableStyleGroup

A table style group.

Application | Document | TableStyleGroup

TableStyleGroup

Property	Type	Access	Description
allTableStyles	Array of TableStyle	readonly	All Table styles
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the TableStyleGroup.
index	number	readonly	The index of the TableStyleGroup within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the TableStyleGroup.
parent	Application Document TableStyleGroup	readonly	The parent of the TableStyleGroup (a Document, Application or TableStyleGroup).
properties	Object	r/w	A property that allows setting of several properties at the same time.
tableStyleGroups	TableStyleGroups TableStyleGroup	readonly	A collection of table style groups.
tableStyles	TableStyles TableStyle	readonly	A collection of table styles.

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

TableStyleGroup duplicate ()
Duplicates the TableStyleGroup.

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

Parameter	Type	Description
key	string	The 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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

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

Parameter	Type	Description
to	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The location relative to the reference object or within the containing object.
reference	Application 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.

Parameter	Type	Description
replacingWith	CharacterStyle 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.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)