Class
CustomTextVariablePreference |
| | The preferences for a custom text variable. Base Class: Preference |
QuickLinks |
addEventListener, getElements, removeEventListener, toSource, toSpecifier |
Hierarchy
|
| CustomTextVariablePreference |
|
Properties
| | Property | Type | Access | Description |
|---|
| contents | SpecialCharactersString |
r/w | The contents of the text. Can return: String or SpecialCharacters enumerator. |
| eventListeners | EventListeners |
readonly | A collection of event listeners. |
| events | Events |
readonly | A collection of events. |
| isValid | bool |
readonly | Returns true if the object specifier resolves to valid objects. |
| parent | TextVariable |
readonly | The parent of the CustomTextVariablePreference (a TextVariable). |
| properties | Object |
r/w | A property that allows setting of several properties at the same time. |
|
Methods
| InstancesEventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|
| eventType | string | The event type. |
| handler | File
JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array of CustomTextVariablePreference getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|
| eventType | string | The registered event type. |
| handler | File
JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the CustomTextVariablePreference.
string toSpecifier ()
Retrieves the object specifier.
|
Element of |
TextVariable.variableOptions
|
Return |
Array of CustomTextVariablePreference CustomTextVariablePreference.getElements ()
|