Class

Assignment

 An assignment.

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier, update

Hierarchy

Document

Assignment

AssignedStory

Properties

Property	Type	Access	Description
assignedStories	AssignedStories	readonly	A collection of assigned stories.
assignmentFileStatus	AssignmentStatus: AssignmentStatus.ASSIGNMENT_UP_TO_DATE AssignmentStatus.ASSIGNMENT_OUT_OF_DATE AssignmentStatus.ASSIGNMENT_FILE_MISSING	readonly	The status of the assignment file.
documentPath	string	readonly	The file path to the document that contains the page that the hyperlink jumps to. Note: Valid only when hyperlink destination is an external page. For information, see hyperlink desination and hyperlink external page destination.
exportOptions	AssignmentExportOptions: AssignmentExportOptions.EMPTY_FRAMES AssignmentExportOptions.ASSIGNED_SPREADS AssignmentExportOptions.EVERYTHING	r/w	The content to export in the assignment.
filePath	File	readonly	The full path to the file.
frameColor	3 Reals (0 - 255) UIColors	r/w	The color of the frames in the assignment, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
id	number	readonly	The unique ID of the Assignment.
index	number	readonly	The index of the Assignment within its containing object.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the Assignment.
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	r/w	The user name to assign to tracked changes and notes.

Methods

Instances

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

Parameter	Type	Description
key	string	The 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.

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

Assignment remove ()
Deletes the assignment and its file.

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

string toSpecifier ()
Retrieves the object specifier.

void update ()
Updates the assignment file.

Element of

AssignedStory.parent

Used in:

AssignedStory AssignedStory.move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])

array of Assignment Assignments.itemByRange (from: any, to: any)

Assignment Assignments.nextItem (obj: Assignment)

Assignment Assignments.previousItem (obj: Assignment)

Return

Assignment Assignment.remove ()

Assignment Assignments.add (filePath: File[, withProperties: Object])

Assignment Assignments.anyItem ()

Array of Assignment Assignments.everyItem ()

Assignment Assignments.firstItem ()

Assignment Assignments.item (index: any)

Assignment Assignments.itemByID (id: number)

Assignment Assignments.itemByName (name: string)

Array of Assignment Assignments.itemByRange (from: any, to: any)

Assignment Assignments.lastItem ()

Assignment Assignments.middleItem ()

Assignment Assignments.nextItem (obj: Assignment)

Assignment Assignments.previousItem (obj: Assignment)

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index