CellStyleGroup

A cell style group.

Properties

Property	Type	Access	Description
allCellStyles	Array of CellStyle	readonly	All Cell styles
cellStyleGroups	CellStyleGroups	readonly	A collection of cell style groups.
cellStyles	CellStyles	readonly	A collection of cell styles.
id	number	readonly	The unique ID of the CellStyleGroup.
index	number	readonly	The index of the CellStyleGroup 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 CellStyleGroup.
parent	any	readonly	The parent of the CellStyleGroup (a Document, Application or CellStyleGroup).
properties	Object	r/w	A property that allows setting of several properties at the same time.

Methods

CellStyleGroupduplicate ()
Duplicates the CellStyleGroup.

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

Parameter	Type	Description
key	string	The key.

Array of CellStyleGroupgetElements ()
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.

CellStyleGroupmove (to:
LocationOptions[, reference:
any])
Moves the CellStyleGroup 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 CellStyleGroup.

Parameter	Type	Description
replacingWith	ParagraphStyle CharacterStyle	The CellStyleGroup to apply in place of the deleted CellStyleGroup. Can accept: ParagraphStyle or CharacterStyle. (Optional)

string toSource ()
Generates a string which, if executed, will return the CellStyleGroup.

string toSpecifier ()
Retrieves the object specifier.

Used in:

CellStyleGroups.previousItem (

obj:
CellStyleGroup )

CellStyleGroups.nextItem (

obj:
CellStyleGroup )

Returned by:

CellStyleGroup CellStyleGroup .duplicate (

)

Array of CellStyleGroup CellStyleGroup .getElements (

)

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

CellStyleGroup CellStyleGroups.add (
[withProperties:
Object]
)

CellStyleGroup CellStyleGroups.anyItem (

)

Array of CellStyleGroup CellStyleGroups.everyItem (

)

CellStyleGroup CellStyleGroups.firstItem (

)

CellStyleGroup CellStyleGroups.item (
index:
any
)

CellStyleGroup CellStyleGroups.itemByID (
id:
number
)

CellStyleGroup CellStyleGroups.itemByName (
name:
string
)

Array of CellStyleGroup CellStyleGroups.itemByRange (
from:
any, to:
any
)

CellStyleGroup CellStyleGroups.lastItem (

)

CellStyleGroup CellStyleGroups.middleItem (

)

CellStyleGroup CellStyleGroups.nextItem (
obj:
CellStyleGroup
)

CellStyleGroup CellStyleGroups.previousItem (
obj:
CellStyleGroup
)