CellStyleGroup

A cell style group.

Methods:

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

Objects:

CellStyle, CellStyleGroups, CellStyles, Number, Object, String

Property Listing

Property

Type

Access

Description

allCellStyles

Array of CellStyle

readonly

All Cell styles

cellStyleGroups

CellStyleGroups CellStyleGroup

readonly

A collection of cell style groups.

cellStyles

CellStyles CellStyle

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

read/write

A property that can be set to any string.

name

String

read/write

The name of the CellStyleGroup.

parent

Application

CellStyleGroup

Document

readonly

The parent of the CellStyleGroup (a Document, Application or CellStyleGroup).

properties

Object

read/write

A property that allows setting of several properties at the same time.

Method Listing

CellStyleGroup duplicate ()

Duplicates the CellStyleGroup.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

CellStyleGroup 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.

Parameter

Type

Description

key

String

The key.

value

String

The value.

CellStyleGroup move (to:LocationOptions, reference:Varies CellStyle CellStyleGroup CharacterStyle CharacterStyleGroup Document ParagraphStyle ParagraphStyleGroup TableStyle TableStyleGroup Application)

Moves the style to the specified location.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

CellStyle

CellStyleGroup

CharacterStyle

CharacterStyleGroup

Document

ParagraphStyle

ParagraphStyleGroup

TableStyle

TableStyleGroup

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)

undefined remove (replacingWith:Varies ParagraphStyle CharacterStyle)

Deletes the style.

Parameter

Type

Description

replacingWith

ParagraphStyle

CharacterStyle

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

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

CellStyle.parent

CellStyleGroup.parent

Return

CellStyleGroups.add()

CellStyleGroup.duplicate()

CellStyleGroup.move()

CellStyleGroup.getElements()

CellStyleGroups.anyItem()

CellStyleGroups.everyItem()

CellStyleGroups.nextItem()

CellStyleGroups.previousItem()

CellStyleGroups.itemByID()

CellStyleGroups.item()

CellStyleGroups.itemByName()

CellStyleGroups.itemByRange()

CellStyleGroups.firstItem()

CellStyleGroups.lastItem()

CellStyleGroups.middleItem()