K4 InDesign Javascript API Documentation

TextCharacterStyleGroups

A collection of character style groups.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[withProperties])
  → CharacterStyleGroup
anyItem(
)
  → CharacterStyleGroup
count(
)
  → number
everyItem(
)
  → CharacterStyleGroup
firstItem(
)
  → CharacterStyleGroup
item(
index)
  → CharacterStyleGroup
itemByID(
id)
  → CharacterStyleGroup
itemByName(
name)
  → CharacterStyleGroup
itemByRange(
from, to)
  → CharacterStyleGroup
lastItem(
)
  → CharacterStyleGroup
middleItem(
)
  → CharacterStyleGroup
nextItem(
obj)
  → CharacterStyleGroup
previousItem(
obj)
  → CharacterStyleGroup
toSource(
)
  → string
add(
[withProperties])
  → CharacterStyleGroup
Creates a new CharacterStyleGroup.
withProperties Object Initial values for properties of the new CharacterStyleGroup (Optional)
anyItem(
)
  → CharacterStyleGroup
Returns any CharacterStyleGroup in the collection.
count(
)
  → number
Displays the number of elements in the CharacterStyleGroup.
everyItem(
)
  → CharacterStyleGroup
Returns every CharacterStyleGroup in the collection.
firstItem(
)
  → CharacterStyleGroup
Returns the first CharacterStyleGroup in the collection.
item(
index)
  → CharacterStyleGroup
Returns the CharacterStyleGroup with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → CharacterStyleGroup
Returns the CharacterStyleGroup with the specified ID.
id number The ID.
itemByName(
name)
  → CharacterStyleGroup
Returns the CharacterStyleGroup with the specified name.
name string The name.
itemByRange(
from, to)
  → CharacterStyleGroup
Returns the CharacterStyleGroups within the specified range.
from The CharacterStyleGroup, index, or name at the beginning of the range. Can accept: CharacterStyleGroup, Long Integer or String.
to The CharacterStyleGroup, index, or name at the end of the range. Can accept: CharacterStyleGroup, Long Integer or String.
lastItem(
)
  → CharacterStyleGroup
Returns the last CharacterStyleGroup in the collection.
middleItem(
)
  → CharacterStyleGroup
Returns the middle CharacterStyleGroup in the collection.
nextItem(
obj)
  → CharacterStyleGroup
Returns the CharacterStyleGroup whose index follows the specified CharacterStyleGroup in the collection.
obj CharacterStyleGroup The CharacterStyleGroup whose index comes before the desired CharacterStyleGroup.
previousItem(
obj)
  → CharacterStyleGroup
Returns the CharacterStyleGroup with the index previous to the specified index.
obj CharacterStyleGroup The index of the CharacterStyleGroup that follows the desired CharacterStyleGroup.
toSource(
)
  → string
Generates a string which, if executed, will return the CharacterStyleGroup.