Packagecom.adobe.indesign
Classpublic class Book
InheritanceBook Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  automaticDocumentConversion : Boolean
If true, automatically converts the book content object during repagination and synchronization.
Book
  automaticPagination : Boolean
If true, automatically updates page numbers when pages in book content files are added, deleted, or rearranged.
Book
  bookContents : BookContents
[read-only] A collection of book content objects.
Book
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Book
  events : Events
[read-only] A collection of events.
Book
  filePath : File
[read-only] The full path to the file.
Book
  fullName : File
[read-only] The full path to the Book, including the name of the Book.
Book
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the Book within its containing object.
Book
  insertBlankPage : Boolean
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.
Book
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Book
  label : String
A property that can be set to any string.
Book
  mergeIdenticalLayers : Boolean
If true, merges identically named layers when exporting to PDF.
Book
  modified : Boolean
[read-only] If true, the Book has been modified since it was last saved.
Book
  name : String
[read-only] The name of the Book.
Book
  parent : Application
[read-only] The parent of the Book (a Application).
Book
  preferences : Preferences
[read-only] A collection of preferences objects.
Book
  preflightBookOptions : PreflightBookOption
[read-only] Preflight book option settings.
Book
  printPreferences : PrintPreference
[read-only] Print preference settings.
Book
  properties : Object
A property that allows setting of several properties at the same time.
Book
  repaginationOption : RepaginateOption
Page numbering options for book content objects within the book.
Book
  saved : Boolean
[read-only] If true, the Book has been saved since it was created.
Book
  smartMatchStyleGroups : SmartMatchOptions
How to match styles with same name while synchronizing a book.
Book
  styleSourceDocument : Object
Current style source document.
Book
  synchronizeBulletNumberingList : Boolean
If true, synchronize bullets and numbering.
Book
  synchronizeCellStyle : Boolean
If true, synchronize cell styles.
Book
  synchronizeCharacterStyle : Boolean
If true, synchronize character styles.
Book
  synchronizeConditionalText : Boolean
If true, synchronize conditional text.
Book
  synchronizeMasterPage : Boolean
If true, synchronize master pages.
Book
  synchronizeObjectStyle : Boolean
If true, synchronize object styles.
Book
  synchronizeParagraphStyle : Boolean
If true, synchronize paragraph styles.
Book
  synchronizeSwatch : Boolean
If true, synchronize swatches.
Book
  synchronizeTableOfContentStyle : Boolean
If true, synchronize table of content styles.
Book
  synchronizeTableStyle : Boolean
If true, synchronize table styles.
Book
  synchronizeTextVariable : Boolean
If true, synchronize text variables.
Book
  synchronizeTrapStyle : Boolean
If true, synchronize trap styles.
Book
Public Methods
 MethodDefined By
  
