EccoApp Properties

Calendar date

 

Activates the Ecco calendar, showing the specified date. This date should be supplied as a date variant or as a string which can be converted to a date. Examples:

Set MyEcco = New EccoApp 
MyEcco.Calendar = Now 'Sets calendar to today's date
MyEcco.Calendar = "July 1, 2001" 'Sets calendar to July 1, 2001

Changes

 

Read-only collection of EccoItems. Returns an EccoItems collection consisting of all items in the Ecco file which have changed since the last time this function was invoked. Note that this function is reset when the EccoApp object is initialized, so the first time this property is read, it will only return Ecco items which have changed since the EccoApp object was initialized.

 

CreateFolder (name, type)

 

Creates a new folder with the specified name and type, and returns it as an EccoFolder object. Specify the type as one of the following:
        fldCheck (=1) creates a check (boolean) folder

        fldDate (=2) creates a date folder

        fldNumber (=3) creates a number folder.

        fldText (=4) creates a text folder.
        fldPopup (=5) creates a  popup folder.
 

If no type is specified, or if an invalid type is specified, a text folder is created.
 

Example:

Set MyFolder=MyEcco.CreateFolder("Projects", fldDate)

CreateItem (ItemText)

 

Creates a new Ecco item and returns it as an EccoItem object.

 

ErrID

 

Returns an integer which identifies the return code of the last action performed by VBEcco.  Press here for more information.

 

ErrMsg

 

Returns a string which identifies the status of the last action performed by VBEcco.  Press here for more information.

 

File

 

Read-write string. Opens the specified filename and activates it. If the specified filename is already open, activates that file. If the specified file is not found, does nothing.

 

Example:

Set MyEcco = New EccoApp 
MyEcco.File = "c:\Ecco32\Projects.eco"

Returns the current filename. Note that this filename will be enclosed in quotes, which is particularly useful if it is necessary to process a long file name (which may contain embedded spaces) under Windows 9x/NT/Me/2000.

 

Folders (type)

 

Returns a collection of EccoFolder objects representing all folders in the Ecco file.  If type is omitted, then all folders in the Ecco file are returned.


Specify type as follows, to return only selected types of folders:

        fldCheck (=1) creates a check (boolean) folder

        fldDate (=2) creates a date folder

        fldNumber (=3) creates a number folder.

        fldText (=4) creates a text folder.
        fldPopup (=5) creates a  popup folder.
 

GetFolder (folder)

 

Returns the specified folder as an EccoFolder object.  You may specify the folder using either its name (text) or unique ID number (integer).  Note: Ecco allows more than one folder to have the same name.  When this folder is used with such a folder name, it cannot be predicted which folder will be returned.  If you know the folder's ID number (as with the built-in Ecco folders), you can be assured of specifying the right folder by using the ID number instead of the name.

 

GetUserID

 

Returns the unique User ID which matches a given user name.  This is used to (1) verify that a particular user is a licensed user, or (2) generate a unique User ID for a registered user.

 

Items

 

Read-only collection of Ecco items. Returns an EccoItems collection consisting of all items in the Ecco file.

 

Registered

 

Returns True if the Register method was successful; otherwise returns False.  Used to determine if the user has successfully registered a VBEcco application.

 

Selection

 

Read-only. Returns an EccoItems collection consisting of all selected items in the Ecco file. Returns nothing if no items are selected.

 

Ticklers

 

Read-only. Returns an EccoItems collection consisting of all items in the Ticklers view.

 

View

 

Write-only string. Sets the Ecco view to a specific named view. For example, to display a view named "Projects," use the following:

Set MyEcco = New EccoApp 
MyEcco.View = "Projects" 

If the specified view is not found, nothing is done.

 

ViewItems (viewname)
 

Read-only collection of Ecco items. Returns an EccoItems collection consisting of all top-level items contained in the specified named view.  If the specified named view does not exist, an empty collection is returned.


The differences between a collection of items in a folder and a collection of items in a view are that (1) a view can contain more than one folder, and (2) a view can be filtered. However, since the EccoItems collection permits the collection to be filtered, you can, using an EccoItems collection, set multiple filter criteria within your application. With that in mind, the main benefit to using this property is to dynamically access a view which reflects filter criteria established by the user rather than by the developer.