K4 InDesign Javascript API Documentation

TextParagraphStyleGroups

A collection of paragraph style groups.

Instance Properties

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

Methods

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