Adobe InDesign CS6 Server (8.0) Object Model JS: CharacterStyleGroups

InDesign Server CS6

Class

CharacterStyleGroups

 A collection of character style groups.

See also CharacterStyleGroup.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

CharacterStyleGroup [] (index: number)
Returns the CharacterStyleGroup with the specified index.

ParameterTypeDescription
indexnumberThe index.

CharacterStyleGroup add ([withProperties: Object])
Creates a new CharacterStyleGroup.

ParameterTypeDescription
withPropertiesObjectInitial 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.

Array of 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.

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

CharacterStyleGroup itemByID (id: number)
Returns the CharacterStyleGroup with the specified ID.

ParameterTypeDescription
idnumberThe ID.

CharacterStyleGroup itemByName (name: string)
Returns the CharacterStyleGroup with the specified name.

ParameterTypeDescription
namestringThe name.

Array of CharacterStyleGroup itemByRange (from: varies, to: varies)
Returns the CharacterStyleGroups within the specified range.

ParameterTypeDescription
fromCharacterStyleGroup
Long Integer
String
The CharacterStyleGroup, index, or name at the beginning of the range. Can accept: CharacterStyleGroup, Long Integer or String.
toCharacterStyleGroup
Long Integer
String
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.

ParameterTypeDescription
objCharacterStyleGroupThe CharacterStyleGroup whose index comes before the desired CharacterStyleGroup.

CharacterStyleGroup previousItem (obj: CharacterStyleGroup)
Returns the CharacterStyleGroup with the index previous to the specified index.

ParameterTypeDescription
objCharacterStyleGroupThe index of the CharacterStyleGroup that follows the desired CharacterStyleGroup.

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

Element of

Application.characterStyleGroups

CharacterStyleGroup.characterStyleGroups

Document.characterStyleGroups

Jongware, 28-Apr-2012 v3.0.3iContents :: Index