TypefiFieldDefinition

Methods:

addEventListener, extractLabel, getElements, insert, insertLabel, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, String, TypefiFieldCounterValueStyle, TypefiFieldDataType, TypefiFieldType,

Property Listing

Property	Type	Access	Description
counterFormat	TypefiFieldCounterValueStyle TypefiFieldCounterValueStyle.ARABIC TypefiFieldCounterValueStyle.ARABIC_ABJAD TypefiFieldCounterValueStyle.ARABIC_ALIF_BA_TAH TypefiFieldCounterValueStyle.ASTERISKS TypefiFieldCounterValueStyle.DOUBLE_LEADING_ZEROS TypefiFieldCounterValueStyle.FULL_WIDTH_ARABIC TypefiFieldCounterValueStyle.HEBREW_BIBLICAL TypefiFieldCounterValueStyle.HEBREW_NON_STANDARD TypefiFieldCounterValueStyle.KANJI TypefiFieldCounterValueStyle.KATAKANA_MODERN TypefiFieldCounterValueStyle.KATAKANA_TRADITIONAL TypefiFieldCounterValueStyle.LOWER_LETTERS TypefiFieldCounterValueStyle.LOWER_ROMAN TypefiFieldCounterValueStyle.NUMBER_WORD_LOWER TypefiFieldCounterValueStyle.NUMBER_WORD_MIXED TypefiFieldCounterValueStyle.NUMBER_WORD_UPPER TypefiFieldCounterValueStyle.SINGLE_LEADING_ZEROS TypefiFieldCounterValueStyle.SYMBOLS TypefiFieldCounterValueStyle.TRIPLE_LEADING_ZEROS TypefiFieldCounterValueStyle.UPPER_LETTERS TypefiFieldCounterValueStyle.UPPER_ROMAN String	read/write	The field counter format. Can return: TypefiFieldCounterValueStyle enumerator or String.
dataType	TypefiFieldDataType TypefiFieldDataType.COUNTER TypefiFieldDataType.PLAIN_TEXT	read/write	The field data type
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
fieldContext	TypefiFieldType TypefiFieldType.ELEMENT_FIELD TypefiFieldType.PROJECT_FIELD TypefiFieldType.SECTION_FIELD	read/write	The field context
id	Number	readonly	The unique ID of the TypefiFieldDefinition.
index	Number	readonly	The index of the TypefiFieldDefinition within its containing object.
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.
name	String	read/write	The name of the TypefiFieldDefinition.
parent	Document	readonly	The parent of the TypefiFieldDefinition (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
sampleText	String	read/write	The field's example text

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.

TypefiFieldDefinition getElements ()

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

undefined insert (storyOffset:InsertionPoint)

Place Field at insertion point

Parameter	Type	Description
storyOffset	InsertionPoint	The location within the story, specified as an insertion point

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

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)