BookContents

A collection of book content objects.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

BookContent [] (index:Number)

Returns the BookContent with the specified index.

Parameter	Type	Description
index	Number	The index.

BookContent add (fullName:File, [at:Number=Number], withProperties:Object)

Creates a new book content object.

Parameter	Type	Description
fullName	File	The full path name of the new book content object.
at	Number	The location of the book content object within the book. (Optional) (default: -1)
withProperties	Object	Initial values for properties of the new BookContent (Optional)

Parameter

Type

Description

fullName

File

The full path name of the new book content object.

Number

The location of the book content object within the book. (Optional)

(default: -1)

withProperties

Object

Initial values for properties of the new BookContent (Optional)

BookContent anyItem ()

Returns any BookContent in the collection.

Number count ()

Displays the number of elements in the BookContent.

BookContent everyItem ()

Returns every BookContent in the collection.

BookContent firstItem ()

Returns the first BookContent in the collection.

BookContent item (index:Varies LongInteger String)

Returns the BookContent with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

BookContent itemByID (id:Number)

Returns the BookContent with the specified ID.

Parameter	Type	Description
id	Number	The ID.

BookContent itemByName (name:String)

Returns the BookContent with the specified name.

Parameter	Type	Description
name	String	The name.

BookContent itemByRange (from:Varies BookContent LongInteger String, to:Varies BookContent LongInteger String)

Returns the BookContents within the specified range.

Parameter	Type	Description
from	BookContent LongInteger String	The BookContent, index, or name at the beginning of the range. Can accept: BookContent, Long Integer or String.
to	BookContent LongInteger String	The BookContent, index, or name at the end of the range. Can accept: BookContent, Long Integer or String.

Parameter

Type

Description

from

BookContent

LongInteger

String

The BookContent, index, or name at the beginning of the range. Can accept: BookContent, Long Integer or String.

BookContent

LongInteger

String

The BookContent, index, or name at the end of the range. Can accept: BookContent, Long Integer or String.

BookContent lastItem ()

Returns the last BookContent in the collection.

BookContent middleItem ()

Returns the middle BookContent in the collection.

BookContent nextItem (obj:BookContent)

Returns the BookContent whose index follows the specified BookContent in the collection.

Parameter	Type	Description
obj	BookContent	The BookContent whose index comes before the desired BookContent.

BookContent previousItem (obj:BookContent)

Returns the BookContent with the index previous to the specified index.

Parameter	Type	Description
obj	BookContent	The index of the BookContent that follows the desired BookContent.

String toSource ()

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

Object of

Book.bookContents