Books
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Book [] (index:
number)
Returns the Book with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Book add (fullName:
File[, withProperties:
Object])
Creates a new book.
| Parameter | Type | Description |
|---|---|---|
| fullName | File | The full path name of the new book file, including the book file extension '.indb'. |
| withProperties | Object | Initial values for properties of the new Book (Optional) |
Book anyItem ()
Returns any Book in the collection.
number count ()
Displays the number of elements in the Book.
Array
of Book everyItem ()
Returns every Book in the collection.
Book firstItem ()
Returns the first Book in the collection.
Book item (index:
varies)
Returns the Book with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | The index or name. Can accept: Long Integer or String. |
Book itemByName (name:
string)
Returns the Book with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of Book itemByRange (from:
varies, to:
varies)
Returns the Books within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Book Long Integer String | The Book, index, or name at the beginning of the range. Can accept: Book, Long Integer or String. |
| to | Book Long Integer String | The Book, index, or name at the end of the range. Can accept: Book, Long Integer or String. |
Book lastItem ()
Returns the last Book in the collection.
Book middleItem ()
Returns the middle Book in the collection.
Book nextItem (obj:
Book)
Returns the Book whose index follows the specified Book in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Book | The Book whose index comes before the desired Book. |
Book previousItem (obj:
Book)
Returns the Book with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Book | The index of the Book that follows the desired Book. |
string toSource ()
Generates a string which, if executed, will return the Book.
Element of
Application.books
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |