Adobe InCopy CS6 (8.0) Object Model JS: Section

InCopy CS6

previous page next page

Class

Section

A section.

QuickLinks

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

Hierarchy

Document

Section

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
alternateLayout	string	readonly	The alternate layout name for a set of pages.
alternateLayoutLength	number	readonly	The number of pages in the alternate layout section.
continueNumbering	bool	readonly	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	bool	readonly	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	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
length	number	readonly	The number of pages in the section.
marker	string	readonly	The section marker.
name	string	r/w	The name of the Section; this is an alias to the Section's label property.
pageNumberStart	number (range: 1 - 999999)	readonly	The page number assigned to the first page in the section. Note: Valid only when continue numbering is false.
pageNumberStyle	PageNumberStyleString	readonly	The page number style. Can return: PageNumberStyle enumerator or String.
pageStart	Page	readonly	The start page for the section.
pagination	PaginationOption: PaginationOption.AUTO_PAGINATE PaginationOption.FROM_LAST_PAGE	readonly	The pagination option for this section for adding and removing pages in HTML5.
paginationMaster	MasterSpread NothingEnum	readonly	The master to apply when pages are added in HTML5. Can also accept: NothingEnum enumerator.
parent	Document	readonly	The parent of the Section (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
sectionPrefix	string	r/w	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.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	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.

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

Parameter	Type	Description
key	string	The key.
value	string	The value.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)