VST Programmers Guide GP10

Visual Studio® Tools for Microsoft Dynamics® GP 2010
Programmer’s Guide
Copyright Copyright © 2010 Microsoft Corporation. All rights reserved.
Limitation of liability This document is provided “as-is”. Information and views expressed in this document, including URL
and other Internet Web site references, may change without notice. You bear the risk of using it.
Some examples depicted herein are provided for illustration only and are fictitious. No real
association or connection is intended or should be inferred.
Intellectual property This document does not provide you with any legal rights to any intellectual property in any Microsoft
product.
You may copy and use this document for your internal, reference purposes.
Trademarks Microsoft, Dexterity, Microsoft Dynamics, Visual Basic, Visual Studio, Windows, Windows Server, and
Windows Vista are trademarks of the Microsoft group of companies.
All other trademarks are property of their respective owners.
Warranty disclaimer Microsoft Corporation disclaims any warranty regarding the sample code contained in this
documentation, including the warranties of merchantability and fitness for a particular purpose.
License agreement Use of this product is covered by a license agreement provided with the software product. If you have
any questions, please call the Microsoft Dynamics GP Customer Assistance Department at
800-456-0025 (in the U.S. or Canada) or +1-701-281-6500.
Publication date March 2010

Contents
Introduction ................................................................................................................................................. 2
What’s in this manual...................................................................................................................................2
What’s new in this release of Visual Studio Tools....................................................................................2
Prerequisites...................................................................................................................................................3
Symbols and conventions ............................................................................................................................3
Product support ............................................................................................................................................4
Chapter 1: SDK Installation ........................................................................................................ 5

Installation procedure ..................................................................................................................................5
Template registration....................................................................................................................................6
What was installed........................................................................................................................................7
Upgrading to Visual Studio 2008................................................................................................................7
Part 1: Getting Started ............................................................................................................. 10

Chapter 2: Integration Basics.................................................................................................. 11
What Visual Studio Tools provides .......................................................................................................... 11
Architecture ................................................................................................................................................. 11
Creating a project ........................................................................................................................................12
Chapter 3: Upgrading an Integration .............................................................................. 15

Upgrading from Release 9 .........................................................................................................................15
Upgrading from Release 10 .......................................................................................................................19
Part 2: Developing Integrations ................................................................................... 22

Chapter 4: WinForms ...................................................................................................................... 23
Adding a Dynamics GP form to a project ...............................................................................................23
WinForm properties....................................................................................................................................24
Adding controls...........................................................................................................................................25
Chapter 5: Control Reference ................................................................................................ 27

Buttons..........................................................................................................................................................27
TextBoxes......................................................................................................................................................29
Labels ............................................................................................................................................................30
ComboBoxes ................................................................................................................................................30
ListBoxes ......................................................................................................................................................30
Chapter 6: Dictionary Assembly Generator .............................................................. 31

Creating application assemblies ...............................................................................................................31
Output files ..................................................................................................................................................31
Using the Dictionary Assembly Generator .............................................................................................32
Optimizing the assembly generating process.........................................................................................34
Chapter 7: Accessing Dictionary Resources ............................................................ 35

Adding references.......................................................................................................................................35
Namespace...................................................................................................................................................36
PROGRAMMER’S GUIDE i
C O N T E N T S
Dictionary class ...........................................................................................................................................36

Accessing additional resources .................................................................................................................37
Variables for dictionary resources ............................................................................................................37
Chapter 8: Events .............................................................................................................................. 39

Registering events.......................................................................................................................................39
Responding to events .................................................................................................................................41
Unregistering events...................................................................................................................................42
Chapter 9: Working with Tables ........................................................................................... 45

Tables in Microsoft Dynamics GP.............................................................................................................45
Table buffers.................................................................................................................................................46
Opening and closing tables .......................................................................................................................47
Keys...............................................................................................................................................................48
Retrieving a row..........................................................................................................................................48
Saving a row ................................................................................................................................................49
Updating a row ...........................................................................................................................................50
Removing a row ..........................................................................................................................................51
Table operation errors ................................................................................................................................52
Ranges...........................................................................................................................................................53
Row locking .................................................................................................................................................57
Multiuser processing ..................................................................................................................................57
Chapter 10: Building and Deploying ................................................................................ 63

Setting assembly information....................................................................................................................63
Building an integration ..............................................................................................................................64
Deploying an integration...........................................................................................................................65
Chapter 11: Debugging ................................................................................................................. 67

Preparing to debug .....................................................................................................................................67
Examining the application.........................................................................................................................68
Disabling events ..........................................................................................................................................68
Chapter 12: Modified and Alternate Forms............................................................... 69

Modified forms............................................................................................................................................69
Alternate forms ...........................................................................................................................................70
Guidelines ....................................................................................................................................................71
Chapter 13: Implementing Macro Support ................................................................ 73

Overview of macro support ......................................................................................................................73
Recording macros .......................................................................................................................................73
Playing macros ............................................................................................................................................74
Handling asynchronous processes during playback.............................................................................76
Chapter 14: Using Lookups ...................................................................................................... 77

How lookups work .....................................................................................................................................77
Available lookups........................................................................................................................................78
Lookup example..........................................................................................................................................78
ii P R O G R A M M E R ’ S G U I D E
C O N T E N T S
Part 3: Resource Reference ................................................................................................ 82

Chapter 15: Forms............................................................................................................................. 83
Accessing forms ..........................................................................................................................................83
Form methods .............................................................................................................................................83
Form properties...........................................................................................................................................85
Form events .................................................................................................................................................86
Chapter 16: Windows ..................................................................................................................... 87

Accessing windows ....................................................................................................................................87
Window methods........................................................................................................................................87
Window properties .....................................................................................................................................87
Window events............................................................................................................................................88
Chapter 17: Scrolling Windows ............................................................................................ 93

Accessing scrolling windows ....................................................................................................................93
Scrolling window methods........................................................................................................................93
Scrolling window properties.....................................................................................................................93
Scrolling window events............................................................................................................................93
Chapter 18: Window Fields ....................................................................................................... 97

Accessing window fields ...........................................................................................................................97
Window field methods...............................................................................................................................97
Window field properties ............................................................................................................................99
Window field events.................................................................................................................................100
Chapter 19: Tables ......................................................................................................................... 101

Accessing tables ........................................................................................................................................101
Table methods............................................................................................................................................102
Table properties .........................................................................................................................................105
Chapter 20: Table Fields ........................................................................................................... 107

Accessing table fields ...............................................................................................................................107
Table field methods...................................................................................................................................107
Table field properties ................................................................................................................................108
Chapter 21: Commands ............................................................................................................ 109

Command types ........................................................................................................................................109
Accessing commands ...............................................................................................................................109
Command methods ..................................................................................................................................109
Chapter 22: Globals ....................................................................................................................... 111

Accessing globals ...................................................................................................................................... 111
Global properties....................................................................................................................................... 111
Chapter 23: Procedures ............................................................................................................ 113

Accessing global procedures ................................................................................................................... 113
Accessing form-level procedures............................................................................................................ 113
Procedure methods................................................................................................................................... 113
Procedure events....................................................................................................................................... 114
Parameters for procedures....................................................................................................................... 115
PROGRAMMER’S GUIDE iii

C O N T E N T S
Invokable procedures ............................................................................................................................... 116
Chapter 24: Functions ................................................................................................................. 117

Accessing global functions ...................................................................................................................... 117
Accessing form-level functions............................................................................................................... 117
Function methods ..................................................................................................................................... 118
Function events ......................................................................................................................................... 118
Parameters for functions.......................................................................................................................... 119
Invokable functions ..................................................................................................................................120
Chapter 25: Composites ........................................................................................................... 121

Composite types........................................................................................................................................121
Accessing composites...............................................................................................................................121
Composite field methods.........................................................................................................................123
Composite field properties ......................................................................................................................125
Composite field events.............................................................................................................................126
Part 4: Integration Examples ........................................................................................ 128

Chapter 26: Field Defaulter ................................................................................................... 129
Overview....................................................................................................................................................129
Running the sample application.............................................................................................................129
How Visual Studio Tools was used ........................................................................................................130
Chapter 27: Estimate Freight............................................................................................... 131

Overview....................................................................................................................................................131
Chapter 28: Environmental Details ................................................................................ 135

Overview....................................................................................................................................................135
Chapter 29: Lookups ................................................................................................................... 139

Overview....................................................................................................................................................139
Glossary ..................................................................................................................................................... 143
Index ............................................................................................................................................................... 145
iv P R O G R A M M E R ’ S G U I D E
INTRODUCTION
Introduction
Welcome to Visual Studio® Tools for Microsoft Dynamics® GP. This documentation
explains how to integrate applications you create with Visual Studio into Microsoft
Dynamics GP. Before you begin creating an integration for Microsoft Dynamics GP,
take a few moments to review the information presented here.
What’s in this manual

The Visual Studio Tools for Microsoft Dynamics GP Programmer’s Guide is
designed to give you an in-depth understanding of how to use these tools to create
an application that integrates with Microsoft Dynamics GP. Even if you are familiar
with using Visual Studio to develop applications, you will find it helpful to browse
the material presented here.
Information is divided into the following parts:
• Part 1, Getting Started, explains how to install Visual Studio Tools for Microsoft
Dynamics GP and begin creating an integration.
• Part 2, Developing Integrations, provides detailed information about creating

WinForms that match the Microsoft Dynamics GP appearance. Interacting with
Microsoft Dynamics GP through events is discussed. Building, deploying, and
debugging integrations are also addressed.
• Part 3, Resource Reference, provides detailed information about interacting

with the various types of resources in Microsoft Dynamics GP.
• Part 4, Integration Examples, describes example integrations that use Visual

Studio Tools for Microsoft Dynamics GP.
What’s new in this release of Visual Studio Tools

Refer to the following list for more information about the new features added for
this release of Visual Studio Tools for Microsoft Dynamics GP.
1. Modal dialog events

Events for modal dialogs have been added. These events allow you to modify
and respond to the modal dialog windows in Microsoft Dynamics GP. Refer to
BeforeModalDialog and AfterModalDialog in Chapter 16, “Windows,” for
details about using these new events.
2. Procedure events
Events for procedures have been added. Refer to Procedure events on page 114
for more information.
3. Function events
Events for functions have been added. Refer to Function events on page 118 for
more information.
4. Events can be unregistered

Some events in Visual Studio Tools can now be unregistered. See Unregistering
events on page 42 for more information.
2 P R O G R A M M E R ’ S G U I D E
IN T RO D U C T IO N
5. Table buffers as parameters

You can now access procedures and functions that have table buffers as
parameters.
6. Macro support
You can add code to forms you create with Visual Studio Tools so that the forms
can be accessed by the macro system in Microsoft Dynamics GP. Refer to
Chapter 13, “Implementing Macro Support,” for more information.
Prerequisites
You must be using Microsoft Dynamics GP 2010. Since you will be working with
Microsoft Dynamics GP, knowledge of the accounting system will be helpful.
Consult the Microsoft Dynamics GP documentation resources to learn more about
the product.
You will also want to install the SDK for Microsoft Dynamics GP. The SDK is
available in the Tools folder on the Microsoft Dynamics GP installation media. It
contains useful information about Microsoft Dynamics GP, such as lists of
commonly-used procedures and functions.
To use Visual Studio Tools for Microsoft Dynamics GP, Visual Studio 2005 with
Service Pack 1 or Visual Studio 2008 is required. Earlier versions of Visual Studio
cannot be used. It is assumed that you are familiar with programming in a managed
language such as C#. This documentation uses both C# and Visual Basic to
demonstrate how to create integrations.
Symbols and conventions

To help you use this documentation more effectively, we’ve used the following
symbols and conventions within the text to make specific types of information
stand out.
Symbol Description
The light bulb symbol indicates helpful tips, shortcuts,
and suggestions.
Warnings indicate situations you should be aware of

when completing tasks.
Margin notes summarize Margin notes call attention to critical information and
important information. direct you to other areas of the documentation where
a topic is explained.
Convention Description
Part 1, Getting Started Bold type indicates a part name.
Chapter 5, “Web Methods” Quotation marks indicate a chapter name.
Adding controls Italicized type indicates a section name.
using System.IO; This font is used to indicate script examples.
Dictionary Assembly Acronyms are spelled out the first time they’re used.
Generator (DAG)
TAB or ALT+M Small capital letters indicate a key or a key sequence.
PROGRAMMER’S GUIDE 3
I N T R O D U C T I O N
Product support
Microsoft Dynamics GP developer technical support can be accessed online or by
telephone. Go to www.microsoft.com/dynamics and click the CustomerSource or
PartnerSource link, or call 888-477-7877 (in the US and Canada) or 701-281-0555.
Chapter 1: SDK Installation
The Visual Studio Tools for Microsoft Dynamics GP SDK contains the components
needed to create and build integrations. The following topics are discussed:
• Installation procedure
• Template registration
• What was installed
• Upgrading to Visual Studio 2008
Installation procedure
The Visual Studio Tools for Microsoft Dynamics GP SDK installer requires Visual
Studio 2005 or Visual Studio 2008 to be installed first. For testing integrations, you
will also want Microsoft Dynamics GP installed.
If you have installed an earlier version of the Visual Studio Tools SDK, be sure that you
remove it from the system before you install the new version.
To install the Visual Studio Tools for Microsoft Dynamics GP SDK, complete the
following procedure:
1. Start the Visual Studio Tools SDK installer.

Start the installer by running the VSToolsSDK.exe.
2. View the welcome screen.

Click Next to continue.
3. Acknowledge the license agreement.

Read and acknowledge the license agreement. Click Next to continue.
4. Specify the features to install.

Choose the features that will be installed:
Feature Description
Visual Studio 2005 Templates The C# and Visual Basic templates for projects and
forms. Visual Studio 2005 is required to install this
feature.
Visual Studio 2008 Templates The C# and Visual Basic templates for projects and
forms. Visual Studio 2008 is required to install this
feature.
Documentation The Visual Studio Tools for Microsoft Dynamics GP
Programmer’s Guide.
Samples Sample integrations that demonstrate Visual Studio
Tools.
Assemblies and Assembly The Dictionary Assembly Generator (Dag.exe) and
Generator the dictionary assemblies for the products that ship
with Microsoft Dynamics GP. Also includes the
IntelliSense XML files used by Visual Studio to
display information about the resources accessed
through the application assemblies.
5. Specify the installation location.

Use the default location, or choose another location. Click next to continue.
PA RT 1 G E TT I N G S T A R TE D
6. Begin the installation.

Click Install to begin installing the SDK components.
During the installation, Visual Studio must be reconfigured to recognize the new
templates being installed. This process may take a few minutes to complete.
7. Finish the installation.

Click Finish to complete the installation.
Template registration
If you are running with limited user privileges or with User Account Control (UAC)
active, the templates installed for Visual Studio Tools may not be registered in
Visual Studio. You may need to manually register the templates so they will appear
as selections when you create new projects.
To register the templates, perform the following command to have Visual Studio
2005 re-create its template cache:
C:\Program Files\Microsoft Visual Studio 8\Common7\IDE\devenv.exe /setup
Use the following command for Visual Studio 2008 to re-create its template cache:
C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\devenv.exe /setup
On systems that are running with UAC (User Account Control), you will need to set
the properties of the devenv.exe application to be run with administrative
privileges.
On systems with UAC,

choose to run devenv.exe
as an administrator.
C H A P T E R 1 S D K I N S T A L L A T I O N
What was installed

The following items are installed for Visual Studio Tools for Microsoft Dynamics GP
in the location you specified:
Component Description
VSTDGPReadme.rtf Contains late-breaking information about
Visual Studio Tools for Microsoft Dynamics
GP.
VSTDGPProgrammersGuide.pdf Documentation for Visual Studio Tools.
Samples.zip Sample Visual Studio projects that
demonstrate Visual Studio Tools.
Microsoft.Dexterity.Bridge.dll Core Microsoft Dynamics GP components
Microsoft.Dexterity.Shell.dll used by Visual Studio Tools integrations.
Microsoft.Dynamics.Framework.UI.Navigation.dll
Microsoft.Dynamics.Framework.UI.WinForms.
Controls.dll
Dag.exe The Dictionary Assembly Generator, used to
create application assemblies for application
dictionaries and forms dictionaries.
Bidi32.dll Support files needed for Dag.exe
Ddapi.dll
Tntlib.dll
Dex.dic
Dex.ini
Application Assemblies Assemblies that contain information about
the resources in each dictionary that is
shipped with Microsoft Dynamics GP. In
addition to US English, other local versions
of application assemblies are included.
IntelliSense XML files Used by Visual Studio to display information
about the corresponding application
assembly.
If you chose to install them, the project templates for C# and Visual Basic will be in
the appropriate locations for Visual Studio.
Upgrading to Visual Studio 2008

If you have previously installed the Visual Studio Tools for Microsoft Dynamics GP
2010 SDK and want to upgrade from Visual Studio 2005 to Visual Studio 2008,
complete the following procedure:
1. Install Visual Studio 2008.
2. Start the Visual Studio Tools SDK installer.

Start the installer by running the VSToolsSDK.exe. The updated components for
Visual Studio Tools will be installed.
3. Close the installer.

When the installer has finished updating components, click Finish.
4. Change the Visual Studio Tools installation.

In Add or Remove Programs (Windows XP or Windows Server 2003) or
Programs and Features (Windows Vista, Windows 7, or Windows Server 2008)
choose Visual Studio Tools for Microsoft Dynamics GP 2010 SDK. Click Change.
5. Add a new feature.

Click Add/Remove Features to add a new feature to the Visual Studio Tools
installation.
6. Install the Visual Studio 2008 templates.

Mark the option to install the Visual Studio 2008 templates, and then click Next.
Click Install to begin the installation process.
7. Finish the installation.

Click Finish to complete the installation.
PART 1: GETTING STARTED
Part 1: Getting Started
This portion of the documentation describes how to get started creating an
integration using Visual Studio Tools for Microsoft Dynamics GP. The following
topics are discussed:
• Chapter 1, “SDK Installation,” explains how to install Visual Studio Tools SDK
for Microsoft Dynamics GP.
• Chapter 2, “Integration Basics,” describes the architecture of a Visual Studio

Tools for Microsoft Dynamics GP integration. It also explains how to create a
project for a new integration.
• Chapter 3, “Upgrading an Integration,” explains how to upgrade an existing

integration to work with the current version of Visual Studio Tools for Microsoft
Dynamics GP.
Chapter 2: Integration Basics
Before you create an integration using Visual Studio Tools for Microsoft Dynamics
GP, it will be helpful to understand the basics of an integration. The following topics
are discussed:
• What Visual Studio Tools provides

• Architecture
• Creating a project
What Visual Studio Tools provides

Visual Studio Tools for Microsoft Dynamics GP provides three main capabilities for
an integrating application:
Customized WinForms
Any WinForms included in an integrating application can use capabilities provided
by Visual Studio Tools for Microsoft Dynamics GP to match the appearance of the
core application. The appearance of the window as well as the various controls in
the window can be customized. You will learn about creating windows for your
integration in Chapter 4, “WinForms,” and Chapter 5, “Control Reference.”
Access to dictionary resources

Integrating applications have access to the numerous resources available in the
application dictionaries used for Microsoft Dynamics GP. An integrating
application can access the forms, windows, window fields, tables, and table fields in
each dictionary. They can also access global variables, commands, procedures, and
functions defined in each dictionary. You will learn about accessing dictionary
resources in Chapter 7, “Accessing Dictionary Resources.”
Access to events
Integrating applications can be notified of events that occur in Microsoft Dynamics
GP, such as a window being opened, or the focus moving to a field. The applications
can respond to the events, performing actions like verifying field values or opening
additional windows. Chapter 8, “Events,” contains information about registering
for and responding to events.
Architecture
Visual Studio Tools for Microsoft Dynamics GP consists of runtime components and
development components.
Runtime components
The runtime components for Visual Studio Tools are installed with Microsoft
Dynamics GP, and provide the functionality used by the integrations. These consist
of the following:
Dexterity Shell This assembly (Microsoft.Dexterity.Shell.dll) provides the

drawing capabilities that allow an integrating application to match the appearance
of Microsoft Dynamics GP.
Dexterity Bridge This assembly (Microsoft.Dexterity.Bridge.dll) provides the

access to events in Microsoft Dynamics GP, as well as the resources in the
application dictionaries.
Application assemblies Each dictionary that will be accessed by a Visual

Studio Tools for Microsoft Dynamics GP integration will have an application
assembly. Each application assembly provides access to the resources in its
corresponding dictionary. For example, the Application.Dynamics.dll assembly
provides access to the resources in the Dynamics.dic dictionary.
Visual Studio Tools for Microsoft Dynamics GP includes the application assemblies
for all the modules that ship with Microsoft Dynamics GP. You can use the
Dictionary Assembly Generator tool (Dag.exe) to create application assemblies for
other third-party dictionaries for Microsoft Dynamics GP. You will learn more about
this tool in Chapter 6, “Dictionary Assembly Generator.”
AddIns folder The assemblies for the integrating applications created with
Visual Studio Tools for Microsoft Dynamics GP are placed in this folder. When
Microsoft Dynamics GP is launched, it automatically looks in this folder and
attempts to launch the integrating applications it finds there.
Development components
The following development components are installed in the folder where you chose
to install Visual Studio Tools for Microsoft Dynamics GP:
DAG.exe This is the Dictionary Assembly Generator tool, used to create

application assemblies for dictionaries. You will use this to create application
assemblies for third-party dictionaries that do not have them. You will also use it to
create application assemblies for forms dictionaries in cases where your integration
must interact with modified forms in Microsoft Dynamics GP.
IntelliSense XML files The IntelliSense XML file contains the information
about the application assembly that is displayed in the IntelliSense within Visual
Studio. The name of the application XML file matches that of the application
assembly it corresponds to. For example, the Application.Dynamics.xml file
contains information about the Application.Dynamics.dll assembly.
The following components are installed into the Visual Studio installation:
Visual Basic project This is the template project for an add-in that is based in
Visual Basic.
Visual C# project This is the template project for an add-in that is based in
Visual C#.
Creating a project
Use the following procedure to create a new Visual Studio project for a Microsoft
Dynamics GP add-in.
1. Start Visual Studio.

If it isn’t already running, start Visual Studio.
2. Create a new project.

In the File menu, point to New and choose Project.
3. Select the project type.

Choose either a Visual Basic project or a Visual C# project. Under the type you
have selected, choose Dynamics GP.
C H A P T E R 2 I N T E G R A T I O N B AS I C S
4. Choose the Microsoft Dynamics GP Add-in template.

In the list of available templates, choose the Microsoft Dynamics GP Add-in
project template.
If the Microsoft Dynamics GP templates are not listed, you may need to register them
manually. Refer to Template registration on page 6 for details about doing this.
5. Specify the name and location of the project.

Click OK to create the project.
Chapter 3: Upgrading an Integration
If you have created an integration with Visual Studio Tools for an earlier release of
Microsoft Dynamics GP, use the following procedures to upgrade your integration
to work with the current version of Visual Studio Tools. Be sure you have installed
the current version of Visual Studio Tools before attempting to upgrade your
integrations. The following upgrade procedures are described:
• Upgrading from Release 9

• Upgrading from Release 10
Upgrading from Release 9

If your integration was created with Release 9 of Visual Studio Tools, use the
following procedures to upgrade your integration to work with Visual Studio Tools
for Microsoft Dynamics GP 2010. Separate procedures are included for C# and
Visual Basic.
C# integration
Use the following procedure to upgrade a Visual Studio Tools integration created
with C#.
1. Open the solution for your integration.

Using Visual Studio, open the solution file for the integration you want to
upgrade.
2. Rebuild application assemblies.

If you had built any application assemblies for your integration, you will need
to re-build them so they are up-to-date with the latest version of Microsoft
Dynamics GP.
3. Update the assembly references.

