Adobe InCopy CS5.5 (7.5) Object Model JS: TextMacro

InCopy CS5.5

Class

TextMacro

 An expandable text macro.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application
TextMacro
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
expansionstring r/wThe expansion text that replaces the text macro.
indexnumber readonlyThe index of the TextMacro within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe name of the TextMacro.
parentApplication readonlyThe parent of the TextMacro (a Application).
propertiesObject r/wA 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

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.3iContents :: Index