InDesign2026
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 21.5.1.73
Collection of ColorGroupSwatch

ColorGroupSwatches

A collection of color group swatches.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

→ ColorGroupSwatch

Returns the ColorGroupSwatch with the specified index.

index Number The index.
→ ColorGroupSwatch

Adds a color group swatch.

swatchItemRef Swatch swatch to be added to color group
withProperties? Object Initial values for properties of the new ColorGroupSwatch
→ Number

Displays the number of elements in the ColorGroupSwatch.

→ ColorGroupSwatch[]

Returns every ColorGroupSwatch in the collection.

→ ColorGroupSwatch

Returns the first ColorGroupSwatch in the collection.

→ ColorGroupSwatch

Returns the ColorGroupSwatch with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
→ ColorGroupSwatch[]

Returns the ColorGroupSwatches within the specified range.

from ColorGroupSwatch | LongInteger | String The ColorGroupSwatch, index, or name at the beginning of the range. Can accept: ColorGroupSwatch, Long Integer or String.
to ColorGroupSwatch | LongInteger | String The ColorGroupSwatch, index, or name at the end of the range. Can accept: ColorGroupSwatch, Long Integer or String.
→ ColorGroupSwatch

Returns the last ColorGroupSwatch in the collection.

→ ColorGroupSwatch

Returns the middle ColorGroupSwatch in the collection.

→ ColorGroupSwatch

Returns the ColorGroupSwatch whose index follows the specified ColorGroupSwatch in the collection.

obj ColorGroupSwatch The ColorGroupSwatch whose index comes before the desired ColorGroupSwatch.
→ ColorGroupSwatch

Returns the ColorGroupSwatch with the index previous to the specified index.

obj ColorGroupSwatch The index of the ColorGroupSwatch that follows the desired ColorGroupSwatch.
→ String

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

Object of 1

Properties elsewhere that hold a ColorGroupSwatches.

ColorGroup.colorGroupSwatches