Typefi settings on the section level
Go to Property Listing | Method Listing
addEventListener, getElements, getFieldValue, removeEventListener, resetAllToDefaults, setField, toSource, toSpecifier
Property |
Type |
Access |
Description |
---|---|---|---|
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
readonly |
The parent of the TypefiSectionSettings (a Section). |
||
read/write |
A property that allows setting of several properties at the same time. |
||
read/write |
Section instance |
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
TypefiSectionSettings getElements ()
Resolves the object specifier, creating an array of object references.
String getFieldValue (name:String)
Get the value of a field of TypefiSectionSettings
Parameter |
Type |
Description |
---|---|---|
name |
The name of the field |
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined resetAllToDefaults ()
Reset the Typefi specific data of TypefiSectionSettings to the default values
undefined setField (name:String, [value:Varies String LongInteger=Varies String LongInteger])
Set the value of a field of TypefiSectionSettings
Parameter |
Type |
Description |
---|---|---|
name |
The name of the field |
|
value |
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 TypefiSectionSettings.
String toSpecifier ()
Retrieves the object specifier.