FileNameVariablePreference

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Object, String,

Hierarchy:

Class: FileNameVariablePreference

Property Listing

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
includeExtension	Boolean	read/write	If true, includes the file extension.
includePath	Boolean	read/write	If true, includes the entire path of the file.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
parent	TextVariable	readonly	The parent of the FileNameVariablePreference (a TextVariable).
properties	Object	read/write	A property that allows setting of several properties at the same time.
textAfter	String	read/write	The text that follows the value of the variable. (Limit: 128 characters)
textBefore	String	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	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

FileNameVariablePreference 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	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the FileNameVariablePreference.

String toSpecifier ()

Retrieves the object specifier.