Typefi element definition
Go to Property Listing | Method Listing
addEventListener, apply, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier
Boolean, EventListeners, Events, Number, Object, ParagraphStyle, String, TypefiElementType, TypefiElementVariantDefinitions,
Property |
Type |
Access |
Description |
---|---|---|---|
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
read/write |
External paragraph style. Can return: ParagraphStyle or String. |
||
readonly |
The unique ID of the TypefiElementDefinition. |
||
readonly |
The index of the TypefiElementDefinition within its containing object. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
read/write |
Keep order |
||
read/write |
A property that can be set to any string. |
||
read/write |
The name of the TypefiElementDefinition. |
||
readonly |
The parent of the TypefiElementDefinition (a Document). |
||
read/write |
A property that allows setting of several properties at the same time. |
||
read/write |
The element type |
||
TypefiElementVariantDefinitions TypefiElementVariantDefinition |
readonly |
A list of Typefi element variant definitions |
|
read/write |
Writer paragraph style. Can return: ParagraphStyle or String. |
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) |
TypefiElementVariantDefinition apply (pageItem:PageItem)
Applies element to page item
Parameter |
Type |
Description |
---|---|---|
pageItem |
The page item that needs to be assigned the element type |
String extractLabel (key:String)
Gets the label value associated with the specified key.
Parameter |
Type |
Description |
---|---|---|
key |
The key. |
TypefiElementDefinition getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined remove ()
Deletes the TypefiElementDefinition.
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) |
String toSource ()
Generates a string which, if executed, will return the TypefiElementDefinition.
String toSpecifier ()
Retrieves the object specifier.
TypefiElementDefinitions.add()
TypefiElementDefinition.getElements()
TypefiElementDefinitions.anyItem()
TypefiElementDefinitions.everyItem()
TypefiElementDefinitions.nextItem()
TypefiElementDefinitions.previousItem()
TypefiElementDefinitions.itemByID()
TypefiElementDefinitions.item()
TypefiElementDefinitions.itemByName()
TypefiElementDefinitions.itemByRange()
TypefiElementDefinitions.firstItem()