An assignment.
assignment elements
| Name | Refer to By |
|---|---|
| assigned stories | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
assignment properties
| Property | Type | Access | Description | ||
|---|---|---|---|---|---|
| assignment file status | assignment status enumeration | read | The status of the assignment file.
|
||
| class | integer | read | The class descriptor type. | ||
| document path | string | read | The path to the document this destination points to. | ||
| export options | Assignment export options enumeration | r/w | The fidelity of the assignment proxy file.
|
||
| file path | alias or string | read | The file path. | ||
| frame color | list of 3 fixed (0 – 255), UI colors enumeration | r/w | The color of the assignment’s frames.
|
||
| id | integer | read | A unique number identifying the object. | ||
| index | integer | 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. | ||
| object reference | object | read | An object reference for this object. | ||
| parent | object | read | The parent of the object. | ||
| properties | record | r/w | Property that allows setting of several properties at the same time. | ||
| user name | string | r/w | The user name for tracked changes and notes. |
assignment methods
| Method | Returns | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| delete | assignment | Delete an assignment and its file. | |||||||||
| extract label | string | Gets the content of the label associated with the specified key (name).
|
|||||||||
| insert label | 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. |