Class

Books

 A collection of books.

QuickLinks

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

Methods

Book add (fullName:File[, withProperties:Object])
Creates a new book.

ParameterTypeDescription
fullNameFileThe full path name of the new book file, including the book file extension '.indb'.
withPropertiesObjectInitial 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:any)
Returns the Book with the specified index or name.

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

Book itemByName (name:string)
Returns the Book with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Book itemByRange (from:any, to:any)
Returns the Books within the specified range.

ParameterTypeDescription
fromBook
Long Integer
String
The Book, index, or name at the beginning of the range. Can accept: Book, Long Integer or String.
toBook
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.

ParameterTypeDescription
objBookThe Book whose index comes before the desired Book.

Book previousItem (obj:Book)
Returns the Book with the index previous to the specified index.

ParameterTypeDescription
objBookThe 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

Contents :: Index