The assembly references for the project will be incorrect, because they won’t
refer to the new versions of the Visual Studio Tools components and application
assemblies.
The assembly references

are incorrect and need to
be updated.
Add references to the updated Visual Studio Tools assemblies, to replace the
broken references.
The reference to the Microsoft.Dexterity.Shell.UI assembly is a special situation. This

component was merged into the Microsoft.Dexterity.Shell assembly. Create a reference
to the Microsoft.Dexterity.Shell assembly, and delete the reference to the
Microsoft.Dexterity.Shell.UI assembly.
4. Update the namespaces used in integration code.

The namespace for the shell (user interface) components of the Visual Studio
Tools integration has changed. The namespace reference must be changed from:
Microsoft.Dexterity.Shell.UI
To the updated value:
Microsoft.Dexterity.Shell
5. Update the namespace references used for any forms.

The same namespace change must be made for any forms you created for your
integration. When you attempt to open a form in the Visual Studio designer,
you will see an error similar to the following:
This means that the code used for the form is using the old namespace, rather
than the new Microsoft.Dexterity.Shell namespace. You must view the code for
the form, and change all of the namespace references to remove the “UI”
portion. This will be required in several places. An example of code to be fixed
is shown highlighted in the following illustration.
You may need to expand some hidden sections of the code to find all of the references.
After making these changes to the form’s code, save the updated file. Close the
form designer if it is still open, and then re-open the form. The form should now
open and have the updated Microsoft Dynamics GP appearance.
6. Build the solution.

Choose to build the updated solution in Visual Studio. You may encounter
build errors if your integration references resources in Microsoft Dynamics GP
that have been deleted, moved, or renamed. You will need to fix these issues
and rebuild the integration.
C H A P T E R 3 U P G R A D I N G A N I N TE G R A T I O N
Visual Basic integration

Use the following procedure to upgrade a Visual Studio Tools integration created
with Visual Basic.

upgrade.

Dynamics GP.

assemblies.
The assembly references

are incorrect and need to
be updated.
broken references.
The reference to the Microsoft.Dexterity.Shell.UI assembly is a special situation. This

component was merged into the Microsoft.Dexterity.Shell assembly. Create a reference
to the Microsoft.Dexterity.Shell assembly, and delete the reference to the
Microsoft.Dexterity.Shell.UI assembly.
4. Update the namespaces used in integration code.

The namespace for the shell (user interface) components of the Visual Studio
Tools integration has changed. Any namespace reference must be changed
from:
Microsoft.Dexterity.Shell.UI
To the updated value:
5. Update the namespace references used for any forms.

The same namespace change must be made for any forms you created for your
integration. When you attempt to open a form in the Visual Studio designer, the
code for the form will be displayed:
Fix the namespace

references for the form.
6. Update the form designer code.

Open the “Designer” source file for the form to fix the references so they use the
new Microsoft.Dexterity.Shell namespace. Change all of the namespace
references to remove the “UI” portion. This will be required in several places.
An example of code to be fixed is shown in the following illustration.
Fix all of the references

to use the new
namespace.
After making these changes to the form’s code, save the updated file. Re-open
the form. The form should appear in the form designer and have the updated
Microsoft Dynamics GP appearance.

C H A P T E R 3 U P G R A D I N G A N I N TE G R A T I O N
Upgrading from Release 10

If your integration was created with Release 10 of Visual Studio Tools, use the
following procedures to upgrade your integration to work with Visual Studio Tools
for Microsoft Dynamics GP 2010. The upgrade procedure is relatively simple. The
same procedure can be used for both C# and Visual Basic.

upgrade.

Dynamics GP.

assemblies.
incorrect references.

PART 2: DEVELOPING INTEGRATIONS
Part 2: Developing Integrations
This portion of the documentation describes the various techniques you will use as
you develop integrations using Visual Studio Tools for Microsoft Dynamics GP. The
following topics are discussed:
• Chapter 4, “WinForms,” describes how to create WinForms that have the

appearance of windows in Microsoft Dynamics GP.
• Chapter 5, “Control Reference,” provides details of the various controls that are
modified by Visual Studio Tools for Microsoft Dynamics GP.
• Chapter 6, “Dictionary Assembly Generator,” describes the tool used to create

.NET assemblies that provide access to dictionary resources.
• Chapter 7, “Accessing Dictionary Resources,” explains how to access resources

in dictionaries from your integrating application.
• Chapter 8, “Events,” describes how to register for and respond to events for
Microsoft Dynamics GP.
• Chapter 9, “Working with Tables,” describes how to directly access Microsoft

Dynamics GP tables from an integration.
• Chapter 10, “Building and Deploying,” explains how to build and deploy an
integration you have created.
• Chapter 11, “Debugging,” explains how to debug an integration created with

Visual Studio Tools for Microsoft Dynamics GP.
• Chapter 12, “Modified and Alternate Forms,” describes how to access resources
on modified forms and alternate forms in Microsoft Dynamics GP.
• Chapter 13, “Implementing Macro Support,” explains how to make forms

created with Visual Studio Tools accessible by the macro system in Microsoft
Dynamics GP.
• Chapter 14, “Using Lookups,” describes how to use existing lookups from
Microsoft Dynamics GP in your Visual Studio Tools integration.
Chapter 4: WinForms
Standard WinForms are the basis for the user interface for add-ins created with
Visual Studio Tools for Microsoft Dynamics GP. These WinForms and the controls
placed on them are specially modified to match the appearance of Microsoft
Dynamics GP. Information about WinForms is divided into the following sections:
• Adding a Dynamics GP form to a project

• WinForm properties
• Adding controls
Adding a Dynamics GP form to a project

To add a new Dynamics GP form to an add-in project, complete the following
procedure:
1. Add a new component.

In Visual Studio, choose Add Component from the Project menu.
2. Select a Microsoft Dynamics GP Form.

In the list of templates, choose a Microsoft Dynamics GP form.
Choose a Microsoft
Dynamics GP Form.
3. Name the new form.

Give the form a name that is appropriate for how it will be used.
4. Add the new form.

Click Add to add the new WinForm to the project.
5. Specify the form properties.

Set the necessary properties for the new form.
PA RT 2 D E V E L O PI N G I N TE G R A T I O N S
WinForm properties
WinForms that are added to a Visual Studio Tools for Microsoft Dynamics GP
project have several additional properties that control their appearance. Setting
these properties correctly helps match the appearance of Microsoft Dynamics GP.
These properties are:
• AutoSetDexColors
• ControlArea
• StatusArea
These WinForm properties are found in the “Dexterity” group in the Properties pane in
Visual Studio.
AutoSetDexColors
The AutoSetDexColors property controls whether the colors used for the WinForm
will automatically match the color scheme selected in the user preferences within
Microsoft Dynamics GP. Set this property to True to match the Microsoft Dynamics
GP appearance.
ControlArea
The ControlArea property specifies whether the band called the control area is
drawn at the top of the WinForm. In standard Microsoft Dynamics GP windows,
controls such as Save, Clear, and Delete buttons are placed in the control area. Set
this property to True to display the control area for a WinForm.
This is the control area.
StatusArea
The StatusArea property specifies whether the band called the status area is drawn
at the bottom of the WinForm. A divider line is drawn across the bottom of the
WinForm to indicate the status area. In standard Microsoft Dynamics GP windows,
controls like browse buttons, note buttons, and help buttons are placed in the status
area. Set this property to True to display the status area for a WinForm.
This is the status area.
C H A P T E R 4 W I N F O R M S
Adding controls
You can add controls to the forms for your Microsoft Dynamics GP integration the
same way you add them to standard windows forms. Simply select the control in
the Toolbox and drag it out onto the form.
To add a control, just

select it in the Toolbox
and drag it onto the form.
When you add the controls, additional properties will be available for some of them
to match the Microsoft Dynamics GP appearance. For example, push buttons will
have additional properties. Refer to Chapter 5, “Control Reference,” for more
information about individual controls.
Chapter 5: Control Reference
You can use any of the available controls on the WinForms for your Microsoft
Dynamics GP integration. Some of the standard controls have been customized to
better match the appearance of Microsoft Dynamics GP. This portion of the
documentation describes the controls that have additional properties or updated
characteristics when used on a WinForm in a Visual Studio Tools for Microsoft
Dynamics GP project. The following controls are discussed:
• Buttons
• TextBoxes
• Labels
• ComboBoxes
• ListBoxes
Buttons
Button controls are used for each of the button types in a Microsoft Dynamics GP
form. The button controls on a WinForm for a Microsoft Dynamics GP project get
their additional characteristics from the dexButtonProvider you see on the
WinForm layout. The ButtonType property is an additional property available for
each button. It specifies how the button control is displayed and what
characteristics it will have. You can set the AutoSetDexColors property to True so
the button colors will match colors in Microsoft Dynamics GP.
The following is a list of the settings for the ButtonType property, and a description
of how each button type is used.
Standard
Standard buttons don’t have their appearance modified changed when placed on a
WinForm for a Dynamics GP project. The following illustration shows a standard
button.
This is a standard button
Toolbar
Buttons with the ButtonType set to Toolbar are typically placed in the control area of
a Microsoft Dynamics GP form. These buttons have a flat appearance, with a special
color highlighting when the pointer is placed over them. It is also common for these
buttons to have pictures on them. The following illustration shows a toolbar button.
A toolbar button is
typically placed in the
control area.
ToolbarWithSeparator
The buttons with the type ToolbarWithSeparator buttons are typically placed in the
control area, like buttons with the type Toolbar. However, they have an additional
separator line drawn on the right side of the button to separate it from the other
controls in the control area. The following illustration shows two buttons that have
the type ToolbarWithSeparator. Notice the separator line drawn to the right of each
button.
These are toolbar buttons

with separators.
StatusArea
Buttons placed in the status area at the bottom of a window should have the type
StatusArea. These buttons should display only graphics, and will have a special 3-D
border drawn around them when the pointer is placed over them. These buttons
should have the Tooltip property set so they will display a description of the action
the button performs. A status area button is shown in the following illustration. It
displays a tooltip that describes the purpose of the button.
Buttons in the status area

typically have only pictures.
Field
Buttons that show only pictures, and are placed next to other controls in the form
should have the ButtonType property set to Field. These buttons are used for things
like lookups or expansions. Several buttons with this type are shown next to a text
control in the following illustration.
These are field

buttons.
Pictures for buttons

Each Visual Studio for Microsoft Dynamics GP project includes several standard
images that are used for buttons in Microsoft Dynamics GP. These images (in PNG
format) should be used with the buttons you create for your integrations. The
following table lists the images and describes how they are used.
Image Name Description

Field_Delete.png Used for delete buttons in the window area placed
next to fields.
Field_Edit.png Used for edit buttons in the window area placed next
to fields.
Field_Expansion.png Used for expansion buttons in the window area
placed next to fields.
Field_Lookup.png Used for lookup buttons in the window area placed
next to fields.
Field_MapPoint.png Used for MapPoint buttons in the window area placed
next to fields.
C H A P T E R 5 C O N T R O L R E F E R E N C E
Image Name Description

Field_NoteAbsent.png Used for note buttons in the window area placed next
to fields.
Field_NotePresent.png Used for note buttons in the window area placed next
to fields.
HelpImage.png Used for the Help button placed in the status area of
the window.
Toolbar_Cancel.png Used for the Cancel button placed in the window
control area.
Toolbar_Clear.png Used for the Clear button placed in the window
control area.
Toolbar_Copy.png Used for the Copy button placed in the window
control area.
Toolbar_Delete.png Used for the Delete button placed in the window
control area.
Toolbar_DeleteAll.png Used for the Delete All button placed in the window
control area.
Toolbar_New.png Used for the New button placed in the window control
area.
Toolbar_Open.png Used for the Open button placed in the window
control area.
Toolbar_Post.png Used for the Post button placed in the window control
area.
Toolbar_Print.png Used for the Print button placed in the window control
area.
Toolbar_Redisplay.png Used for the Redisplay button placed in the window
control area.
Toolbar_Save.png Used for the Save button placed in the window
control area.
Toolbar_Void.png Used for the Void button placed in the window control
area.
VCR_First.png Used for the First browse control in the window status
area.
VCR_Last.png Used for the Last browse control in the window status
area.
VCR_Next.png Used for the Next browse control in the window
status area.
VCR_Previous.png Used for the Previous browse control in the window
status area.
Window_NoteAbsent.png Used for the note button in the window status area.
Window_NotePresent.png Used for the note button in the window status area.
TextBoxes
TextBox controls are used for the string, integer, currency, date, and time controls in
a Microsoft Dynamics GP form. Text boxes have the AutoSetDexColors property
that can be set to True so the control colors will match colors in Microsoft Dynamics
GP.
A TextBox control is used

for standard fields like
currency values.
Unlike the standard controls in Microsoft Dynamics GP, the textbox controls have
no built-in support to format data such as currency values. You will need to add
additional code to your integration to match the behavior of the controls in
Microsoft Dynamics GP. For instance, the following C# code sets the value of the
textbox in the previous illustration. It uses the Format method for the String object
to format the currency value.
// Display the value, formatting it as a currency amount

textBoxEstimatedFreight.Text = String.Format("{0:C}",EstimatedFreight);
Labels
Label controls are used for the text labels that appear next to controls in the
Microsoft Dynamics GP form. They correspond to the static text items that appear
in standard Microsoft Dynamics GP windows.
A label control displays

the text label that appears
next to another control.
Label controls have the LinkField property that should be set when a specific field
is being labeled. This property is set to the name of the control that the label applies
to. When specified in the Microsoft Dynamics GP User Preferences, the label will be
drawn with the single underline that is standard for prompts.
To have the underlined label draw correctly, be sure the AutoSize property for the label is set
to False.
ComboBoxes
Use the ComboBox control in cases where you would use a drop-down list or
combo box in Microsoft Dynamics GP. ComboBox controls have the
AutoSetDexColors property that can be set to True so the control colors will match
colors in Microsoft Dynamics GP.
The following illustration shows a ComboBox control being used as a drop-down

list in a Microsoft Dynamics GP form.
ListBoxes
Use the ListBox control in cases where you would used a list box or multi-select list
box in Microsoft Dynamics GP.
Chapter 6: Dictionary Assembly Generator
The Dictionary Assembly Generator (DAG.exe) is a utility included with Visual
Studio Tools for Microsoft Dynamics GP that creates a managed code assembly that
provides access to resources in an application dictionary. Information about this tool
is divided into the following sections:
• Creating application assemblies

• Output files
• Using the Dictionary Assembly Generator
• Optimizing the assembly generating process
Creating application assemblies

Several application assemblies are included with the Visual Studio Tools for
Microsoft Dynamics GP. These are the assemblies for the core application
(Dynamics.dic) and the other applications that are delivered with Microsoft
Dynamics GP.
When developing integrations that use resources from these dictionaries, always
use the application assemblies that are included with the Visual Studio Tools
installation. These assemblies are digitally signed, indicating they were produced
by Microsoft. Don’t generate your own versions of application assemblies for
dictionaries shipped with the Microsoft Dynamics GP product.
You will create application assemblies for the following cases:
• A forms dictionary exists for a product, and you want your Microsoft Dynamics
GP integration to access the modified resources in the forms dictionary.
• You have installed a third-party dictionary for which no application assembly

exists, and you want to access resources in this dictionary from your Microsoft
Dynamics GP integration. The third-party dictionary could contain new forms
and other resources. It could contain alternate forms from the Dynamics.dic
dictionary.
Output files
The Dictionary Assembly Generator produces two output files that are used in your
integration: an application assembly and IntelliSense data file.
Application assembly
The most important output is the application assembly. This is the managed code
assembly that provides access to the resources in a dictionary. Each dictionary can
have one corresponding application assembly.
The following naming convention is used for application dictionaries:
Application.ProductName.dll
The following naming convention is used for forms dictionaries:
Application.ProductName.ModifiedForms.dll
ProductName is automatically derived from product name in the launch file. Any
spaces or special characters in the product name are removed.
For example, the application assembly that provides access to resources in the
SRVCADV.dic application dictionary is named Application.FieldService.dll. The
application assembly that provides access to the resources in the forms dictionary
(FRMS949..dic) is named Application.FieldService.ModifiedForms.dll.
IntelliSense data file

The second type of output from the Dictionary Assembly Generator is the
IntelliSense data file that will be used by Visual Studio. This file has the same name
as its corresponding application assembly, but has the .xml extension. As you write
code, Visual Studio will use the information from this file to display details about
the resources that can be accessed through the application assembly. An example of
the IntelliSense for a dictionary resource is shown in the following illustration.
Information from the

application assembly
XML file is displayed in
IntelliSense.
Using the Dictionary Assembly Generator

The Dictionary Assembly Generator (DAG.exe) is installed in the location where
you installed Visual Studio Tools. Typically this will be the following location:
C:\Program Files\Microsoft Dynamics\GP2010 VS Tools SDK
The Dictionary Assembly Generator is a command-line tool, and should be run

from a command prompt. Open a command prompt and set the current location to
the folder where DAG.exe is located.
To view the command syntax, use the following command at the command prompt:
dag.exe /?
The Dictionary Assembly Generator uses the product ID to identify the dictionary
for which you want to build the application assembly. Look in the launch file
(typically Dynamics.set) for a list of the products installed.
C H A P T E R 6 D I C T I O N A R Y A S S EM B L Y G E N ER AT O R
Optionally, you can specify the launch file that the Dictionary Assembly Generator
will look in to find the list of installed products and the corresponding dictionary
locations. If you don’t supply the name of the launch file, DAG.exe will look for the
launch file named Dynamics.set in the current location.
Since you are running DAG.exe from a different location than where Microsoft Dynamics
GP is installed, you will need to supply the complete path to the launch file.
The Dictionary Assembly Generator must be able to write to the location where it is being
run from. This means the user running DAG.exe must be part of the Administrators group
or the Power Users group on Windows XP. On a system running with User Account
Control (UAC), it means launching DAG.exe with Administrative privileges.
Building an application assembly

The Dictionary Assembly Generator will build an application assembly for the main
dictionary for an application or for the forms dictionary for an application. When
generating an assembly for an application dictionary, use the /M parameter. For
example, the following command generates the application assembly for the main
dictionary of the Sample Integrating Application. This application has the product
ID value 3333. The path to the launch file (Dynamics.set) is supplied.
dag.exe 3333 "C:\Program Files\Microsoft Dynamics\GP\Dynamics.set" /M
This command produces two files:
• Application.SampleIntegratingApp.dll
• Application.SampleIntegratingApp.xml
To generate an assembly for a forms dictionary, use the /F parameter. For example,
the following command generates the application assembly for the forms dictionary
of the Field Service product (with dictionary ID 949).
dag.exe 949 "C:\Program Files\Microsoft Dynamics\GP\Dynamics.set" /F
This command produces two files:
• Application.FieldService.ModifiedForms.dll
• Application.FieldService.ModifiedForms.xml
Refer to Modified forms on page 69 for details about creating an application assembly for the
forms dictionary (Forms.dic) used by Microsoft Dynamics GP.
Signing an application assembly

You may want to sign the application assemblies you create. This is a good practice,
because it helps ensure that only the official version of an application assembly is
being used. The Dictionary Assembly Generator can sign the assemblies that it
creates. It can fully sign the assemblies, or delay sign them. You can use the SN.exe
utility (included with the .NET Framework) to create a strong name key file (.snk)
used to sign the assembly.
Once you create and use a strong name key file, keep it in a safe location. You will need to use
it every time you build or rebuild application assemblies.
The following example shows how the application assembly for the sample
integrating application is fully signed using the Sample.snk strong name key. The
Sample.snk file was generated using the SN.exe utility.
/S:Sample.snk
Overriding the application assembly name

When creating an application assembly for a dictionary, the Dictionary Assembly
Generator will use the product name from the launch file. This may not be the name
you want to use for the application assembly. You can use the /N parameter to
specify a different name for the application assembly being generated.
For example, the following command will create an application assembly for the
sample integrating application, but use the name “Develop” instead of the product
name in the launch file.

/N:Develop
The generated application assembly will have the name Application.Develop.dll.
Overriding the main referenced dictionary name

When generating application assemblies for dictionaries that integrate with
Microsoft Dynamics GP, the Dictionary Assembly Generator must be able to
reference the application assembly for the main dictionary (typically
Application.Dynamics.dll). If the application assembly for the main dictionary has
been given a different name, you can use the /NM parameter to specify which new
name so the application assembly can be found.
For example, if the application assembly for the main dictionary was named
Application.DynamicsGP.dll, you would use the following command to create an
application assembly for the sample integrating application. Notice that the /NM
parameter is used to specify the name of the main application assembly that is being
referenced.

/NM:DynamicsGP
Optimizing the assembly generating process

Producing an application assembly for large dictionaries is a resource-intensive
process. The Dictionary Assembly Generator will use a large amount of memory
(often over 1 gigabyte) and substantial processor time when producing an
application assembly. To optimize the process, do the following:
• Use the best hardware you have available to generate the application assembly.
• Close all other applications before starting the process.
• Temporarily turn off background processing tasks, such as virus scanning.
Chapter 7: Accessing Dictionary Resources
To create an integration for Microsoft Dynamics GP or the additional applications
that are installed with it, your code must access resources in the various application
dictionaries. This portion of the documentation describes how to do this for your
project. The following topics are discussed:
• Adding references
• Namespace
• Dictionary class
• Accessing additional resources
• Variables for dictionary resources
Adding references
To access the resources in a specific dictionary, a project must contain a reference to
the application assembly for that dictionary. When you create a new Visual Studio
Tools for Microsoft Dynamics GP project, it will automatically contain a reference to
the Application.Dynamics.dll application assembly. This provides access to
resources in the Dynamics.dic dictionary. To access resources in other dictionaries,
add references to the application assemblies for them.
If a dictionary doesn’t have a corresponding application assembly, refer to Chapter 6,

“Dictionary Assembly Generator,” to learn how to create one.
For example, to access resources from the “Sample Integrating App” application
installed with Microsoft Dynamics GP, the project should contain a reference to the
Application.SampleIntegratingApp.dll application assembly. The following
illustration shows this reference for a C# project.
This reference provides

access to the resources in
the corresponding
dictionary.
Namespace
Resources for a dictionary are accessed through the following namespace:
Microsoft.Dexterity.Applications
To make it convenient to access resources, this namespace is included in the C#

project template with the using statement. In the Visual Basic project template, it’s
included using the Imports statement. Referencing the namespace prevents you
from having to fully-qualify references to dictionary resources.
Dictionary class
The resources in a dictionary are accessed through a single class that is available
after you add the reference to the dictionary’s application assembly. The class has
the same name that appears in the application assembly. For instance, the class to
access resources for the Dynamics dictionary is named Dynamics. Similarly, the
class used to access resources for the Sample Integrating Application is named
SampleIntegratingApp. This is the same name that appears in the application
assembly, Application.SampleIntegratingApp.dll.
The five primary resource types in a dictionary are accessed through properties of
the class. These resource types are:
• Forms
• Globals
• Procedures
• Functions
• Tables
To access a resource of the specific type, start by typing the dictionary class name,
and then property for the resource type. IntelliSense in Visual Studio will present a
list of the specific type of resources available in the dictionary. For example, the
following illustration shows the forms resources in the Dynamics core application.
Type the dictionary class name

and the resource type
property. IntelliSense displays
a list of resources.
When you’ve selected a resource of the specific type, you will see a list of the
properties, methods, and events available for that resource. The following
illustration shows some of the properties, methods, and events for the AboutBox
form in the Dynamics dictionary.
C H A P T E R 7 A C C E S S I N G D I C T I O N A R Y R ES O U R C E S
Accessing additional resources

Several additional resource types are accessed through the Forms property of a
dictionary class. These include:
• Windows
• Commands
• Form-level procedures
• Form-level functions
• Form-level table buffers
As an example, the following C# statement opens the Customer Maintenance

