Documents
A collection of documents.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
Document [] (index:Number)
Returns the Document with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Document add ([showingWindow:Boolean=Boolean], documentPreset:DocumentPreset, withProperties:Object)
Creates a new document.
|
Parameter |
Type |
Description |
|---|---|---|
|
showingWindow |
If true, displays the document. (Optional) (default: true) |
|
|
documentPreset |
The document preset to use. (Optional) |
|
|
withProperties |
Initial values for properties of the new Document (Optional) |
Document anyItem ()
Returns any Document in the collection.
Number count ()
Displays the number of elements in the Document.
Document everyItem ()
Returns every Document in the collection.
Document firstItem ()
Returns the first Document in the collection.
Document item (index:Varies LongInteger String)
Returns the Document with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
Document itemByID (id:Number)
Returns the Document with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Document itemByName (name:String)
Returns the Document with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Document itemByRange (from:Varies Document LongInteger String, to:Varies Document LongInteger String)
Returns the Documents within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The Document, index, or name at the beginning of the range. Can accept: Document, Long Integer or String. |
|
to |
LongInteger |
The Document, index, or name at the end of the range. Can accept: Document, Long Integer or String. |
Document lastItem ()
Returns the last Document in the collection.
Document middleItem ()
Returns the middle Document in the collection.
Document nextItem (obj:Document)
Returns the Document whose index follows the specified Document in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Document whose index comes before the desired Document. |
Document previousItem (obj:Document)
Returns the Document with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Document that follows the desired Document. |
String toSource ()
Generates a string which, if executed, will return the Document.
Object of
Application.documents