TypefiMasterSpreadSettings

Methods:

addEventListener, getElements, getFieldValue, removeEventListener, resetAllToDefaults, setField, toSource, toSpecifier

Hierarchy:

Class: TypefiMasterSpreadSettings

Property Listing

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
parent	MasterSpread	readonly	The parent of the TypefiMasterSpreadSettings (a MasterSpread).
properties	Object	read/write	A property that allows setting of several properties at the same time.

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)

TypefiMasterSpreadSettings getElements ()

Resolves the object specifier, creating an array of object references.

String getFieldValue (name:String)

Get the value of a field of TypefiMasterSpreadSettings

Parameter	Type	Description
name	String	The name of the field

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)

undefined resetAllToDefaults ()

Reset the Typefi specific data of TypefiMasterSpreadSettings to the default values

undefined setField (name:String, [value:Varies String LongInteger=Varies String LongInteger])

Set the value of a field of TypefiMasterSpreadSettings

Parameter

Type

Description

name

String

The name of the field

value

String

LongInteger

The value of the field as string or as integer. The empty string will recompute the value of a counter field! If not specified, the field value will be reset. Can accept: String or Long Integer. (Optional)

(default: )

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

MasterSpread.typefiSettings

Return

TypefiMasterSpreadSettings.getElements()