Packagecom.adobe.indesign
Classpublic class BookContent
InheritanceBookContent Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  date : Date
[read-only] The date and time the BookContent was created.
BookContent
  documentPageRange : String
[read-only] The page range of the book content object within the book.
BookContent
  eventListeners : EventListeners
[read-only] A collection of event listeners.
BookContent
  events : Events
[read-only] A collection of events.
BookContent
  filePath : File
[read-only] The full path to the file.
BookContent
  fullName : File
[read-only] The full path to the BookContent, including the name of the BookContent.
BookContent
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the BookContent.
BookContent
  index : Number
[read-only] The index of the BookContent within its containing object.
BookContent
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
BookContent
  label : String
A property that can be set to any string.
BookContent
  name : String
[read-only] The name of the BookContent.
BookContent
  parent : Book
[read-only] The parent of the BookContent (a Book).
BookContent
  properties : Object
A property that allows setting of several properties at the same time.
BookContent
  size : Number
[read-only] The size of the BookContent file.
BookContent
  status : BookContentStatus
[read-only] The status of the book content object file.
BookContent
Public Methods
 MethodDefined By
  
addEventListenerBookContent(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
BookContent
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
BookContent
 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.
BookContent
 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.
BookContent
 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
  
move(toParam:LocationOptions = null, referenceParam:BookContent = null):BookContent
Moves the book content object.
BookContent
  
preflight(toParam:File = null, autoOpenParam:Boolean = false):void
Preflight a book content object and optionally save the resulting report.
BookContent
  
remove():void
Deletes the BookContent.
BookContent
  
removeEventListenerBookContent(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
BookContent
  
replace(usingParam:File = null):BookContent
Replaces a book content object with a new file.
BookContent
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
Matches the formatting of the book content object to the style source document.
BookContent
  
toSpecifier():String
Retrieves the object specifier.
BookContent
 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
dateproperty
date:Date  [read-only]

The date and time the BookContent was created.


Implementation
    public function get date():Date
documentPageRangeproperty 
documentPageRange:String  [read-only]

The page range of the book content object within the book.


Implementation
    public function get documentPageRange():String
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 BookContent, including the name of the BookContent.


Implementation
    public function get fullName():File
idproperty 
id:Number  [read-only]

The unique ID of the BookContent.


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

The index of the BookContent within its containing object.


Implementation
    public function get index():Number
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
nameproperty 
name:String  [read-only]

The name of the BookContent.


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

The parent of the BookContent (a Book).


Implementation
    public function get parent():Book
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
sizeproperty 
size:Number  [read-only]

The size of the BookContent file.


Implementation
    public function get size():Number
statusproperty 
status:BookContentStatus  [read-only]

The status of the book content object file.


Implementation
    public function get status():BookContentStatus
Method Detail
addEventListenerBookContent()method
public function addEventListenerBookContent(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
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.

move()method 
public function move(toParam:LocationOptions = null, referenceParam:BookContent = null):BookContent

Moves the book content object.

Parameters

toParam:LocationOptions (default = null) — (LocationOptions) The location relative to the reference object or within the book. (Optional)
 
referenceParam:BookContent (default = null) — (BookContent) The reference object. Note: Required when the to parameter specifies before or after. (Optional)

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

Preflight a book content object 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)

remove()method 
public function remove():void

Deletes the BookContent.

removeEventListenerBookContent()method 
public function removeEventListenerBookContent(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
replace()method 
public function replace(usingParam:File = null):BookContent

Replaces a book content object with a new file. Note: If the new file replaces the current style source document, the new file becomes the style source document.

Parameters

usingParam:File (default = null) — (File) The full path name of the new book content object.

Returns
BookContent
synchronize()method 
public function synchronize():void

Matches the formatting of the book content object to the style source document.

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String