Adobe InCopy CS5 (7.0) Object Model JS: DocumentPreset

previous page next page

Class

DocumentPreset

A preset that contains all of the new document settings.

DocumentPreset

Property	Type	Access	Description
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
facingPages	bool	r/w	If true, the document has facing pages.
id	number	readonly	The unique ID of the DocumentPreset.
index	number	readonly	The index of the DocumentPreset 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.
name	string	r/w	The name of the DocumentPreset.
pageHeight	Measurement Unit (Number or String)	r/w	The height of the page.
pageSize	string	r/w	The size of the page.
pageWidth	Measurement Unit (Number or String)	r/w	The width of the page.
parent	Application	readonly	The parent of the DocumentPreset (a Application).
properties	Object	r/w	A property that allows setting of several properties at the same time.
textAreaDepth	number	r/w	The depth of the text area.
textAreaDepthUnit	TextAreaDepthUnit: TextAreaDepthUnit.DEPTH_CHARS TextAreaDepthUnit.DEPTH_WORDS TextAreaDepthUnit.DEPTH_LINES TextAreaDepthUnit.DEPTH_COLUMN_INCHES TextAreaDepthUnit.DEPTH_PAGES	r/w	The unit in which to measure the text area depth.
textAreaWidth	Measurement Unit (Number or String)	r/w	The width of the text area.

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)

DocumentPreset duplicate ()
Duplicates the DocumentPreset.

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

Parameter	Type	Description
key	string	The key.

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

void remove ()
Deletes the DocumentPreset.

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)