window. Notice how the window is accessed through the form object.
Dynamics.Forms.RmCustomerMaintenance.RmCustomerMaintenance.Open();
Windows provide further access to two additional resource types:
• Fields
• Scrolling windows
For instance, the following C# statement sets the value of the Comment 1 field in the
Vendor Maintenance window.
Dynamics.Forms.PmVendorMaintenance.PmVendorMaintenance.Comment1.Value
= "A preferred vendor";
You will learn more about the details about using each resource type in Part 3, Resource
Reference.
Variables for dictionary resources

Within your code, it may be useful to create variables for specific resources in an
application dictionary. The definitions for the various dictionary resources are
found in an additional namespace available in the application assembly. This
namespace has the same name that appears in the application assembly, but has
“Dictionary” appended. For instance, to reference the definitions for resources in
the Dynamics main dictionary, you would use this namespace:
Microsoft.Dexterity.Applications.DynamicsDictionary
To reference resources for the Sample Integrating Application, you would use this
namespace:
Microsoft.Dexterity.Applications.SampleIntegratingAppDictionary;
After creating the variable, you can assign its value and then use it in your code. For
example, the following C# code creates a variable for the Vendor Maintenance form
in Microsoft Dynamics GP. It assigns the form to the variable, and then uses it to
open the form.
PmVendorMaintenanceForm VendorMaintenanceForm;
VendorMaintenanceForm = Dynamics.Forms.PmVendorMaintenance;
VendorMaintenanceForm.Open();
Using a variable can simplify your code, especially when accessing dictionary
resources that have long names. For example, the following C# code creates a
variable for the Customer Maintenance window in Microsoft Dynamics GP. Then it
sets the values of two fields in the window. Notice it take less code to set the field
when the variable for the window is used.
// Create the variable and set its value

RmCustomerMaintenanceForm.RmCustomerMaintenanceWindow CustMaintWindow;
CustMaintWindow = Dynamics.Forms.RmCustomerMaintenance.RmCustomerMaintenance;
// Accessing window fields requires less code when using the variable
CustMaintWindow.Comment1.Value = "Comment 1";
Dynamics.Forms.RmCustomerMaintenance.RmCustomerMaintenance.Comment2.Value =
"Comment 2";
Chapter 8: Events
Applications that integrate with Microsoft Dynamics GP often need to be notified
when specific events occur in the system. This portion of the documentation
describes how to register to be notified when events occur in the system. It also
describes how to write event handlers that can respond to the events. Information is
divided into the following sections:
• Registering events
• Responding to events
• Unregistering events
Registering events
Your integrating application must register every event that it should be notified of
in the system. Event registrations are added to the Initialize() method, located in
the template code that is automatically added when you created your Visual Studio
Tools for Microsoft Dynamics GP project.
The resources for which you can register events, such as forms, windows, or fields,
each list the events they make available. For example, a form has the following
events available:
• OpenBeforeOriginal
• OpenAfterOriginal
• CloseBeforeOriginal
• CloseAfterOriginal
Refer to each resource type described in Part 3, Resource Reference, for the list of
events that are available for that resource.
To register an event, find the resource for which you want to register the event. Pick
the event you want, and then specify the event handler method. The event handler
is the method that contains the code that runs in response to the event.
C#
Visual Studio will assist you when you register an event in C# code. Begin by
referencing the resource for which you want to register an event. Add the +=
operator, and Visual Studio will display IntelliSense indicating it will complete the
event handler. Simply press the TAB key to add the event handler registration.
After the event handler registration is added, Visual Studio will offer to add the
event handler method for the new event. Press the TAB key again to add the event
handler method. When you’re finished, the completed event will look similar to the
following:
public void Initialize()

{
Dynamics.Forms.RmCustomerMaintenance.OpenAfterOriginal += new
EventHandler(RmCustomerMaintenance_OpenAfterOriginal);
}
void RmCustomerMaintenance_OpenAfterOriginal(object sender, EventArgs e)

{
throw new Exception("The method or operation is not implemented.");
}
Visual Basic
Registering an event in a Visual Basic project requires two steps. First, in the
Initialize() method of the project, the AddHandler statement registers the event.
The AddHandler statement takes two parameters. The first specifies the resource
and event, while the second specifies the event handler method that will be run. The
following example registers the AfterOpen event for the Customer Maintenance
form in Microsoft Dynamics GP.
Sub Initialize() Implements IDexterityAddIn.Initialize
AddHandler Dynamics.Forms.RmCustomerMaintenance.OpenAfterOriginal, _
AddressOf RMCustMaintAfterOpen
End Sub
In the second step, the event handler method is added. The parameters for this
method must match those required by the event. The IntelliSense for the event
displays the parameters the event handler must have.
The parameters required

for the event handler
method are displayed.
The following example shows the event handler method added for the event
created in the previous example.
Public Sub RMCustMaintAfterOpen(ByVal sender As Object, ByVal e _

As System.EventArgs)
MsgBox("Not Implemented")
End Sub
C H A P T E R 8 E V E N T S
Responding to events
The event handler method contains the code that runs in response to the event. This
code can perform whatever action is required for your integrating application. For
example, the following C# code is the event handler that runs in response to the
value of the Sales Document Number field being changed in the Sales Transaction
Entry window. If the EstimateFreight form is open, the controls on the form are set.
void SopNumber_Change(object sender, EventArgs e)
{
// If the Estimate Freight form is open, update the document number
// and clear the other controls so the new calculation can be performed.
if (EstimateFreightForm.Created == true)
{
EstimateFreightForm.textBoxDocumentNumber.Text =
SOPEntryWindow.SopNumber.Value;
EstimateFreightForm.textBoxEstimatedFreight.Clear();
EstimateFreightForm.textBoxTotalWeight.Clear();
}
}
Event arguments
The event arguments for some events provide additional information about the
event. The event arguments for procedure events and function events allow access
to the parameters for the procedure or function call. For instance, the following C#
example is the event handler for InvokeAfterOriginal event for the
GetAutoComplete function in Microsoft Dynamics GP. The event arguments
contain the parameters that were passed into the function. The event handler
examines the value of the first parameter to verify that its value is “DYNSA”. If it is,
the code sets the result of the function to false.
void GetAutoComplete_InvokeAfterOriginal(object sender,
SyUserDefaultsForm.GetAutoCompleteFunction.InvokeEventArgs e)
{
// Set the return value to always turn off auto-complete for DYNSA user
if (e.inParam1 == "DYNSA")
{
e.result = false;
}
}
The event arguments for modal dialog events allow access to the buttons and
message displayed in the modal dialog. For example, the following Visual Basic
code is the event handler for the BeforeModalDialog event of the Sales Transaction
Entry window. It shows how the event arguments are used to examine the message
text displayed by the modal dialog, and then used to respond to the dialog.
Private Sub SopEntryWindow_BeforeModalDialog(ByVal sender As Object, ByVal e
As BeforeModalDialogEventArgs)
' Examine the dialog to determine whether it is the one to respond do

If e.DialogType = DialogType.Ask Then
If e.Message.Contains("want to add a customer") Then
' Click the Customer button in the modal dialog
e.Response = DialogResponse.Button1
End If
End If
End Sub
Cancelling events
Some events can be cancelled through the event handler. Typically, these are events
that occur before the event in the core application, such as the OpenBeforeOriginal
event for a form. The event argument parameter that is passed to the event handler
for these events has a special type that allows the event to be cancelled.
For example, the following Visual Basic example is the event handler for the
BeforeOpen event of the Customer Maintenance form. The event handler method
examines the current user logged into the system. If it’s the “sa” user, a message is
displayed and the window isn’t opened. Notice how the event arguments are used
to cancel the event.
Public Sub RMCustMaintBeforeOpen(ByVal sender As Object, ByVal e _

As System.ComponentModel.CancelEventArgs)
If Dynamics.Globals.UserId.Value = "sa" Then
'Display the message

MsgBox("Do not access this window as the Administrator")
'Prevent the form from opening

Dynamics.Forms.RmCustomerMaintenance.Close()
'Cancel pending events

e.Cancel = True
End If
End Sub
Unregistering events
At some point after you have registered an event, the event may no longer be
needed. To unregister an event, use the standard syntax for either C# or Visual
Basic. You can unregister the following types of events:
• Procedure events
• Function events
• Modal dialog events
The other types of events cannot be unregistered. If you try to unregister them, an exception
will be thrown.
C#
The following C# example shows how you would unregister an AfterModalDialog
event. The method named IvItemMaintenance_AfterModalDialog had been
registered as the event handler for the modal dialog event.
ItemMaintenanceForm.IvItemMaintenance.AfterModalDialog -= new
EventHandler<AfterModalDialogEventArgs>(IvItemMaintenance_AfterModalDialog);
C H A P T E R 8 E V E N T S
Visual Basic
The following Visual Basic example shows how you would unregister the
InvokeAfterOriginal event for the AddSuccessfulLoginRecord procedure. The
method named AddSuccessfulLogin had been registered as the event handler for
the procedure event.
RemoveHandler Dynamics.Procedures.AddSuccessfulLoginRecord.InvokeAfterOriginal, _
AddressOf AddSuccessfulLogin
Chapter 9: Working with Tables
A Visual Studio Tools integration can interact directly with tables defined in
Microsoft Dynamics GP. Using the table integration capability is much simpler than
creating and managing external connections to the Microsoft Dynamics GP
database. Information about working with tables is divided into the following
sections:
• Tables in Microsoft Dynamics GP

• Table buffers
• Opening and closing tables
• Keys
• Retrieving a row
• Saving a row
• Updating a row
• Removing a row
• Table operation errors
• Ranges
• Row locking
• Multiuser processing
Tables in Microsoft Dynamics GP

To learn about tables in Microsoft Dynamics GP, you will need to access information
from the following sources.
Resource Descriptions tool

The Resource Descriptions tool available in Microsoft Dynamics GP provides
essential details about each table in the application. Information such as the fields in
the table and the keys defined for the table can be found here.
Important details, such as the

keys defined for the table,
can be found in the Table
Descriptions window.
Microsoft Dynamics GP SDK

The Microsoft Dynamics GP SDK contains detailed diagrams and descriptions of
the tables in Microsoft Dynamics GP. You can use these diagrams to learn about the
table in a specific module, and how the tables work together. Information about
how transactions flow through the various tables is also available in the Microsoft
Dynamics GP SDK.
IntelliSense
The IntelliSense available in Visual Studio will be helpful by listing what tables are
available, as well as which fields are available in those tables.
IntelliSense lists which

tables are available. A
description of each table
is also provided.
Table buffers
A table buffer provides access to one row of a specific table. The information in the
table buffer comes from either the table or a script that has run. Your code will
interact with the table buffer when you perform operations on the table. There are
two types of table buffers: global and form-level.
A global table buffer is created when a table is accessed directly through the global list
of tables. Global table buffers are accessed through the dictionary class. This class
has a Tables property that provides access to the collection of tables defined in the
dictionary. A global table buffer is not associated with any specific form. This makes
global table buffers useful in situations where a Visual Studio Tools integration
must read from or write to a Dynamics GP table, but isn’t interacting with the user
interface.
Dynamics GP Global Visual Studio Tools

Table Table Buffer Application Code
By default, a global table buffer for a table is shared with all of the other Visual
Studio Tools add-ins that are accessing that same table. If you want your integration
to create a global table buffer that is not shared, use the Clone() method when
creating the instance of the global table buffer.
A form-level table buffer is created when a table is attached to a form in Microsoft

Dynamics GP. There is one table buffer for each table that is attached to the form.
Each form-level table buffer is shared by the code that is part of the form, as well as
any code outside of the form that accesses the table through that form. The Tables
property for the form allows access to the table buffers for the tables that are
attached to the form. Because they are shared, form-level table buffers aren’t
typically used by Visual Studio Tools integrations to directly read from or write to
tables. Instead, the form-level table buffers are examined to find what data the
Dynamics GP window has read or is writing to the specific table.
C H A P T E R 9 WO R K IN G WIT H T A B LE S
Form
Dynamics GP
Window
Visual Studio Tools Form-level

Application Code Table Buffers
Dynamics GP Tables
Opening and closing tables

There is no explicit “open” operation for a table in Visual Studio Tools. The first
time a table buffer is accessed, the table is automatically opened. The table buffer
remains open until it is closed.
When your integrating application’s code has finished working with a global table
buffer, it must be closed using the Close() method for the table. Failing to close a
global table buffer will cause a “Background process is running: Exit Aborted” error
when the user attempts to exit Microsoft Dynamics GP.
The user will see this error

when global table buffers are
left open in a Visual Studio
Tools integration.
For form-level table buffers, the table buffer will be closed when the form is closed.
Explicitly closing a form-level table buffer with the Close() method is needed rarely.
The following C# example shows how a table is accessed through a global table
buffer. The first row of the table (the RM Customer Master table) is retrieved, and
the customer number is displayed. Notice how the table buffer is closed at the end
of the example.
RmCustomerMstrTable CustomerMasterTable;
CustomerMasterTable = Dynamics.Tables.RmCustomerMstr;
// Read the first row of the table

CustomerMasterTable.GetFirst();
// Display the name for the row retrieved

MessageBox.Show(CustomerMasterTable.CustomerName.Value);
// Close the table buffer

CustomerMasterTable.Close();
Keys
A key is a field or combination of fields in a table that is used to sort and locate
specific rows in the table. Typically, the value of the key field or fields is unique for
each row in a table so a specific row can be located. Keys that don’t uniquely
identify a specific row are used to refer to a range of rows in the table.
The keys for a table are identified by number, beginning with the value 1. When you
specify the key you want to use for a table, you will supply the corresponding
integer. The Table Descriptions window in Microsoft Dynamics GP lists the keys for
each table, and the key segments (fields) that each key contains.
The keys for the table are

listed in numeric order.
The fields in each key are

listed here.
You will use the keys for a table when you retrieve a specific row from the table.
This is described in the next section, Retrieving a row. You will also use keys when
you want to perform operations on a range of rows in the table. You will learn more
about this in Ranges on page 53.
Retrieving a row
Retrieving a row from a table is a multi-step process. First, you must decide which
key you want to use to retrieve the row. Use the Table Descriptions window in
Microsoft Dynamics GP to view the keys and each key’s components. Specify the
key to use, and then set the values of the key fields. Finally, use the Get() or
Change() method for the table to retrieve the record. Which you use depends on
whether you want to lock the record. You will learn more about locking in Row
locking on page 57.
The following C# example retrieves the row for the customer American Electrical
Contractor from the RM_Customer_MSTR table. The second key of the
RM_Customer_MSTR table is used. This key contains one component, the
Customer Name. The contact person for the retrieved customer is displayed in a
dialog.
// Variable for any table operation error

TableError err;
// Create a reference to the table

// Set the key to use for the table

// Key 2 - Contains the Customer Name
CustomerMasterTable.Key = 2;
// Set the value for the key columns

CustomerMasterTable.CustomerName.Value = "American Electrical Contractor";
// Retrieve the row

err = CustomerMasterTable.Get();
if (err == TableError.NoError)
{
MessageBox.Show(CustomerMasterTable.ContactPerson.Value);
}
else
{
// Display the error that occurred
MessageBox.Show(err.ToString());
}
// Close the table
Saving a row
To save a new row in a table, set the fields in the table to the values you want to
save. Then use the Save() method to save the new row in the table. The following C#
example adds a new row to the GL_Account_Category_MSTR table. It sets the
values for the fields in the table, then saves the new row.

TableError err;

GlAccountCategoryMstrTable CategoryMasterTable;
CategoryMasterTable = Dynamics.Tables.GlAccountCategoryMstr;
// Set the fields in the table

CategoryMasterTable.AccountCategoryNumber.Value = (short)49;
CategoryMasterTable.AccountCategoryDescription.Value = "Profit Sharing";
// Save the new row

err = CategoryMasterTable.Save();
if(err == TableError.Duplicate)
{
MessageBox.Show("Account category already exists");
}
// Close the table

CategoryMasterTable.Close();
Updating a row
To update a row in a table, first read the row with the Change() method. This
retrieves the row and locks it, allowing you to make changes. Set the values of the
fields you want to change for the row. Finally, use the Save() method to save the
changed row back to the table.
The following C# example reads the row for Adam Park Resort. The Contact Person
for this row is changed the “Steve K.” Then the row is saved back to the
RM_Customer_MSTR table.

TableError err;


// Key 1 - Contains the Customer Number
// Set the key field in the table

CustomerMasterTable.CustomerNumber.Value = "ADAMPARK0001";
// Attempt to read the row. The Change() method will lock the row.
err = CustomerMasterTable.Change();
{
// The row was read successfully, so update the value
CustomerMasterTable.ContactPerson.Value = "Steve K.";
// Save the updated row

err = CustomerMasterTable.Save();
if (err != TableError.NoError)
{
MessageBox.Show("An error occurred updating the row: " +
err.ToString());
}
}
else
{
MessageBox.Show("An error occurred retrieving the row to update: " +
err.ToString());
}
// Close the table

Removing a row
To remove a row from a table, first read the row with the Change() method. This
retrieves the row and locks it. Then use the Remove() statement to remove the row
from the table.
The following C# example reads and locks the row for the inventory item
“WIRE100” in the IV_Item_MSTR table. If the item is successfully read, it is
removed from the table.

TableError err;

IvItemMstrTable ItemMasterTable;
ItemMasterTable = Dynamics.Tables.IvItemMstr;

// Key 1 - Contains the Item Number
ItemMasterTable.Key = 1;
// Set the key field in the table

ItemMasterTable.ItemNumber.Value = "WIRE100";
// Attempt to read the row. The Change() method will lock the row.
err = ItemMasterTable.Change();
{
// Attempt to remove the row
err = ItemMasterTable.Remove();
{
MessageBox.Show("An error occured removing the row: " +
err.ToString());
}
}
// Close the table

ItemMasterTable.Close();
Table operation errors

An error code is returned from each of the table operations that can be performed.
The possible error codes are contained in the TableError enumeration. Many of the
errors included in the enumeration will not occur in the released versions of
Microsoft Dynamics GP. The following table describes the error values that your
Visual Studio Tools integration is likely to encounter:
Constant Description
Changed The row being saved was changed by another user.
DatabasePermissionViolation The current user does not have security privileges to access
the table.
DoubleLock A row was already locked in the table buffer.
Duplicate The row being saved already exists in the table.
EndOfTable The row cannot be retrieved because the beginning or end of
the table has been reached.
InvalidKeyNumber The table does not have a key with the number specified.
NoError No error occurred.
NoLock An operation such as Remove() was performed, but no row
had been locked.
NotFound The row was not found in the table.
NotSupported The table operation is not supported for the table. For
example, attempting to actively lock a row on a table that
doesn’t allow it.
Sharing The row is actively locked by another user.
TooManyOpenTables Too many tables are open in the application.
Unknown An unknown error occurred.
Typically, your code will do one or both of the following after each table operation:
• Check for the NoError value, indicating the table operation was successful. If
the operation was successful, the next processing step can continue.
• Check for a specific error, such as NotFound. The code must respond
appropriately, such as displaying a message for the user.
If an unexpected error occurs after performing a table operation, it’s always a good
idea to display the details of the error to the user. Include information such as the
table, the operation being performed, and the error that occurred.
When a table operation error occurs, your code won’t follow the typical code path. Be sure
that your code closes any tables it has accessed. Otherwise, the user won’t be able to exit
Ranges
When working with tables, it is often efficient to limit the amount of information
being accessed. You can do this by setting up a range for the table. A range is based
on a key for the table, and allows you to access a specified portion of the rows in the
table. The selected range will be treated as an entire table. For instance, calling the
GetFirst() method returns the first row in the range. Calling the GetLast() method
returns the last row in the range, and so on.
You use the RangeStart() and RangeEnd() methods to specify the range for a table.
You can specify one range per table, and the range is associated with a specific key.
The range will be used only when the table is accessed using the key the range is
associated with. To clear the range specified for a table, use the RangeClear()
method.
Example 1 - Range with simple key

In the following C# example, a range is used to limit the rows accessed to only those
customers whose names begin with “A”. Notice that the second key for the table,
composed of the Customer Name field, is used for the RangeStart() and
RangeEnd() methods. The first and last rows in the range are displayed.

TableError err;


// Key 2 - Contains the Customer Name
// Specify the start of the range

CustomerMasterTable.Clear();
CustomerMasterTable.CustomerName.Value = "A";
CustomerMasterTable.RangeStart();
// Specify the end of the range

CustomerMasterTable.Clear();
CustomerMasterTable.CustomerName.Value = "B";
CustomerMasterTable.RangeEnd();
// Display the first item in the range

err = CustomerMasterTable.GetFirst();
{
MessageBox.Show("First customer: " +
CustomerMasterTable.CustomerName.Value);
}
else
{
MessageBox.Show("An error occured retrieving the row: " +
err.ToString());
}
// Display the last item in the range

err = CustomerMasterTable.GetLast();
{
MessageBox.Show("Last customer: " +
CustomerMasterTable.CustomerName.Value);
}
else
{
err.ToString());
}
// Close the table

Example 2 - Range with multi-segment key

If a key is composed of several segments, you can create ranges based on serveral
key segments. It’s important that all segments of the key be set when specifying the
start and end of the range. The Clear() and Fill() methods are often used when
creating a range based on a multi-segment key. They are used to set all of the fields
in the table buffer to the empty value or the filled value. This ensures that all of the
key segments have been specified before the RangeStart() or RangeEnd() methods
are called.
For example, the following C# code creates a range for the IV_Item_MSTR table that
includes only items in the COMPONENTS class. The range is created using key 3
for the Item Master table. This key has two segments: Item Class Code and Item
Number.
To set the beginning of the range, the Clear() method is used to set the fields in the
IV_Item_MSTR table buffer to the minimum value. The Item Class Code field in the
table buffer is set to “COMPONENTS”. The RangeStart() method specified this is
the beginning of the range.
To set the end of the range, the Fill() method is used to set the fields in the
IV_Item_MSTR table buffer to the maximum value. The Item Class Code field in the
table buffer is set to “COMPONENTS”. The RangeEnd() method specifies this is the
end of the range.
The key values for the range are shown in the following illustration. The range will
include rows where the Item Class Code value is “COMPONENT” and the Item
Number can be any value.
Item Class Code Item Number
Range Start “COMPONENT” (Cleared)
Range End “COMPONENT” (Filled)

TableError err;

IvItemMstrTable ItemMasterTable;
ItemMasterTable = Dynamics.Tables.IvItemMstr;

// Key 3 - Contains the Item Class Code and the Item Number
ItemMasterTable.Key = 3;

ItemMasterTable.Clear();
ItemMasterTable.ItemClassCode.Value = "COMPONENTS";
ItemMasterTable.RangeStart();

ItemMasterTable.Fill();
ItemMasterTable.ItemClassCode.Value = "COMPONENTS";
ItemMasterTable.RangeEnd();
// Read through the items in the range

StringBuilder itemList = new StringBuilder();
err = ItemMasterTable.GetFirst();
while(err == TableError.NoError)
{
// Add the item to the list
itemList.AppendLine(ItemMasterTable.ItemNumber + " " +
ItemMasterTable.ItemDescription);
// Get the next item in the range

err = ItemMasterTable.GetNext();
}
// Display the list of items

MessageBox.Show(itemList.ToString());
// Close the table

ItemMasterTable.Close();
Example 3 - Removing rows in a range

Once a range is created for a table, you can use the RangeRemove() method to
remove all of the rows in that range from the table. In many cases, this will be faster
than removing individual rows using the Remove() method.
The following C# example deletes all customer information for St. Patrick’s
Hospital. A single row must be deleted from the RM_Customer_MSTR and the
RM_Customer_MSTR_SUM tables. Several rows must be deleted from the
RM_Customer_MSTR_ADDR table. A range is used to remove the rows from this
table.

