Typefi element instance
Go to Property Listing | Method Listing
addEventListener, createAnchor, extractLabel, getElements, getFieldValue, insertLabel, remove, removeEventListener, setField, toSource, toSpecifier
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
read/write |
An optional external id string |
||
|
readonly |
The unique ID of the TypefiElementInstance. |
||
|
readonly |
The index of the TypefiElementInstance within its containing object. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The name of the TypefiElementInstance; this is an alias to the TypefiElementInstance's label property. |
||
|
readonly |
The parent of the TypefiElementInstance (a Document). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
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) |
TypefiElementAnchor createAnchor (storyOffset:InsertionPoint)
Create a Typefi element anchor at the given position
|
Parameter |
Type |
Description |
|---|---|---|
|
storyOffset |
The location within the story, specified as an insertion point |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
TypefiElementInstance getElements ()
Resolves the object specifier, creating an array of object references.
String getFieldValue (name:String)
Get the value of a field of TypefiElementInstance
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name of the field |
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined remove ()
Deletes the TypefiElementInstance.
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 setField (name:String, [value:Varies String LongInteger=Varies String LongInteger])
Set the value of a field of TypefiElementInstance
|
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 TypefiElementInstance.
String toSpecifier ()
Retrieves the object specifier.
TypefiElementPageItem.instance
TypefiElementAnchor.instance
Event.parent
EventListener.parent
MutationEvent.parent
TypefiElementInstance.getElements()
TypefiElementInstances.anyItem()
TypefiElementInstances.everyItem()
TypefiElementInstances.nextItem()
TypefiElementInstances.previousItem()
TypefiElementInstances.itemByID()
TypefiElementInstances.itemByName()
TypefiElementInstances.itemByRange()
TypefiElementInstances.firstItem()