Object

Book

A book.

Hierarchy

Application

Book

BookContent

5 preference objects

EPubExportPreference | EPubFixedLayoutExportPreference | Preference | PreflightBookOption | PrintPreference

Properties

Type	Access	Description
Boolean	read/write	If true, automatically converts the book content object during repagination and synchronization.
Boolean	read/write	If true, automatically updates page numbers when pages in book content files are added, deleted, or rearranged.
BookContents<BookContent>	readonly	A collection of book content objects.
EPubExportPreference	readonly	EPub export preference settings.
EPubFixedLayoutExportPreference	readonly	EPub fixed layout export preference settings.
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
Folder	readonly	The path to the folder containing the book.
File	readonly	The full path to the Book, including the name of the Book.
Number	readonly	The index of the Book within its containing object.
Boolean	read/write	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.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
Boolean	read/write	If true, merges identically named layers when exporting to PDF.
Boolean	readonly	If true, the Book has been modified since it was last saved.
String	readonly	The name of the Book.
Application	readonly	The parent of the Book (a Application).
Preferences<Preference>	readonly	A collection of preferences objects.
PreflightBookOption	readonly	Preflight book option settings.
PrintPreference	readonly	Print preference settings.
Object	read/write	A property that allows setting of several properties at the same time.
RepaginateOption	read/write	Page numbering options for book content objects within the book.
Boolean	readonly	If true, the Book has been saved since it was created.
SmartMatchOptions	read/write	How to match styles with same name while synchronizing a book.
Document \| BookContent	read/write	Current style source document. Can return: Document or BookContent.
Boolean	read/write	If true, synchronize bullets and numbering.
Boolean	read/write	If true, synchronize cell styles.
Boolean	read/write	If true, synchronize character styles.
Boolean	read/write	If true, synchronize conditional text.
Boolean	read/write	If true, synchronize cross reference formats
Boolean	read/write	If true, synchronize master pages.
Boolean	read/write	If true, synchronize object styles.
Boolean	read/write	If true, synchronize paragraph styles.
Boolean	read/write	If true, synchronize swatches.
Boolean	read/write	If true, synchronize table of content styles.
Boolean	read/write	If true, synchronize table styles.
Boolean	read/write	If true, synchronize text variables.
Boolean	read/write	If true, synchronize trap styles.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ void

Close the Book

saving? SaveOptions Whether to save changes before closing the Book

savingIn? File The file in which to save the Book

versionComments? String The comment for this version

forceSave? Boolean Forcibly save a version

→ void

Exports the book to a file.

format ExportFormat | String 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.

showingOptions? Boolean Used to specify if the PDF Export Options Dialog needs to be shown or not

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

whichDocuments? 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

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ String

Gets the label value associated with the specified key.

key String The key.

→ Book[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.

value String The value.

→ Boolean

Packages the document.

to File The folder, alias, or path in which to place the packaged files.

copyingFonts Boolean If true, copies fonts used in the document to the package folder.

copyingLinkedGraphics Boolean If true, copies linked graphics files to the package folder.

copyingProfiles Boolean If true, copies color profiles to the package folder.

updatingGraphics Boolean If true, updates graphics links to the package folder.

includingHiddenLayers Boolean If true, copies fonts and links from hidden layers to the package.

ignorePreflightErrors Boolean If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist.

creatingReport Boolean If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information.

includeIdml? Boolean If true, generates and includes IDML in the package folder.

includePdf? Boolean If true, generates and includes PDF in the package folder.

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.

useDocumentHyphenationExceptionsOnly? Boolean 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.

versionComments? String The comments for the version.

forceSave? Boolean If true, forcibly saves a version.

→ void

Preflight a book and optionally save the resulting report.

to? File The preflight report to save to.

autoOpen? Boolean If true, automatically open the report after creation.

→ void

Prints the Book(s).

printDialog? Boolean Whether to invoke the print dialog

using? PrinterPresetTypes | PrinterPreset Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset.

→ Boolean

Removes the event listener.

eventType String The registered event type.

handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ void

Repaginates the book.

→ void

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.

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ void

Synchronizes the entire book to the style source document.

→ String

Generates a string which, if executed, will return the Book.

→ String

Retrieves the object specifier.

→ void

Updates the cross references in the entire book.

→ void

Update all numbers (e.g. Page numbers, chapter numbers and paragraph numbers) throughout the book.

→ void

Updates chapter numbers and paragraph numbers throughout the book.

Object of 10

Properties elsewhere that hold a Book.

Application.activeBook BookContent.parent EPubExportPreference.parent EPubFixedLayoutExportPreference.parent Event.parent EventListener.parent MutationEvent.parent Preference.parent PreflightBookOption.parent PrintPreference.parent

Parameter of 4

Method parameters that accept a Book.

Books.itemByRange(from)Books.nextItem(obj)Books.previousItem(obj)Document.createTOC(fromBook)

Return 13

Methods that return a Book.

Book.getElements()Books.[]()Books.add()Books.anyItem()Books.everyItem()Books.firstItem()Books.item()Books.itemByName()Books.itemByRange()Books.lastItem()Books.middleItem()Books.nextItem()Books.previousItem()