Adobe InCopy CS5 (7.0) Object Model JS: FileNameVariablePreference

InCopy CS5

Class

FileNameVariablePreference

 The preferences for a file name variable. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

TextVariable
Preference
FileNameVariablePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
includeExtensionbool r/wIf true, includes the file extension.
includePathbool r/wIf true, includes the entire path of the file.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentTextVariable readonlyThe parent of the FileNameVariablePreference (a TextVariable).
propertiesObject r/wA property that allows setting of several properties at the same time.
textAfterstring r/wThe text that follows the value of the variable. (Limit: 128 characters)
textBeforestring r/wThe text that precedes the value of the variable. (Limit: 128 characters)

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 FileNameVariablePreference getElements ()
Resolves the object specifier, creating an array of object references.

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 FileNameVariablePreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

TextVariable.variableOptions

Return

Array of FileNameVariablePreference FileNameVariablePreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index