Assignment
An assignment.
Assignment Properties
| Property |
Type |
Access |
Description |
| AssignedStories |
AssignedStories |
read |
Every assigned story. |
| AssignmentFileStatus |
idAssignmentStatus enumeration |
read |
The status of the assignment file. |
| DocumentPath |
String |
read |
The path to the document this destination points to. |
| ExportOptions |
idAssignmentExportOptions enumeration |
r/w |
The fidelity of the assignment proxy file. |
| FilePath |
File (String) |
read |
The file path. |
| FrameColor |
Array of 3 Doubles (0 – 255), idUIColors enumeration (see table at end of chapter) |
r/w |
The color of the assignment’s frames. |
| Id |
Long |
read |
A unique number identifying the object. |
| Index |
Long |
read |
Index of the object within its parent object. |
| Label |
String |
r/w |
A label that can be set to any string. |
| Name |
String |
r/w |
The name of the object. |
| Parent |
Object |
read |
The parent of the object. |
| UserName |
String |
r/w |
The user name for tracked changes and notes. |
Assignment Methods
| Method |
Returns |
Description |
| Delete |
Assignment |
Deletes the object. |
| ExtractLabel |
String |
Gets the content of the label associated with the specified key (name). |
| InsertLabel |
Nothing |
Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| Update |
Nothing |
Update an assignment file. |
Previous post: Assignments
Next post: AssignedStory