Software Development Kit (SDK)
Technical Reference Guide
Windows 2000 Windows 95 Windows 98 Windows
NT
Conventions used in this section
Overview of the ACT! OLE Database Object
How
can developers use an ACT! OLE Database Object?
How
does the OLE Database Object affect the ACT! user interface?
Is
the OLE Database Object a database tool for developing applications that can
access ACT! data?
Features and limitations of the ACT! OLE
Database Object
Using the Database Object with Visual C++
Using
properties in Visual C++
ACT! Database Unique ID field considerations
ACT! OLE Database Object definitions
FindDuplicates Method (requires ACT! 2000 or
later)
GetDataEx Method (requires ACT! 4.0.2 or
later)
GetDuplicateCriteria Method (requires ACT!
2000 or later)
GetSort Method (requires ACT! 4.0 or later)
SetDataEx Method (requires ACT! 4.0.2 or
later)
SetDuplicateCriteria Method (requires ACT!
2000 or later)
Activity object properties and methods
HasDetails Method (requires ACT! 2000 or
later)
IsOutlookActivity Method (requires ACT! 2000
or later)
NextScheduledWith Property (requires ACT! 4.0
or later)
SetRecurringDaysAndWeeksofMonth Method
LoadLookUpQuery Method (requires ACT! 3.0.6
or later)
LookupMyRecord Method (requires ACT! 2000 or
later)
SetAsMyRecord Method (requires ACT! 4.0 or
later)
Database object properties and methods
ActVersion Method (requires ACT! 3.0.6 or
later)
BeginBatchInsert Method (requires ACT! 4.0.2
or later)
BeginBatchUpdate Method (requires ACT! 4.0.2
or later)
DatabaseVersion Method (requires ACT! 4.0 or
later)
EndBatchInsert Method (requires ACT! 4.0.2 or
later)
EndBatchUpdate Method (requires ACT! 4.0.2 or
later)
GetDatabasePath Method (requires ACT! 4.0 or
later)
GetTableId Method (requires ACT! 3.0.6 or
later)
GetTableNameFromId Method (requires ACT!
3.0.6 or later)
GetTableNameFromIndex Method (requires ACT!
3.0.6 or later)
IsInBatchMode Property (requires ACT! 4.0.2
or later)
IsLocked Property (requires ACT! 4.0.2 or
later)
Lock Method (requires ACT! 4.0.2 or later)
OpenEx Method (requires ACT! 4.0 or later)
Relations Property (requires ACT! 3.0.6 or
later)
TableCount Method (requires ACT! 3.0.6 or
later)
Unlock Method (requires ACT! 4.0.2 or later)
Version Property (requires ACT! 3.0.6 or
later)
ClearContactScope Method (requires ACT! 3.0.7
or later)
SetContactScope Method (requires ACT! 3.0.7
or later)
ExceptionInfo object properties and methods
Fields object properties and methods
AutoPopulate Property (requires ACT! 2000 or
later)
BeginBatch Method (requires ACT! 4.0.2 or
later)
EndBatch Method (requires ACT! 4.0.2 or
later)
EntryRule Property (requires ACT! 4.0.2 or
later)
FieldId Property (requires ACT! 3.0.7 or
later)
FieldIdAt Property (requires ACT! 3.0.6 or
later)
GetLinkToList Method (requires ACT! 2000 or
later)
SetLinkToList Method (requires ACT! 2000 or
later)
UnLinkLists Method (requires ACT! 2000 or
later)
Group object properties and methods
AddSubGroup Method (requires ACT! 2000 or
later)
AssignParent Method (requires ACT! 2000 or
later)
ChangeToParentGroup Method (requires ACT!
2000 or later)
ChangeToSubGroup Method (requires ACT! 2000
or later)
ClearContactScope Method (requires ACT! 3.0.7
or later)
GetParent Method (requires ACT! 2000 or
later)
GetSubGroup Method (requires ACT! 2000 or
later)
GetSubGroupCount Method (requires ACT! 2000
or later)
GetSubGroupList Method (requires ACT! 2000 or
later)
GroupType Method (requires ACT! 2000 or
later)
SetContactScope Method (requires ACT! 3.0.7
or later)
ClearScope Method (requires ACT! 2000 or
later)
GetScope Method (requires ACT! 2000 or later)
SetScope Method (requires ACT! 2000 or later)
PopupInfo object properties and methods
Relations object properties and methods
Count Property (requires ACT! 3.0.6 or later)
GetColumn1ID Method (requires ACT! 3.0.6 or
later)
GetColumn2ID Method (requires ACT! 3.0.6 or
later)
GetTable1ID Method (requires ACT! 3.0.6 or
later)
GetTable2ID Method (requires ACT! 3.0.6 or
later)
UsesRelationTable Method (requires ACT! 3.0.6
or later)
AssociateWithContact Method (requires ACT!
2000 or later)
AssociateWithGroup Method (requires ACT! 2000
or later)
CompleteSale Method (requires ACT! 2000 or
later)
ReopenSale Method (requires ACT! 2000 or
later)
Users object properties and methods
AddUser Method (requires ACT! 4.0 or later)
CheckIsPhonebook Method (requires ACT! 4.0 or
later)
CurrentUserAccess Method (requires ACT! 3.0.6
or later)
CurrentUserId Method (requires ACT! 3.0.6 or
later)
CurrentUserName Method (requires ACT! 3.0.6
or later)
CurrentUserSecurity Method (requires ACT!
3.0.6 or later)
GetPassword Method (requires ACT! 4.0 or
later)
SetAsPhonebook Method (requires ACT! 4.0 or
later)
Conventions used in this section
Using properties in Visual C++
Using the Application Object with Visual C++
ACT! OLE Application Object model
Changes for ACT! 2000 version 5.0.2
ClearError Method (requires ACT! 4.0 or
later)
CurrentFieldId Method (requires ACT! 2000 or
later)
CurrentRecord Method (requires ACT! 2000 or
later)
GetMode Method (requires ACT! 2000 or later)
HasRecordChanged Method (requires ACT! 2000
or later)
LookupKeyword Method (requires ACT! 2000 or
later)
ViewState Property (requires ACT! 2000 or
later)
Application object properties and methods
ActVersion Property (requires ACT! 2000 or
later)
BackupDB Method (requires ACT! 4.0 or later)
ClearError Method (requires ACT! 4.0 or
later)
GetActiveDB Method (not currently
implemented)
GetCurrentUserName Method (requires ACT! 4.0
or later)
GetVersion Method (requires ACT! 4.0 or
later)
LastContactListModTime Property
RemoveOutlookActivities Method (requires ACT!
2000 or later)
RestoreDB Method (requires ACT! 4.0 or later)
UpdateOutlookActivities Method (requires ACT!
2000 or later)
ContactListView object methods
AddNewContact Method (obsolete)
AddNewContactEx Method (requires ACT! 4.0 or
later)
AddNewActivity Method (obsolete)
AddNewActivityEx Method (requires ACT! 4.0 or
later)
AddNoteHistory Method (obsolete)
AddNoteHistoryEx Method (requires ACT! 4.0 or
later)
AttachFile Method (requires ACT! 4.0 or
later)
CompleteSale Method (requires ACT! 2000 or
later)
CreateLookup Method (requires ACT! 2000 or
later)
CreateSalesForecast Method (requires ACT!
2000 or later)
DeleteContactFast Method (requires ACT! 2000
or later)
GetTabCount Method (requires ACT! 4.0 or
later)
GetTabName Method (requires ACT! 4.0 or
later)
LookupFieldEx Method (requires ACT! 4.0 or
later)
NewContactDialog Method (requires ACT! 4.0 or
later)
Sales Method (requires ACT! 2000 or later)
SelectContactDlg Method (requires ACT! 4.0 or
later)
SetActiveGroupName Method (requires ACT! 4.0
or later)
TriggerActivitySeries Method (requires ACT!
2000 or later)
GetOpenFolderMessageCount Method (requires
ACT! 2000 or later)
Sort Method (requires ACT! 2000 or later)
GetFilter Method (requires ACT! 4.0 or later)
SetFilter Method (requires ACT! 4.0 or later)
AddNewSubGroup Method (requires ACT! 2000 or
later)
AddNoteEx Method (requires ACT! 4.0 or later)
AttachFile Method (requires ACT! 4.0 or
later)
ChangeToParentGroup Method (requires ACT!
2000 or later)
ChangeToSubGroup Method (requires ACT! 2000
or later)
Collapse Method (requires ACT! 2000 or later)
DeleteGroupFast Method (requires ACT! 2000 or
later)
Expand Method (requires ACT! 2000 or later)
GetSubGroupCount Method (requires ACT! 2000
or later)
GetTabCount Method (requires ACT! 4.0 or
later)
GetTabName Method (requires ACT! 4.0 or
later)
GroupType Method (requires ACT! 2000 or
later)
IsExpanded Method (requires ACT! 2000 or
later)
LookupFieldEx Method (requires ACT! 4.0 or
later)
MailComposeView object methods
AddBccRecepient Method (requires ACT! 2000 or
later)
AddCcRecepient Method (requires ACT! 2000 or
later)
Preferences object properties and methods
AttachMsgToContact Property (requires ACT!
4.0 or later)
AttachToMsgUsing Property (requires ACT! 4.0
or later)
CalMinDurationForBanner Property (requires
ACT! 4.0 or later)
CheckScheduleConflicts Property
ClearError Method (requires ACT! 4.0 or
later)
ContactSalutation Property (requires ACT! 4.0
or later)
EnableSpeedLoader Property (requires ACT! 4.0
or later)
GenerateSynchReport Property (requires ACT!
4.0 or later)
GetActivityCleanupStyle Method
GetAttachmentInfo Method (requires ACT! 4.0
or later)
GetDataToSynch Method (requires ACT! 4.0 or
later)
GetDBMaintReminderInfo Method (requires ACT!
2000 or later)
GetEmailSystem Method (requires ACT! 4.0 or
later)
GetLastError Method (requires ACT! 4.0 or
later)
GetSchdActivityDefaults Method
GetSynchSchedule Method (obsolete)
GetSynchScheduleInfo Method (requires ACT!
4.0 or later)
GetSynchUpdateInfo Method (requires ACT! 4.0
or later)
NewActivitiesSeparate Property (requires ACT!
4.0 or later)
PromptToPrintEnvelope Property (requires ACT!
4.0 or later)
ReceivedSynchLocation Property (requires ACT!
4.0 or later)
RemindToBackup Property (requires ACT! 4.0 or
later)
ReturnReceipt Property (requires ACT! 4.0 or
later)
SetActivityCleanupStyle Method
SetAttachmentInfo Method (requires ACT! 4.0
or later)
SetDataToSynch Method (requires ACT! 4.0 or
later)
SetDBMaintReminderInfo Method (requires ACT!
2000 or later)
SetEmailSystem Method (requires ACT! 4.0 or
later)
SetSchdActivityDefaults Method
SetSynchSchedule Method (obsolete)
SetSynchScheduleInfo Method (requires ACT! 4.0
or later)
SetSynchUpdateInfo Method (requires ACT! 4.0
or later)
ShowContactParsingDialog Property (requires
ACT! 2000 or later)
UseDialer Property (not currently
implemented)
UseTypeahead Property (requires ACT! 4.0 or
later)
WaitTime Property (requires ACT! 4.0 or
later)
AddNewActivity Method (obsolete)
AddNewActivityEx Method (requires ACT! 4.0 or
later)
Views object property and methods
ClearError Method (requires ACT! 4.0 or
later)
CreateBrowserView Method (requires ACT! 2000
version 5.0.2 or later)
CreateBrowserViewFromUrl Method (requires
ACT! 2000 version 5.0.2 or later)
CreateEx Method (requires ACT! 2000 or later)
FindExplorerView Method (requires ACT! 4.0 or
later)
GetViewEx Method (requires ACT! 2000 version
5.0.2 or later)
Conventions used in this manual
Adding a VBScript script file to ACT!
Using ACT! Scripting Support with the OLE
Application Object
Registering the custom control
Using event control in Visual Basic
Using event control in Visual C++
Syntax conventions used in this manual
Changes for ACT! 2000 version 5.0.2
Defining the control file header
Defining the view in the View section
Adding navigation buttons to the toolbar in
the Commands section (ACT! 4.0 only)
Adding URL buttons to the navigation toolbar
in the URL section
Creating a custom bitmap for the View bar
button
Creating custom icons for navigation toolbar
buttons
Using the added views and tabs
Conventions used in this manual
Changes for ACT! 2000 version 5.0.2
Understanding the Command Object
AddAuxCommandEnabled Method (requires ACT!
2000 version 5.0.2 or later)
AddAuxCommandToMenu Method (requires ACT!
2000 version 5.0.2 or later)
AddAuxCommandToToolsMenu Method
AddAuxSubMenu Method (requires ACT! 2000
version 5.0.2 or later)
AuxCommandExistsInMenus Method (requires ACT!
2000 version 5.0.2 or later)
AuxCommandExistsInToolbar Method
AuxCommandExistsInToolsMenu Method
AuxSubMenuExists Method (requires ACT! 2000
version 5.0.2 or later)
RemoveAuxCommandFromMenus Method (requires
ACT! 2000 version 5.0.2 or later)
RemoveAuxCommandFromToolbar Method
RemoveAuxCommandFromToolsMenu Method
RemoveAuxSubMenu Method (requires ACT! 2000
version 5.0.2 or later)
Overview of ACT! Database Files
ACT! database table relationships
Looking at ACT! Database Tables
List table (.DDB) fields (requires ACT! 2000
or later)
Notes/History table (.HDB) fields
Relational table (.REL) fields
Understanding
the Relational table
Sales table (.SDB) fields (ACT! 2000 or
later)
Software Development Kit (SDK)
Technical Reference Guide
Windows 2000 Windows 95 Windows 98 Windows
NT
ACT! Software Development Kit (SDK)
Technical Reference Guide
The software described in this book is furnished under a
license agreement and may be used only in accordance with the terms of the
agreement.
Copyright Notice
Portions of this publication copyright 2000 Interact Commerce Corporation.
Portions of this publication copyright 1993 ‑ 2000
Symantec Corporation under exclusive license to Interact Commerce Corporation.
All Rights Reserved.
Released: 6/2000 for ACT! 2000
This document may not, in whole or in part, be copied,
photocopied, reproduced, translated, or reduced to any electronic medium or
machine-readable form without prior consent in writing from Interact Commerce
Corporation, 8800 N. Gainey Center Dr. #200, Scottsdale, AZ 85258.
ALL EXAMPLES WITH NAMES, COMPANY NAMES, OR COMPANIES THAT
APPEAR IN THIS MANUAL ARE IMAGINARY AND DO NOT REFER TO, OR PORTRAY, IN NAME OR
SUBSTANCE, ANY ACTUAL NAMES, COMPANIES, ENTITIES, OR INSTITUTIONS. ANY
RESEMBLANCE TO ANY REAL PERSON, COMPANY, ENTITY, OR INSTITUTION IS PURELY
COINCIDENTAL.
Every effort has been made to ensure the accuracy of this
manual. However, Interact Commerce makes no warranties with respect to this
documentation and disclaims any implied warranties of merchantability and
fitness for a particular purpose. Interact Commerce shall not be liable for any
errors or for incidental or consequential damages in connection with the
furnishing, performance, or use of this manual or the examples herein. The
information in this document is subject to change without notice.
Trademarks
ACT! is a registered trademark and SideACT! is a trademark
under exclusive license to Interact Commerce Corporation by their owner,
Symantec Corporation, in the United States and other countries. Interact
Commerce Corporation and not Symantec Corporation has produced this publication
and is responsible for the contents hereof. Symantec and WinFax are U.S.
registered trademarks of Symantec Corporation. WinFax PRO is a trademark of
Symantec Corporation. Microsoft, MS, Windows, Windows CE, Windows NT, Word,
Schedule+, ActiveX, FoxPro, Visual Basic, and Visual C++ are either registered
trademarks or trademarks of Microsoft Corporation in the U.S. and/or other
countries. Dale Carnegie Training is a registered trademark of Dale Carnegie
and Associates, Inc. ECCO is a trademark of NetManage Inc. ExpensAble is a
registered trademark of Managemark, Inc. Palm is a trademark of Palm, Inc.
GoldMine is a trademark of Goldmine Software Corp. Janna Contact is the
exclusive property of Janna Systems Inc. Maximizer is a registered trademark of
Modatech Systems Inc. Lotus Organizer is a trademark of Lotus Development
Corporation. Quicken is a registered trademark of Intuit, Inc. Sidekick is a
trademark of Starfish Software. Sharkware is a trademark of CogniTech
Corporation. Tracker is a trademark of Softcode Pty Ltd. Yahoo! is a registered
trademark of Yahoo! Inc. WordPerfect is a registered trademark of Novell, Inc.
CompuServe is a registered trademark of CompuServe, Inc., and its affiliates.
cc:Mail and cc:Mail Mobile are trademarks of cc:Mail, Inc., a wholly owned
subsidiary of Lotus Development Corporation. Day Runner is a registered
trademark of Day Runner, Inc. Day-Timer is a registered trademark of
Day-Timers, Inc. Netscape is a trademark of Netscape Communications
Corporation. Portions of ACT! are Copyright 1995 by Streetwise Software. All
rights reserved.
Other product names mentioned in this
manual may be trademarks or registered trademarks of their respective companies
and are the sole property of their respective manufacturers.
Printed in the United States of America.
10 9 8 7 6 5
4 3 2 1
INTERACT
COMMERCE CORPORATION LICENSE AND WARRANTY
NOTICE: INTERACT COMMERCE
CORPORATION LICENSES THE ENCLOSED SOFTWARE TO YOU ONLY UPON THE CONDITION THAT
YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS LICENSE AGREEMENT. PLEASE READ
THE TERMS CAREFULLY BEFORE OPENING THIS PACKAGE, AS OPENING THE PACKAGE WILL
INDICATE YOUR ASSENT TO THEM. IF YOU DO NOT AGREE TO THESE TERMS, THEN INTERACT
COMMERCE CORPORATION IS UNWILLING TO LICENSE THE SOFTWARE TO YOU, IN WHICH
EVENT YOU SHOULD RETURN THE FULL PRODUCT WITH PROOF OF PURCHASE TO THE DEALER
FROM WHOM IT WAS ACQUIRED WITHIN THIRTY DAYS OF PURCHASE, AND YOUR MONEY WILL
BE REFUNDED.
LICENSE AND WARRANTY
The software which accompanies this license (the Software) is the property of Interact Commerce Corporation or its licensors and
is protected by copyright law. While Interact Commerce Corporation continues to
own the Software, you will have certain rights to use the Software after your
acceptance of this license. Except as may be modified by a license addendum
which accompanies this license, your rights and obligations with respect to the
use of this Software are as follows:
You may:
(i) use only one copy of the Software on a single computer;
(ii) make one copy of the Software for archival purposes, or copy the software
onto the hard disk of your computer and retain the original for archival
purposes;
(iii) use the Software on a network, provided that you have a licensed copy of
the Software for each computer that can access the Software over that network;
(iv) after written notice to Interact Commerce Corporation, transfer the
Software on a permanent basis to another person or entity, provided that you
retain no copies of the Software and the transferee agrees to the terms of this
agreement; and
(v) if a single person uses the computer on which the Software is installed at
least 80% of the time, then after registering the product, that person may also
use the Software on a single home computer.
You may not:
(i) copy the documentation which accompanies the Software;
(ii) sublicense, rent or lease any portion of the Software;
(iii) reverse engineer, decompile, disassemble, modify, translate, make any
attempt to discover the source code of the Software, or create derivative works
from the Software; or
(iv) use a previous version or copy of the Software after you have received a
disk replacement set or an upgraded version as a replacement of the prior
version, unless you donate a previous version of an upgraded version to a
charity of your choice, and such charity agrees in writing that it will be the
sole end user of the product, and that it will abide by the terms of this
agreement. Unless you so donate a previous version of an upgraded version, upon
upgrading the Software, all copies of the prior version must be destroyed.
Thirty Day Money Back Guarantee:
If you are the original licensee of this copy of the Software and are
dissatisfied with it for any reason, you may return the complete product,
together with your receipt, to the place of purchase, postage prepaid, for a
full refund at any time during the thirty day period following the delivery to
you of the Software.
Limited Warranty:
Interact Commerce warrants that the media on which the Software is distributed
will be free from defects for a period of thirty (30) days from the date of
delivery of the Software to you. Your sole remedy in the event of a breach of
this warranty will be that Interact Commerce will, at its option, replace any
defective media returned to Interact Commerce within the warranty period or
refund the money you paid for the Software. Interact Commerce does not warrant
that the Software will meet your requirements or that operation of the Software
will be uninterrupted or that the Software will be error-free.
THE ABOVE WARRANTY IS
EXCLUSIVE AND IN LIEU OF ALL OTHER WARRANTIES, WHETHER EXPRESS OR IMPLIED,
INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. THIS WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS. YOU
MAY HAVE OTHER RIGHTS, WHICH VARY FROM STATE TO STATE.
Disclaimer of Damages:
REGARDLESS OF WHETHER ANY REMEDY SET FORTH HEREIN FAILS OF ITS ESSENTIAL
PURPOSE, IN NO EVENT WILL INTERACT COMMERCE BE LIABLE TO YOU FOR ANY SPECIAL,
CONSEQUENTIAL, INDIRECT OR SIMILAR DAMAGES, INCLUDING ANY LOST PROFITS OR LOST
DATA ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE EVEN IF INTERACT
COMMERCE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME STATES DO
NOT ALLOW THE LIMITATION OR EXCLUSION OF LIABILITY FOR INCIDENTAL OR
CONSEQUENTIAL DAMAGES SO THE ABOVE LIMITATION OR EXCLUSION MAY NOT APPLY TO
YOU. IN NO CASE SHALL INTERACT COMMERCE CORPORATION'S LIABILITY EXCEED THE
PURCHASE PRICE FOR THE SOFTWARE. The disclaimers and limitations set forth
above will apply regardless of whether you accept the Software.
U.S. Government Restricted Rights:
RESTRICTED RIGHTS LEGEND. All Interact Commerce products and documentation are
commercial in nature. The software and software documentation are Commercial Items, as that term is defined in 48 C.F.R. 2.101, consisting of Commercial Computer Software and Commercial Computer Software Documentation, as such terms are defined in 48 C.F.R. 252.227-7014(a)(5) and 48 C.F.R. 252.227-7014(a)(1), and used in 48 C.F.R. 12.212 and 48 C.F.R. 227.7202, as applicable. Consistent with 48 C.F.R.
12.212, 48 C.F.R. 252.227-7015, 48 C.F.R. 227.7202 through 227.7202-4, 48 C.F.R. 52.227-14, and other relevant sections of the Code of Federal
Regulations, as applicable, Interact Commerce's computer software and computer
software documentation are licensed to United States Government end users with
only those rights as granted to all other end users, according to the terms and
conditions contained in this license agreement. Manufacturer is Interact
Commerce Corporation, 8800 N. Gainey Center Drive #200, Scottsdale, Arizona,
85258, USA.
General:
This Agreement will be governed by the laws of the State of Arizona. This
Agreement may only be modified by a license addendum which accompanies this
license or by a written document which has been signed by both you and Interact
Commerce. Should you have any questions concerning this Agreement, or if you
desire to contact Interact Commerce for any reason, please write: Interact
Commerce Customer Sales and Service, 8800 N. Gainey Center Drive #200,
Scottsdale, Arizona, 85258, USA.
Introducing the ACT!TM SDK
The ACT! Software Development Kit (SDK) includes documentation and sample code files for SDK components that are built into the ACT! application. You can use the ACT! SDK to extend the functionality of ACT!, enable external applications to control ACT! and read and write to ACT! database tables, and add auxiliary commands to the user interface to execute external programs. The ACT! SDK was developed for use by ACT! Certified Consultants, ACT! add-on product developers, independent software developers, and corporate developers.
The ACT! Software Development Kit (SDK) Technical Reference Guide is a set of eight documents: this introduction, sections for each of the five current components of the ACT! SDK, two appendixes of reference material, and a Readme file.
The following table describes the documents included in the ACT! Software Development Kit (SDK) Technical Reference Guide.
|
Section |
Document |
Description |
|
Introduction |
Introducing the ACT! SDK |
Introduction to the manual. Includes an overview, license and warranty information, and technical support information. |
|
I |
ACT! OLE Database Object |
Describes the ACT! OLE Database Object component of the ACT! SDK, which uses OLE automation to enable non-ACT! applications to read and write information in ACT! database tables. |
|
II |
ACT! OLE Application Object |
Describes the ACT! OLE Application Object component of the ACT! SDK, which uses OLE automation to provide non-ACT! applications with both control and context interrogation of the ACT! application. |
|
III |
ACT! Scripting Support |
Describes how to create scripts that can be notified of events in the ACT! application. |
|
IV |
Adding Extensible Views and Tabs to ACT! |
Describes how to add views, accessible by a Contact or Group tab or View command, to display HTML content within the ACT! application. |
|
V |
Adding Custom Commands to ACT! |
Describes the ACT! OLE Command Object component of the ACT! SDK, which uses OLE automation to add custom commands to ACT! that execute external programs. |
|
Appendix A |
ACT! Database File Format Reference |
Describes the file formats of ACT! database tables and relationships among ACT! tables. |
|
Appendix B |
ACT! Command ID Reference |
Lists ACT! command IDs referenced in the ACT! Application Object and Adding Custom Commands to ACT! sections of the ACT! SDK. |
The following sample files are included with the ACT! Software Development Kit (SDK).
· Sample Microsoft Visual Basic and Visual C++ code files for the ACT! OLE Application Object and the ACT! OLE Database Object.
· Sample control files for adding extensible views and tabs to the ACT! application.
Service and Support
Solutions
The ACT! Software Development Kit (SDK) offers two support options: “How Do I” support and Consulting services. For the latest information about support for the ACT! SDK, visit http://www.actsoftware.com/, click the Add Ons link, then click the Software Development Kit link.
To learn more about general ACT! Customer Service and Technical Support solutions, visit the web sites listed in the ACT! User’s Guide or choose Service and Support Information from the Help menu within ACT! See the back cover of the ACT! User’s Guide for general Customer Service and Technical Support telephone numbers.
“How-Do-I” Technical Support for the ACT! SDK is charged at $50 US per incident. An incident is defined as a question regarding one specific operation.
Please call (480) 444-1399 or (800) 927-3989 to leave a message for an ACT! SDK specialist. Your call will be returned within two business days. “How-Do-I” support is available Monday through Friday, 6:00 a.m. to 5:00 p.m. Pacific Standard Time.
Users of the ACT! SDK are also entitled to code debugging services. These services are charged at $100 US per hour. These services cover errors encountered during use of the ACT! SDK.
Please call(480) 444-1399 or (800) 927-3989 to leave a message for an ACT! SDK specialist. Your call will be returned within two business days. Consulting services are available Monday through Friday, 6:00 a.m. to 5:00 p.m. Pacific Standard Time.
Programming services are available from independent ACT! Certified Consultants. For a list of ACT! Certified Consultants, visit http://www.actsoftware.com/ then click the Certified Consultants link.
Every
effort has been made to ensure the accuracy of this information. Interactive
Commerce Corporation reserves the right to limit any single support call,
change the terms and conditions of support, and change support pricing and
service availability without notice.
I
ACT! Software Development Kit (SDK)
Technical Reference Guide
ACT! OLE Database Object
section
The software described
in this book is furnished under a license agreement and may be used only in
accordance with the terms of the agreement.
Copyright
Notice
Portions of this
publication copyright
2000 Interact Commerce Corporation. Portions of this publication copyright 1993 ‑ 2000
Symantec Corporation under exclusive license to Interact Commerce Corporation.
All Rights Reserved.
Released: 6/2000 for
ACT! 2000
This document may not,
in whole or in part, be copied, photocopied, reproduced, translated, or reduced
to any electronic medium or machine-readable form without prior consent in
writing from Interact Commerce Corporation, 8800 N. Gainey Center Dr. #200,
Scottsdale, AZ 85258.
ALL EXAMPLES WITH NAMES,
COMPANY NAMES, OR COMPANIES THAT APPEAR IN THIS MANUAL ARE IMAGINARY AND DO NOT
REFER TO, OR PORTRAY, IN NAME OR SUBSTANCE, ANY ACTUAL NAMES, COMPANIES,
ENTITIES, OR INSTITUTIONS. ANY RESEMBLANCE TO ANY REAL PERSON, COMPANY, ENTITY,
OR INSTITUTION IS PURELY COINCIDENTAL.
Every effort has been
made to ensure the accuracy of this manual. However, Interact Commerce makes no
warranties with respect to this documentation and disclaims any implied
warranties of merchantability and fitness for a particular purpose. Interact
Commerce shall not be liable for any errors or for incidental or consequential
damages in connection with the furnishing, performance, or use of this manual
or the examples herein. The information in this document is subject to change
without notice.
Trademarks
ACT! is a registered
trademark and SideACT! is a trademark under exclusive license to Interact
Commerce Corporation by their owner, Symantec Corporation, in the United States
and other countries. Interact Commerce Corporation and not Symantec Corporation
has produced this publication and is responsible for the contents hereof.
Symantec and WinFax are U.S. registered trademarks of Symantec Corporation.
WinFax PRO is a trademark of Symantec Corporation. Microsoft, MS, Windows,
Windows CE, Windows NT, Word, Schedule+, ActiveX, FoxPro, Visual Basic, and
Visual C++ are either registered trademarks or trademarks of Microsoft
Corporation in the U.S. and/or other countries. Dale Carnegie Training is a
registered trademark of Dale Carnegie and Associates, Inc. ECCO is a trademark
of NetManage Inc. ExpensAble is a registered trademark of Managemark, Inc. Palm
is a trademark of Palm, Inc. GoldMine is a trademark of Goldmine Software Corp.
Janna Contact is the exclusive property of Janna Systems Inc. Maximizer is a
registered trademark of Modatech Systems Inc. Lotus Organizer is a trademark of
Lotus Development Corporation. Quicken is a registered trademark of Intuit,
Inc. Sidekick is a trademark of Starfish Software. Sharkware is a trademark of
CogniTech Corporation. Tracker is a trademark of Softcode Pty Ltd. Yahoo! is a
registered trademark of Yahoo! Inc. WordPerfect is a registered trademark of
Novell, Inc. CompuServe is a registered trademark of CompuServe, Inc., and its
affiliates. cc:Mail and cc:Mail Mobile are trademarks of cc:Mail, Inc., a
wholly owned subsidiary of Lotus Development Corporation. Day Runner is a
registered trademark of Day Runner, Inc. Day-Timer is a registered trademark of
Day-Timers, Inc. Netscape is a trademark of Netscape Communications
Corporation. Portions of ACT! are Copyright 1995 by Streetwise Software. All
rights reserved.
Other
product names mentioned in this manual may be trademarks or registered
trademarks of their respective companies and are the sole property of their
respective manufacturers.
Printed in the United
States of America.
10 9 8 7 6 5
4 3 2 1
CONTENTS
Section
I ACT! OLE Database Object
Chapter
1 Getting Started with the OLE
Database Object.......................................... 17
Conventions
used in this section........................................................................... 17
Syntax conventions....................................................................................... 17
Terminology.................................................................................................. 18
Parameter
types.................................................................................................. 18
Special
data types............................................................................................... 19
Overview
of the ACT! OLE Database Object........................................................... 21
Features
and limitations of the ACT! OLE Database Object............................... 22
System
requirements..................................................................................... 22
Development
languages................................................................................. 22
Using
the Database Object with Visual C++..................................................... 22
Understanding
key files........................................................................................ 24
Using
the type library........................................................................................... 25
ACT!
Database Unique ID field considerations........................................................ 25
ACT!
OLE Database Object definitions.................................................................. 26
ACT!
OLE object model........................................................................................ 27
What’s
new......................................................................................................... 28
Changes
for ACT! 3.0.6.................................................................................. 28
Changes
for ACT! 3.0.7.................................................................................. 29
Changes
for ACT! 4.0..................................................................................... 29
Changes
for ACT! 4.0.2.................................................................................. 30
Changes
for ACT! 2000.................................................................................. 30
Chapter
2 Using Database Object Properties
and Methods...................................... 33
Common
properties and methods.......................................................................... 34
Add
Method.................................................................................................. 38
Close
Method................................................................................................ 39
Data
Property................................................................................................ 39
Delete
Method............................................................................................... 40
Edit
Method.................................................................................................. 41
Error
Property............................................................................................... 41
Execute
Method............................................................................................ 42
FieldCount
Property....................................................................................... 42
Fields
Property.............................................................................................. 43
FindDuplicates
Method (requires ACT! 2000 or later)......................................... 43
GetDataEx
Method (requires ACT! 4.0.2 or later).............................................. 44
GetDuplicateCriteria
Method (requires ACT! 2000 or later)................................. 46
GetSort
Method (requires ACT! 4.0 or later)...................................................... 47
GoTo
Method................................................................................................ 48
IsBOF
Property............................................................................................. 48
IsEOF
Property............................................................................................. 49
IsLocked
Property......................................................................................... 49
IsOpen
Property............................................................................................ 49
Jump
Method................................................................................................ 50
LastError
Property......................................................................................... 50
LockLevel
Property........................................................................................ 51
Lookup
Method............................................................................................. 51
LookupKeyword
Method................................................................................. 52
MoveFirst
Method.......................................................................................... 53
MoveLast
Method.......................................................................................... 53
MoveNext
Method.......................................................................................... 53
MovePrevious
Method.................................................................................... 54
Name
Property.............................................................................................. 54
Position
Property........................................................................................... 54
Query
Property.............................................................................................. 55
Rebuild
Method............................................................................................. 55
RecordCount
Property.................................................................................... 55
SetDataEx
Method (requires ACT! 4.0.2 or later).............................................. 56
SetDuplicateCriteria
Method (requires ACT! 2000 or later).................................. 57
Sort
Method.................................................................................................. 58
Update
Method.............................................................................................. 59
Activity
object properties and methods.................................................................. 60
Clear
Method................................................................................................ 62
ClearClearedFilter
Method.............................................................................. 62
ClearContactScope
Method............................................................................ 62
ClearDateScope
Method................................................................................ 63
ClearGroupScope
Method.............................................................................. 63
ClearPriorityFilter
Method............................................................................... 63
ClearRecurring
Method................................................................................... 64
ClearTimedFilter Method................................................................................ 64