CaptionMetadataVariablePreference
The preferences for a caption metadata variable.
Go to Property Listing | Method Listing
Methods:
addEventListener, getElements, removeEventListener, toSource, toSpecifier
Objects:
Hierarchy:
Superclass: Preference
Class: CaptionMetadataVariablePreference
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
Name of the metadata provider. |
||
|
readonly |
The parent of the CaptionMetadataVariablePreference (a TextVariable). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
read/write |
The text that follows the value of the variable. (Limit: 128 characters) |
||
|
read/write |
The text that precedes the value of the variable. (Limit: 128 characters) |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
CaptionMetadataVariablePreference getElements ()
Resolves the object specifier, creating an array of object references.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the CaptionMetadataVariablePreference.
String toSpecifier ()
Retrieves the object specifier.
Object of
Event.parent
EventListener.parent
MutationEvent.parent
TextVariable.variableOptions