K4 InDesign Javascript API Documentation

TablesTableStyleGroups

A collection of table style groups.

Instance Properties

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

Methods

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