BookContents
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
BookContent add (fullName:
File[, withProperties:
Object])
Adds a book content object to the book.
| Parameter | Type | Description |
|---|---|---|
| fullName | File | The full path name of the document file to add to the book. |
| 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.
Array
of BookContent everyItem ()
Returns every BookContent in the collection.
BookContent firstItem ()
Returns the first BookContent in the collection.
BookContent item (index:
any)
Returns the BookContent with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long String | The index or name. Can accept: Long 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. |
Array
of BookContent itemByRange (from:
any, to:
any)
Returns the BookContents within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | BookContent Long String | The BookContent, index, or name at the beginning of the range. Can accept: BookContent, Long or String. |
| to | BookContent Long String | The BookContent, index, or name at the end of the range. Can accept: BookContent, Long 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.
Element of
Book.bookContents
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |