Adobe InCopy CS5 (7.0) Object Model JS: Assignment

InCopy CS5

previous page next page

Class

Assignment

An assignment.

QuickLinks

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

Hierarchy

Document

Assignment

AssignedStory | Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
assignedStories	AssignedStories	readonly	A collection of assigned stories.
documentPath	File	readonly	The path to the document that the hyperlink destination points to.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
exportOptions	AssignmentExportOptions: AssignmentExportOptions.EMPTY_FRAMES AssignmentExportOptions.ASSIGNED_SPREADS AssignmentExportOptions.EVERYTHING	readonly	The content to export in the assignment.
filePath	string	readonly	The file path (colon delimited on the Mac OS). Can also accept: File.
frameColor	3 Reals (0 - 255) NothingEnum UIColors	readonly	The color of the assignment's frames. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum enumerator.
id	number	readonly	The unique ID of the Assignment.
includeLinksWhenPackage	bool	r/w	If true, includes linked files when packaging the assignment.
index	number	readonly	The index of the Assignment 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	readonly	The name of the Assignment.
packageUpToDate	bool	readonly	If true, the assignment package is up to date.
packaged	bool	readonly	If true, the assignment is packaged.
parent	Document	readonly	The parent of the Assignment (a Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
userName	string	readonly	The user name to assign to tracked changes and notes.

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)

File createPackage (filePath: File, packageType: PackageType[, submit: bool=true][, includeAdded: bool=true][, withProperties: Object])
Creates an assignment package.

Parameter	Type	Description
filePath	File	The full path name of the assignment pacakge file.
packageType	PackageType: PackageType.FORWARD_PACKAGE PackageType.RETURN_PACKAGE	The package type.
submit	bool	If true, submit assigned stories before packaging the assignment. (Optional) (default: true)
includeAdded	bool	If true, includes added links in the assginment package. (Optional) (default: true)
withProperties	Object	Initial values for properties of the new Assignment (Optional)

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

Parameter	Type	Description
key	string	The key.

Array of Assignment 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)