Assignment

An assignment.

Go to Property Listing | Method Listing

Methods:

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

Objects:

AssignedStories, AssignmentExportOptions, AssignmentStatus, File, Number, Object, String, UIColors,

Preferences:

AssignmentExportOptions

Property Listing

Property	Type	Access	Description
assignedStories	AssignedStories AssignedStory	readonly	A collection of assigned stories.
assignmentFileStatus	AssignmentStatus AssignmentStatus.ASSIGNMENT_FILE_MISSING AssignmentStatus.ASSIGNMENT_OUT_OF_DATE AssignmentStatus.ASSIGNMENT_UP_TO_DATE	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.ASSIGNED_SPREADS AssignmentExportOptions.EMPTY_FRAMES AssignmentExportOptions.EVERYTHING	read/write	The content to export in the assignment.
filePath	File	readonly	The full path to the file.
frameColor	Array of 3 Reals (0 - 255) UIColors	read/write	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	read/write	A property that can be set to any string.
name	String	read/write	The name of the Assignment.
parent	Document	readonly	The parent of the Assignment (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
userName	String	read/write	The user name to assign to tracked changes and notes.

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Object getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined update ()

Updates the assignment file.

Object of

AssignedStory.parent

Return

Assignments.add()

Assignment.remove()

Assignments.anyItem()

Assignments.everyItem()

Assignments.nextItem()

Assignments.previousItem()

Assignments.itemByID()

Assignments.item()

Assignments.itemByName()

Assignments.itemByRange()

Assignments.firstItem()

Assignments.lastItem()

Assignments.middleItem()