BookContent
A book content object.
BookContent Properties
| Property |
Type |
Access |
Description |
| date |
Date |
read |
Date and time. |
| documentPageRange |
String |
read |
The page range of the book content document. |
| fullName |
File |
read |
The full path including the name. |
| 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. |
| parent |
Object |
read |
The parent of the object. |
| properties |
An array of property names and values |
r/w |
Property that allows setting of several properties at the same time. |
| size |
Long |
read |
Size of the book content file. |
| status |
BookContentStatus enumeration |
read |
The status of the book content. |
BookContent Methods
| Method |
Returns |
Description |
| extractLabel |
String |
Gets the content of the label associated with the specified key (name). |
| getElements |
Array of Objects |
Resolve the object specifier. |
| insertLabel |
Nothing |
Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| move |
BookContent |
Moves the book content before/after another book content, or to beginning/end of the book. |
| remove |
Nothing |
Delete the object. |
| replace |
BookContent |
Replaces the book content. |
| synchronize |
Nothing |
Synchronizes this book content to the style source document. |
| toSource |
String |
Generate JavaScript source that, if executed, will return the specified objects. |
| toSpecifier |
String |
Retrieve the object specifier. |
Previous post: BookContents
Next post: Book