Adobe InCopy CS5 (7.0) Object Model JS: CellStyleGroup

InCopy CS5

Class

CellStyleGroup

 A cell style group.

QuickLinks

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

Hierarchy

Application | CellStyleGroup | Document
CellStyleGroup
CellStyle | CellStyleGroup | Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
allCellStyles Array of CellStyle readonlyAll Cell styles
cellStyleGroupsCellStyleGroups readonlyA collection of cell style groups.
cellStylesCellStyles readonlyA collection of cell styles.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the CellStyleGroup.
indexnumber readonlyThe index of the CellStyleGroup within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the CellStyleGroup.
parentApplicationCellStyleGroup
Document
readonlyThe parent of the CellStyleGroup (a Document, Application or CellStyleGroup).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

CellStyleGroup duplicate ()
Duplicates the CellStyleGroup.

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

ParameterTypeDescription
keystringThe key.

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

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

ParameterTypeDescription
toLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location relative to the reference object or within the containing object.
referenceApplication
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.

ParameterTypeDescription
replacingWithCharacterStyle
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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

CellStyle.parent

CellStyleGroup.parent

Used in:

CellStyleGroup CellStyleGroups.nextItem (obj: CellStyleGroup)

CellStyleGroup CellStyleGroups.previousItem (obj: CellStyleGroup)

Return

CellStyleGroup CellStyleGroup.duplicate ()

Array of CellStyleGroup CellStyleGroup.getElements ()

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

CellStyleGroup CellStyleGroups.[] (index: number)

CellStyleGroup CellStyleGroups.add ([withProperties: Object])

CellStyleGroup CellStyleGroups.anyItem ()

Array of CellStyleGroup CellStyleGroups.everyItem ()

CellStyleGroup CellStyleGroups.firstItem ()

CellStyleGroup CellStyleGroups.item (index: varies)

CellStyleGroup CellStyleGroups.itemByID (id: number)

CellStyleGroup CellStyleGroups.itemByName (name: string)

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

CellStyleGroup CellStyleGroups.lastItem ()

CellStyleGroup CellStyleGroups.middleItem ()

CellStyleGroup CellStyleGroups.nextItem (obj: CellStyleGroup)

CellStyleGroup CellStyleGroups.previousItem (obj: CellStyleGroup)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index