addEventListenerBook(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Book
  
close(savingParam:SaveOptions = null, savingInParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Close the Book
Book
  
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, whichDocumentsParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Exports the book to a file.
Book
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Book
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
Resolves the object specifier, creating an array of object references.
Book
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Book
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
packageForPrint(toParam:File = null, copyingFontsParam:Boolean, copyingLinkedGraphicsParam:Boolean, copyingProfilesParam:Boolean, updatingGraphicsParam:Boolean, includingHiddenLayersParam:Boolean, ignorePreflightErrorsParam:Boolean, creatingReportParam:Boolean, versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean
Packages the document.
Book
  
preflight(toParam:File = null, autoOpenParam:Boolean = false):void
Preflight a book and optionally save the resulting report.
Book
  
print(printDialogParam:Boolean, usingParam:Object = null):void
Prints the Book(s).
Book
  
removeEventListenerBook(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Book
  
repaginate():void
Repaginates the book.
Book
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
save(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Saves the book.
Book
  
Synchronizes the entire book to the style source document.
Book
  
toSpecifier():String
Retrieves the object specifier.
Book
  
Updates the cross references in the entire book.
Book
  
Update all numbers (e.g.
Book
  
Updates chapter numbers and paragraph numbers throughout the book.
Book
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
automaticDocumentConversionproperty
automaticDocumentConversion:Boolean

If true, automatically converts the book content object during repagination and synchronization.


Implementation
    public function get automaticDocumentConversion():Boolean
    public function set automaticDocumentConversion(value:Boolean):void
automaticPaginationproperty 
automaticPagination:Boolean

If true, automatically updates page numbers when pages in book content files are added, deleted, or rearranged.


Implementation
    public function get automaticPagination():Boolean
    public function set automaticPagination(value:Boolean):void
bookContentsproperty 
bookContents:BookContents  [read-only]

A collection of book content objects.


Implementation
    public function get bookContents():BookContents
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
filePathproperty 
filePath:File  [read-only]

The full path to the file.


Implementation
    public function get filePath():File
fullNameproperty 
fullName:File  [read-only]

The full path to the Book, including the name of the Book.


Implementation
    public function get fullName():File
indexproperty 
index:Number  [read-only]

The index of the Book within its containing object.


Implementation
    public function get index():Number
insertBlankPageproperty 
insertBlankPage:Boolean

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.


Implementation
    public function get insertBlankPage():Boolean
    public function set insertBlankPage(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
mergeIdenticalLayersproperty 
mergeIdenticalLayers:Boolean

If true, merges identically named layers when exporting to PDF.


Implementation
    public function get mergeIdenticalLayers():Boolean
    public function set mergeIdenticalLayers(value:Boolean):void
modifiedproperty 
modified:Boolean  [read-only]

If true, the Book has been modified since it was last saved.


Implementation
    public function get modified():Boolean
nameproperty 
name:String  [read-only]

The name of the Book.


Implementation
    public function get name():String
parentproperty 
parent:Application  [read-only]

The parent of the Book (a Application).


Implementation
    public function get parent():Application
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
preflightBookOptionsproperty 
preflightBookOptions:PreflightBookOption  [read-only]

Preflight book option settings.


Implementation
    public function get preflightBookOptions():PreflightBookOption
printPreferencesproperty 
printPreferences:PrintPreference  [read-only]

Print preference settings.


Implementation
    public function get printPreferences():PrintPreference
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
repaginationOptionproperty 
repaginationOption:RepaginateOption

Page numbering options for book content objects within the book.


Implementation
    public function get repaginationOption():RepaginateOption
    public function set repaginationOption(value:RepaginateOption):void
savedproperty 
saved:Boolean  [read-only]

If true, the Book has been saved since it was created.


Implementation
    public function get saved():Boolean
smartMatchStyleGroupsproperty 
smartMatchStyleGroups:SmartMatchOptions

How to match styles with same name while synchronizing a book.


Implementation
    public function get smartMatchStyleGroups():SmartMatchOptions
    public function set smartMatchStyleGroups(value:SmartMatchOptions):void
styleSourceDocumentproperty 
styleSourceDocument:Object

Current style source document. Can return: Document or BookContent.


Implementation
    public function get styleSourceDocument():Object
    public function set styleSourceDocument(value:Object):void
synchronizeBulletNumberingListproperty 
synchronizeBulletNumberingList:Boolean

If true, synchronize bullets and numbering.


Implementation
    public function get synchronizeBulletNumberingList():Boolean
    public function set synchronizeBulletNumberingList(value:Boolean):void
synchronizeCellStyleproperty 
synchronizeCellStyle:Boolean

If true, synchronize cell styles.


Implementation
    public function get synchronizeCellStyle():Boolean
    public function set synchronizeCellStyle(value:Boolean):void
synchronizeCharacterStyleproperty 
synchronizeCharacterStyle:Boolean

If true, synchronize character styles.


Implementation
    public function get synchronizeCharacterStyle():Boolean
    public function set synchronizeCharacterStyle(value:Boolean):void
synchronizeConditionalTextproperty 
synchronizeConditionalText:Boolean

If true, synchronize conditional text.


Implementation
    public function get synchronizeConditionalText():Boolean
    public function set synchronizeConditionalText(value:Boolean):void
synchronizeMasterPageproperty 
synchronizeMasterPage:Boolean

If true, synchronize master pages.


Implementation
    public function get synchronizeMasterPage():Boolean
    public function set synchronizeMasterPage(value:Boolean):void
synchronizeObjectStyleproperty 
synchronizeObjectStyle:Boolean

If true, synchronize object styles.


Implementation
    public function get synchronizeObjectStyle():Boolean
    public function set synchronizeObjectStyle(value:Boolean):void
synchronizeParagraphStyleproperty 
synchronizeParagraphStyle:Boolean

If true, synchronize paragraph styles.


Implementation
    public function get synchronizeParagraphStyle():Boolean
    public function set synchronizeParagraphStyle(value:Boolean):void
synchronizeSwatchproperty 
synchronizeSwatch:Boolean

If true, synchronize swatches.


Implementation
    public function get synchronizeSwatch():Boolean
    public function set synchronizeSwatch(value:Boolean):void
synchronizeTableOfContentStyleproperty 
synchronizeTableOfContentStyle:Boolean

If true, synchronize table of content styles.


Implementation
    public function get synchronizeTableOfContentStyle():Boolean
    public function set synchronizeTableOfContentStyle(value:Boolean):void
synchronizeTableStyleproperty 
synchronizeTableStyle:Boolean

If true, synchronize table styles.


Implementation
    public function get synchronizeTableStyle():Boolean
    public function set synchronizeTableStyle(value:Boolean):void
synchronizeTextVariableproperty 
synchronizeTextVariable:Boolean

If true, synchronize text variables.


Implementation
    public function get synchronizeTextVariable():Boolean
    public function set synchronizeTextVariable(value:Boolean):void
synchronizeTrapStyleproperty 
synchronizeTrapStyle:Boolean

If true, synchronize trap styles.


Implementation
    public function get synchronizeTrapStyle():Boolean
    public function set synchronizeTrapStyle(value:Boolean):void
Method Detail
addEventListenerBook()method
public function addEventListenerBook(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
close()method 
public function close(savingParam:SaveOptions = null, savingInParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Close the Book

Parameters

savingParam:SaveOptions (default = null) — (SaveOptions) Whether to save changes before closing the Book (Optional)
 
savingInParam:File (default = null) — (File) The file in which to save the Book (Optional)
 
versionCommentsParam:String (default = null) — (String) The comment for this version (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) Forcibly save a version (Optional)

exportFile()method 
public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, whichDocumentsParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Exports the book to a file.

Parameters

formatParam:Object (default = null) — (Object) 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.
 
toParam:File (default = null) — (File) The file to which to export the book. (Optional)
 
showingOptionsParam:Boolean (default = false) — (Boolean) Used to specify if the PDF Export Options Dialog needs to be shown or not (Optional)
 
usingParam:PDFExportPreset (default = null) — (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)
 
whichDocumentsParam:Array (default = null) — (Array) 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)
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

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

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

packageForPrint()method 
public function packageForPrint(toParam:File = null, copyingFontsParam:Boolean, copyingLinkedGraphicsParam:Boolean, copyingProfilesParam:Boolean, updatingGraphicsParam:Boolean, includingHiddenLayersParam:Boolean, ignorePreflightErrorsParam:Boolean, creatingReportParam:Boolean, versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean

Packages the document.

Parameters

toParam:File (default = null) — (File) The folder, alias, or path in which to place the packaged files.
 
copyingFontsParam:Boolean (default = NaN) — (Boolean) If true, copies fonts used in the document to the package folder.
 
copyingLinkedGraphicsParam:Boolean (default = NaN) — (Boolean) If true, copies linked graphics files to the package folder.
 
copyingProfilesParam:Boolean (default = NaN) — (Boolean) If true, copies color profiles to the package folder.
 
updatingGraphicsParam:Boolean (default = NaN) — (Boolean) If true, updates graphics links to the package folder.
 
includingHiddenLayersParam:Boolean (default = NaN) — (Boolean) If true, copies fonts and links from hidden layers to the package.
 
ignorePreflightErrorsParam:Boolean (default = NaN) — (Boolean) If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist.
 
creatingReportParam:Boolean (default = NaN) — (Boolean) If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information.
 
versionCommentsParam:String (default = null) — (String) The comments for the version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

Returns
Boolean
preflight()method 
public function preflight(toParam:File = null, autoOpenParam:Boolean = false):void

Preflight a book and optionally save the resulting report.

Parameters

toParam:File (default = null) — (File) The preflight report to save to. (Optional)
 
autoOpenParam:Boolean (default = false) — (Boolean) If true, automatically open the report after creation. (Optional)

print()method 
public function print(printDialogParam:Boolean, usingParam:Object = null):void

Prints the Book(s).

Parameters

printDialogParam:Boolean (default = NaN) — (Boolean) Whether to invoke the print dialog (Optional)
 
usingParam:Object (default = null) — (Object) Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)

removeEventListenerBook()method 
public function removeEventListenerBook(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
repaginate()method 
public function repaginate():void

Repaginates the book.

save()method 
public function save(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void

Saves the book.

Parameters

toParam:File (default = null) — (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)
 
versionCommentsParam:String (default = null) — (String) The comment for this version. (Optional)
 
forceSaveParam:Boolean (default = false) — (Boolean) If true, forcibly saves a version. (Optional)

synchronize()method 
public function synchronize():void

Synchronizes the entire book to the style source document.

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String
updateAllCrossReferences()method 
public function updateAllCrossReferences():void

Updates the cross references in the entire book.

updateAllNumbers()method 
public function updateAllNumbers():void

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

updateChapterAndParagraphNumbers()method 
public function updateChapterAndParagraphNumbers():void

Updates chapter numbers and paragraph numbers throughout the book.