TableError err;
// Create references to the tables

RmCustomerMstrSumTable CustomerMasterSummaryTable;
CustomerMasterSummaryTable = Dynamics.Tables.RmCustomerMstrSum;
RmCustomerMstrAddrTable CustomerMasterAddressTable;
CustomerMasterAddressTable = Dynamics.Tables.RmCustomerMstrAddr;
// Delete the row from the Customer Master Summary table

CustomerMasterSummaryTable.Key = 1;
CustomerMasterSummaryTable.CustomerNumber.Value = "STPATRIC0001";
err = CustomerMasterSummaryTable.Change();
{
err = CustomerMasterSummaryTable.Remove();
}
// Close the table

CustomerMasterSummaryTable.Close();
// Delete the row from the Customer Master table

CustomerMasterTable.CustomerNumber.Value = "STPATRIC0001";
err = CustomerMasterTable.Change();
{
err = CustomerMasterTable.Remove();
}
// Close the table

// Delete the rows from the Customer Master Address table

// Key 1 has two segments (Customer Number and Address Code)
CustomerMasterAddressTable.Key = 1;

CustomerMasterAddressTable.Clear();
CustomerMasterAddressTable.CustomerNumber.Value = "STPATRIC0001";
CustomerMasterAddressTable.RangeStart();

CustomerMasterAddressTable.Fill();
CustomerMasterAddressTable.CustomerNumber.Value = "STPATRIC0001";
CustomerMasterAddressTable.RangeEnd();
// Remove the rows from the range

CustomerMasterAddressTable.RangeRemove();
// Close the table

CustomerMasterAddressTable.Close();
Row locking
A row must be locked to delete it or save any changes made to it. A lock is applied
when a row is read from a table. Two types of locked can be used: passive and
active.
Passive locking
A passive lock allows other users to access the row. They can delete the row or make
changes to it. Passive locking ensures that other users accessing the row can be
made aware that the row has been deleted or that the contents of the row have
changed. A pasive lock is applied every time a row is read using the Change()
method.
The Get() method is used only to read a row. It never locks the row.
Active locking
An active lock allows other users to read the row, but not make any changes or delete
the row. Active locking ensures that the user who has the active lock is the only user
who can make changes or delete the row. If other users try to delete or change the
row, they will receive a sharing error. An ative lock is applied each time a row is
read using the Change() method and the activeLock parameter for the method is set
to true.
Not all tables in Microsoft Dynamics GP allow active locking. If you try to actively lock a
row on a table that doesn’t support it, a NotSupported error will be returned.
Releasing locks
Any of the following actions release a row lock:
• Using the Release() method.
• Using the Save() method or the Remove() method, regardless of whether the
method was successful.
If a row is currently locked in a table buffer, and you attempt to lock another row,
you will receive an DoubleLock error that indicates a row was already locked.
Multiuser processing
Microsoft Dynamics GP supports multiple users accessing the same table at the
same time. This is accomplished through Optimistic Concurrency Control (OCC), a
form of record locking that allows multiple users to work in the same tables and
access the same rows with minimal restrictions, while helping to ensure data
integrity.
To allow multiple users to successfully use Microsoft Dynamics GP while Visual

Studio Tools integrations are accessing data, you must choose the type of locking
used. You must also handle any error conditions that occur as a result of multiple
users working with the same row in a table.
The following table lists the various locking scenarios that can occur. The events
listed happen in order from left to right. For example, in the first row User A
passively locks a row, then User B passively locks the same row. User A deletes the
row, then User B changes the contents of the row and saves the row. The changes
User B made will be saved.
User A User B User A User B Result

1 Passively locks a Passively locks Deletes the row. Changes the The changes User B made will be
row. the same row. contents of the row saved.
and saves the
changes.
2 Passively locks a Passively locks Changes the Deletes the row. The row will be deleted.
row. the same row. contents of the row
and saves the row.
3 Passively locks a Passively locks Changes a field Changes a Both changes will be saved.
row. the same row. and saves the row. different field and
saves the row.
4 Passively locks a Passively locks Changes a field Changes the same User B will get an error indicating
row. the same row. and saves the row. field and attempts the row changed. User B’s changes
to save the row. won’t be saved.
5 Passively locks a Passively locks Deletes the row. Attempts to delete User B will get an error indicating
row. the same row. the row. the row is missing.
6 Actively locks a Passively locks Keeps the active Attempts to delete User B will get a row locked error.
row. the same row. lock. the row or change The row won’t be deleted or the
a field and save the changes won’t be saved.
row.
7 Actively locks a Passively locks Deletes the row. Changes the row If user B changed the row and
row. the same row. The active lock is and saves it or saved, the changes will be saved.
released. deletes the row. If User B attempts to delete the row,
User B will get an error indicating
the row is missing.
8 Actively locks a Passively locks Makes changes Changes the row If User B changed the same field as
row. the same row. and saves the row. and saves it or User A, User B will get an error
The active lock is deletes the row. indicating the row changed. User
released. B’s changes won’t be saved.
If user B changed different fields,
the changes will be saved.
If User B deleted the row, the row
will be deleted.
9 Passively locks a Actively locks the Attempts to delete Keeps the active User A will get a row locked error,
row. same row. the row or change lock. even though User B’s active lock
a field and save the came later than User A’s lock.
row.
10 Actively locks a Attempts to User B will get a row locked error.
row. actively lock the
same row.
Scenarios 1 through 3 don’t produce any errors. To be multiuser compatible, your

application should be able to handle scenarios 4 to 10, alerting users that an error
occurred, and allowing them to respond appropriately.
Use the error value returned from the various table operations like Save() or
Remove() to trap errors so your code can deal with the errors that occur. The
following examples show how to trap for multiuser errors when reading, saving
and removing records.
You should not check for multiuser error conditions on tables containing text fields. Text
fields are those that store text up to 32,000 characters long. Multiuser error codes are not
properly returned for tables containing text fields.
Example 1
The following C# example reads and actively locks the first row in the
RM_Sales_WORK table. It uses the value returned from the ChangeFirst() method
to handle the Sharing error resulting from the row being actively locked by another
user.
TableError err;
// Create references to the tables

RmSalesWorkTable SalesWorkTable;
SalesWorkTable = Dynamics.Tables.RmSalesWork;
// Release any existing lock

SalesWorkTable.Release();
// Retrieve the first row and actively lock it

err = SalesWorkTable.ChangeFirst(true);
if (err == TableError.Sharing)
{
// The row is actively locked by another user
MessageBox.Show("This row is currently locked by another user.");
}
// Close the table

SalesWorkTable.Close();
Example 2
The following C# example reads the first row of the RM_Customer_MSTR table,
changes the Salesperson ID, and attempts to save the changed row. The return value
from the Save() method is used to handle an error resulting from the row being
changed or actively locked by another user.
TableError err;
// Create reference to the table

// Release any existing lock

CustomerMasterTable.Release();
// Read the first row in the table

err = CustomerMasterTable.ChangeFirst();
// Change the Salesperson ID

CustomerMasterTable.SalespersonId.Value = "STEVE K.";
// Save the changed row

// Handle any errors

