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

InDesign Server CS6

Class

ObjectStyleGroups

 A collection of object style groups.

See also ObjectStyleGroup.

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

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

ParameterTypeDescription
indexnumberThe index.

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

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new ObjectStyleGroup (Optional)

ObjectStyleGroup anyItem ()
Returns any ObjectStyleGroup in the collection.

number count ()
Displays the number of elements in the ObjectStyleGroup.

Array of ObjectStyleGroup everyItem ()
Returns every ObjectStyleGroup in the collection.

ObjectStyleGroup firstItem ()
Returns the first ObjectStyleGroup in the collection.

ObjectStyleGroup item (index: varies)
Returns the ObjectStyleGroup with the specified index or name.

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong Integer
ObjectStyleGroup
String
The ObjectStyleGroup, index, or name at the beginning of the range. Can accept: ObjectStyleGroup, Long Integer or String.
toLong Integer
ObjectStyleGroup
String
The ObjectStyleGroup, index, or name at the end of the range. Can accept: ObjectStyleGroup, Long Integer or String.

ObjectStyleGroup lastItem ()
Returns the last ObjectStyleGroup in the collection.

ObjectStyleGroup middleItem ()
Returns the middle ObjectStyleGroup in the collection.

ObjectStyleGroup nextItem (obj: ObjectStyleGroup)
Returns the ObjectStyleGroup whose index follows the specified ObjectStyleGroup in the collection.

ParameterTypeDescription
objObjectStyleGroupThe ObjectStyleGroup whose index comes before the desired ObjectStyleGroup.

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

ParameterTypeDescription
objObjectStyleGroupThe index of the ObjectStyleGroup that follows the desired ObjectStyleGroup.

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

Element of

Application.objectStyleGroups

Document.objectStyleGroups

ObjectStyleGroup.objectStyleGroups

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