A table style group.
Go to Property Listing | Method Listing
duplicate, move, remove, insertLabel, extractLabel, toSource, getElements, toSpecifier, addEventListener, removeEventListener
Application, Boolean, Document, EventListeners, Events, Number, Object, String, TableStyle, TableStyleGroup, TableStyleGroups, TableStyles,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
allTableStyles |
Array of TableStyle |
readonly |
All Table styles |
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
id |
readonly |
The unique ID of the TableStyleGroup. |
|
|
index |
readonly |
The index of the TableStyleGroup within its containing object. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
label |
read/write |
A property that can be set to any string. |
|
|
name |
read/write |
The name of the TableStyleGroup. |
|
|
parent |
readonly |
The parent of the TableStyleGroup (a Document, Application or TableStyleGroup). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
|
|
tableStyleGroups |
readonly |
A collection of table style groups. |
|
|
tableStyles |
readonly |
A collection of table styles. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
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 |
The key. |
TableStyleGroup getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
TableStyleGroup move (to:LocationOptions, reference:Varies)
Moves the style to the specified location.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
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 |
Varies |
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) |
undefined remove (replacingWith:Varies)
Deletes the style.
|
Parameter |
Type |
Description |
|---|---|---|
|
replacingWith |
Varies |
The style to apply in place of the deleted style. Can accept: ParagraphStyle or CharacterStyle. (Optional) |
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the TableStyleGroup.
String toSpecifier ()
Retrieves the object specifier.
Event.parent
EventListener.parent
MutationEvent.parent
TableStyle.parent
TableStyleGroup.parent