Object Methods - Teklynx Discover ActiveX Programmer's Manual

Chapter 2 -- 44
Object
Methods
Note
Note
" " " " Documents.Add
VTS_DISPATCH or Document
Adds a new Document to the collection.
Return value: Returns a Document object if succeeded.
Parameters:
strDocumentName
Specifies the name of the new document to add.
If none, system automatically assigns one.
" " " " Documents.CloseAll
VTS_NONE CloseAll ( boolSaveChanges ).
Closes all documents.
Parameters:
boolSaveChanges
the save action for all documents. (default: True).
If boolSaveChanges is True and a document has not been
previously saved, the Saves As dialog box is automatically
prompted.
" " " " Documents.Item
VTS_DISPATCH or Document
Returns a Document of a collection, either by position or by
name.
If the value provided as Index does not match any existing
member of the collection, no object is returned.
Parameters:
varIndex Required VT_VARIANT or Variant. The name or
index number of a member of the collection.
The index can be a numeric expression (a number from 1 to the
value of the collection's Count property), a constant, or a string.
If the value provided as Index doesn't match any existing
member of the collection, an error occurs.
The Item method is the default method for collections. There-
fore, the following two lines of code are equivalent.
Object.Documents(1)
Object.Documents.Item(1)
Add(strDocumentName).
Optional VT_BSTR or String.
Optional VT_BOOL or Boolean. Specifies
Item( varIndex ).
Programmer's Guide