TextMacro
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| expansion | string | r/w | The expansion text that replaces the text macro. |
| index | number | readonly | The index of the TextMacro within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| name | string | r/w | The name of the TextMacro. |
| parent | Application | readonly | The parent of the TextMacro (a Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
Instances
EventListener 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 TextMacro getElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the TextMacro.
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 TextMacro.
Used in:
TextMacro TextMacros.nextItem (obj: TextMacro)
TextMacro TextMacros.previousItem (obj: TextMacro)
Return
Array of TextMacro TextMacro.getElements ()
TextMacro TextMacros.[] (index: number)
TextMacro TextMacros.add (name: string, expansion: string[, withProperties: Object])
TextMacro TextMacros.anyItem ()
Array of TextMacro TextMacros.everyItem ()
TextMacro TextMacros.firstItem ()
TextMacro TextMacros.item (index: varies)
TextMacro TextMacros.itemByName (name: string)
Array of TextMacro TextMacros.itemByRange (from: varies, to: varies)
TextMacro TextMacros.lastItem ()
TextMacro TextMacros.middleItem ()
TextMacro TextMacros.nextItem (obj: TextMacro)
TextMacro TextMacros.previousItem (obj: TextMacro)
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |