Adobe InDesign CS5 (7.0) Object Model JS: SoundBehaviors

InDesign CS5

Class

SoundBehaviors

 A collection of sound behavior objects.

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

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

ParameterTypeDescription
indexnumberThe index.

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

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

SoundBehavior anyItem ()
Returns any SoundBehavior in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objSoundBehaviorThe SoundBehavior whose index comes before the desired SoundBehavior.

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

ParameterTypeDescription
objSoundBehaviorThe index of the SoundBehavior that follows the desired SoundBehavior.

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

Element of

Button.soundBehaviors

Jongware, 20-Jun-2010 v3.0.3dContents :: Index