if (err == TableError.Changed)
{
// The row was changed by another user.
MessageBox.Show("This row has been changed by another user. Their changes
will be overridden.");
// Re-read the current row to lock it

CustomerMasterTable.Change();
// Re-write the value

CustomerMasterTable.SalespersonId.Value = "STEVE K.";
// Attempt the save again

{
MessageBox.Show("Customer could not be updated.");
}
}
else if (err == TableError.Sharing)
{
MessageBox.Show("This row is actively locked by another user. Changes will
not be saved.");
}
else if (err != TableError.NoError)
{
// Some other table error occurred
MessageBox.Show("An error occured updating the customer: " +
err.ToString());
}
// Close the table

Example 3
The following script reads the last row in the GL_Account_Category_MSTR table
and attempts to delete it. The error value returned from the Remove() method is
used to handle an error resulting from the row being actively locked or already
deleted by another user.

TableError err;
// Create reference to the table

GlAccountCategoryMstrTable AccountCategoryMasterTable;
AccountCategoryMasterTable = Dynamics.Tables.GlAccountCategoryMstr;
// Release any lock on the row

AccountCategoryMasterTable.Release();
// Retrieve the last row

err = AccountCategoryMasterTable.ChangeLast();
{
// Row was read and can be removed
err = AccountCategoryMasterTable.Remove();
if (err == TableError.Sharing)
{
// The row is actively locked

MessageBox.Show("This row is actively locked by another user.
It cannot be removed.");
}
else if (err == TableError.NotFound)
{
// The row was removed by another user
MessageBox.Show("This row was removed by another user.");
}
else if (err != TableError.NoError)
{
MessageBox.Show("An error occured removing the row: " +
err.ToString());
}
}
else
{
err.ToString());
}
// Close the table

AccountCategoryMasterTable.Close();
Chapter 10: Building and Deploying
This portion of the documentation describes how to build and deploy an integration
created with Visual Studio Tools for Microsoft Dynamics GP. Information is divided
into the following sections:
• Setting assembly information

• Building an integration
• Deploying an integration
Setting assembly information

It’s important to set the assembly information so the assembly you build for your
Visual Studio Tools for Microsoft Dynamics GP integration is properly identified
and versioned. Be sure you set the following items:
• Title
• Description
• Company
• Major, minor, and build numbers
C# application
For integrations written in C#, the assembly information is set in the
AssemblyInfo.cs source file for the project. The following portion of this file shows
the various name values that should be set.
// General Information about an assembly is controlled through the following

// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("Estimate Freight")]
[assembly: AssemblyDescription("Estimate Freight Sample Integration")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("Microsoft")]
[assembly: AssemblyProduct("EstimateFreight")]
[assembly: AssemblyCopyright("Copyright © Microsoft 2009")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
The following portion of this file shows the version, build, and revision numbers
that should be set.
// Version information for an assembly consists of the following four values:

//
// Major Version
// Minor Version
// Build Number
// Revision
//
// You can specify all values or default the Revision and Build Numbers
// by using the '*' as shown below:
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]
Visual Basic application

For integrations written in Visual Basic, the assembly information is set in the
Assembly Information window. Access this window. To view this windows, choose
to display the properties for the Visual Basic project. Click the Application tab, and
then click the Assembly Information button.
Building an integration
To build the integration, complete the following procedure:
1. Set the solution configuration.

If you’re building a test version of the integration, set the solution configuration
to “Debug”. If you are building a final version of the integration, set the
solution configuration to “Release”.
Set the solution

configuration to either
Debug or Release.

Choose Build Solution from the Build menu.
3. Verify there were no build warnings.

If there were build warnings, fix them and build again.
4. Copy the assembly to the AddIns folder.

Copy the assembly for your integration from the “Debug” or “Release” folder
for your project to the AddIns folder in the Microsoft Dynamics GP installation.
5. Copy any application assemblies needed.

If you created any application assemblies for your integration, be sure to copy
them to the Microsoft Dynamics GP folder.
6. Start Microsoft Dynamics GP.

Your integrating application should be loaded when Microsoft Dynamics GP
starts. Verify that your integration is working properly.
C H A P T E R 1 0 B U I LD IN G A N D D EP LO Y IN G
Deploying an integration
When deploying your integration built with Visual Studio Tools for Microsoft
Dynamics GP, be sure that you include the following:
• The assembly for your integration.
• Any additional application assemblies you generated that are specific to your
integration.
• Instructions that explain how to install your integration.
Chapter 11: Debugging
When developing an integrating application, you may find it necessary to examine
the code with the Visual Studio debugger. Information about debugging your
Microsoft Dynamics GP integration is divided into the following sections:
• Preparing to debug
• Examining the application
• Disabling events
Preparing to debug
To prepare your integrating application for debugging, complete the following
procedure.
1. Build and deploy the integration.

Be sure that you have built the Debug version of your project.

Microsoft Dynamics GP must be running so that your integrating application is
loaded.
3. Set breakpoints in your code.

Within Visual Studio, set breakpoints in your code to indicate where you want
processing to wait.
4. Choose to attach to a process.

Since your integrating application is running within the Dynamics.exe process,
you must attach the Visual Studio debugger to this process. From within Visual
Studio, choose Attach to Process from the Debug menu.
5. Select the Dynamics.exe process.

In the Attach to Process window, locate the Dynamics.exe process and select it
in the list.
Locate the Dynamics.exe

process and select it in
the list.
Click Attach to attach to the process. Control will be returned to Visual Studio.
Examining the application

Once your integrating application has stopped at a breakpoint, you can use Visual
Studio’s tools to examine your code. Do the following:
1. Switch to Microsoft Dynamics GP.
2. Perform the actions to exercise your code.

Within Microsoft Dynamics GP, perform the actions that will execute the code
you want to examine.
3. Examine your code.

When Visual Studio encounters a breakpoint, it will become the active
application. Use the tools within Visual Studio to examine your code.
Examine your code while

stopped at the
breakpoints you set.
4. Finish debugging.
When you have finished debugging your integrating application, choose Stop
Debugging from the Debug menu in Visual Studio.
Disabling events
In some cases, you may want to disable the events for the Visual Studio Tools add-
ins to confirm whether they are causing some specific behavior in the Microsoft
Dynamics GP application. To disable events, use the Customization Status window
in Microsoft Dynamics GP. To open this window, point to Customize in the Tools
menu, and then choose Customization Status. Select the Microsoft Dynamics GP
product, and then click Disable. Be sure to enable the events after you have
completed your tests.
Chapter 12: Modified and Alternate Forms
To access modified or alternate forms from a Visual Studio Tools for Microsoft
Dynamics GP, a special process is used. This portion of the documentation describes
the steps necessary. Information is divided into the following sections:
• Modified forms
• Alternate forms
• Guidelines
Modified forms
Modified forms contain modifications that have been made with the Modifier. To
access these modifications from your Visual Studio Tools for Microsoft Dynamics
GP project, complete the following procedure:
1. Create an application assembly for the forms dictionary.

If the forms dictionary for the application that has been modified doesn’t have
an application assembly, create one using the process described in Chapter 6,
“Dictionary Assembly Generator.” For example, the following command
creates the application assembly for the forms dictionary of the core Dynamics
GP product:
dag.exe 0 "C:\Program Files\Microsoft Dynamics\GP\Dynamics.set" /F /N:Dynamics
The /N option is necessary because the application assembly uses the name
“Dynamics”, while the product name in the launch file is “Microsoft Dynamics GP”.
2. Add the reference to the application assembly for your project.

In Visual Studio, add the reference to the application assembly. The following
illustration show the reference added for the application assembly that provides
access to modified forms for the Dynamics GP core dictionary.
This reference to the

application assembly provides
access to the modified forms
for the application.
3. Access the modified forms.

Modified forms are accessed through an additional dictionary class that has the
same name as the application’s dictionary class, but with the additional phrase
“Modified”. For instance, the dictionary class used to access modified forms for
the Dynamics core application is:
DynamicsModified
The following C# code sets the value of a new field on the Credit Limit window of
the Customer Maintenance form. The new field is a local field, added with the
Modifier, and named “Test”.
DynamicsModified.Forms.RmCustomerMaintenance.RmCreditLimit.LocalTest.Value =
"Modified Field";
When accessing resources that are defined in the main dictionary for an application, access
them through the main dictionary class, rather than through the “Modified” class for the
application.
Alternate forms
Alternate forms are forms from the core Dynamics dictionary that have been
changed by a third-party developer, and are stored in a third-party dictionary. The
new and changed resources for the alternate form are accessed through the third-
party application’s application assembly. To access alternate forms from you Visual
Studio Tools for Microsoft Dynamics GP project, complete the following procedure:
1. Create an application assembly for the third-party dictionary.

If the third-party dictionary doesn’t already have an application assembly,
create one using the process described in Chapter 6, “Dictionary Assembly
Generator.” For example, the following command creates the application
assembly for the Sample Integrating Application, to which an alternate form
(PM Vendor Maintenance) was added for this example:
2. Add the reference to the application assembly for your project.

In Visual Studio, add the reference to the application assembly. The following
illustration show the reference added for the application assembly that provides
access to the alternate forms in the Sample Integrating App application.
This reference to the

application assembly provides
access to the alternate forms
for the application.
3. Access the alternate forms.

Alternate forms are accessed through the dictionary class for the assembly that
contains them. For instance, the alternate forms in the Sample Integrating App
application would be accessed through its dictionary class:
SampleIntegratingApp
C H A P T E R 1 2 M O D IFI ED A N D AL T ER N AT E F O R M S
The following C# code sets the value of a new field on the Vendor Maintenance
window of the alternate version of the Vendor Maintenance form, which is part of
the Sample Integrating App dictionary. The new field is a local field named “Test”.
SampleIntegratingApp.Forms.PmVendorMaintenance.PmVendorMaintenance.
LocalTest.Value = "Alternate Field";
Guidelines
If you are planning to use Visual Studio Tools for Microsoft Dynamics GP to
develop an integration for general distribution, we recommend that you limit the
references to resources on modified or alternate forms. Because of security settings,
a specific user may not have access to the modified or alternate version of a form,
possibly causing errors in your integration. If you do distribute an integration
which accesses modified or alternate forms, be sure that your code properly handles
cases when these resources are not available.
For instance, when you set or retrieve the value of a field, use a try...catch block to
enclose the statements. This allows your code to catch any exceptions that are
thrown because the field cannot be accessed. The following C# example shows how
a field in window for an alternate version of the Vendor Maintenance form can be
set within a try...catch block.
// Set the Status local field in the alternate form

try
{
SampleIntegratingApp.Forms.PmVendorMaintenance.PmVendorMaintenance.
LocalStatus.Value = "Preferred";
}
catch (Exception ex)
{
// The field was not accessible. In this example, display a message.
MessageBox.Show(ex.Message);
}
Chapter 13: Implementing Macro Support
You can add macro support for the forms you create with Visual Studio Tools.
Information about doing this is contained in the following sections:
• Overview of macro support

• Recording macros
• Playing macros
• Handling asynchronous processes during playback
Overview of macro support

In Visual Studio Tools, forms you create that inherit from the DexUIForm can be
integrated into the macro system in Microsoft Dynamics GP. Support for the macro
system is not automatic. To support the macro system you will do the following:
• You must add calls to the RecordMacroItem() in the appropriate places in your
Visual Studio Tools add-in to record macro commands for your form.
• You must override the PlayMacroItem() method in the DexUIForm base class,
and add code to support playback of your macro commands.
• If your Visual Studio Tools form makes asynchronous calls to other processes
that the macro system will need to wait for, you will need to override the
IsAsynchEventPending() method.
Recording macros
In your Visual Studio Tools form, identify the places that the user can perform
actions. Actions include things like clicking buttons, adding text to text fields, or
moving the focus. In the events that run due to these user actions, you will add code
that calls the RecordMacroItem() method to record a text string and optional
comment that identify and describe the action. For example, the following C# code
records a macro command for the Energy Star check box:
RecordMacroItem("ClickHit EnergyStar", "Toggle the Energy Star check box");
The text strings passed to the RecordMacroItem() method are written to the macro
as ShellCommand macro statements.
ShellCommand 'ClickHit EnergyStar' # Toggle the Energy Star check box
The the RecordMacroItem() method records values only when a macro is being recorded.
Macro syntax
The text string and optional comment recorded in the macro are the only
information available to your Visual Studio Tools add-in when the macro is played
back. These text strings must contain enough information for your code to
determine the action that must be performed.
There is no predefined syntax for the text strings recorded. You must define the text
strings so that they can be parsed by your add-in, and then the add-in can perform
the actions indicated. The macro support in the Environmental Details Visual Studio
Tools sample is a good starting point. The syntax of its macro statements is similar
to the standard Microsoft Dynamics GP macro language.
Placement
Where you place the RecordMacroItem() calls in your code can affect how data is
written to the macro. Some experimenting may be required to find which event for a
control is most appropriate for recording a macro action. For example, when
recording the text entered into a text box control, the Validating event is the most
appropriate place for the RecordMacroItem() call. The following C# example shows
the Validating event for the YearlyEnergyCost text box in the Environmental Details
sample.
private void textBoxYearlyEnergyCost_Validating(object sender,

CancelEventArgs e)
{
// Set the change flag for the Item Maintenance window
GPAddIn.ItemMaintenanceWindow.IsChanged = true;
// If a macro is being recorded, record the value.

RecordMacroItem("TypeTo YearlyEnergyCost \"" +
textBoxYearlyEnergyCost.Text + "\"", String.Empty);
}
The following table lists the event where the macro recording code should be placed
for common controls.
Control Event
Text box Validating
Push Button Click
Check box Validating
Playing macros
When a ShellCommand macro statement is played back, and your Visual Studio
Tools form is active, the PlayMacroItem() method will be called. You must override
this method in your Visual Studio Tools add-in code, and process the macro
statements for your form. The following C# example shows how you override the
base method.
public override void PlayMacroItem(MacroPlaybackEventArgs e)

{
Event arguments
The following event arguments are passed into the PlayMacroItem() method:
Handled This is a boolean parameter that indicates whether the action for macro
statement has been performed. You should check the value of this parameter at the
beginning of your PlayMacroItem() method. If its value is true, the macro statement
has already been handled, so your code should take no action. If you determine that
your code should perform the action for the macro statement, set the Handled
parameter to true when the action is complete. This tells other code that the macro
statement has already been processed.
MacroText This string parameter contains the macro string that was written by
the RecordMacroItem() method when the macro was recorded. You will need parse
this string to determine whether your add-in must perform the macro action.
C H A P T E R 1 3 IM P L EM EN T IN G M A CRO S U PP O R T
MacroComment This string parameter contains the comment that was written
by the RecordMacroItem() method when the macro was recorded.
Processing macro statements

Your code will retrieve the MacroText parameter from the event arguments, and
then parse the text to determine whether this macro statement should be performed
by your add-in. You can use any approach you like when parsing the macro
statement. The Environmental Details sample uses regular expressions to parse the
macro statement. The following C# example shows the complete PlayMacroItem()
method for the sample. Notice that if the code performs the macro action, it sets the
Handled parameter to true. If it doesn’t perform the action, it allows the base class
to do so.
public override void PlayMacroItem(MacroPlaybackEventArgs e)

{
Match m;
if (e.Handled == false)
{
// Process Yearly Energy Cost text box
m = Regex.Match(e.MacroText, "TypeTo YearlyEnergyCost \"(.+)\"");
if (m.Success)
{
if (m.Groups.Count >= 2)
{
textBoxYearlyEnergyCost.Focus();
textBoxYearlyEnergyCost.Text = m.Groups[1].Value;
e.Handled = true;
}
}
// Process Notes text box

m = Regex.Match(e.MacroText, "TypeTo EnvNotes \"(.+)\"");
if (m.Success)
{
{
textBoxNotes.Focus();
textBoxNotes.Text = m.Groups[1].Value;
e.Handled = true;
}
}
// Process the push buttons and check boxes

m = Regex.Match(e.MacroText, "ClickHit (\\w+)");
if (m.Success)
{
{
// Energy Star check box
if (m.Groups[1].Value == "EnergyStar")
{
checkBoxEnergyStar.Focus();
checkBoxEnergyStar.Checked = !checkBoxEnergyStar.Checked;
e.Handled = true;
}
// Recyclable check box

if (m.Groups[1].Value == "Recyclable")
{
checkBoxRecyclable.Focus();
checkBoxRecyclable.Checked = !checkBoxRecyclable.Checked;
e.Handled = true;
}
// Close button
if (m.Groups[1].Value == "CloseButton")
{
buttonClose.Focus();
buttonClose.PerformClick();
e.Handled = true;
}
}
}
}
// Macro command was not ours, so let the base class process it.
base.PlayMacroItem(e);
}
Handling asynchronous processes during playback

If your Visual Studio Tools form makes asynchronous calls to other processes that
the macro system will need to wait for, you may need to override the
IsAsynchEventPending() method of the DexUIForm base class. This method is
called periodically when a macro is being played. If the method returns true, the
macro system will wait for the asynchronous event to finish before additional macro
statements are processed.
Override the IsAsynchEventPending() method only if your Visual Studio Tools add-in has
asynchronous processes that the macro system must wait for.
The following C# example shows how you override the method from the base class.
Typically, you will create your own flag that tracks whether your add-in is running
an asynchronous process. In the IsAsynchEventPending() method, you will return
the value of this flag. When the asynchronous process starts, you will set the flag to
true. This causes the macro system to wait for the asynchronous event. When the
asynchronous process finishes, you will set the flag to false. This will allow the
macro system to resume processing.
public override bool IsAsyncEventPending

{
get
{
// Return the value of the flag that indicates whether an
// asynchronous event is being processed.
return InAsyncEventFlag;
}
}
Chapter 14: Using Lookups
Lookups are special-purpose windows used to retrieve existing ID values for
objects in Microsoft Dynamics GP, such as customers, vendors, and sales
documents. You may need to retrieve ID values for your Visual Studio Tools
integration. In many cases, you can use the lookups defined in Microsoft Dynamics
GP to retrieve ID values for fields on your Visual Studio Tools form. Information
about using lookups is divided into the following sections:
• How lookups work

• Available lookups
• Lookup example
How lookups work

Lookup windows in Microsoft Dynamics GP are separate forms. The core Dynamics
dictionary contains lookups with basic lookup functionality. The lookup windows
that the user sees in Microsoft Dynamics GP are actually alternate versions of the
forms, and are defined in the SmartList dictionary. This means that your Visual
Studio Tools code will reference lookups from the SmartList dictionary.
The following steps describe the basic operation of a lookup for a Visual Studio
Tools integration:
1. Add code to track that your integration has opened the lookup.
Lookup forms can be opened by the core Microsoft Dynamics GP application,
and by other integrating products. Your Visual Studio Tools integration must
track that it has opened the lookup, so it will know to retrieve the value that
was selected by the user.
Typically, each lookup used by a Visual Studio Tools integration is tracked

using a static variable defined in the GPAddIn class. The variable must be set
when the lookup is opened, and cleared when the lookup returns a value.
2. Add code to open the lookup form.

Typically, the user clicks a lookup button that opens the lookup form. In your
Visual Studio Tools form, you will add code to the lookup button that will open
the lookup form.
3. Register the ClickBeforeOriginal event for the Select button.

A value is returned from the lookup when the user clicks the Select button in
the lookup form. You will register the ClickBeforeOriginal event on the Select
button to be notified when the button is clicked.
4. Return the ID of the selected item.

When the user clicks the Select button in the lookup, the ID of the selected item
is returned by the event handler for the ClickBeforeOriginal event. This event
handler also clears the static variable that is tracking that the lookup was
opened by the Visual Studio Tools integration.
Available lookups
Several different patterns have been used to code the lookup forms in Microsoft
Dynamics GP. Each pattern requires a specific technique to use the lookup. To learn
what lookups are available and how to call them, refer to the document titled
“Calling Lookup Forms from Dexterity” in the Microsoft Dynamics GP SDK. The
link for this document is found in the Foundation group of the Procedures and
functions section of the Microsoft Dynamics GP SDK help file.
The Lookups sample, described in Chapter 29, “Lookups,” demonstrates how to use several
common lookup forms in a Visual Studio Tools integration.
In some cases, Visual Studio Tools cannot access all of the resources required to use
the lookup form. For example, some lookup forms are opened by calling procedures
that have reference parameters. Because Visual Studio Tools cannot call procedures
with reference parameters, these lookup forms cannot be used with Visual Studio
Tools integrations.
Lookup example
The following example shows how to use the Customers and Prospects lookup
form in Microsoft Dynamics GP to retrieve customer numbers for a Visual Studio
Tools integration.
1. Add a reference to the SmartList application assembly.

The Customers and Prospects lookup is one of the enhanced lookups for
Microsoft Dynamics GP that are contained in the SmartList dictionary.
2. Add a Lookup button to the Visual Studio Tools form.

Refer to Adding controls on page 25 for details about how to add a control to a
Visual Studio Tools form.
3. Add the flag to track that a lookup was opened.

In the GPAddIn class, add a static variable to track that a lookup was opened.
The following C# example shows code that does this.
// Flag to track that a lookup was opened

public static Boolean ReturnToLookup = false;
4. Add code to open the lookup form.

In the Click event for the Lookup button, add code that opens the lookup. The
actions that this code must perform will depend on the lookup that you are
using. Refer to the document “Calling Lookup Forms from Dexterity” in the
Microsoft Dynamics GP SDK for information about the available lookups. For
the Customers and Prospects lookup, the following actions must be performed:
• The flag is set that indicates the lookup was opened by the Visual Studio
Tools integration.
• The CustomerLookup form must be opened.
• The Initialize procedure on the CustomerLookup form must be called. This

configures how data is displayed in the lookup.
C H A P T E R 1 4 U S I N G L O O K U P S
The following C# example shows how the Customers lookup is opened.
private void CustomerLookup_Click(object sender, EventArgs e)

{
// Create a reference to the CustomerLookup form
Microsoft.Dexterity.Applications.SmartListDictionary.
CustomerLookupForm customerLookup = SmartList.Forms.CustomerLookup;
// Set the flag indicating that we opened the lookup

GPAddIn.ReturnToLookup = true;
// Open the CustomerLookup form

customerLookup.Open();
// Call the Initialize procedure to configure the Customer Lookup

customerLookup.Procedures.Initialize.Invoke(1, 0,
CustomerNumber.Text, "", "", "", "", "");
}
5. Register the ClickBeforeOriginal event for the Select button.

In the Initialize method of the GPAddIn class, register the ClickBeforeOriginal
event of the Select button on the CustomerLookup window. The following C#
example shows this registration.
// Select button on the Customers lookup window

Microsoft.Dexterity.Applications.SmartListDictionary.CustomerLookupForm
customerLookupForm = SmartList.Forms.CustomerLookup;
customerLookupForm.CustomerLookup.SelectButton.ClickBeforeOriginal +=
new System.ComponentModel.CancelEventHandler(
SelectButton_ClickBeforeOriginal);
6. Return the ID of the selected item.

In the event handler for the ClickBeforeOriginal event of the Select button,
check the flag that indicates whether the Visual Studio Tools add-in opened the
lookup. If it did, then return the customer number for the customer selected in
the scrolling window of the Customers and Prospects lookup. The following C#
example shows the event handler that performs these actions.
void SelectButton_ClickBeforeOriginal(object sender,

System.ComponentModel.CancelEventArgs e)
{
// Run this code only if the add-in opened the lookup.
if (GPAddIn.ReturnToLookup == true)
{
// Retrieve the customer number of the row selected in the
// scrolling window of the Customers lookup.
Microsoft.Dexterity.Applications.SmartListDictionary.
CustomerLookupForm customerLookupForm =
SmartList.Forms.CustomerLookup;
string customerNumber = customerLookupForm.CustomerLookup.
CustomerLookupScroll.CustomerNumber.Value;
// Display the value retrieved

LookupsWindow.CustomerNumber.Text = customerNumber;
// Clear the flag that indicates a value is to be retrieved from

// the lookup.
GPAddIn.ReturnToLookup = false;
}
}
PART 3: RESOURCE REFERENCE
Part 3: Resource Reference
This portion of the documentation provides detailed information about each type of
resource you can access with Visual Studio Tools for Microsoft Dynamics GP. Each
resource has the following:
• Information about accessing the resource

• A list of methods
• A list of properties
• A list of events
The following resources are discussed:
• Chapter 15, “Forms,” describes form resources.
• Chapter 16, “Windows,” describes window resources.
• Chapter 17, “Scrolling Windows,” describes scrolling window resources.
• Chapter 18, “Window Fields,” describes window field resources.
• Chapter 19, “Tables,” describes table resources.
• Chapter 20, “Table Fields,” describes table field resources.
• Chapter 21, “Commands,” describes command resources.
• Chapter 22, “Globals,” describes global variable resources.
• Chapter 23, “Procedures,” describes procedure resources.
• Chapter 24, “Functions,” describes function resources.
• Chapter 25, “Composites,” describes composite resources.
Chapter 15: Forms
Forms are the basic resource of the Microsoft Dynamics GP application. They
provide the organization for the interface presented to the user. The following items
for forms are discussed:
• Accessing forms
• Form methods
• Form properties
• Form events
Accessing forms
Forms for an application dictionary are accessed through the dictionary class. This
class has a Forms property that provides access to the collection of forms in the
dictionary. The dictionary class for the application dictionary is located in the
following namespace:
For instance, to access the collection of forms in the Dynamics dictionary, use the
following syntax:
Microsoft.Dexterity.Applications.Dynamics.Forms
To access a specific form, such as the Sales Transaction Entry form (SopEntry), use
the following syntax:
Microsoft.Dexterity.Applications.Dynamics.Forms.SopEntry
Form methods
Forms provide the following methods:
• AddMenuHandler()
• Close()
• Dispose()
• Open()
AddMenuHandler()
The AddMenuHandler() method adds a menu item to the “Additional” menu that
appears in windows in Microsoft Dynamics GP. The menu item will be available
when the form is open. This method takes three parameters:
EventHandler – The function that will be run when the menu item is chosen in
MenuItemName – A string containing the text that will be displayed for the menu
item.
AcceleratorKey – A string containing a single character that will be used as the

accelerator key for the menu item. Be sure this accelerator key does not conflict with
any existing accelerator keys. If you don’t want an accelerator key, use the empty
string.
PA RT 3 R E S O U R C E R E F E R E N C E
The following C# example shows how a menu handler for the “Estimate Freight”
menu item is added to the SopEntry form in Microsoft Dynamics GP:
Dynamics.Forms.SOPEntry.AddMenuHandler(OpenEstimateFreight,
"Estimate Freight", "F");
This code is the event handler for the menu item. Notice that it takes two arguments
like standard event handlers.
static void OpenEstimateFreight(object sender, EventArgs e)

{
if (EstimateFreightForm == null)
{
EstimateFreightForm = new EstimateFreight();
}
else
{
if (EstimateFreightForm.Created == false)
{
EstimateFreightForm = new EstimateFreight();
}
}
// Always show and activate the WinForm

EstimateFreightForm.Show();
EstimateFreightForm.Activate();
}
}
The following Visual Basic example shows how the same menu handler for the
“Estimate Freight” menu item is added to the SopEntry form in Microsoft Dynamics
GP.
Dim EstimateFreightHandler as System.EventHandler
EstimateFreightHandler = New System.EventHandler(AddressOf

OpenEstimateFreight)
Dynamics.Forms.SOPEntry.AddMenuHandler(EstimateFreightHandler, "Estimate
Freight", "F")
This code is the event handler for the menu item. Notice that it also takes two
arguments like standard event handlers.
Shared Sub OpenEstimateFreight(ByVal sender As Object, ByVal e As EventArgs)

If EstimateFreightForm Is Nothing Then
Try
EstimateFreightForm = New EstimateFreightForm()
Catch ex As Exception
MessageBox.Show(ex.Message)
End Try
Else
If EstimateFreightForm.Created = False Then
EstimateFreightForm = New EstimateFreightForm()
End If
End If
C H A PT E R 1 5 F O R M S
' Always show and activate the WinForm

EstimateFreightForm.Show()
EstimateFreightForm.Activate()
End Sub
Close()
The Close() method closes the form.
Dispose()
The Dispose() method releases the memory used for the form after it is no longer
needed.
Open()
The Open() method attempts to open the form.
Form properties
Forms provide the following properties:
• Commands
• Functions
• IsOpen
• IsChanged
• Procedures
Commands
The Commands property provides access to the list of commands that are defined
by the form. Refer to Chapter 21, “Commands,” to learn more about using
commands in your application.
Functions
The Functions property provides access to the list of form-level functions that are
defined by the form. Refer to Chapter 24, “Functions,” for more information about
functions.
IsChanged
The IsChanged property has the value true if the change flag for the form is set, and
false if it is not. The change flag is automatically set to true when any field value for
the form has changed.
IsOpen
The IsOpen property has the value true if the form is open, and false if it is not.
Procedures
The Procedures property provides access to the list for form-level procedures that
are defined by the form. Refer to Chapter 23, “Procedures,” to learn more about
using procedures.
Tables
The Tables property provides access to the list of tables that are attached to the
form. Refer to Chapter 9, “Working with Tables,” and Chapter 19, “Tables,” for more
information about using the tables attached to forms.
Form events
Forms provide the following events:
OpenBeforeOriginal
This event occurs when the form is opened, but before the form’s open event is run.
This event can be canceled.
OpenAfterOriginal
This event occurs when the form is opened, but after the form’s open event is run.
CloseBeforeOriginal
This event occurs when the form is closed, before the form’s close event is run. This
event can be canceled.
CloseAfterOriginal
This event occurs when the form is closed, after the form’s close event is run.
Chapter 16: Windows
Windows are a part of form in Microsoft Dynamics GP. They display the user
interface for the application. The following items are discussed:
• Accessing windows
• Window methods
• Window properties
• Window events
Accessing windows
Windows for an application dictionary are accessed as properties of the form that
they are contained in. For example, the Sales Transaction Entry window (SopEntry)
is part of the SopEntry form. To access it, you would use the following syntax:
Dynamics.Forms.SopEntry.SopEntry
The IntelliSense in Visual Studio will tell you what form and window in Microsoft
Dynamics GP are being referred to by the expression.
Window methods
Windows provide the following methods:
• Close()
• Open()
• PullFocus()
Close()
The Close() method closes the window.
Open()
The Open() method attempts to open the window.
PullFocus()
The PullFocus() method will remove the focus from the current window. No item in
the window will be focused. Any pending “validate” or “leave” events for the
currently-focused field will be run. Use this method in situations where you want
all of the pending actions to be run before your integrating application performs its
processing.
Window properties
Windows provide the following properties:
• IsChanged
• IsOpen
IsChanged
The IsChanged property has the value true if the change flag for the form is set, and
false if it is not. The change flag is automatically set to true when any field value for
the window has changed.
IsOpen
The IsOpen property has the value true if the window is open, and false if it is not.
Window events
Windows provide the following events:
• ActivateBeforeOriginal
• ActivateAfterOriginal
• PrintBeforeOriginal
• PrintAfterOriginal
• BeforeModalDialog
• AfterModalDialog
OpenBeforeOriginal
This event occurs when the window is opened, but before the window’s open event
is run. This event can be canceled.
OpenAfterOriginal
This event occurs when the window is opened, but after the window’s open event is
run.
ActivateBeforeOriginal
This event occurs each time the window becomes active, before the window’s
activate event is run. The activate event occurs every time the window is opened or
brought to the front by the user. It occurs after the Open event.
The Activate event must be used cautiously. It shouldn’t perform any actions that can cause
dialogs to appear because the application can become suspended in an endless loop.
ActivateAfterOriginal
This event occurs each time the window becomes active, after the window’s activate
event is run.
CloseBeforeOriginal
This event occurs when the window is closed, but before the window’s close event
is run. This event can be canceled.
CloseAfterOriginal
This event occurs when the window is closed, but after the window’s close event is
run.
PrintBeforeOriginal
This event occurs when the print action for the window is chosen, but before the
window’s print event is run. The print action for a window occurs when the user
chooses the Print menu item from the File menu, or clicks the Print button on the
window. This event can be canceled.
PrintAfterOriginal
This event occurs when the print action for the window is chosen, but after the
window’s print event is run.
C H A P T E R 1 6 W I N D O W S
BeforeModalDialog
This event occurs when the a modal dialog is displayed by a window, but before the
dialog is actually shown to the user. The event arguments allow access the
properties of the modal dialog:
DialogType Indicates the type of modal dialog that is being displayed. The
DialogType enumeration defines the following available types:
Type Description
Ask A modal dialog generated by the error, warning, or ask()
script commands.
GetString A modal dialog generated by the getstring() command.
Message Contains the text that is displayed in the modal dialog. Setting the value
of this property in the BeforeModalDialog event allows you to change the text
displayed in the modal dialog. Typically, the value of this parameter is examined to
find out what message is going to be displayed to the user.
Button1Text Contains the text that is displayed in button 1 of the modal dialog.
Setting the value of this property in the BeforeModalDialog event allows you to
change the text displayed in the button.
Setting the value of this property in the BeforeModalDialog event allows you to
change the text displayed in the button.
For getstring() dialogs, this is the editable string in the dialog. Setting the value of
this property in the BeforeModalDialog event allows you to change the text
displayed in the button or the editable field.
Response Indicates the response to the modal dialog. The DialogResponse

enumeration defines the available responses:
Response type Description

Button1 Button 1 in the modal dialog is clicked.
Ok The OK button in the getstring() modal dialog is clicked.
Cancel The Cancel button in the getstring() modal dialog is
clicked.
None No response was made.
Setting this property in the BeforeModalDialog event allows your code to respond
to the dialog, and prevents the dialog from being displayed to the user. Setting the
response to None will allow the dialog to be displayed.
The following Visual Basic example creates references to the Sales Transction Entry
form and window, and then registers a BeforeModalDialog event for the Sales
Transaction Entry window.
' Create a reference to the Sales Transtion Entry form

Shared SOPEntryForm As SopEntryForm = Dynamics.Forms.SopEntry
' Create a reference to the Sales Transaction Entry window

Shared SOPEntryWindow As SopEntryForm.SopEntryWindow = SOPEntryForm.SopEntry
Sub Initialize() Implements IDexterityAddin.Initialize
AddHandler SOPEntryWindow.BeforeModalDialog, AddressOf _

SopEntryWindow_BeforeModalDialog
End Sub
The following example is the BeforeModalDialog event handler for the event
registered inthe previous example. When a modal dialog is to be displayed, the
code examines the text of the message to determine whether it is the message that
asks the user whether they want to add a new customer or a new prospect. If it is,
the Response parameter of the event arguments is set to Button1, indicating that a
new customer should be created. This prevents the modal dialog from being
displayed.
Private Sub SopEntryWindow_BeforeModalDialog(ByVal sender As Object, ByVal e

As BeforeModalDialogEventArgs)
' Examine the dialog to determine whether it is the one to respond do

If e.DialogType = DialogType.Ask Then
If e.Message.Contains("want to add a customer") Then
' Click the Customer button in the modal dialog
e.Response = DialogResponse.Button1
End If
End If
End Sub
AfterModalDialog
This event occurs when the user has acted on a modal dialog displayed by a
window. This event allows you to retrieve the choice that the user made in the
modal dialog. Typically, you will examine the DialogType and Message properties
in the event arguments to find out what dialog is being displayed. Then you can
examine the Response property in the event arguments to learn how the user
responded to the dialog.
The following C# example creates references to the Item Maintenance form and the
Item Maintenance window, and then registers for the AfterModalDialog event for
the Item Maintenance window.
// Create a reference to the Item Maintenance form

public static IvItemMaintenanceForm ItemMaintenanceForm =
Dynamics.Forms.IvItemMaintenance;
// Create a reference to the Item Maintenance window

public static IvItemMaintenanceForm.IvItemMaintenanceWindow
ItemMaintenanceWindow = ItemMaintenanceForm.IvItemMaintenance;

{
ItemMaintenanceForm.IvItemMaintenance.AfterModalDialog +=
new EventHandler<AfterModalDialogEventArgs>
(IvItemMaintenance_AfterModalDialog);
}
C H A P T E R 1 6 W I N D O W S
The following C# example is the AfterModalDialog event handler for the event
registered inthe previous example. When a modal dialog is to be displayed, the
code examines the text of the message to determine whether it is the message that
asks the user whether they want to delete the current item. The Response property
of the event arguments is examined to find out whether the user clicked Delete in
the modal dialog. If the user did, the additional information stored for the item is
also deleted.
void IvItemMaintenance_AfterModalDialog(object sender,

AfterModalDialogEventArgs e)
{
// Is it an 'ask' dialog?
if (e.DialogType == DialogType.Ask)
{
// It it verifying a delete action?
if (e.Message.Contains("want to delete"))
{
// Did the user click Delete (button 1)?
if (e.Response == DialogResponse.Button1)
{
// Delete the environmental details for the current item.
DataAccessHelper.DeleteEnvironmentalDetails();
}
}
}
}
Chapter 17: Scrolling Windows
Scrolling windows are a special type of window in Microsoft Dynamics GP that are
used to display or access data directly from a database table. The following items
are discussed:
• Accessing scrolling windows

• Scrolling window methods
• Scrolling window properties
• Scrolling window events
Accessing scrolling windows

Scrolling windows for an application dictionary are accessed as properties of the
window that they are contained in. For example, the Line Scroll scrolling window in
the Sales Transaction Entry window of Microsoft Dynamics GP is accessed using the
following syntax:
Dynamics.Forms.SopEntry.SopEntry.LineScroll
The IntelliSense in Visual Studio will tell you what scrolling window in Microsoft
Dynamics GP is being referred to by the expression.
Scrolling window methods

There are no additional methods for scrolling windows.
Scrolling window properties

There are no additional properties for scrolling windows.
Scrolling window events

Scrolling windows provide the following events:
• LineFillBeforeOriginal
• LineFillAfterOriginal
• LineEnterBeforeOriginal
• LineEnterAfterOriginal
• LineChangeBeforeOriginal
• LineChangeAfterOriginal
• LineLeaveBeforeOriginal
• LineLeaveAfterOriginal
• LineInsertBeforeOriginal
• LineInsertAfterOriginal
• LineDeleteBeforeOriginal
• LineDeleteAfterOriginal
LineFillBeforeOriginal
This event occurs before the line fill event for the scrolling window. The line fill
event occurs each time a new line is added to the scrolling window from the linked
table, such as when the user scrolls to a new line. When the scrolling window first
fills, the line fill event occurs repeatedly until the scrolling window is full. The line
fill event also occurs each time the user moves the focus to an existing line in the
scrolling window. The line fill event occurs before the line enter event.
To find out what data will be added to the current row of the scrolling window,
examine the current row of the form-level table buffer for the table linked to the
scrolling window.
When using this event, you cannot examine the window fields for the scrolling window to
determine what row is being added. The values of the window fields will not have been set
yet.
The LineFillBeforeOriginal event can be cancelled. If the event is cancelled, the

current row in the table linked to the scrolling window will not be added to the
scrolling window.
For example, the following C# code registers the LineFillBeforeOriginal event for
the scrolling window in the Customers and Prospects window in Microsoft
Dynamics GP.

{
Dynamics.Forms.CustomerLookup.CustomerLookup.CustomerLookupScroll.
LineFillBeforeOriginal += new System.ComponentModel.CancelEventHandler
(CustomerLookupScroll_LineFillBeforeOriginal);
}
The following is the C# code that runs in response to this event. It allows only
customers in the “TERRITORY 2” sales territory to be displayed. The
RmCustomerMstr table is linked to the scrolling window, so the values for the
scrolling window come from this table. Notice how the code is accessing the current
row of the form-level table buffer for the RmCustomerMstr table to find out what
row is being added to scrolling window. The SalesTerritory field in the current row
of the table is examined. If it is not “TERRITORY 2”, the event is cancelled. This
prevents the row from being displayed in the scrolling window.
void CustomerLookupScroll_LineFillBeforeOriginal(object sender,

System.ComponentModel.CancelEventArgs e)
{
if(Dynamics.Forms.CustomerLookup.Tables.RmCustomerMstr.SalesTerritory.
Value != "TERRITORY 2")
{
// Not in TERRITORY 2, so do not display the line
e.Cancel = true;
}
}
LineFillAfterOriginal
This event occurs after the line fill event for the scrolling window.
LineEnterBeforeOriginal
This event occurs when the focus moves to a line in the scrolling window, but before
the scrolling window’s line enter event is run. This event can be canceled.
LineEnterAfterOriginal
This event occurs when the focus moves to a line in the scrolling window, but after
the scrolling window’s line enter event is run.
C H A P T E R 1 7 S C R O L L I N G W I N D O W S
LineChangeBeforeOriginal
This event occurs when the focus leaves a line in the scrolling window, and the
contents of the line has been modified. The event runs before the scrolling window’s
line change event is run. This event can be canceled.
LineChangeAfterOriginal
This event occurs when the focus leaves a line in the scrolling window, and the
contents of the line has been modified. The event runs after the scrolling window’s
line change event is run.
LineLeaveBeforeOriginal
This event occurs when the focus leaves a line in the scrolling window, but before
the scrolling window’s line leave event is run. This event can be canceled.
LineLeaveAfterOriginal
This event occurs when the focus leaves a line in the scrolling window, but after the
scrolling window’s line leave event is run.
LineInsertBeforeOriginal
This event occurs when a new line is added to the scrolling window, but before the
scrolling window’s line insert event is run. This event can be canceled.
LineInsertAfterOriginal
This event occurs when a new line is added to the scrolling window, but after the
scrolling window’s line insert event is run.
LineDeleteBeforeOriginal
This event occurs when a line is removed from the scrolling window, but before the
scrolling window’s line delete event is run. This event can be canceled.
LineDeleteAfterOriginal
This event occurs when a line is removed from the scrolling window, but after the
scrolling window’s line delete event is run.
Chapter 18: Window Fields
Window fields display individual data items on a window. The following items are
discussed:
• Accessing window fields

• Window field methods
• Window field properties
• Window field events
Accessing window fields

Windows fields for an application dictionary are accessed as properties of the
window or scrolling window that they are contained in. For example, the SOP
Number (SopNumber) field is available on the Sales Transaction Entry window
(SopEntry). To access it, you would use the following syntax:
Dynamics.Forms.SopEntry.SopEntry.SopNumber
As another example, the QTY To Backorder (QtyToBackOrder) field is available on

the Line Scroll (LineScroll) scrolling window of the Sales Transaction Entry
window(SopEntry). To access this field, you would use the following syntax:
Dynamics.Forms.SopEntry.SopEntry.LineScroll.QtyToBackOrder
The IntelliSense in Visual Studio will tell you what field in Microsoft Dynamics GP is being
referred to by the expression.
Some fields in windows are called local fields, because they are used only within a
specific form. For instance, the Sales Transaction Entry window (SopEntry) contains
a local field named (L) BillTo Address 1. The (L) in the name is the standard way
local fields are identified in Microsoft Dynamics GP. In a Visual Studio Tools for
Microsoft Dynamics GP project, the names of these fields are prefixed with the
“Local” to indicate they are local fields. For example, to access the BillTo Address 1
local field, you would use the following syntax:
Dynamics.Forms.SopEntry.SopEntry.LocalBillToAddress1
Window field methods

Window fields provide the following methods:
• Clear()
• Disable()
• Enable()
• Fill()
• Focus()
• ForceValidate()
• Hide()
• Lock()
• RunValidate()
• Show()
• Unlock()
Clear()
The Clear() method sets the field to its cleared value. The following table lists the
cleared value for standard datatypes:
Datatype Cleared value

Date 0/0/0
Currency 0
Integer 0
Long 0
String Empty string
Time 000000 which corresponds to 12:00:00 AM
Disable()
The Disable() method makes the field appear in a disabled state, and prevents the
user from making changes to the field.
Enable()
The Enable() method allows a previously disabled field to receive user input.
Fill()
The Fill() method sets the field to its filled value. The following table lists the filled
value for standard datatypes:
Datatype Filled value

Date 12/31/9999
Currency 99999999999999.99999
Integer 32,767
Long 2,147,483,647
String The length byte (first byte) of the string is set to the
storage size of the string minus 1. Each of the
remaining bytes is set to string equivalent of ASCII 255.
Time 23:59:59
Focus()
The Focus() method moves the focus to the field.
ForceValidate()
The ForceValidate() method controls whether the validate event will occur when
the focus leaves the field. If the validate event occurs, any validation code for the
field will be run. This method takes one boolean parameter. Supplying the value
true forces the validate event to occur. Supplying the value false clears any previous
call to force the validate event to occur.
Hide()
The Hide() method causes the field to become invisible and inaccessible to the user.
Lock()
The Lock() method causes a field to become inaccessible to the user. The field’s
appearance will not change.
C H A P T E R 1 8 W I N D O W F I E L D S
RunValidate()
The RunValidate() method causes any validation code for the window field to be
run.
Show()
The Show() method causes a previously hidden field to become visible and
accessible to the user.
Unlock()
The Unlock() method causes a previously locked field to become accessible to the
user.
Window field properties

Window fields have the following properties:
• IsEmpty
• IsFilled
• Value
IsEmpty
The IsEmpty property returns the value true when the value of the field is empty
for the specific field type. The following table lists the empty value for standard
datatypes:
Datatype Empty value

Date 0/0/0
Currency 0
Integer 0
Long 0
String Empty string
IsFilled
The IsFilled property returns the value true when the value of the field is set to the
maximum value for the specific field type. The following table lists the filled value
for standard datatypes:

Date 12/31/9999
Currency 99999999999999.99999
Integer 32,767
Long 2,147,483,647
Time 23:59:59
Value
The Value property is used to set or retrieve the value of the field. The IntelliSense
in Visual Studio will tell you what type of value is used for the field.
Window field events

Window fields provide the following events:
• Change
• EnterBeforeOriginal
• EnterAfterOriginal
• LeaveBeforeOriginal
• LeaveAfterOriginal
• ValidateBeforeOriginal
• ValidateAfterOriginal
Change
This event occurs when the value of the field changes, such as being set by the user
or changed by other code in Microsoft Dynamics GP.
ClickAfterOriginal
This event occurs when the user clicks a button, but after the button’s click event is
run.
ClickBeforeOriginal
This event occurs when the user clicks a button, but before the button’s click event is
run. This event can be canceled.
EnterBeforeOriginal
This event occurs when the focus moves to the field, but before the field’s enter
event is run. This event can be canceled.
EnterAfterOriginal
This event occurs when the focus moves to the field, but after the field’s enter event
is run.
LeaveBeforeOriginal
This event occurs when the focus moves from the field, but before the field’s leave
event is run. This event can be canceled.
LeaveAfterOriginal
This event occurs when the focus moves from the field, but after the field’s leave
event is run.
ValidateBeforeOriginal
This event occurs when the focus is to move from the field, and the field has been
set to be validated. A field will be validated when its value has been changed, or the
validation has been forced, such as with the ForceValidate() method. This event
occurs before the field’s validate event. It can be canceled.
ValidateAfterOriginal
This event occurs when the focus is to move from the field, and the field has been
set to be validated. This event occurs after the field’s validate event.
Chapter 19: Tables
Tables are the basic resource of the Microsoft Dynamics GP application that
provides access to the database. Methods provided for each table allow creating,
retrieving, updating, or deleting rows from the table in the database. The following
items for tables are discussed:
• Accessing tables
• Table methods
• Table properties
Accessing tables
A table buffer provides access to one row of a specific table. Your code will interact
with the table buffer when you perform operations on the table. There are two types
of table buffers: global and form-level.
Global table buffers

A global table buffer is created when a table is accessed directly through the global list
of tables. Global table buffers are accessed through the dictionary class. This class
has a Tables property that provides access to the collection of tables defined in the
For instance, to access the collection of tables in the Dynamics dictionary, use the
following syntax:
Microsoft.Dexterity.Applications.Dynamics.Tables
To access a specific table, such as the RM_Customer_MSTR table

(RmCustomerMstr), use the syntax shown below. (This example assumes the
namespace mentioned above has been referenced.)
Dynamics.Tables.RmCustomerMstr
The IntelliSense in Visual Studio will tell you what table in Microsoft Dynamics GP is
being referred to by the expression.
By default, a global table buffer for a table is shared with all of the other Visual
Studio Tools add-ins that are accessing that same table. If you want your integration
to create a global table buffer that is not shared, use the Clone() method when
creating the instance of the global table buffer.
Form-level table buffers

A form-level table buffer is created when a table is attached to a form in Microsoft
Dynamics GP. There is one table buffer for each table that is attachd to the form.
Each form-level table buffer is shared by the code that is part of the form, as well as
any code outside of the form that accesses the table through that form. The Tables
property for the form allows access to the table buffers for the tables that are
attached to the form. For example, to access the form-level procedures for Sales
Transaction Entry Form (SopEntryForm) in Microsoft Dynamics GP, you would use

Dynamics.Forms.SopEntry.Tables
The IntelliSense in Visual Studio will tell you what form-level table in Microsoft Dynamics
GP is being referred to by the expression.
Table methods
Tables provide the following methods:
• Change()
• ChangeFirst()
• ChangeLast()
• ChangePrevious()
• Clear()
• Clone()
• Close()
• Fill()
• Get()
• GetFirst()
• GetLast()
• GetNext()
• GetPrevious()
• RangeClear()
• RangeEnd()
• RangeRemove()
• RangeStart()
• Release()
• Remove()
• Save()
Change()
The Change() method retrieves a row from the table and passively or actively locks
the row, allowing changes to be made to it. The row retrieved is determined by the
key specified for the table and the values that were specified for the key segments.
The Change() method has one parameter:
ActiveLock – A optional boolean. The value true specifies that an active lock will be
applied to the row. The value false (the default value) specifies that a passive lock
will be applied.
ChangeFirst()
The ChangeFirst() method retrieves the first row from the table and passively or
actively locks the row, allowing changes to be made to it. The row retrieved is
determined by the key specified for the table. The ChangeFirst() method has one
parameter:
will be applied.
C H A P T E R 1 9 T A B LE S
ChangeLast()
The ChangeLast() method retrieves the last row from the table and passively or
determined by the key specified for the table. The ChangeLast() method has one
parameter:
will be applied.
ChangeNext()
The ChangeNext() method retrieves the next row from the table and passively or
determined by the key specified for the table and the values of the key fields for the
row currently in the table buffer. The ChangeNext() method has one parameter:
will be applied.
ChangePrevious()
The ChangePrevious() method retrieves the previous row from the table and
passively or actively locks the row, allowing changes to be made to it. The row
retrieved is determined by the key specified for the table and the values of the key
fields for the row currently in the table buffer. The ChangePrevious() method has
one parameter:
will be applied.
Clear()
The Clear() method sets all of the fields in the table buffer to their cleared values.
The following table lists the cleared value for standard datatypes:

Date 0/0/0
Currency 0
Integer 0
Long 0
String Empty string
Clone()
The Clone() method creates a new instance of a global table buffer for a table. This
new table buffer instance is not shared, so it is not accessible by other Visual Studio
Tools add-ins. The Clone() method has no effect when when with form-level table
buffers.
Close()
The Close() method closes the table buffer.

Fill()
The Fill() method sets all of the fields in the table buffer to their maximum values.
The following table lists the filled value for standard datatypes:

Date 12/31/9999
Currency 99999999999999.99999
Integer 32,767
Long 2,147,483,647
String The length byte (first byte) of the string is set to
the storage size of the string minus 1. Each of the
remaining bytes is set to string equivalent of
ASCII 255.
Time 23:59:59
Get()
The Get() method retrieves a row from the table. No lock is applied to the row. The
row retrieved is determined by the key specified for the table and the values that
were specified for the key segments.
GetFirst()
The GetFirst() method retrieves the first row from the table. No lock is applied to
the row. The row retrieved is determined by the key specified for the table.
GetLast()
The GetLast() method retrieves the last row from the table. No lock is applied to the
row. The row retrieved is determined by the key specified for the table.
GetNext()
The GetNext() method retrieves the next row from the table. No lock is applied to
the row. The row retrieved is determined by the key specified for the table and the
values of the key fields for the row currently in the table buffer.
GetPrevious()
The GetPrevious() method retrieves the previous row from the table. No lock is
applied to the row. The row retrieved is determined by the key specified for the
table and the values of the key fields for the row currently in the table buffer.
RangeClear()
The RangeClear() method removes the range that was specified for the table.
RangeEnd()
The RangeEnd() method specifies the current values of the key segments in the
table buffer as the end of the range of rows in the table. The Key property specifies
which key will be used for the range.
RangeRemove()
The RangeRemove() method attempts to delete all of the rows in the current range
from the table.
RangeStart()
The RangeStart() method specifies the current values of the key segments in the
table buffer as the beginning of the range of rows in the table. The Key property
specifies which key will be used for the range.
C H A P T E R 1 9 T A B LE S
Release()
The Release() method releases any passive or active lock for a row in the table
buffer. The row values remain in the table buffer.
Remove()
The Remove() method deletes the current row in the table buffer from the table. The
row must be passivly or actively locked before it can be deleted.
Save()
The Save() method saves the values currently in the table buffer to the table. If the
row is locked in the table buffer, it will be updated. If no row in the table is locked, a
new row will be added.
Table properties
Tables have the following property:
• Key
Key
The Key property is used to set or retrieve the key currently being used by the table
buffer to access the table. The keys for a table are identified by number, beginning
with the value 1. When you specify the key you want to use for a table, you will
supply the corresponding integer. The Table Descriptions window in Microsoft
Dynamics GP lists the keys for each table, and the key segments (fields) that each
key contains.

Chapter 20: Table Fields
Table fields represent individual data items in a row of a table. The following items
are discussed:
• Accessing table fields

• Table field methods
• Table field properties
Accessing table fields

Table fields for an application dictionary are accessed as properties of the table that
they are contained in. For example, the Item Number (ItemNumber) field is
available in the Inventory Item Master (IvItemMstr) table. To access it, you would
use the following syntax:
Dynamics.Tables.IvItemMstr.ItemNumber
The IntelliSense in Visual Studio will tell you what field in Microsoft Dynamics GP is being
referred to by the expression.
Table field methods

Table fields provide the following methods:
• Clear()
• Fill()
Clear()
The Clear() method sets the field to its cleared value. The following table lists the
cleared value for standard datatypes:

Date 0/0/0
Currency 0
Integer 0
Long 0
String Empty string
Fill()
The Fill() method sets the field to its filled value. The following table lists the filled
value for standard datatypes:

Date 12/31/9999
Currency 99999999999999.99999
Integer 32,767
Long 2,147,483,647
Time 23:59:59

Table field properties

Table fields have the following properties:
• IsEmpty
• IsFilled
• Value
IsEmpty
datatypes:

Date 0/0/0
Currency 0
Integer 0
Long 0
String Empty string
IsFilled

Date 12/31/9999
Currency 99999999999999.99999
Integer 32,767
Long 2,147,483,647
Time 23:59:59
Value
The Value property is used to set or retrieve the value of the field. The IntelliSense
in Visual Studio will tell you what type of value is used for the field.
Chapter 21: Commands
In Microsoft Dynamics GP, commands are used to encapsulate a small piece of
functionality for the application. They are typically used for navigation. Commands
can appear in menus and also in toolbars in Microsoft Dynamics GP. The following
items are discussed:
• Command types
• Accessing commands
• Command methods
Command types
A command can be one of the following types:
Form A form command opens the specified form.
Script A script command runs the script code that is defined for it.
Command list A command list command is a container for other commands. A

command list can be used as a menu, submenu, or a toolbar.
Accessing commands
Commands for an application dictionary are accessed using the Commands
property of the form that they are contained in. Most commands in Microsoft
Dynamics GP are contained in forms that are used specifically for commands. The
names of these forms begin with “Command” and include the module for which
the commands are used. For example, to access the command used to open the
SmartList window in Microsoft Dynamics GP, you would use the following syntax:
Dynamics.Forms.CommandSystem.Commands.SmartList
The IntelliSense in Visual Studio will tell you what command in Microsoft Dynamics GP is
being referred to by the expression.
Command methods
Commands provide the following methods:
• Check()
• Disable()
• Enable()
• Hide()
• Run()
• Show()
• Uncheck()
Check()
The Check() method causes the command to appear checked if it is displayed in a
menu or on a toolbar.
Disable()
The Disable() method causes the command to appear disabled if it is displayed in a
menu or on a toolbar. Once disabled, the command cannot be run.

Enable()
The Enable() method causes a previously disabled command to become enabled. It
will appear enabled if it is displayed in a menu or on a toolbar.
Hide()
The Hide() method causes a command to be hidden in any menu or toolbar in
which it appears. The command can still be run.
Run()
The Run() method performs the action of the command. For form commands, it
opens the corresponding form. For script commands, it executes the script code that
is attached to the command.
Show()
The Show() method causes a previously hidden command to be displayed in any
menu or toolbar in which it appears.
Uncheck()
The Uncheck() method causes the command to appear unchecked if it is displayed
in a menu or on a toolbar.
Chapter 22: Globals
Globals are used to hold values accessible to the entire Microsoft Dynamics GP
application. The following items are discussed:
• Accessing globals
• Global properties
Accessing globals
Globals for an application dictionary are accessed through the dictionary class. This
class has a Globals property that provides access to the collection of globals in the
For instance, to access the collection of globals in the Dynamics dictionary, use the
following syntax:
Microsoft.Dexterity.Applications.Dynamics.Globals
To access a specific global value, such as the current user’s ID (UserId), use the
following syntax:
Microsoft.Dexterity.Applications.Dynamics.Globals.UserId
Global properties
Globals have the following properties available:
• IsEmpty
• IsFilled
• Value
IsEmpty
datatypes:

Date 0/0/0
Currency 0
Integer 0
Long 0
String Empty string

IsFilled

Date 12/31/9999
Currency 99999999999999.99999
Integer 32,767
Long 2,147,483,647
Time 23:59:59
Value
The Value property is used to retrieve the value of the global. The IntelliSense in
Visual Studio will tell you what type of value is used for the field. Global values
cannot be set from a Visual Studio Tools for Microsoft Dynamics GP project.
Chapter 23: Procedures
There are two types of procedures in a Dynamics GP application dictionary. Global
procedures are blocks of code that are accessed from various places throughout the
application. Parameters are used to send values to a procedure and also to return
values from it. Form-level procedures are like global procedures, with the exception
that they are defined as part of a specific form. Typically, they perform some action
specific to the form they are defined for. The following items are discussed:
• Accessing global procedures

• Accessing form-level procedures
• Procedure methods
• Procedure events
• Parameters for procedures
• Invokable procedures
Accessing global procedures

Global procedures for an application dictionary are accessed through the dictionary
class. This class has a Procedures property that provides access to the collection of
global procedures in the dictionary. The dictionary class for the application
dictionary is located in the following namespace:
For instance, to access the collection of global procedures in the Dynamics

dictionary, use the following syntax:
Microsoft.Dexterity.Applications.Dynamics.Procedures
To access a specific global procedure, such as the Get_Next_Form_Note_To_Open

procedure (GetNextFormNoteToOpen), use the syntax shown below. (This example
assumes the namespace mentioned above has been referenced.)
Dynamics.Procedures.GetNextFormNoteToOpen
The IntelliSense in Visual Studio will tell you what global procedure in Microsoft Dynamics
Accessing form-level procedures

Form-level procedures for an application dictionary are accessed through the form
they are contained in. The Procedures property for the form allows access to the
form-level procedures. For example, to access the form-level procedures for Sales
Dynamics.Forms.SopEntry.Procedures
The IntelliSense in Visual Studio will tell you what form-level procedure in Microsoft
Procedure methods
Procedures provide the following method:
• Invoke()

Invoke()
The Invoke() method is used to run the specified procedure. The parameters for this
method will depend on the procedure that is being run. The following table lists the
types of parameters for procedures:
Type Description
in Parameters of type “in” are used only to pass values into the procedure.
out Parameters of type “out” are used only to pass values out of the
procedure.
inout Parameters of type “inout” are used to pass values into the procedure,
and to pass values out of the procedure.
The IntelliSense in Visual Studio will tell you the type of each parameter for a procedure. It
will also tell you the datatype of each parameter, such as decimal or string.
For example, the following C# code calls the CheckNoteIdString global procedure.
This procedure has one “in” parameter and two “out” parameters. Notice that the
out keyword is required for the parameters to which values are returned.
Dynamics.Procedures.CheckNoteIdString.Invoke("Estimate Freight", out

isPresent, out formNumber);
You can refer to the Microsoft Dynamics GP SDK for details about the procedures
available to invoke. Some procedures in Microsoft Dynamics GP have optional
parameters defined. Visual Studio Tools does not support optional parameters. You
must supply all parameters for a procedure when you invoke it from Visual Studio
Tools.
Procedure events
Procedures provide the following events:
• InvokeBeforeOriginal
• InvokeAfterOriginal
InvokeBeforeOriginal
This event occurs when the procedure is invoked, but before the original procedure
is run. The event arguments allow access the parameters of the procedure. Refer to
Parameters for procedures on page 115 to learn more about working with parameters
in procedure events.
InvokeAfterOriginal
This event occurs when the procedure is invoked, but after the original procedure is
run.The event arguments allow access the parameters of the procedure. Refer to
Parameters for procedures on page 115 to learn more about working with parameters
in procedure events.
The following C# example registers the InvokeAfterOriginal event for the

AddSuccessfulLoginRecord procedure in Microsoft Dynamics GP.
Dynamics.Procedures.AddSuccessfulLoginRecord.InvokeAfterOriginal +=
new AddSuccessfulLoginRecordProcedure.InvokeEventHandler(
AddSuccessfulLoginRecord_InvokeAfterOriginal);
C H A PT E R 2 3 P R O C ED U R E S
The following C# example is the event handler for the event registered in the
previous example. The event handler for the AddSuccessfulLoginRecord procedure
is typically used to perform setup operations, because the user has successfully
logged into a company.
void AddSuccessfulLoginRecord_InvokeAfterOriginal(object sender,

AddSuccessfulLoginRecordProcedure.InvokeEventArgs e)
{
// Setup code is placed here
}
Parameters for procedures

When you invoke a procedure or use procedure events, you will need to work with
the parameters of the procedure.
Learning about the parameters

There are several ways you can learn about the parameters for a procedure:
• When invoking a procedure, the IntelliSense lists the parameters and their data
types.
• The event arguments passed to the event handler for procedure events will list
the available parameters and their data types.
• The Parameters for Microsoft Dynamics GP section of the Microsoft Dynamics GP

SDK contains a complete listing of the parameters for the procedures in
Microsoft Dynamics GP and several integrating dictionaries. The parameter
documents in this section of the SDK also list the parameter names, which can
be helpful when determining how the parameters are used.
Accessing parameter values

In the InvokeBeforeOriginal and InvokeAfterOriginal event handlers, you can use
the event arguments to access the values of the parameters that were passed into the
procedure. Be aware that other applications that integrate with Microsoft Dynamics
GP may have changed the values of the parameters.
Changing parameter values

In the InvokeBeforeOriginal and InvokeAfterOriginal event handlers, you can
change the values of “out” and “inout” parameters. The values of “in” parameters
cannot be changed.
We recommend that you avoid changing parameter values in Microsoft Dynamics GP

procedures. Changing the parameter values can signficantly alter the operation of Microsoft
Dynamics GP.
If a procedure is being processed in the background queue in Microsoft Dynamics

GP, the event handler will be passed a copy of the original parameters for the
procedure. This means that any changes you make to the parameters will be
ignored.

Invokable procedures
With this release of Visual Studio Tools for Microsoft Dynamics GP, not all
procedures can be invoked. Procedures with the following characteristics cannot be
invoked:
• The procedure uses “anonymous” parameters. These parameter types aren’t

known at the time the application is compiled.
• The procedure uses “reference” parameters. These parameter types contain a

link to a specific resource in the application dictionary.
• If a composite field used as a procedure parameter contains a reference value,

that procedure cannot be invoked.
If a procedure cannot be run by this version of Visual Studio Tools, it will not be
included in the procedure lists displayed by the IntelliSense in Visual Studio.
Chapter 24: Functions
There are two types of functions in a Dynamics GP application dictionary. Global
functions are blocks of code that are accessed from various places throughout the
application. Parameters are used to send values to a function and also to return
values from it. In addition, functions always return a value. Form-level functions are
like global functions, with the exception that they are defined as part of a specific
form. Typically, they perform some action specific to the form they are defined for.
The following items are discussed:
• Accessing global functions

• Accessing form-level functions
• Function methods
• Function events
• Parameters for functions
• Invokable functions
Accessing global functions

Global functions for an application dictionary are accessed through the dictionary
class. This class has a Functions property that provides access to the collection of
global functions in the dictionary. The dictionary class for the application dictionary
is located in the following namespace:
For instance, to access the collection of global functions in the Dynamics dictionary,
use the following syntax:
Microsoft.Dexterity.Applications.Dynamics.Functions
To access a specific global function, such as the GetCurrentDirectory function

(GetCurrentDirectory), use the following syntax shown below. (This example
assumes the namespace mentioned above has been referenced.)
Dynamics.Functions.GetCurrentDirectory
The IntelliSense in Visual Studio will tell you what global function in Microsoft Dynamics
Accessing form-level functions

Form-level functions for an application dictionary are accessed through the form
they are contained in. The Functions property for the form allows access to the
form-level functions. For example, to access the form-level functions for Sales
Dynamics.Forms.SopEntry.Functions
The IntelliSense in Visual Studio will tell you what form-level function in Microsoft

Function methods
Functions provide the following method:
• Invoke()
Invoke()
The Invoke() method is used to run the specified function. The parameters for this
method will depend on the procedure that is being run. The following table lists the
types of parameters for functions:
Type Description
in Parameters of type “in” are used only to pass values into the function.
out Parameters of type “out” are used only to pass values out of the
function.
inout Parameters of type “inout” are used to pass values into the function,
and to pass values out of the function.
The Invoke() method will have a return value to which the return value of the
function will be returned.
The IntelliSense in Visual Studio will tell you the type of each parameter and the return
value for a function. It will also tell you the datatype of each parameter and the return value,
such as decimal or string.
For example, the following C# code calls the GetCurrentDirectory global function.
This procedure has no parameters and returns a string value.
string currentDirectory;
currentDirectory = Dynamics.Functions.GetCurrentDirectory.Invoke();
You can refer to the Microsoft Dynamics GP SDK for details about the functions
available to invoke. Some functions in Microsoft Dynamics GP have optional
parameters defined. Visual Studio Tools does not support optional parameters. You
must supply all parameters for a function when you invoke it from Visual Studio
Tools.
Function events
Functions provide the following events:
• InvokeBeforeOriginal
• InvokeAfterOriginal
InvokeBeforeOriginal
This event occurs when the function is invoked, but before the original function is
run. The event arguments allow access the parameters and return value of the
function. Refer to Parameters for functions on page 119 to learn more about working
with parameters and return value in function events.
InvokeAfterOriginal
This event occurs when the function is invoked, but after the original function is
run.The event arguments allow access the parameters and return value of the
function. Refer to Parameters for functions on page 119 to learn more about working
with parameters and return value in function events.
C H A P T E R 2 4 F U N C T I O N S
The following C# example registers the InvokeAfterOriginal event for the

GetAutoComplete function of the UserDefaultsForm in Microsoft Dynamics GP.
UserDefaultsForm.Functions.GetAutoComplete.InvokeAfterOriginal +=
new SyUserDefaultsForm.GetAutoCompleteFunction.InvokeEventHandler(
GetAutoComplete_InvokeAfterOriginal);
The following C# example is the event handler for the event registered in the
previous example. The event handler uses the event arguments to examine the first
parameter passed into the function. If the parameter value is “DYNSA”, the return
value of the function is set to false. This will turn off the auto-complete functionality
for the DYNSA user.
void GetAutoComplete_InvokeAfterOriginal(object sender,

SyUserDefaultsForm.GetAutoCompleteFunction.InvokeEventArgs e)
{
// Set the return value to always turn off auto-complete for DYNSA user
if (e.inParam1 == "DYNSA")
{
e.result = false;
}
}
Parameters for functions

When you invoke a function or use function events, you will need to work with the
parameters and return value of the function.
Learning about the parameters and return value

There are several ways you can learn about the parameters and return value for a
function:
• When invoking a function, the IntelliSense lists the parameters and return
value, along with their data types.
• The event arguments passed to the event handler for function events will list
the available parameters and return value, along with their data types.
• The Parameters for Microsoft Dynamics GP section of the Microsoft Dynamics GP

SDK contains a complete listing of the parameters and return values for the
functions in Microsoft Dynamics GP and several integrating dictionaries. The
parameter documents in this section of the SDK also list the parameter and
return value names, which can be helpful when determining how the
parameters and return value are used.
Accessing parameter and return values

In the InvokeBeforeOriginal and InvokeAfterOriginal event handlers, you can use
the event arguments to access the values of the parameters that were passed into the
function. You can also access the value returned from the function. Be aware that
other applications that integrate with Microsoft Dynamics GP may have changed
the values of the parameters or the return value.

Changing parameter and return values

In the InvokeBeforeOriginal and InvokeAfterOriginal event handlers, you can
change the values of “out” and “inout” parameters. The values of “in” parameters
cannot be changed. You can also change the value returned from the function.
We recommend that you avoid changing parameter and return values in Microsoft
Dynamics GP functions. Changing the parameter and return values can signficantly alter
the operation of Microsoft Dynamics GP.
Invokable functions
With this release of Visual Studio Tools for Microsoft Dynamics GP, not all functions
can be invoked. Functions with the following characteristics cannot be invoked:
• The function uses “anonymous” parameters. These parameter types aren’t

known at the time the application is compiled.
• The function uses “reference” parameters. These parameter types contain a link
to a specific resource in the application dictionary.
• If a composite field used as a function parameter contains a reference value, that

function cannot be invoked.
If a function cannot be run by this version of Visual Studio Tools, it will not be
included in the function lists displayed by the IntelliSense in Visual Studio.
Chapter 25: Composites
In Microsoft Dynamics GP, a composite is a group of fields and their associated data
types which form a single data type. Each part of the composite is called a
component. In Microsoft Dynamics GP, composites are used to store data that
consists of several parts, such as the account number. Composites are also used to
group together the parameters that are passed to procedures and functions. The
following items are discussed:
• Composite types
• Accessing composites
• Composite field methods
• Composite field properties
• Composite field events
Composite types
When you access composite resources from a dictionary, each composite will have
several types defined for it. Each type is used in specific situations in Microsoft
Dynamics GP. The following table describes the composite types.
Type Example Description

Base AccountNumberComposite The base implementation of the
composite type.
Data AccountNumberCompositeData The base implementation of the
composite type, but with
properties that provide access to
the components of the
composite.
Read-only AccountNumberCompositeReadOnly A read-only version of the
composite. It is used in cases
such as passing the composite
value as a parameter for a
procedure or function.
With events AccountNumberCompositeWithEvents The composite with the standard
window field events.
With full events AccountNumberCompositeWithFullEvents The composite with the standard
window field events, and the
same field events for each
component of the composite.
In most cases, the IntelliSense will tell you what composite type is required for a specific
situation.
Accessing composites
Composites can be displayed as fields on windows, and are accessed as properties
of the window or scrolling window they are contained in. Composites can also be
used to create variables that are passed as parameters for procedures and functions.
Window fields
Composite fields are accessed as properties of the window or scrolling window they
are contained in. For example, to access the Account Number CS field in the
Account Maintenance window of Microsoft Dynamics GP, you would use the
following syntax:
Dynamics.Forms.GlAccountMaintenance.GlAccountMaintenance.AccountNumberCs

Variables
In some cases, you may want to retrieve the value of a composite and use it as a
variable in your Visual Studio Tools integration. You can create an instance of the
composite, and then set the value of the composite variable.
For example, the following C# code creates an instance of the AccountNumberCs

composite, which appears in the Account Maintenance window in Microsoft
Dynamics GP. The value of this window field is retrieved. The value of each
component is combined into a string and displayed in a message.
// Create an instance of the AccountNumberCs composite

Microsoft.Dexterity.Applications.DynamicsDictionary.AccountNumberCsComposite
Data accountNumber = new AccountNumberCsCompositeData();
// Reference the Account Maintenance form

Microsoft.Dexterity.Applications.DynamicsDictionary.GlAccountMaintenanceForm
AccountMaintenance = Dynamics.Forms.GlAccountMaintenance;
// Retrieve the Account Number value

accountNumber = AccountMaintenance.GlAccountMaintenance.AccountNumberCs;
string accountNumberString = "";
// Retrieve the individual components

for (int i = 0; i < accountNumber.Length; i++)
{
accountNumberString = accountNumberString + accountNumber[i] + " ";
}
// Display the account number

System.Windows.Forms.MessageBox.Show("Account number: " +
accountNumberString);
Parameters
You can create composite variables and pass them as parameters for procedures and
functions. A variable based on the “read-only” composite type must be used as the
parameter. To create a “read-only” composite variable, you must first create a
variable based on the “data” composite type.
For example, the following C# code creates a variable of the type

AccountNumberCompositeData, and sets its component values. A variable of the
type AccountNumberCompositeReadOnly is created. Its constructor uses the
“data” composite variable to supply the composite’s value. The “read-only” version
of the composite value is passed as a parameter to the ConvertAcctToAliasStr
function.
Microsoft.Dexterity.Applications.DynamicsDictionary.AccountNumberComposite
Data accountNumberData = new AccountNumberCompositeData();
accountNumberData[0] = "000";
accountNumberData[3] = "";
// Create the read-only composite that is used for the function call
Microsoft.Dexterity.Applications.DynamicsDictionary.AccountNumberComposite
ReadOnly accountNumber = new AccountNumberCompositeReadOnly
(accountNumberData);
C H A P T E R 2 5 C O M P O S IT E S
// Convert the account number to its account alias

string alias = Dynamics.Forms.GlAcctBase.Functions.ConvertAcctToAliasStr.
Invoke(accountNumber);
// Display the account alias

System.Windows.Forms.MessageBox.Show("Account alias: " + alias);
Components
To access the individual components for most composites, you can use the
properties of the composite. The composite will have a property for each
component of the composite.
Some composites, such as the AccountNumberComposite, are defined dynamically

by Microsoft Dynamics GP. These composites do not have the named properties to
access the individual components of the composite. To access components for these
composites, you must use the component’s index. For instance, the following C#
code creates an instance of the AccountNumber composite and sets the value of
each component.
AccountNumberCompositeData accountNumberData = new

AccountNumberCompositeData();
accountNumberData[3] = "";
Composite field methods

Composite fields provide the following methods:
• Clear()
• Disable()
• Enable()
• Fill()
• Focus()
• ForceValidate()
• Hide()
• Lock()
• RunValidate()
• Show()
• Unlock()
Clear()
The Clear() method sets each component of the composite to its cleared value. The
following table lists the cleared value for standard datatypes:

Date 0/0/0
Currency 0
Integer 0
Long 0
String Empty string

Disable()
The Disable() method makes the composite field appear in a disabled state, and
prevents the user from making changes to the field.
Enable()
The Enable() method allows a previously disabled composite field to receive user
input.
Fill()
The Fill() method sets each component of the composite to its filled value. The
following table lists the filled value for standard datatypes:

Date 12/31/9999
Currency 99999999999999.99999
Integer 32,767
Long 2,147,483,647
Time 23:59:59
Focus()
The Focus() method moves the focus to the composite field.
ForceValidate()
The ForceValidate() method controls whether the validate event will occur when
the focus leaves the composite field. If the validate event occurs, any validation
code for the composite field will be run. This method takes one boolean parameter.
Supplying the value true forces the validate event to occur. Supplying the value
false clears any previous call to force the validate event to occur.
Hide()
The Hide() method causes the composite field to become invisible and inaccessible
to the user.
Lock()
The Lock() method causes a composite field to become inaccessible to the user. The
field’s appearance will not change.
RunValidate()
The RunValidate() method causes any validation code for the composite field to be
run.
Show()
The Show() method causes a previously hidden composite field to become visible
and accessible to the user.
Unlock()
The Unlock() method causes a previously locked composite field to become
accessible to the user.
C H A P T E R 2 5 C O M P O S IT E S
Composite field properties

Composite fields have the following properties:
• IsEmpty
• IsFilled
• Length
• Value
IsEmpty
The IsEmpty property returns the value true when the value of the composite field
is empty for the specific field type. The following table lists the empty value for
standard datatypes:

Date 0/0/0
Currency 0
Integer 0
Long 0
String Empty string
IsFilled
The IsFilled property returns the value true when the value of the composite field is
set to the maximum value for the specific field type. The following table lists the
filled value for standard datatypes:

Date 12/31/9999
Currency 99999999999999.99999
Integer 32,767
Long 2,147,483,647
Time 23:59:59
Length
The Length property is used to retrieve the number of components in the composite
field.
Value
The Value property is used to set or retrieve the value of the composite field. The
IntelliSense in Visual Studio will tell you what type of value is used for the field.

Composite field events

Composite fields provide the following events:
• Change
• EnterBeforeOriginal
• EnterAfterOriginal
• LeaveBeforeOriginal
• LeaveAfterOriginal
• ValidateBeforeOriginal
• ValidateAfterOriginal
Composites of the type “with events” supply these events for the composite as a
single field. Composites of the type “with full events” supply these events for the
composite as a single field, and also for each of the components of the composite.
Change
This event occurs when the value of the composite or component changes, such as
being set by the user or changed by other code in Microsoft Dynamics GP.
EnterBeforeOriginal
This event occurs when the focus moves to the composite field or component, but
before the field or component enter event is run. This event can be canceled.
EnterAfterOriginal
This event occurs when the focus moves to the composite field or component, but
after the field or component enter event is run.
LeaveBeforeOriginal
This event occurs when the focus moves from the composite field or component,
but before the field’s leave event is run. This event can be canceled.
LeaveAfterOriginal
This event occurs when the focus moves from the composite field or component,
but after the field’s leave event is run.
ValidateBeforeOriginal
This event occurs when the focus is to move from the composite field or component,
and the composite field or component has been set to be validated. A field or
component will be validated when its value has been changed, or the validation has
been forced, such as with the ForceValidate() method. This event occurs before the
composite field or component validate event. It can be canceled.
ValidateAfterOriginal
This event occurs when the focus is to move from the composite field or component,
and the composite field or component has been set to be validated. This event
occurs after the composite field or component validate event.
PART 4: INTEGRATION EXAMPLES
Part 4: Integration Examples
This portion of the documentation describes integration examples that show how to
use Visual Studio Tools for Microsoft Dynamics GP. The following examples are
discussed:
• Chapter 26, “Field Defaulter,” describes an example that uses events to default
field values in Microsoft Dynamics GP.
• Chapter 27, “Estimate Freight,” describes an example that estimates freight

amounts for sales documents in Microsoft Dynamics GP.
• Chapter 28, “Environmental Details,”describes an example that stores

additional environmental detail information for items in Microsoft Dynamics
GP.
• Chapter 29, “Lookups,” describes an example the shows how six common
lookups are implemented for a Visual Studio Tools integration.
The following table indicates which features of Visual Studio Tools for Microsoft
Dynamics GP features are implemented in each sample.
Field Estimate Environmental Lookups

Defaulter Freight Details
Visual Studio Tools form X X X
Access to Dynamics GP fields X X X
Field events X X X X
Form events X X
Modal dialog events X
Procedure/function access X
Table access X X
DUOS integration X
Note integration X
Lookups X
Online help X
Macro support X
Chapter 26: Field Defaulter
This sample application demonstrates how events in Microsoft Dynamics GP can be
used to default field values. The sample defaults the City and State fields when a
user enters a value for the ZIP code field in the Customer Maintenance window. The
following topics are discussed:
• Overview
• Running the sample application
• How Visual Studio Tools was used
Overview
This sample application integrates with the Customer Maintenance window in
Microsoft Dynamics GP. It automatically defaults values for the City and State fields
when the user supplies a known ZIP Code.
The City and State fields

are set based on the ZIP
Code value entered.
This sample uses a fixed set of ZIP Codes and correspond City and State values. An
actual application would use a more extensive set.
Running the sample application

To run this sample application, perform the following steps:
1. Extract the .zip archive containing the samples.

In the folder where Visual Studio Tools was installed, locate the Samples.zip
archive. This archive contains both the C# and Visual Basic versions of the
samples. Extract this archive to a location that you have permissions to access.
2. Open the Field Defaulter sample solution.

Using Visual Studio, open the solution file FieldDefaulter.sln for the C# or
Visual Basic version of the sample.
3. Verify the references for the sample solution.

Use Visual Studio to view the references for the project. The Estimate Freight
sample should include references to the following assemblies:
• Application.Dynamics
• Microsoft.Dexterity.Bridge
If any of these references for the project are not valid, re-add them to the project.
4. Set the Solution Configuration.

Set the Solution Configuration to Release to build the release version of the
application.

PA RT 4 IN T E G R A TI O N E XA M P LE S
5. Build the application.

From the Build menu, choose Build Solution. If there are no build errors, the
assembly for the Field Defaulter application will be built.
6. Install the Field Defaulter assembly.

Copy the FieldDefaulter.dll from the Release folder for the project to the AddIns
folder in the Microsoft Dynamics GP installation.

The Field Defaulter sample application will loaded.
8. Open the Customer Maintenance window.

In Microsoft Dynamics GP, open the Customer Maintenance window.
9. Enter a ZIP Code.

For demonstration purposes, this sample application recognizes only a small
number of ZIP codes. You can enter any of the follow ZIP codes and have the
corresponding City and State filled in:
02109 58104
53151 58474
55111 60605
56560 85012
58078 95014
58102 98052
58103
When you have finished, close Microsoft Dynamics GP.
How Visual Studio Tools was used

This sample application uses the eventing and resource access features of Visual
Studio Tools for Microsoft Dynamics GP.
Resources accessed
The Field Defaulter sample uses the following resources in the Dynamics
dictionary:
Forms
• RmCustomerMaintenance
Windows
• RmCustomerMaintenance
Events
The Field Defaulter sample registers the following event in Microsoft Dynamics GP:
• A change event for the ZipCode field in the Customer Maintenance window,
used to look up the value entered. If the city and state can be found for the ZIP
code value entered, their value are automatically set in the window.
Chapter 27: Estimate Freight
This sample application demonstrates several techniques useful when creating
Microsoft Dynamics GP integrations. The sample integrates with the Sales
Transaction Entry window. The following topics are discussed:
• Overview
Overview
This sample application integrates with the Sales Transaction Entry window in
Microsoft Dynamics GP. It retrieves shipping weight information about the items in
the current sales document, calculates an estimated shipping weight for all of the
items, and then estimates the freight cost. The estimated freight value is placed into
the Freight field of the Sales Transaction Entry window.
The Estimate Freight

window estimates freight
for the current sales
document.
This sample uses a fixed set of shipping methods and shipping rates. An actual
application would use a more extensive rate table, and possibly a web service to
access freight rates.
The Estimate Freight sample uses the table access capabilities of Visual Studio Tools
to access data in Microsoft Dynamics GP.


2. Open the Estimate Freight sample solution.

Using Visual Studio, open the solution file EstimateFreight.sln for the C# or
Visual Basic version of the sample.

Use Visual Studio to view the references for the project. The Estimate Freight
sample should include references to the following assemblies:
• Microsoft.Dexterity.Shell


application.

assembly for the Estimate Freight application will be built.
6. Install the Estimate Freight assembly.

Copy the EstimateFreight.dll from the Release folder for the project to the
AddIns folder in the Microsoft Dynamics GP installation.
7. Install the Estimate Freight help file.

Copy the EstimateFreight.chm help file from the EstimateFreight folder into the
Dynamics GP installation folder. The help file should be placed in the same
folder as the GreatPlains.chm help file.

The Estimate Freight sample application will loaded.
9. Open the Sales Transaction Entry window.

In Microsoft Dynamics GP, open the Sales Transaction Entry window.
10. Display a sales document.

You can display an existing sales document or create a new sales document.
11. Add items to the sales document.

Be sure the sales document has inventory items for which the estimated
shipping weight has been specified.
12. Display the Estimate Freight window.

In the Additional menu, choose Estimate Freight. The Estimate Freight window
will appear.
13. Choose a shipping method and calculate the freight.

Choose either Air or Ground as the shipping method, and then click Calculate
to calculate the estimated freight.
14. Return the Freight amount to the sales document.

Click Save to return the estimated freight amount to the Freight field for the
sales document.

This sample application uses several features of Visual Studio Tools for Microsoft
Dynamics GP to implement this integration.
User interface
The special WinForm available for Dynamics GP add-ins was used when creating
the Estimate Freight window. The customized buttons and images were also used.
The sample illustrates technique that can be used to implement window-level notes
and the online help link.
C H A P T E R 2 7 E S T IM AT E FR EI G HT
Resources accessed
The Estimate Freight sample uses many resources in the Dynamics dictionary:
Forms
• SOPEntry
• FormNote1
• FormNote2
• FormNote3
• FormNote4
• FormNote5
Windows
• SOPEntry
Global procedures
• CheckForNote
• CheckNoteIdString
• GetNextFormNoteToOpen
Tables
Data from the following tables is accessed to compute the estimated freight for the
current sales document:
• IvItemMstr (Inventory Item Master)

• SopLineWork (SOP Line Work)
Events
The Estimate Freight sample registers the following events in Microsoft Dynamics
GP:
• A menu handler event for the Sales Transaction Entry form, used to open the
Estimate Freight window.
• A form close event on the Sales Transaction Entry form, used to indicate when
the Sales Transaction Entry window has been closed.
• A watch event for the SOP Number field in the Sales Transaction Entry window,
used to keep the Estimate Freight window updated with the current sales
document.
• An enter event for the Freight field in the Sales Transaction Entry window, used
to ask the user whether they want to estimate the freight amount if a value
hasn’t been supplied.
• Several form close events for the various “Note” forms in Microsoft Dynamics
GP, used to keep the Note button on the Estimate Freight window updated.

Chapter 28: Environmental Details
This sample application demonstrates several techniques useful when creating
Microsoft Dynamics GP integrations. The sample integrates with the Item
Maintenance window. The following topics are discussed:
• Overview
Overview
This sample application integrates with the Item Maintenance window in Microsoft
Dynamics GP. It stores environmental information about the item. The additional
data is stored in the DUOS (Dynamics User Object Store) table for the current
company.
The Environmental Details

window tracks environmental
information for the current
inventory item.
This sample also implements support for the macro system, allowing macros to be
recorded and played back for this window.


2. Open the Environmental Details sample solution.

Using Visual Studio, open the solution file EnvironmentalDetails.sln for the C#
or Visual Basic version of the sample.

Use Visual Studio to view the references for the project. The Environmental
Details sample should include references to the following assemblies:

application.


assembly for the Environmental Details application will be built.
6. Install the Environmental Details assembly.

Copy the EnvironmentalDetails.dll from the Release folder for the project to the
AddIns folder in the Microsoft Dynamics GP installation.

The Estimate Freight sample application will loaded.
8. Open the Item Maintenance window.

In Microsoft Dynamics GP, open the Item Maintenance window.
9. Display an item.
You can display an existing item or create a new item.
10. Display the Environmental Details window.

In the Additional menu, choose Environmental Details. The Environmental
Details window will appear.
11. Supply the environmental details for the item.

Enter the following environmental details:
• Yearly energy cost

• Notes
• Recyclable
• Energy Start Rated
12. Save the changes to the item.

Click Save in the Item Maintenance window to save the changes for the item.

This sample application uses several features of Visual Studio Tools for Microsoft
Dynamics GP to implement this integration.
User interface
the Environmental Details window.
Resources accessed
The Estimate Freight sample uses many resources in the Dynamics dictionary:
Forms
• IvItemMaintenanceForm
Windows
• IvItemMaintenanceWindow
Tables
Data for the integration is stored in the following table:
• SyUserObjectStoreTable (DUOS)
C H A P T E R 2 8 E N V IR O N M EN T A L D E T AIL S
This is the same table used by VBA to store data. The DUOSHelper class of the
Environmental Details sample contains methods that are used to write, retrieve, and
delete rows from the DUOS table.
Events
The Environmental Details sample registers the following events in Microsoft
Dynamics GP:
• A menu handler event for the Item Maintenance form, used to display the
Environmental Details form.
• A form open event on the Item Maintenance form, used to create an instance of
the Environmental Details form.
• A form close event on the Item Maintenance form, used to indicate when the
Item Maintenance window has been closed. This event closes the
Environmental Details form and removes it from memory.
• A change event for the Item Number field in the Item Maintenance window,
used to keep the Environmental Details window updated with the current item
being displayed.
• A change event for the Item Description field in the Item Maintenance window,
used to keep the Environmental Details window updated with the current item
being displayed.
• A change event for the Save Record field in the Item Maintenance window, used
to save the environmental details when the user saves the item.
• An after modal dialog event for the Item Maintenance window, used to retrieve
the response when the user confirms whether to delete the current item. If the
user chooses to delete the current item, the corresponding environmental
details information is also deleted.
Macro support
Calls to the RecordMacroItem() method have been added to the controls in the
Environmental Details form to support recording macro statements. The
PlayMacroItem() method from the DexUIForm base class has been overridden to
support playback of the macro statements that have been recorded.

Chapter 29: Lookups
This sample application demonstrates how to use several common lookup forms in
Microsoft Dynamics GP. The following topics are discussed:
• Overview
Overview
This sample application demonstrates how to implement common lookup forms in
a Visual Studio Tools integration. Refer to Chapter 14, “Using Lookups,” for details
about how to implement lookups.
This sample implements the following lookups:
• Customer Number
• Vendor ID
• Item Number
• GL Account Number
• SOP Document Number
• POP Document Number
.

2. Open the Lookups sample solution.

Using Visual Studio, open the solution file Lookups.sln for the C# or Visual
Basic version of the sample.

Use Visual Studio to view the references for the project. The Lookups sample
should include references to the following assemblies:
• Application.SmartList


application.

assembly the for the Lookups application will be built.
6. Install the Lookups assembly.

Copy the Lookups.dll from the Release folder for the project to the AddIns
folder in the Microsoft Dynamics GP installation.

The Lookups sample application will loaded.
8. Open the About Box window.

In Microsoft Dynamics GP, open the About Box window. It is accessed from the
Help menu in the main Microsoft Dynamics GP window.
9. Display the Lookups window.

In the Additional menu, choose Lookups. The Lookups window will appear.
10. Use the sample lookups.

Use the sample lookups, just as you would any other lookups in Microsoft
Dynamics GP.

This sample application uses the basic features of Visual Studio Tools for Microsoft
Dynamics GP.
User interface
the Lookups window.
Resources accessed
The Lookups sample uses the following resources in the Dynamics and SmartList
dictionaries:
Forms
• AboutBox
• CustomerLookupForm
• VendorLookupForm
• IvItemNumberLookupForm
• AccountLookupForm
• SopDocumentLookupForm
• PopDocumentLookupForm
Composites
• AccountNumberCompositeData
Form-level functions
• ConvertAcctToStr of the GlAcct form
C H A P T E R 2 9 L O O K U P S
Events
The Lookups sample registers the following events in Microsoft Dynamics GP:
• A menu handler event for the AboutBox form, used to open the Lookups
window.
• A click event for the SelectButton field in each of the lookup windows, to notify
the Lookups sample that the user clicked the Select button.
• A validate event for the PopPoLookup field in the PopDocumentLookup

window, to prevent the validation from running when the POP Number lookup
is opened from a Visual Studio Tools integration. This is a work-around for an
issue that causes the POP Number lookup to be closed immediately after being
opened.

Glossary Global variables
A variable available the entire time the
Microsoft Dynamics GP application is open.
Active lock Visual Studio Tools code can read the value
A method of locking that ensures only one of global variables.
user can change or delete the contents of a
row at one time. The data in the locked row Key
can’t be changed or deleted by another user A field or combination of fields within a row
until the lock is released. that is used as the basis by which to store,
retrieve, and sort the row in a table.
Alternate forms
Forms from the core Dynamics dictionary Launch file
that have been changed by a third-party A file that is used to start an application with
developer, and are stored in a third-party the Dynamics GP runtime engine. This file
dictionary. stores the location of the main application
dictionary, the name and location of any
Application assembly forms and reports dictionaries, and the name
A .NET assembly used by Visual Studio and location of any integrating dictionaries.
Tools to provide access to the resources in
Microsoft Dynamics GP dictionary. Each Local fields
application dictionary can have one Special fields that are defined for and used
corresponding application assembly. only within a specific form in Microsoft
Dynamics GP.
Buffer
A temporary storage area in a computer’s Modified forms
memory. The Microsoft Dynamics GP Forms in the Microsoft Dynamics GP
runtime uses several types of buffers, such as application that contain modifications made
table buffers and window buffers. with the Modifier.
Control area Passive lock

A band drawn at the top of a Microsoft A method of locking that allows other users
Dynamics GP window. Controls such as to access and make changes to the row.
Save, Clear, and Delete buttons are placed in Product ID
the control area. An integer ID that is used to uniquely
Dictionary Assembly Generator identify an application dictionary. The
The tool (DAG.exe) used to build application Dictionary Assembly Generator refers to
assemblies for dictionaries. dictionaries based on their product ID.
Dexterity Bridge assembly Segments

The assembly Microsoft.Dexterity.Bridge.dll One field of the group of fields that compose
that provides the access to events in a key for a table.
Microsoft Dynamics GP, as well as the Status area
resources in the application dictionaries.
An area at the bottom of a Microsoft
Dictionary class Dynamics GP window created by a divider
A class used to reference the resources in an line drawn across the window. Controls like
application dictionary. The class is available browse buttons, note buttons, and help
after a reference to the application assembly buttons are placed in the status area.
for a dictionary has been added to the Visual Table buffer
Studio project.
A buffer that acts as an intermediate storage
Dexterity Shell assembly area to hold one row from a table.
The assembly Microsoft.Dexterity.Shell.
UI.dll that provides the drawing capabilities
that allow an integrating application to
match the appearance of Microsoft
Dynamics GP
Forms dictionary
The dictionary in a Microsoft Dynamics GP
installation that contains the modified forms
for an application. Each application
dictionary can have a forms dictionary.
Global fields
A type of field that can be used in any form
or any table in Microsoft Dynamics GP.

Index C
C#
composites (continued)
accessing through code 121
registering events 39 as procedure and function
A setting assembly information 63 parameters 122
Accessing Dictionary Resources, chapter unregistering events 42 as variables 122
35-38 upgrading integrations 15 as window fields 121
ActivateAfterOriginal, window event 88 cancelling events 42 chapter 121-126
ActivateBeforeOriginal, window event 88 Change defined 121
active locks composite field event 126 resource reference 121
defined 143 window field event 100 retrieving number of components 125
described 57 Change(), table method 102 types of 121
releasing 57 ChangeFirst(), table method 102 control area
AddIns folder, described 12 ChangeLast(), table method 103 defined 143
Additional menu, adding items to 83 ChangeNext(), table method 103 described 24
AddMenuHandler(), form method 83 ChangePrevious(), table method 103 Control Reference, chapter 27-30
AfterModalDialog, window event 90 Check(), command method 109 ControlArea, WinForms property 24
alternate forms Clear() controls
accessing with code 70 composite field method 123 adding to forms 25
creating application assembly for 70 table field method 107 buttons 27
defined 143 table method 103 combo boxes 30
guidelines for accessing 71 window field method 98 control reference 27
using try...catch with 71 ClickAfterOriginal, window field event labels 30
application assemblies 100 list boxes 30
creating 31 ClickBeforeOriginal, window field event text boxes 29
defined 143 100 conventions, in documentation 3
described 12 Clone(), table method 103 Customization Status window 68
installing 5 Close()
naming convention 31 form method 85
D
overriding name 34 DAG.exe, see Dictionary Assembly
table method 103
references to 35 Generator
window method 87
referencing main application Debug, solution configuration 64
CloseAfterOriginal
assembly 34 debugging
form event 86
shipped with Visual Studio Tools 12 attaching to a process 67
window event 88
signing 33 chapter 67-68
CloseBeforeOriginal
which to use 31 examining application 68
form event 86
architecture, for Visual Studio Tools 11 integrations 67
window event 88
assembly information, for integrations 63 preparations for 67
combo box controls, described 30
asynchronous processes, handling for deleting, rows from tables 51
command-line, for Dictionary Assembly
macro playback 76 deploying integrations 65
Generator 32
AutoSetDexColors Developing Integrations, part 22-71
Commands, form property 85
control property 27 devenv.exe, using to register templates 6
commands
WinForms property 24 Dexterity Bridge assembly
defined 143
chapter 109-110
B command list commands 109
described 11
background process error, when not Dexterity Shell assembly
form commands 109
closing tables 47 defined 143
methods for 109
BeforeModalDialog, window event 89 described 11
resource reference 109
buffers, defined 143 Dictionary Assembly Generator
script commands 109
Building and Deploying, chapter 63-65 application assembly 31
types of 109
building integrations 64 chapter 31-34
components, installed with Visual Studio
buttons commands for 32
Tools 7
field 28 creating application assemblies 31
components of composites
pictures for 28 defined 143
standard 27 described 12, 31
defined 121
status area 28 IntelliSense data file 32
retrieving number of components 125
toolbar 27 launch file used 33
composite fields
toolbar with separator 28 optimizing processing 34
events for 126
types of 27 output from 31
methods for 123
ButtonType property, for button controls using 32
properties for 125
27 when to use 31
composites
where installed 32
accessing components 123

IN DEX
dictionary class events (continued) functions (continued)

defined 143 unregistering 42 chapter 117-120
examples 36 unregistering with C# code 42 invokable procedures 120
for alternate forms 70 unregistering with Visual Basic code learning parameters 119
for modified forms 69 43 learning return value 119
resource types to access 36 exceptions methods for 118
using to access dictionary resources example 71 optional parameters 118
36 handling for modified and alternate parameter types 118
dictionary resources forms 71 parameters for 119
accessing 35 resource reference 117
accessing through dictionary class 36 F return value 118
additional resources 37 field, buttons 28
list of 82 Field Defaulter G
lists in IntelliSense 36 overview 129 Get(), table method 104
namespace for accessing 36, 37 sample integration 129 GetFirst(), table method 104
variable for 37 use of Visual Studio Tools 130 GetLast(), table method 104
working with 82 fields GetNext(), table method 104
Disable() global 143 GetPrevious(), table method 104
command method 109 local 143 Getting Started, part 10-13
composite field method 124 table fields 107 global fields, defined 143
window field method 98 window fields 97 global functions
disabling events 68 files, see tables accessing through code 117
Dispose(), form method 85 Fill() described 117
documentation, symbols and conventions composite field method 124 global procedures
3 table field method 107 accessing through code 113
Dynamics.exe, application process when table method 104 described 113
debugging 67 window field method 98 global table buffers
focus, removing from current window 87 accessing 101
E Focus() described 46, 101
Enable() composite field method 124 shared access 46, 101
command method 110 window field method 98 globals
composite field method 124 ForceValidate() accessing through code 111
window field method 98 composite field method 124 chapter 111-112
EnterAfterOriginal window field method 98 defined 143
composite field event 126 form-level functions properties for 111
window field event 100 accessing through code 117 resource reference 111
EnterBeforeOriginal described 117
composite field event 126 form-level procedures H
window field event 100 accessing through code 113 Hide()
Environmental Details described 113 command method 110
overview 135 form-level table buffers composite field method 124
running 135 accessing 101 window field method 98
sample integration 135 described 46, 101
use of Visual Studio Tools 136 forms I
errors, for table operations 52 accessing through code 83 Implementing Macro Support, chapter
Estimate Freight chapter 83-86 73-76
overview 131 events for 86 Initialize() method, for registering events
running 131 methods for 83 39
sample integration 131 properties for 85 installation
use of Visual Studio Tools 132 resource reference 83 chapter 5-8
event arguments, when playing macros 74 forms dictionaries Visual Studio Tools SDK 5
events application assemblies for 31 Integration Basics, chapter 11-13
cancelling events 42 application assembly for 69 Integration Examples, part 128-141
chapter 39-43 defined 143 integrations
disabling 68 generating application assembly for building 64
event arguments 41 33 debugging 67
overview 39 function, events for 118 deploying 65
registering 39 Functions, form property 85 setting assembly information 63
registering with C# code 39 functions IntelliSense, table information in 46
registering with Visual Basic code 40 changing parameter values 120 IntelliSense XML files
responding to 41 changing return values 120 described 12
generating 32
I N D E X
IntelliSense XML files (continued) LineInsertAfterOriginal, scrolling modified forms (continued)

installing 5 window event 95 creating application assembly for 69
naming convention 32 LineInsertBeforeOriginal, scrolling defined 143
Invoke() window event 95 guidelines for accessing 71
function method 118 LineLeaveAfterOriginal, scrolling using try...catch with 71
procedure method 114 window event 95 using with Visual Studio Tools 69
IsAsynchEventPending() method 76 LineLeaveBeforeOriginal, scrolling multiuser processing
IsChanged, window property 87 window event 95 described 57
IsEmpty LinkField property, for label controls 30 reading rows 59
composite field property 125 list box controls, described 30 removing rows 60
global property 111 local fields updating rows 59
table field property 108 accessing 97
window field property 99 defined 143 N
IsFilled described 97 names, overriding application assembly
composite field property 125 naming convention for 97 name 34
global property 112 Lock() namespace, for accessing dictionary
table field property 108 composite field method 124 resources 36, 37
window field property 99 window field method 98
IsOpen locking O
form property 85 active locking 57 Open()
window property 87 multiuser scenarios 57 form method 85
passive locking 57 window method 87
K releasing locks 57 OpenAfterOriginal
Key, table property 105 rows 57 form event 86
keys lookups window event 88
defined 143 available to use in Visual Studio Tools OpenBeforeOriginal
for tables 48 78 form event 86
segments for 48 example 78 window event 88
operation of 77 optimistic concurrency control, described
L using existing lookup windows 77 57
label controls Lookups sample optimizing, application assembly
described 30 integration 139 generation 34
linked field 30 overview 139
launch file running 139
P
defined 143 parameters
use of Visual Studio Tools 140
used by Dictionary Assembly for functions 119
Generator 33 M for procedures 115
LeaveAfterOriginal macro support optional parameters 114, 118
composite field event 126 asynchronous processes 76 passive locks
window field event 100 for Visual Studio Tools forms 73 defined 143
LeaveBeforeOriginal macro syntax 73 described 57
composite field event 126 overview 73 releasing 57
window field event 100 playing macros 74 PlayMacroItem() method, overriding 74
Length, composite field property 125 recording macros 73 prerequisites, for using Visual Studio
light bulb symbol 3 main dictionary Tools for Microsoft Dynamics GP 3
LineChangeAfterOriginal, scrolling generating application assembly for PrintAfterOriginal, window event 88
window event 95 33 PrintBeforeOriginal, window event 88
LineChangeBeforeOriginal, scrolling overriding application assembly Procedures, form property 85
window event 95 name 34 procedures
LineDeleteAfterOriginal, scrolling margin notes 3 changing parameter values 115
window event 95 menus, adding to Additional menu 83 chapter 113-116
LineDeleteBeforeOriginal, scrolling Microsoft Dynamics GP events for 114
window event 95 events in 39 invokable procedures 116
LineEnterAfterOriginal, scrolling window tables 45 learning parameters 115
event 94 Microsoft Dynamics GP SDK methods for 113
LineEnterBeforeOriginal, scrolling installing 3 optional parameters 114
window event 94 table information in 46 parameter types 114
LineFillAfterOriginal, scrolling window Modified and Alternate Forms, chapter parameters for 115
event 94 69-71 resource reference 113
LineFillBeforeOriginal, scrolling window modified forms process, attaching to Dynamics.exe for
event 93 accessing with code 69 debugging 67
product ID, defined 143

IN DEX
product support, for Visual Studio Tools sample integrations (continued) tables (continued)
for Microsoft Dynamics GP 4 Estimate Freight 131 in Microsoft Dynamics GP 45
projects Field Defaulter 129 keys for 48
adding a Dynamics GP form to 23 installing 5 learning about 45
creating for Visual Studio Tools 12 Lookups 139 methods for 102
PullFocus(), window method 87 Save(), table method 105 multiuser processing 57
saving, rows in tables 49 opening 47
R scrolling windows properties for 105
RangeClear(), table method 104 accessing current row 94 ranges 53
RangeEnd(), table method 104 accessing through code 93 removing rows 51
RangeRemove(), table method 104 chapter 93-95 resource reference 101
ranges described 93 retrieving rows 48
example 53, 54, 55 events for 93 saving rows 49
for table access 53 preventing rows from displaying 94 updating rows 50
multi-segment key 54 resource reference 93 working with 45
removing rows in a range 55 SDK, for Microsoft Dynamics GP 3, 78 technical support, for Visual Studio Tools
simple key 53 segments for Microsoft Dynamics GP 4
RangeStart(), table method 104 defined 143 templates
recording macro statements 73 for keys 48 for Visual Studio 2005 5
RecordMacroItem() method, described 73 sharing global table buffers 46 for Visual Studio 2008 5
references, to application assemblies 35, Show() manually registering 6
69, 70 command method 110 text box controls 29
registering events 39 composite field method 124 third-party applications, application
registering Visual Studio templates 6 window field method 99 assemblies for 31
regular expressions, for parsing macro signing, application assemblies 33 toolbar, button type 27
statements 75 SN.exe, described 33 toolbar with separator, button type 28
Release, solution configuration 64 solution configuration, for a Visual Studio try...catch, using with modified and
Release(), table method 105 project 64 alternate forms 71
releasing locks on table rows 57 standard buttons 27
Remove(), table method 105 status area U
removing rows buttons 28 Uncheck(), command method 110
from tables 51 defined 143 Unlock()
multiuser considerations 60 described 24 composite field method 124
Resource Descriptions tool, described 45 StatusArea, WinForms property 24 window field method 99
Resource Reference, part 82-120 strong name key file, described 33 unregistering events 42
resources, see dictionary resources strong names, for application assemblies updating rows
responding to events 41 33 in tables 50
retrieving rows support, for Visual Studio Tools for multiuser considerations 59
from tables 48 Microsoft Dynamics GP 4 Upgrading an Integration, chapter 15-19
multiuser considerations 59 symbols in documentation 3 upgrading integrations
row locking C# integrations 15
active locking 57 T described 15
described 57 table buffers from Release 10 19
passive locking 57 defined 143 from Release 9 15
releasing locks 57 described 46, 101 Visual Basic integrations 17
rows form-level 46 user interface, for Visual Studio Tools
locking 57 global 46 projects 23
removing from tables 51 sharing access 46 Using Lookups, chapter 77-80
retrieving from tables 48 table fields
saving in tables 49 accessing through code 107 V
updating in tables 50 chapter 107-108 ValidateAfterOriginal
Run(), command method 110 methods for 107 composite field event 126
runtime components, for Visual Studio properties for 108 window field event 100
Tools 11 resource reference 107 ValidateBeforeOriginal
RunValidate() table ranges, example 53, 54, 55 composite field event 126
composite field method 124 Tables, form property 85 window field event 100
window field method 99 tables Value
accessing through code 46, 101 composite field property 125
S chapter 101-105 global property 112
sample integrations closing 47 table field property 108
Environmental Details 135 errors from table operations 52 window field property 99
I N D E X
variables, for dictionary resources 37

Visual Basic
registering events 40
setting assembly information 64
unregistering events 43
upgrading integrations 17
Visual Studio
upgrading to Visual Studio 2008 7
version required for Visual Studio
Tools 3
Visual Studio Tools
accessing modified forms 69
architecture 11
capabilities 11
components installed 7
creating user interface 23
development components 12
prerequisites 3
projects, creating 12
runtime components 11
SDK installation 5
technical support 4
what’s new 2
W
warning symbol 3
window fields
chapter 97-100
events for 100
methods for 97
properties for 99
windows
chapter 87-91
events for 88
local fields 97
methods for 87
properties for 87
WinForms
adding controls to 25
adding to a project 23
chapter 23-25
properties for 24
Working with Tables, chapter 45-61
X
XML files, for IntelliSense 12

VST Programmers Guide GP10

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

VST Programmers Guide GP10

Uploaded by

Copyright:

Available Formats

Visual Studio® Tools for Microsoft Dynamics® GP 2010

All other trademarks are property of their respective owners.

Publication date March 2010

Chapter 1: SDK Installation ........................................................................................................ 5

Part 1: Getting Started ............................................................................................................. 10

Chapter 3: Upgrading an Integration .............................................................................. 15

Part 2: Developing Integrations ................................................................................... 22

Chapter 5: Control Reference ................................................................................................ 27

Chapter 6: Dictionary Assembly Generator .............................................................. 31

Chapter 7: Accessing Dictionary Resources ............................................................ 35

Dictionary class ...........................................................................................................................................36

Chapter 8: Events .............................................................................................................................. 39

Chapter 9: Working with Tables ........................................................................................... 45

Chapter 10: Building and Deploying ................................................................................ 63

Chapter 11: Debugging ................................................................................................................. 67

Chapter 12: Modified and Alternate Forms............................................................... 69

Chapter 13: Implementing Macro Support ................................................................ 73

Chapter 14: Using Lookups ...................................................................................................... 77

Part 3: Resource Reference ................................................................................................ 82

Chapter 16: Windows ..................................................................................................................... 87

Chapter 17: Scrolling Windows ............................................................................................ 93

Chapter 18: Window Fields ....................................................................................................... 97

Chapter 19: Tables ......................................................................................................................... 101

Chapter 20: Table Fields ........................................................................................................... 107

Chapter 21: Commands ............................................................................................................ 109

Chapter 22: Globals ....................................................................................................................... 111

Chapter 23: Procedures ............................................................................................................ 113

PROGRAMMER’S GUIDE iii

Invokable procedures ............................................................................................................................... 116

Chapter 24: Functions ................................................................................................................. 117

Chapter 25: Composites ........................................................................................................... 121

Part 4: Integration Examples ........................................................................................ 128

Chapter 27: Estimate Freight............................................................................................... 131

Chapter 28: Environmental Details ................................................................................ 135

Chapter 29: Lookups ................................................................................................................... 139

Glossary ..................................................................................................................................................... 143

Index ............................................................................................................................................................... 145

What’s in this manual

Information is divided into the following parts:

• Part 2, Developing Integrations, provides detailed information about creating

• Part 3, Resource Reference, provides detailed information about interacting

• Part 4, Integration Examples, describes example integrations that use Visual

What’s new in this release of Visual Studio Tools

1. Modal dialog events

4. Events can be unregistered

5. Table buffers as parameters

Symbols and conventions

Warnings indicate situations you should be aware of

1. Start the Visual Studio Tools SDK installer.

2. View the welcome screen.

3. Acknowledge the license agreement.

4. Specify the features to install.

5. Specify the installation location.

6. Begin the installation.

7. Finish the installation.

C:\Program Files\Microsoft Visual Studio 8\Common7\IDE\devenv.exe /setup

C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\devenv.exe /setup

On systems with UAC,

What was installed

Upgrading to Visual Studio 2008

1. Install Visual Studio 2008.

2. Start the Visual Studio Tools SDK installer.

3. Close the installer.