K4 InDesign Javascript API Documentation

Interactive ElementsSoundBehavior

A sound behavior object.

Extends

Instance Properties

Name Description Access
behaviorEvent BehaviorEvents The event which triggers the behavior. read-write
enableBehavior bool If true, the behavior is enabled. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the SoundBehavior. read-only
index number The index of the SoundBehavior within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the SoundBehavior. read-only
operation PlayOperations The playback mode. read-write
parent The parent of the SoundBehavior (a Button, CheckBox, ComboBox, ListBox, RadioButton, TextBox or SignatureField). read-only
properties Object A property that allows setting of several properties at the same time. read-write
soundItem Sound The sound page item. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → SoundBehavior
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → SoundBehavior
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the SoundBehavior.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the SoundBehavior.
toSpecifier(
)
  → string
Retrieves the object specifier.