Section

A section.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, Page, PageNumberStyle, Preferences, String, TypefiSectionSettings,

Preferences:

Preferences

Property Listing

Property

Type

Access

Description

alternateLayout

String

read/write

The alternate layout name for a set of pages.

alternateLayoutLength

Number

readonly

The number of pages in the alternate layout section.

continueNumbering

Boolean

read/write

If true, continues page numbers sequentially from the previous section.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the Section.

includeSectionPrefix

Boolean

read/write

If true, places the specified prefix before page numbers on all pages in the section.

index

Number

readonly

The index of the Section 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.

length

Number

readonly

The number of pages in the section.

marker

String

read/write

The section marker.

name

String

read/write

The name of the Section.

pageNumberStart

Number (range 1 - 999999)

read/write

The page number assigned to the first page in the section. Note: Valid only when continue numbering is false.

pageNumberStyle

PageNumberStyle

PageNumberStyle.ARABIC

PageNumberStyle.ARABIC_ABJAD

PageNumberStyle.ARABIC_ALIF_BA_TAH

PageNumberStyle.DOUBLE_LEADING_ZEROS

PageNumberStyle.HEBREW_BIBLICAL

PageNumberStyle.HEBREW_NON_STANDARD

PageNumberStyle.KANJI

PageNumberStyle.LOWER_LETTERS

PageNumberStyle.LOWER_ROMAN

PageNumberStyle.SINGLE_LEADING_ZEROS

PageNumberStyle.TRIPLE_LEADING_ZEROS

PageNumberStyle.UPPER_LETTERS

PageNumberStyle.UPPER_ROMAN

String

read/write

The page number style. Can return: PageNumberStyle enumerator or String.

pageStart

Page

read/write

The start page for the section.

parent

Document

readonly

The parent of the Section (a Document).

preferences

Preferences Preference

readonly

A collection of preferences objects.

properties

Object

read/write

A property that allows setting of several properties at the same time.

sectionPrefix

String

read/write

The prefix to place before page numbers on pages in the section. May include up to 8 characters. Note: Valid only when include section prefix is true.

typefiSettings

TypefiSectionSettings

readonly

Typefi specific settings to sections

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)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

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

Parameter

Type

Description

key

String

The key.

value

String

The value.

undefined remove ()

Deletes the Section.

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)

String toSource ()

Generates a string which, if executed, will return the Section.

String toSpecifier ()

Retrieves the object specifier.

Object of

Page.appliedAlternateLayout

Event.parent

EventListener.parent

MutationEvent.parent

Preference.parent

TypefiSectionSettings.parent

Page.appliedSection

Return

Sections.add()

TypefiPageSettings.createSection()

Section.getElements()

Sections.anyItem()

Sections.everyItem()

Sections.nextItem()

Sections.previousItem()

Sections.itemByID()

Sections.item()

Sections.[]()

Sections.itemByName()

Sections.itemByRange()

Sections.firstItem()

Sections.lastItem()

Sections.middleItem()