A table style group.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| allTableStyles | Array of TableStyle | readonly | All Table styles |
| id | number | readonly | The unique ID of the TableStyleGroup. |
| index | number | readonly | The index of the TableStyleGroup within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the TableStyleGroup. |
| parent | any | 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 | readonly | A collection of table style groups. |
| tableStyles | TableStyles | readonly | A collection of table styles. |
Methods
TableStyleGroupduplicate ()
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 TableStyleGroupgetElements ()
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. |
TableStyleGroupmove (to:
LocationOptions[, reference:
any])
Moves the TableStyleGroup to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location relative to the reference object or within the containing object. |
| reference | ParagraphStyle ParagraphStyleGroup CharacterStyle CharacterStyleGroup CellStyle CellStyleGroup TableStyle TableStyleGroup Document Application |
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 TableStyleGroup.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | ParagraphStyle CharacterStyle |
The TableStyleGroup to apply in place of the deleted TableStyleGroup. Can accept: ParagraphStyle or CharacterStyle. (Optional) |
string toSource ()
Generates a string which, if executed, will return the TableStyleGroup.
string toSpecifier ()
Retrieves the object specifier.
Used in:
TableStyleGroups.previousItem (
obj:
TableStyleGroup )
TableStyleGroups.nextItem (
obj:
TableStyleGroup )
Returned by:
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
)