BookContent
QuickLinks
Hierarchy
Properties
Property | Type | Access | Description |
---|---|---|---|
date | Date | readonly | The date and time the BookContent was created. |
documentPageRange | string | readonly | The page range of the book content object within the book. |
filePath | File | readonly | The full path to the file. |
fullName | File | readonly | The full path to the BookContent, including the name of the BookContent. |
id | number | readonly | The unique ID of the BookContent. |
index | number | readonly | The index of the BookContent within its containing object. |
isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
label | string | r/w | A property that can be set to any string. |
parent | Book | readonly | The parent of the BookContent (a Book). |
properties | Object | r/w | A property that allows setting of several properties at the same time. |
size | number | readonly | The size of the BookContent file. |
status | BookContentStatus: BookContentStatus.NORMAL BookContentStatus.MISSING_DOCUMENT BookContentStatus.DOCUMENT_OUT_OF_DATE BookContentStatus.DOCUMENT_IN_USE BookContentStatus.DOCUMENT_IS_OPEN |
readonly | The status of the book content object file. |
Methods
Instances
string extractLabel (key:
string)
Gets the label value associated with the specified key.
Parameter | Type | Description |
---|---|---|
key | string | The key. |
Array of BookContent getElements ()
Resolves the object specifier, creating an array of object references.
void 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. |
BookContent move ([to:
LocationOptions=LocationOptions.AT_END][, reference:
BookContent])
Moves the book content object.
Parameter | Type | Description |
---|---|---|
to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location relative to the reference object or within the book. (Optional) (default: LocationOptions.AT_END) |
reference | BookContent | The reference object. Note: Required when the to parameter specifies before or after. (Optional) |
void preflight ([to:
File][, autoOpen:
bool=false])
Preflight a book content object and optionally save the resulting report.
Parameter | Type | Description |
---|---|---|
to | File | The preflight report to save to. (Optional) |
autoOpen | bool | If true, automatically open the report after creation. (Optional) (default: false) |
void remove ()
Deletes the BookContent.
BookContent replace (using:
File)
Replaces a book content object with a new file. Note: If the new file replaces the current style source document, the new file becomes the style source document.
Parameter | Type | Description |
---|---|---|
using | File | The full path name of the new book content object. |
void synchronize ()
Matches the formatting of the book content object to the style source document.
string toSource ()
Generates a string which, if executed, will return the BookContent.
string toSpecifier ()
Retrieves the object specifier.
Element of
Book.styleSourceDocument
Used in:
void Book.exportFile ([to: File][, showingOptions: bool=false][, using: PDFExportPreset][, whichDocuments: Array of BookContent][, versionComments: string][, forceSave: bool=false])
BookContent BookContent.move ([to: LocationOptions=LocationOptions.AT_END][, reference: BookContent])
array of BookContent BookContents.itemByRange (from: any, to: any)
BookContent BookContents.nextItem (obj: BookContent)
BookContent BookContents.previousItem (obj: BookContent)
Return
Array of BookContent BookContent.getElements ()
BookContent BookContent.move ([to: LocationOptions=LocationOptions.AT_END][, reference: BookContent])
BookContent BookContent.replace (using: File)
BookContent BookContents.[] (index: number)
BookContent BookContents.add (fullName: File[, at: number=-1][, withProperties: Object])
BookContent BookContents.anyItem ()
Array of BookContent BookContents.everyItem ()
BookContent BookContents.firstItem ()
BookContent BookContents.item (index: any)
BookContent BookContents.itemByID (id: number)
BookContent BookContents.itemByName (name: string)
Array of BookContent BookContents.itemByRange (from: any, to: any)
BookContent BookContents.lastItem ()
BookContent BookContents.middleItem ()
BookContent BookContents.nextItem (obj: BookContent)
BookContent BookContents.previousItem (obj: BookContent)
Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |