InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

ColorGroup

A color group

Hierarchy

Application | Document

ColorGroup

ColorGroupSwatch

Properties

NameType AccessDescription
ColorGroupSwatches<ColorGroupSwatch> readonly A collection of color group swatches.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the ColorGroup.
Number readonly The index of the ColorGroup within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the ColorGroup.
Application | Document readonly The parent of the ColorGroup (a Application or Document).
Object read/write A property that allows setting of several properties at the same time.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ ColorGroup

Duplicates the ColorGroup.

→ String

Gets the label value associated with the specified key.

key String The key.
→ ColorGroup[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the ColorGroup.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

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

→ String

Retrieves the object specifier.

→ void

Ungroups a color group

Object of 10

Properties elsewhere that hold a ColorGroup.

Color.parentColorGroupColorGroupSwatch.parentEvent.parentEventListener.parentGradient.parentColorGroupMixedInk.parentColorGroupMixedInkGroup.parentColorGroupMutationEvent.parentSwatch.parentColorGroupTint.parentColorGroup

Parameter of 3

Method parameters that accept a ColorGroup.

ColorGroups.itemByRange(from)ColorGroups.nextItem(obj)ColorGroups.previousItem(obj)

Return 15

Methods that return a ColorGroup.

ColorGroup.duplicate()ColorGroup.getElements()ColorGroups.[]()ColorGroups.add()ColorGroups.anyItem()ColorGroups.everyItem()ColorGroups.firstItem()ColorGroups.item()ColorGroups.itemByID()ColorGroups.itemByName()ColorGroups.itemByRange()ColorGroups.lastItem()ColorGroups.middleItem()ColorGroups.nextItem()ColorGroups.previousItem()