Typefi settings on the page level
Go to Property Listing | Method Listing
addEventListener, applyPrefixAndMarker, createSection, getElements, mainStoryFrame, mainStoryFrames, removeEventListener, 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 TypefiPageSettings (a Page). |
||
|
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) |
undefined applyPrefixAndMarker (type:Varies TypefiSectionDefinition String)
Apply sectionPrefix and marker strings to section
|
Parameter |
Type |
Description |
|---|---|---|
|
type |
The name of a Typefi section definition or a Typefi section definition object. Can accept: TypefiSectionDefinition or String. |
Section createSection (type:Varies TypefiSectionDefinition String, isStartSection:Boolean, [externalId:String=String], startPageNumber:Number, parentSection:Varies TypefiSectionInstance Section)
Make the current page the first page of a new Typefi section instance and set the first page number of the section if provided
|
Parameter |
Type |
Description |
|---|---|---|
|
type |
The name of a Typefi section definition or a Typefi section definition object. Can accept: TypefiSectionDefinition or String. |
|
|
isStartSection |
Optionally specify whether the section is the start section of the document (Optional) |
|
|
externalId |
An optional string that acts as id. If not specified, a GUID is generated (Optional) (default: ) |
|
|
startPageNumber |
Number (range 1 - 999999) |
The optional first page number of the section. Usually only needed for the first section of a publication (Optional) |
|
parentSection |
Optionally specify the parent section if you want to use the section as sub-section. Can accept: TypefiSectionInstance or Section. (Optional) |
TypefiPageSettings getElements ()
Resolves the object specifier, creating an array of object references.
TextFrame mainStoryFrame ()
Get the main story text frame of the page
TextFrame mainStoryFrames ()
Get the chain of main story text frames of the page
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 TypefiPageSettings.
String toSpecifier ()
Retrieves the object specifier.