Book

Methods:

close, exportFile, getElements, packageForGoLive, packageForPrint, print, repaginate, save, synchronize, toSource, toSpecifier

Objects:

BookContents, Boolean, Document, File, Number, Object, PackageForGoLivePreference, PrintPreference, RepaginateOption, String, SynchronizeOptions

Preferences:

PackageForGoLivePreference, PrintPreference, SynchronizeOptions

Property Listing

Property	Type	Access	Description
automaticDocumentConversion	Boolean	read/write	If true, automatically converts the book content object during repagination and synchronization.
automaticPagination	Boolean	read/write	If true, automatically updates page numbers when pages in book content files are added, deleted, or rearranged.
bookContents	BookContents BookContent	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	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.
modified	Boolean	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	read/write	A property that allows setting of several properties at the same time.
repaginationOption	RepaginateOption RepaginateOption.NEXT_EVEN_PAGE RepaginateOption.NEXT_ODD_PAGE RepaginateOption.NEXT_PAGE	read/write	Page numbering options for book content objects within the book.
saved	Boolean	readonly	If true, the Book has been saved since it was created.
styleSourceDocument	Document	read/write	The book content object used as the style source document.
synchronizeOptions	SynchronizeOptions SynchronizeOption	readonly	A collection of book synchronization option styles.

Method Listing

undefined close ([saving:SaveOptions=SaveOptions], savingIn:File)

Closes the Book.

Parameter	Type	Description
saving	SaveOptions SaveOptions.ASK SaveOptions.NO 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)

Parameter

Type

Description

saving

SaveOptions

SaveOptions.ASK

SaveOptions.NO

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)

undefined 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)

Object getElements ()

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

Boolean packageForGoLive (location:File, objects:Array of Varies Pages PageItems Texts)

Packages for GoLive

Parameter	Type	Description
location	File	File location for package
objects	Array of Pages Array of PageItems PageItem Array of Texts Text	Objects location for package. Can accept: Array of Pages, PageItems or Texts. (Optional)

Parameter

Type

Description

location

File

File location for package

objects

Array of Pages

Array of PageItems PageItem

Array of Texts Text

Objects location for package. Can accept: Array of Pages, PageItems or Texts. (Optional)

Boolean packageForPrint (to:File, copyingFonts:Boolean, copyingLinkedGraphics:Boolean, copyingProfiles:Boolean, updatingGraphics:Boolean, includingHiddenLayers:Boolean, ignorePreflightErrors:Boolean, creatingReport:Boolean)

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	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.

undefined print (printDialog:Boolean, using:Varies PrinterPresetTypes PrinterPreset)

Prints the Book(s).

Parameter	Type	Description
printDialog	Boolean	Whether to invoke the print dialog (Optional)
using	PrinterPresetTypes PrinterPresetTypes.CUSTOM PrinterPresetTypes.DEFAULT_VALUE PrinterPreset	Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

Parameter

Type

Description

printDialog

Boolean

Whether to invoke the print dialog (Optional)

using

PrinterPresetTypes

PrinterPresetTypes.CUSTOM

PrinterPresetTypes.DEFAULT_VALUE

PrinterPreset

Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)