K4 InDesign Javascript API Documentation

LayoutSection

A section.

Instance Properties

Name Description Access
alternateLayout string The alternate layout name for a set of pages. read-write
alternateLayoutLength number The number of pages in the alternate layout section. read-only
continueNumbering bool If true, continues page numbers sequentially from the previous section. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the Section. read-only
includeSectionPrefix bool If true, places the specified prefix before page numbers on all pages in the section. read-write
index number The index of the Section within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
length number The number of pages in the section. read-only
marker string The section marker. read-write
name string The name of the Section. read-write
pageNumberStart number The page number assigned to the first page in the section. Note: Valid only when continue numbering is false. read-write
pageNumberStyle The page number style. Can return: PageNumberStyle enumerator or String. read-write
pageStart Page The start page for the section. read-write
parent Document The parent of the Section (a Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
sectionPrefix string 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. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → Section
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Section
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the Section.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Section.
toSpecifier(
)
  → string
Retrieves the object specifier.