CharacterStyleGroups

A collection of character style groups.

Methods:

add, count, item, itemByName, itemByID, itemByRange, firstItem, lastItem, middleItem, previousItem, nextItem, anyItem, everyItem, toSource, []

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

CharacterStyleGroup [] (index:Number)

Returns the CharacterStyleGroup with the specified index.

Parameter

Type

Description

index

Number

The index.

CharacterStyleGroup add (withProperties:Object)

Creates a new CharacterStyleGroup.

Parameter

Type

Description

withProperties

Object

Initial values for properties of the new CharacterStyleGroup (Optional)

CharacterStyleGroup anyItem ()

Returns any CharacterStyleGroup in the collection.

Number count ()

Displays the number of elements in the CharacterStyleGroup.

CharacterStyleGroup everyItem ()

Returns every CharacterStyleGroup in the collection.

CharacterStyleGroup firstItem ()

Returns the first CharacterStyleGroup in the collection.

CharacterStyleGroup item (index:Varies)

Returns the CharacterStyleGroup with the specified index or name.

Parameter

Type

Description

index

Varies

The index or name. Can accept: Long Integer or String.

CharacterStyleGroup itemByID (id:Number)

Returns the CharacterStyleGroup with the specified ID.

Parameter

Type

Description

id

Number

The ID.

CharacterStyleGroup itemByName (name:String)

Returns the CharacterStyleGroup with the specified name.

Parameter

Type

Description

name

String

The name.

CharacterStyleGroup itemByRange (from:Varies, to:Varies)

Returns the CharacterStyleGroups within the specified range.

Parameter

Type

Description

from

Varies

The CharacterStyleGroup, index, or name at the beginning of the range. Can accept: CharacterStyleGroup, Long Integer or String.

to

Varies

The CharacterStyleGroup, index, or name at the end of the range. Can accept: CharacterStyleGroup, Long Integer or String.

CharacterStyleGroup lastItem ()

Returns the last CharacterStyleGroup in the collection.

CharacterStyleGroup middleItem ()

Returns the middle CharacterStyleGroup in the collection.

CharacterStyleGroup nextItem (obj:CharacterStyleGroup)

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

Parameter

Type

Description

obj

CharacterStyleGroup

The CharacterStyleGroup whose index comes before the desired CharacterStyleGroup.

CharacterStyleGroup previousItem (obj:CharacterStyleGroup)

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

Parameter

Type

Description

obj

CharacterStyleGroup

The index of the CharacterStyleGroup that follows the desired CharacterStyleGroup.

String toSource ()

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

Object of

Application.characterStyleGroups

Document.characterStyleGroups

CharacterStyleGroup.characterStyleGroups