Adobe InDesign CS2 (4.0) Object Model JS: Section

InDesign CS2

Class

Section

 A section.

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Hierarchy

Document
Section

Properties

PropertyTypeAccessDescription
continueNumberingbool r/wIf true, continues page numbers sequentially from the previous section.
idnumber readonlyThe unique ID of the Section.
includeSectionPrefixbool r/wIf true, places the specified prefix before page numbers on all pages in the section.
indexnumber readonlyThe index of the Section within its containing object.
labelstring r/wA property that can be set to any string.
lengthnumber readonlyThe number of pages in the section.
markerstring r/wThe section marker.
namestring r/wThe name of the Section.
pageNumberStartnumber (range: 1 - 999999) r/wThe page number assigned to the first page in the section. Note: Valid only when continue numbering is false.
pageNumberStylePageNumberStyleString r/wThe page number style. Can return: PageNumberStyle enumerator or String.
pageStartPage r/wThe start page for the section.
parentDocument readonlyThe parent of the Section (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
sectionPrefixstring r/wThe 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.

Methods

Instances

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Object getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the Section.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Page.appliedSection

Used in:

array of Section Sections.itemByRange (from: any, to: any)

Section Sections.nextItem (obj: Section)

Section Sections.previousItem (obj: Section)

Return

Section Sections.add ([reference: Page][, withProperties: Object])

Section Sections.anyItem ()

Array of Section Sections.everyItem ()

Section Sections.firstItem ()

Section Sections.item (index: any)

Section Sections.itemByID (id: number)

Section Sections.itemByName (name: string)

Array of Section Sections.itemByRange (from: any, to: any)

Section Sections.lastItem ()

Section Sections.middleItem ()

Section Sections.nextItem (obj: Section)

Section Sections.previousItem (obj: Section)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index