A collection of book content objects.
Methods
BookContentadd (fullName:
File[, at:
number=-1 ][, 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) |
BookContentanyItem ()
Returns any BookContent in the collection.
number count ()
Displays the number of elements in the BookContent.
Array of BookContenteveryItem ()
Returns every BookContent in the collection.
BookContentfirstItem ()
Returns the first BookContent in the collection.
BookContentitem (index:
any)
Returns the BookContent with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
BookContentitemByID (id:
number)
Returns the BookContent with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
BookContentitemByName (name:
string)
Returns the BookContent with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of BookContentitemByRange (from:
any, to:
any)
Returns the BookContents within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | BookContent Long Integer String |
The BookContent, index, or name at the beginning of the range. Can accept: BookContent, Long Integer or String. |
| to | BookContent Long Integer String |
The BookContent, index, or name at the end of the range. Can accept: BookContent, Long Integer or String. |
BookContentlastItem ()
Returns the last BookContent in the collection.
BookContentmiddleItem ()
Returns the middle BookContent in the collection.
BookContentnextItem (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. |
BookContentpreviousItem (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