CFAccess Database ActiveX Shareware Components

Version 1.0

 

 

  1. Contents

Overview

Contact

License and Pricing

Installation

Public Types, Properties, and methods

ICFAccessForm Interface

ICFAccessReport Interface

Technical Notes

Legal

 

  1. Overview

a.        Description.  The CFAccess ActiveX component contains two interfaces used to display and control MS-Access forms and reports from an application outside of MS-Access.

b.       Environment.  This component has been tested using MS-Access 2000 on the Windows 2000, Windows XP, and Windows NT 4.0 operating systems. 

 

  1. Contact 

a.        Forward errors, problems, questions or suggestions to:

        gene@cfsoftwareconsultants.com

b.       Web Page:

http://www.cfsoftwareconsultants.com

 

  1. License and Pricing

a.        This component is Shareware.  You may freely evaluate it for 15 days.

b.       The price for use of this component is $20.00 US per developer.  For a shareware license, please send a check payable to CF Software Consultants, Inc. to:

 

CF Software Consultants, Inc.

2046 Coast Guard Drive

Stafford, Virginia USA 22554

 

                     Include an email address for updates/upgrades.

 

c.   Licensing will include free upgrades/bug fixes for versions 1.x.

    

  1. Installation
    1. Unzip the files to any directory.
    2. Install the ActiveX component by typing the following on the command line:

 

             regsvr32   C:\windows\system32\CFAccess.dll

 

    1. If you do not place the CFAccess.dll in the C:\windows\system32 directory, replace that phrase on the command line with the directory where CFAccess.dll resides.

 

 

  1. Public Types, properties and methods.

 

a.       ICFAccessForm Interface

 

Enumerated types

Type

Values

CFFormViewType

FORMVIEW_NORMAL

FORMVIEW_DESIGN

FORMVIEW_PREVIEW

 

CFFormWindowMode

FORMWINDOWMODE_NORMAL

FORMWINDOWMODE_HIDDEN

FORMWINDOWMODE_ICON

FORMWINDOWMODE_DIALOG

 

CFFormDataMode

FORMDATAMODE_PROPERTYSETTINGS

FORMDATAMODE_ADD

FORMDATAMODE_INSERT

FORMDATAMODE_READONLY

 

FormError

FRM_E_GENERAL

FRM_E_DATABASE_VISIBLE

FRM_E_DATABASE_NOT_VISIBLE

FRM_E_DATABASE_NOT_FOUND

 

 

Public Methods

Definition

Purpose

Remarks

STDMETHODIMP ShowForm()

Show the form

Return Values:

No Error: S_OK

Database File Not Found: FRM_E_DATABASE_NOT_FOUND

Database is already Visible:

FRM_E_DATABASE_VISIBLE

General Error:

FRM_E_GENERAL

STDMETHODIMP CloseForm()

Close a visible form

Return Values:

No Error: S_OK

Database is not Visible:

FRM_E_DATABASE_NOT_VISIBLE

General Error:

FRM_E_GENERAL

 

Properties

Name

Purpose

Default Value

Remarks

OpenArgs

The form’s OpenArgs property

EMPTY

If the form is already visible, setting these properties will return the FRM_E_DATABASE_VISIBLE error.

WhereCondition

The form’s Where Condition

EMPTY

Filter

The form’s Filter Property

EMPTY

DataMode

The form’s DataMode (of type TCFFormDataMode)

FORMDATAMODE_PROPERTYSETTINGS

WindowMode

The WindowMode (of type TCFFormWindowMode) for the form

FORMWINDOWMODE_NORMAL

FormName

The form name, as displayed in the MS-Access application.

EMPTY

DatabasePath

The fully articulated path to the MS-Access database.

EMPTY

FormView

The form view (of type TCFFormViewType).

FORMVIEW_NORMAL

 

 

b. ICFAccessReport Interface

 

Enumerated types

Type

Values

CFRptViewType

 

RPTVIEW_NORMAL

RPTVIEW_DESIGN

RPTVIEW_PREVIEW

 

ReportError

RPT_E_GENERAL

RPT_E_DATABASE_VISIBLE

RPT_E_DATABASE_NOT_VISIBLE

RPT_E_DATABASE_NOT_FOUND

 

Public Methods

Definition

Purpose

Remarks

STDMETHODIMP ShowReport();

Shows the report. 

Return Values:

No Error: S_OK

Database File Not Found: RPT_E_DATABASE_NOT_FOUND

Database is already Visible:

RPT_E_DATABASE_VISIBLE

General Error:

RPT_E_GENERAL

STDMETHODIMP CloseReport();

Closes a visible report.

Return Values:

No Error: S_OK

Database is not Visible:

RPT_E_DATABASE_NOT_VISIBLE

General Error:

RPT_E_GENERAL

 

 

 

Properties

Name

Purpose

Default Value

Remarks

WhereCondition

The Where Condition property for the report.

Empty

If the report is already visible setting these properties will return the RPT_E_DATABASE_VISIBLE error

Filter

The Filter Property for the report.

Empty

ReportName

The report name, as displayed in the MS-Access application.

Empty

DatabasePath

Fully articulated path to the MS-Access database.

Empty

ReportView

The Report view (of type TCFViewType).

RPTVIEW_PREVIEW

 

 

  1. Technical Notes.

a.        These components were tested for functionality, coverage, and memory leakage using Turbopower’s Sleuth QA Suite.  All tests were completed successfully.

b.       All tests were run using MS-Access 2000.  These components should work with MS-Access 97 and MS-Access 2002.  However, they have not been specifically tested with these versions.

c.        In order to view a form or a report, MS-Access must be installed on the host machine.  If MS-Access is not installed an error will occur when an attempt is made to display or close the form or report.

 

  1. Legal.

 

a.        This software is offered “as-is” by CF Software Consultants, Inc.  No warranty is included, express or implied.  Any costs to CFSoftware Consultants, Inc. will be limited to the cost of the software itself.

b.        This software is copyright by CF Software Consultants, Inc. 2003. All rights are reserved.  Except for evaluation purposes, it is illegal to use these components without compensation.

c.        These components may be distributed for evaluation purposes.  However, this document must be distributed with the software.