Book
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| automaticDocumentConversion | bool | r/w | If true, automatically converts the book content object during repagination and synchronization. |
| automaticPagination | bool | r/w | If true, automatically updates page numbers when pages in book content files are added, deleted, or rearranged. |
| bookContents | BookContents | readonly | A collection of book content objects. |
| filePath | File | readonly | The full path to the file. |
| fullName | File | readonly | The full path to the Book, including the name of the Book. |
| index | number | readonly | The index of the Book within its containing object. |
| insertBlankPage | bool | r/w | If true, inserts a blank page as necessary to fill in page number gaps caused by the odd or even specification set in the repagination option. |
| modified | bool | readonly | If true, the Book has been modified since it was last saved. |
| name | string | readonly | The name of the Book. |
| packageForGoLivePreferences | PackageForGoLivePreference | readonly | The Package For GoLive preference properties that define how a document is packaged for GoLive. |
| parent | Application | readonly | The parent of the Book (a Application). |
| printPreferences | PrintPreference | readonly | Print preference settings. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| repaginationOption | RepaginateOption: RepaginateOption.NEXT_PAGE RepaginateOption.NEXT_ODD_PAGE RepaginateOption.NEXT_EVEN_PAGE |
r/w | Page numbering options for book content objects within the book. |
| saved | bool | readonly | If true, the Book has been saved since it was created. |
| styleSourceDocument | Document | r/w | The book content object used as the style source document. |
| synchronizeOptions | SynchronizeOptions | readonly | A collection of book synchronization option styles. |
Methods
Instances
void close ([saving:
SaveOptions=SaveOptions.ASK][, savingIn:
File])
Closes the Book.
| Parameter | Type | Description |
|---|---|---|
| saving | SaveOptions: SaveOptions.NO SaveOptions.ASK SaveOptions.YES | The option for saving changes. (Optional) (default: SaveOptions.ASK) |
| savingIn | File | The file path of the saved document. Note: Required only when saving the document for the first time. If the document has previously been saved, specifying a path saves a copy and closes the original document. (Optional) |
void exportFile ([to:
File])
Exports the book to PDF.
| Parameter | Type | Description |
|---|---|---|
| to | File | The full path name, including the file extension '.pdf', of the pdf file. (Optional) |
Array
of Object getElements ()
Resolves the object specifier, creating an array of object references.
bool packageForGoLive (location:
File[, objects:
Array
of any])
Packages for GoLive
| Parameter | Type | Description |
|---|---|---|
| location | File | File location for package |
| objects |
Array
of : Array of Pages PageItems Texts | Objects location for package. Can accept: Array of Pages, PageItems or Texts. (Optional) |
bool packageForPrint (to:
File, copyingFonts:
bool, copyingLinkedGraphics:
bool, copyingProfiles:
bool, updatingGraphics:
bool, includingHiddenLayers:
bool, ignorePreflightErrors:
bool, creatingReport:
bool)
Packages the document for handoff to a service provider.
| Parameter | Type | Description |
|---|---|---|
| to | File | The folder, alias, or path in which to place the packaged files. |
| copyingFonts | bool | If true, copies fonts used in the document to the package folder. |
| copyingLinkedGraphics | bool | If true, copies linked graphics files to the package folder. |
| copyingProfiles | bool | If true, copies color profiles to the package folder. |
| updatingGraphics | bool | If true, updates graphics links to the package folder. |
| includingHiddenLayers | bool | If true, copies fonts and links from hidden layers to the package. |
| ignorePreflightErrors | bool | If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist. |
| creatingReport | bool | If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information. |
void print ([printDialog:
bool][, using:
any])
Prints the Book(s).
| Parameter | Type | Description |
|---|---|---|
| printDialog | bool | Whether to invoke the print dialog (Optional) |
| using | PrinterPreset PrinterPresetTypes | Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional) |
void repaginate ()
Repaginates the book.
void save ([to:
File])
Saves the book.
| Parameter | Type | Description |
|---|---|---|
| to | File | The full path name, including the book file extension '.indb', that specifies where to save the book. (Optional) |
void synchronize ()
Synchronizes the entire book to the style source document.
string toSource ()
Generates a string which, if executed, will return the Book.
Element of
BookContent.parent
PackageForGoLivePreference.parent
PrintPreference.parent
SynchronizeOption.parent
Used in:
array of Book Books.itemByRange (from: any, to: any)
Book Books.nextItem (obj: Book)
Book Books.previousItem (obj: Book)
array of Story Document.createTOC (using: TOCStyle[, replacing: bool=false][, fromBook: Book][, placePoint: Array of Measurement Unit (Number or String)][, includeOverset: bool=false][, destinationLayer: Layer])
Return
Book Books.add (fullName: File[, withProperties: Object])
Book Books.anyItem ()
Array of Book Books.everyItem ()
Book Books.firstItem ()
Book Books.item (index: any)
Book Books.itemByName (name: string)
Array of Book Books.itemByRange (from: any, to: any)
Book Books.lastItem ()
Book Books.middleItem ()
Book Books.nextItem (obj: Book)
Book Books.previousItem (obj: Book)
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |