TextObjectStyleGroups

A collection of object style groups.

Instance Properties

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

Methods

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