book

A books.

book elements

Name Refer to By
book contents by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID
synchronize options by numeric index, as a range of elements, before/after another element, satisfying a
test

book properties

Property Type Access Description
automatic document conversion boolean r/w If true, automatically convert book content documents during repagination and
synchronization.
automatic pagination boolean r/w If true, automatically repaginate book content documents when pagination changes.
class integer read The class descriptor type.
file path alias or string read The file path.
full name alias or string read The full path including the name.
index integer read Index of the object within its parent object.
insert blank page boolean r/w If true, insert blank pages as necessary to meet the repagination options settings.
modified boolean read If true, the book has been modified since it was last saved.
name string read The name of the object.
object reference object read An object reference for this object.
package for GoLive preferences package for GoLive preference read The default Package For GoLive preferences.
parent object read The parent of the object.
print preferences print preference read Print preferences.
properties record r/w Property that allows setting of several properties at the same time.
repagination option repaginate option enumeration r/w Options for repagination.
enumerations
next page, next odd page, next even page
saved boolean read If true, the book has been saved since it was created.
style source document document r/w Current master document.

book methods

Method Returns Description
close Nothing Closes the book.
Parameter Type Description
[saving] save
options enumeration		 Whether to save changes before closing the
object.
enumerations
no, ask,
yes
[saving in] alias or
string		 The file in which to save the object.
export Nothing Export the book to PDF.
Parameter Type Description
[to] alias or
string		 The file to which to export the book.
package boolean Packages the document.
Parameter Type Description
copying
fonts		 boolean Whether to copy required
fonts.
copy-ing linked graphics boolean Whether to
copy linked graphics file.
copying
profiles		 boolean Whether to copy profiles.
creating
report		 boolean Whether to create package
report.
ignore pre-flight er-rors boolean Whether
to ignore preflight errors and package anyways.
includ-ing hidden
layers		 boolean Whether to include objects on hidden
layers.
to alias or string A folder, alias or path as
string in which to place the packaged files.
updating
graphics		 boolean Whether to update graphics links before
packaging.
package for GoLive boolean Packages for GoLive.
Parameter Type Description
location alias or
string		 File location for package.
[objects] list of
pages, page items or texts		 Objects location for package.
print Nothing Print the object.
Parameter Type Description
[print
dialog]		 boolean Whether to invoke the print
dialog.
[using] default/cus-tom or printer
preset		 Printer preset to use.
repaginate Nothing Repaginates the book.
save Nothing Saves the book.
Parameter Type Description
[to] alias or
string		 Where to save the book. If the book is already saved, a copy is saved
at this path, the original file is closed the new copy is opened.
synchronize Nothing Synchronizes all of the documents in the book to the style source document.

Leave a Comment

Previous post:

Next post: