CFAccess Database Control Shareware Components

Version 1.0

 

 

  1. Overview

a.       Description.  The CFAccess package contains two Delphi® components used to display and control MS-Access® forms and reports from an application written in Delphi®.

b.      Environment.  These components have been tested using MS-Access 2000® on the Windows 2000®, Windows XP®, and Windows NT® 4.0 operating systems. 

c.      Delphi Versions.  These components work have been tested with Delphi v4.0. 

 

  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.       These components are Shareware.  You may freely evaluate them for 15 days.

b.      The price for use of both components 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

a.       Place the following files in your component directory:

                                                    i.     CFAccessReport.dcr

                                                   ii.     CFAccessReport.dcu

                                                 iii.     CFAccessForm.dcr

                                                  iv.     CFAccessForm.dcu

                                                    v.     FileNameProp.dcu

b.      From the Delphi IDE menu, choose Component|Install Component.

c.      From the Install Component Dialog box, choose CFAccessReport.dcu.

d.      Select the Package File Name to which you want to install the component

e.      Click the dialog box OK button.

f.       Repeat steps b through e for the CFAccessForm.dcu and FileNameProp.dcu files.

g.      Follow the directions for recompling.  The two components should appear on the component palette under the CFSoftware header.

 

 

  1. Component types, properties, public methods and events:

 

a.      CFAccessForm

 

Enumerated types

Type

Values

TCFFormViewType

acFormViewNormal

acFormViewDesign

acFormViewPreview

 

TCFFormWindowMode

acWindowNormal

acHidden

acIcon

acDialog

 

TCFFormDataMode

acFormPropertySettings

acFormAdd

acFormEdit

acFormReadOnly

Error Definition Type

Definition

Remarks

TCFErrorEvent = procedure (msg : string) of object;

Template for the OnError event

 

Exception Type

Name

Parameter

Remarks

EAccessForm

msg

Contains a description of the error

 

Public Methods

Definition

Purpose

Remarks

constructor Create(AOwner: TComponent)

Constructor

Initializes all attributes

Destructor Destroy

Destructor

Frees all attributes. (Note: Use the Free method rather than calling Destroy directly).

procedure ShowForm()

Show the form 

On error, raises EAccessForm with the appropriate message, OR invokes the OnError event (if set).

procedure CloseForm()

Close a visible form

On error, raises EaccessForm with the appropriate message OR invokes the OnError event (if set).

 

Properties

Name

Purpose

Remarks

OpenArgs

The form’s OpenArgs property

If the form is already

visible, setting these properties will either cause an exception, or, if set, invoke OnError.

WhereCondition

The form’s Where Condition

Filter

The form’s Filter Property

DataMode

The form’s DataMode (of  type TCFFormDataMode)

WindowMode

The WindowMode ( of type TCFFormWindowMode) for the form

FormName

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

DatabasePath

The fully articulated path to the MS-Access  database.

FormView

The form view (of type TCFFormViewType).

 

Events

Name

Purpose

Type

OnError

Event invoked when an error occurs.

TCFErrorEvent

BeforeOpenForm

Event invoked before a form is opened.

TNotifyEvent

AfterOpenForm

Event invoked after a form is opened.  This is invoked regardless of whether an error occurs.

TNotifyEvent

BeforeCloseForm

Event invoiked before an form is closed. 

TNotifyEvent

AfterCloseForm

Event invoked after a form is closed.  This is invoked regardless of whether an error occurs.

TNotifyEvent

 

 

b. CFAccessReport

 

Enumerated types

Type

Values

TCFViewType

 

vtViewNormal

vtViewDesign

vtViewPreview

 

 

Error Definition Type

Definition

Remarks

TCFErrorEvent = procedure (msg : string) of object;

Template for the OnError event

 

Exception Type

Name

Parameter

Remarks

EAccessReport

msg

Contains a description of the error

 

Public Methods

Definition

Purpose

Remarks

constructor Create(AOwner: TComponent);

Constructor

Initializes all attributes

Destructor Destroy;

Destructor

Frees all attributes. (Note: Use the Free method rather than calling Destroy directly).

procedure ShowReport();

Shows the report. 

On error, raises EAccessReport with the appropriate message, OR invokes the OnError event (if set).

procedure CloseReport();

Closes a visible report.

On error, raises EAccessReport with the appropriate message OR invokes the OnError event (if set).

 

Properties

Name

Purpose

Remarks

WhereCondition

The Where Condition property for the report.

If the report is already

visible, setting these properties will either cause an exception, or, if set, invoke OnError.

Filter

The Filter Property for the report.

ReportName

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

DatabasePath

Fully articulated path to the MS-Access  database.

ReportView

The Report view (of type TCFViewType).

 

Events

Name

Purpose

Type

OnError

Event invoked when an error occurs.

TCFErrorEvent

BeforeOpenReport

Event invoked before a report is opened

TNotifyEvent

AfterOpenReport

Event invoked after a report is opened.  This is invoked regardless of whether an error occurs.

TNotifyEvent

BeforeCloseReport

Event invoked before an report is closed. 

TNotifyEvent

AfterCloseReport

Event invoked after a report is closed.  This is invoked regardless of whether an error occurs.

TNotifyEvent

 

 

  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, the components will install correctly, all properties can be set, and your application will compile and run.  However, 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.