TypefiSectionInstance

Methods:

addEventListener, extractLabel, getElements, getFieldValue, insertLabel, remove, removeEventListener, setField, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, String

Property Listing

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
externalId	String	read/write	An optional external id string
id	Number	readonly	The unique ID of the TypefiSectionInstance.
index	Number	readonly	The index of the TypefiSectionInstance within its containing object.
isStartSection	Boolean	read/write	Specify whether the section is the start section of the document
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
markerString	String	read/write	Section marker string
name	String	readonly	The section name
parent	Document	readonly	The parent of the TypefiSectionInstance (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
sectionPrefixString	String	read/write	Section prefix string

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)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

TypefiSectionInstance getElements ()

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

String getFieldValue (name:String)

Get the value of a field of TypefiSectionInstance

Parameter	Type	Description
name	String	The name of the field

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined remove ()

Deletes the TypefiSectionInstance.

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 setField (name:String, [value:Varies String LongInteger=Varies String LongInteger])

Set the value of a field of TypefiSectionInstance

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

String toSpecifier ()

Retrieves the object specifier.