FaxCoverPages Collection Object
The FaxCoverPages collection object contains one or more
FaxCoverPage objects and identifies the available cover
pages.
Properties
Methods
|
Name |
Input Parameters |
Return Values |
|
Add |
Title as String,
FileName as String,
Shared as Boolean |
FaxCoverPage object |
|
Remove |
Index as Long |
|
Remarks
Because there may be multiple cover pages defined, use
the Item property to reference a particular
FaxCoverPage object.
Back to Top
Add Method
The Add method creates and returns a new
FaxCoverPage object in the FaxCoverPages collection. The
Add method also creates server based resources associated
with the new cover page.
Syntax
ObjCoverPages.Add(Title, FileName, Shared)
Remarks
The Title parameter is the title assigned to the new
cover page. The FileName is the name of the new cover page
file. The Shared parameter represents the shared/personal
attribute assigned to the new cover page - where a non-zero
value defines a shared cover page.
Back to Top
Count Property
The Count property returns the number of
FaxCoverPage objects contained in the collection.
Read-only.
Syntax
ObjCoverPages.Count
Data Type
Long
Back to Top
Item Property
The Item property returns a single
FaxCoverPage object from the collection. Read-only.
Syntax
ObjCoverPages.Item(Index)
where Index is a long integer ranging from 1 to the size
of the collection (i.e., value of the Count property).
Data Type
FaxCoverPage object
Remarks
The Item property is the default property of the
FaxCoverPages object.
Back to Top
Remove Method
The Remove method deletes the
FaxCoverPage object with the specified index from the
collection. Server based resources associated with the cover
page are also deleted.
Syntax
ObjCoverPages.Remove(Index)
where Index is a long integer ranging from 1 to the size
of the collection (i.e., value of the Count property).
Remarks
The Remove method is irreversible. The cover page will be
deleted permanently from the FaxCoverPages collection.
If you have another reference to the deleted cover page,
you can still access its properties and methods, but you
cannot associate the cover page with any collection because
the Add method always creates a new object.
Back to Top
|