K4 InDesign Javascript API Documentation

BookBook

A book.

Instance Properties

Name Description Access
automaticDocumentConversion bool If true, automatically converts the book content object during repagination and synchronization. read-write
automaticPagination bool If true, automatically updates page numbers when pages in book content files are added, deleted, or rearranged. read-write
bookContents BookContents A collection of book content objects. read-only
epubExportPreferences EPubExportPreference EPub export preference settings. read-only
epubFixedLayoutExportPreferences EPubFixedLayoutExportPreference EPub fixed layout export preference settings. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
filePath File The full path to the file. read-only
fullName File The full path to the Book, including the name of the Book. read-only
index number The index of the Book within its containing object. read-only
insertBlankPage bool 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. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
mergeIdenticalLayers bool If true, merges identically named layers when exporting to PDF. read-write
modified bool If true, the Book has been modified since it was last saved. read-only
name string The name of the Book. read-only
parent Application The parent of the Book (a Application). read-only
preferences Preferences A collection of preferences objects. read-only
preflightBookOptions PreflightBookOption Preflight book option settings. read-only
printPreferences PrintPreference Print preference settings. read-only
properties Object A property that allows setting of several properties at the same time. read-write
repaginationOption RepaginateOption Page numbering options for book content objects within the book. read-write
saved bool If true, the Book has been saved since it was created. read-only
smartMatchStyleGroups SmartMatchOptions How to match styles with same name while synchronizing a book. read-write
styleSourceDocument Current style source document. Can return: Document or BookContent. read-write
synchronizeBulletNumberingList bool If true, synchronize bullets and numbering. read-write
synchronizeCellStyle bool If true, synchronize cell styles. read-write
synchronizeCharacterStyle bool If true, synchronize character styles. read-write
synchronizeConditionalText bool If true, synchronize conditional text. read-write
synchronizeCrossReferenceFormat bool If true, synchronize cross reference formats read-write
synchronizeMasterPage bool If true, synchronize master pages. read-write
synchronizeObjectStyle bool If true, synchronize object styles. read-write
synchronizeParagraphStyle bool If true, synchronize paragraph styles. read-write
synchronizeSwatch bool If true, synchronize swatches. read-write
synchronizeTableOfContentStyle bool If true, synchronize table of content styles. read-write
synchronizeTableStyle bool If true, synchronize table styles. read-write
synchronizeTextVariable bool If true, synchronize text variables. read-write
synchronizeTrapStyle bool If true, synchronize trap styles. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
close(
[saving] ​[, savingIn] ​[, versionComments] ​[, forceSave])
exportFile(
format ​[, to] ​[, showingOptions] ​[, using] ​[, whichDocuments] ​[, versionComments] ​[, forceSave])
extractLabel(
key)
  → string
getElements(
)
  → Book
insertLabel(
key, value)
packageForPrint(
to, copyingFonts, copyingLinkedGraphics, copyingProfiles, updatingGraphics, includingHiddenLayers, ignorePreflightErrors, creatingReport ​[, includeIdml] ​[, includePdf] ​[, pdfStyle] ​[, useDocumentHyphenationExceptionsOnly] ​[, versionComments] ​[, forceSave])
  → bool
preflight(
[to] ​[, autoOpen])
print(
[printDialog], using)
removeEventListener(
eventType, handler ​[, captures])
  → bool
repaginate(
)
save(
[to] ​[, versionComments] ​[, forceSave])
synchronize(
)
toSource(
)
  → string
toSpecifier(
)
  → string
updateAllCrossReferences(
)
updateAllNumbers(
)
updateChapterAndParagraphNumbers(
)
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
close(
[saving=SaveOptions.ASK] ​[, savingIn] ​[, versionComments] ​[, forceSave=false])
Close the Book
saving SaveOptions Whether to save changes before closing the Book (Optional)
savingIn File The file in which to save the Book (Optional)
versionComments string The comment for this version (Optional)
forceSave bool Forcibly save a version (Optional)
exportFile(
format ​[, to] ​[, showingOptions=false] ​[, using] ​[, whichDocuments] ​[, versionComments] ​[, forceSave=false])
Exports the book to a file.
format The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
to File The file to which to export the book. (Optional)
showingOptions bool Used to specify if the PDF Export Options Dialog needs to be shown or not (Optional)
using PDFExportPreset Used to specify the presets for the export which can be the object of the preset type, enumeration for existing presets or user defined presets, or a string naming the preset to be used, but in case Showing Options is true, the preset specified in the Export Dialog will over ride this parameter (Optional)
whichDocuments Array<BookContent> Used to specify a list of book content references, from the current book, where the list may contain duplicate entries and if the list is not specified then the entire book contents shall be exported (Optional)
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Book
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
packageForPrint(
to, copyingFonts, copyingLinkedGraphics, copyingProfiles, updatingGraphics, includingHiddenLayers, ignorePreflightErrors, creatingReport ​[, includeIdml] ​[, includePdf] ​[, pdfStyle] ​[, useDocumentHyphenationExceptionsOnly] ​[, versionComments] ​[, forceSave=false])
  → bool
Packages the document.
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.
includeIdml bool If true, generates and includes IDML in the package folder. (Optional)
includePdf bool If true, generates and includes PDF in the package folder. (Optional)
pdfStyle string If specified and PDF is to be included, use this style for PDF export if it is valid, otherwise use the last used PDF preset. (Optional)
useDocumentHyphenationExceptionsOnly bool If this option is selected, InDesign flags this document so that it does not reflow when someone else opens or edits it on a computer that has different hyphenation and dictionary settings. (Optional)
versionComments string The comments for the version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
preflight(
[to] ​[, autoOpen=false])
Preflight a book and optionally save the resulting report.
to File The preflight report to save to. (Optional)
autoOpen bool If true, automatically open the report after creation. (Optional)
print(
[printDialog], using)
Prints the Book(s).
printDialog bool Whether to invoke the print dialog (Optional)
using Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
repaginate(
)
Repaginates the book.
save(
[to] ​[, versionComments] ​[, forceSave=false])
Saves the book.
to File The file path. Note: Required only if the book has not been previously saved. If the book has previously been saved, specifying a path saves a copy and closes the original book. (Optional)
versionComments string The comment for this version. (Optional)
forceSave bool If true, forcibly saves a version. (Optional)
synchronize(
)
Synchronizes the entire book to the style source document.
toSource(
)
  → string
Generates a string which, if executed, will return the Book.
toSpecifier(
)
  → string
Retrieves the object specifier.
updateAllCrossReferences(
)
Updates the cross references in the entire book.
updateAllNumbers(
)
Update all numbers (e.g. Page numbers, chapter numbers and paragraph numbers) throughout the book.
updateChapterAndParagraphNumbers(
)
Updates chapter numbers and paragraph numbers throughout the book.