Books

A collection of books.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, 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

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.

Book everyItem ()

Returns every Book in the collection.

Book firstItem ()

Returns the first Book in the collection.

Book item (index:Varies LongInteger String)

Returns the Book with the specified index or name.

Parameter

Type

Description

index

LongInteger

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.

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

Returns the Books within the specified range.

Parameter

Type

Description

from

Book

LongInteger

String

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

to

Book

LongInteger

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.

Object of

Application.books