ObjectStyleGroups

A collection of object 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

ObjectStyleGroup [] (index:Number)

Returns the ObjectStyleGroup with the specified index.

Parameter

Type

Description

index

Number

The index.

ObjectStyleGroup add (withProperties:Object)

Creates a new ObjectStyleGroup.

Parameter

Type

Description

withProperties

Object

Initial 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.

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.

Parameter

Type

Description

index

Varies

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

ObjectStyleGroup itemByID (id:Number)

Returns the ObjectStyleGroup with the specified ID.

Parameter

Type

Description

id

Number

The ID.

ObjectStyleGroup itemByName (name:String)

Returns the ObjectStyleGroup with the specified name.

Parameter

Type

Description

name

String

The name.

ObjectStyleGroup itemByRange (from:Varies, to:Varies)

Returns the ObjectStyleGroups within the specified range.

Parameter

Type

Description

from

Varies

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

to

Varies

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.

Parameter

Type

Description

obj

ObjectStyleGroup

The ObjectStyleGroup whose index comes before the desired ObjectStyleGroup.

ObjectStyleGroup previousItem (obj:ObjectStyleGroup)

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

Parameter

Type

Description

obj

ObjectStyleGroup

The index of the ObjectStyleGroup that follows the desired ObjectStyleGroup.

String toSource ()

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