InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

Assignment

An assignment.

Hierarchy

Document

Assignment

AssignedStory

Properties

NameType AccessDescription
AssignedStories<AssignedStory> readonly A collection of assigned stories.
AssignmentStatus
 readonly The status of the assignment file.
File readonly The path to the document that the hyperlink destination points to.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
AssignmentExportOptions
 read/write The content to export in the assignment.
String | File readonly The file path (colon delimited on the Mac OS). Can also accept: File.
3 Reals (0 - 255)[] | NothingEnum[] | UIColors[]
 read/write The color of the assignment's frames. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum enumerator.
Number readonly The unique ID of the Assignment.
Boolean read/write If true, includes linked files when packaging the assignment.
Number readonly The index of the Assignment within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the Assignment.
Boolean readonly If true, the assignment package is up to date.
Boolean readonly If true, the assignment is packaged.
Document readonly The parent of the Assignment (a Document).
Object read/write A property that allows setting of several properties at the same time.
String read/write The user name to assign to tracked changes and notes.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Cancels the package for an assignment.

→ File

Creates an assignment package.

filePath File The full path name of the assignment package file.
submit? Boolean If true, submits assigned stories before packaging the assignment.
withProperties? Object Initial values for properties of the new Assignment
→ String

Gets the label value associated with the specified key.

key String The key.
→ Assignment[]

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

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the assignment and its file.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

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

→ String

Retrieves the object specifier.

→ void

Updates the assignment file.

versionComments? String The comment for this version.
forceSave? Boolean If true, forcibly saves a version.

Object of 4

Properties elsewhere that hold a Assignment.

AssignedStory.parentEvent.parentEventListener.parentMutationEvent.parent

Parameter of 4

Method parameters that accept a Assignment.

AssignedStory.move(reference)Assignments.itemByRange(from)Assignments.nextItem(obj)Assignments.previousItem(obj)

Return 14

Methods that return a Assignment.

Assignment.getElements()Assignments.[]()Assignments.add()Assignments.anyItem()Assignments.everyItem()Assignments.firstItem()Assignments.item()Assignments.itemByID()Assignments.itemByName()Assignments.itemByRange()Assignments.lastItem()Assignments.middleItem()Assignments.nextItem()Assignments.previousItem()