Visual Studio Tools For Microsoft Dynamics GP 2013 Programmer's Guide

Visual Studio Tools for Microsoft Dynamics GP 2013Programmer’s Guide

CopyrightCopyright 2012 Microsoft Corporation. All rights reserved.Limitation of liabilityThis document is provided “as-is”. Information and views expressed in this document, including URLand 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 realassociation or connection is intended or should be inferred.Intellectual propertyThis document does not provide you with any legal rights to any intellectual property in any Microsoftproduct.You may copy and use this document for your internal, reference purposes.TrademarksMicrosoft, Dexterity, Microsoft Dynamics, Visual Basic, Visual Studio, Windows, Windows Server, andWindows Vista are trademarks of the Microsoft group of companies.All other trademarks are property of their respective owners.Warranty disclaimerMicrosoft Corporation disclaims any warranty regarding the sample code contained in thisdocumentation, including the warranties of merchantability and fitness for a particular purpose.License agreementUse of this product is covered by a license agreement provided with the software product. If you haveany questions, please call the Microsoft Dynamics GP Customer Assistance Department at800-456-0025 (in the U.S. or Canada) or 1-701-281-6500.Publication dateJuly 2012

ContentsIntroduction . 2What’s in this manual.2Prerequisites.2Symbols and conventions .3Product support .3Part 1: Getting Started . 6Chapter 1: SDK Installation . 7Installation procedure .7Template registration.8What was installed.9Upgrading to a newer Visual Studio.9Chapter 2: Integration Basics. 11What Visual Studio Tools provides . 11Architecture . 11Creating a project .12Chapter 3: Upgrading an Integration . 15Upgrading from Release 9 .15Upgrading from Release 10 or later .20Part 2: Developing Integrations . 24Chapter 4: WinForms . 25Adding a Dynamics GP form to a project .25WinForm properties.26Adding controls.27Chapter 5: Control Reference . 29Buttons.29TextBoxes.31Labels .32ComboBoxes .32ListBoxes .32Chapter 6: Dictionary Assembly Generator . 33Creating application assemblies .33Output files .33Using the Dictionary Assembly Generator .34Optimizing the assembly generating process.36Chapter 7: Accessing Dictionary Resources . 37Adding references.37Namespace.38Dictionary class .38PROGRAMMER’SGUIDEi

C O N T E N T SAccessing additional resources .39Variables for dictionary resources .39Chapter 8: Events . 41Registering events.41Responding to events .43Unregistering events.44Chapter 9: Working with Tables . 47Tables in Microsoft Dynamics GP.47Table buffers.48Opening and closing tables .49Keys.50Retrieving a row.50Saving a row .51Updating a row .52Removing a row .53Table operation errors .54Ranges.55Row locking .59Multiuser processing .59Chapter 10: Building and Deploying . 65Setting assembly information.65Building an integration .66Deploying an integration.67Chapter 11: Debugging . 69Preparing to debug .69Examining the application.70Disabling events .70Chapter 12: Modified and Alternate Forms. 71Modified forms.71Alternate forms .72Guidelines .73Chapter 13: Implementing Macro Support . 75Overview of macro support .75Recording macros .75Playing macros .76Handling asynchronous processes during playback.78Chapter 14: Using Lookups . 79How lookups work .79Available lookups.80Lookup example.80iiP R O G R A M M E R ’ SG U I D E

C O N T E N T SPart 3: Resource Reference . 84Chapter 15: Forms. 85Accessing forms .85Form methods .85Form properties.87Form events .88Chapter 16: Windows . 89Accessing windows .89Window methods.89Window properties .89Window events.90Chapter 17: Scrolling Windows . 95Accessing scrolling windows .95Scrolling window methods.95Scrolling window properties.95Scrolling window events.95Chapter 18: Window Fields . 99Accessing window fields .99Window field methods.99Window field properties .101Window field events.102Chapter 19: Tables . 103Accessing tables .103Table methods.104Table properties .107Chapter 20: Table Fields . 109Accessing table fields .109Table field methods.109Table field properties . 110Chapter 21: Commands . 111Command types . 111Accessing commands . 111Command methods . 111Chapter 22: Globals . 113Accessing globals . 113Global properties. 113Chapter 23: Procedures . 115Accessing global procedures . 115Accessing form-level procedures. 115Procedure methods. 115Procedure events. 116Parameters for procedures. 117PROGRAMMER’SGUIDEiii

C O N T E N T SInvokable procedures . 118Chapter 24: Functions . 119Accessing global functions . 119Accessing form-level functions. 119Function methods .120Function events .120Parameters for functions.121Invokable functions .122Chapter 25: Composites . 123Composite types.123Accessing composites.123Composite field methods.125Composite field properties .127Composite field events.128Part 4: Integration Examples . 130Chapter 26: Field Defaulter . 131Overview.131Running the sample application.131How Visual Studio Tools was used .132Chapter 27: Estimate Freight. 133Overview.133Running the sample application.133How Visual Studio Tools was used .134Chapter 28: Environmental Details . 137Overview.137Running the sample application.137How Visual Studio Tools was used .138Chapter 29: Lookups . 141Overview.141Running the sample application.141How Visual Studio Tools was used .142Glossary . 145Index . 147ivP R O G R A M M E R ’ SG U I D E

INTRODUCTION

IntroductionWelcome to Visual Studio Tools for Microsoft Dynamics GP. This documentationexplains how to integrate applications you create with Visual Studio into MicrosoftDynamics 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 manualThe Visual Studio Tools for Microsoft Dynamics GP Programmer’s Guide isdesigned to give you an in-depth understanding of how to use these tools to createan application that integrates with Microsoft Dynamics GP. Even if you are familiarwith using Visual Studio to develop applications, you will find it helpful to browsethe material presented here.Information is divided into the following parts: Part 1, Getting Started, explains how to install Visual Studio Tools for MicrosoftDynamics GP and begin creating an integration. Part 2, Developing Integrations, provides detailed information about creatingWinForms that match the Microsoft Dynamics GP appearance. Interacting withMicrosoft Dynamics GP through events is discussed. Building, deploying, anddebugging integrations are also addressed. Part 3, Resource Reference, provides detailed information about interactingwith the various types of resources in Microsoft Dynamics GP. Part 4, Integration Examples, describes example integrations that use VisualStudio Tools for Microsoft Dynamics GP.PrerequisitesYou must be using Microsoft Dynamics GP 2013. Since you will be working withMicrosoft Dynamics GP, knowledge of the accounting system will be helpful.Consult the Microsoft Dynamics GP documentation resources to learn more aboutthe product.You will also want to install the SDK for Microsoft Dynamics GP. The SDK isavailable in the Tools folder on the Microsoft Dynamics GP installation media. Itcontains useful information about Microsoft Dynamics GP, such as lists ofcommonly-used procedures and functions.To use Visual Studio Tools for Microsoft Dynamics GP, Visual Studio 2010 or lateris required. Earlier versions of Visual Studio cannot be used. It is assumed that youare familiar with programming in a managed language such as C#. Thisdocumentation uses both C# and Visual Basic to demonstrate how to createintegrations.2P R O G R A M M E R ’ SG U I D E

IN T RO D U C T IO NSymbols and conventionsTo help you use this documentation more effectively, we’ve used the followingsymbols and conventions within the text to make specific types of informationstand out.SymbolDescriptionThe light bulb symbol indicates helpful tips, shortcuts,and suggestions.Warnings indicate situations you should be aware ofwhen completing tasks.Margin notes summarizeimportant information.Margin notes call attention to critical information anddirect you to other areas of the documentation wherea topic is explained.ConventionDescriptionPart 1, Getting StartedBold type indicates a part name.Chapter 8, “Events”Quotation marks indicate a chapter name.Adding controlsItalicized type indicates a section name.using System.IO;This font is used to indicate script examples.Dictionary AssemblyGenerator (DAG)Acronyms are spelled out the first time they’re used.TABor ALT MSmall capital letters indicate a key or a key sequence.Product supportMicrosoft Dynamics GP developer technical support can be accessed online or bytelephone. Go to www.microsoft.com/dynamics and click the CustomerSource orPartnerSource link, or call 888-477-7877 (in the US and Canada) or 701-281-0555.PROGRAMMER’SGUIDE3

4P R O G R A M M E R ’ SG U I D E

PART 1: GETTING STARTED

Part 1: Getting StartedThis portion of the documentation describes how to get started creating anintegration using Visual Studio Tools for Microsoft Dynamics GP. The followingtopics are discussed:6P R O G R A M M E R ’ S Chapter 1, “SDK Installation,” explains how to install Visual Studio Tools SDKfor Microsoft Dynamics GP. Chapter 2, “Integration Basics,” describes the architecture of a Visual StudioTools for Microsoft Dynamics GP integration. It also explains how to create aproject for a new integration. Chapter 3, “Upgrading an Integration,” explains how to upgrade an existingintegration to work with the current version of Visual Studio Tools for MicrosoftDynamics GP.G U I D E

Chapter 1:SDK InstallationThe Visual Studio Tools for Microsoft Dynamics GP SDK contains the componentsneeded to create and build integrations. The following topics are discussed: Installation procedureTemplate registrationWhat was installedUpgrading to a newer Visual StudioInstallation procedureThe Visual Studio Tools for Microsoft Dynamics GP SDK installer requires VisualStudio 2010 or later to be installed first. For testing integrations, you will also wantMicrosoft Dynamics GP installed.If you have installed an earlier version of the Visual Studio Tools SDK, be sure that youremove it from the system before you install the new version.To install the Visual Studio Tools for Microsoft Dynamics GP SDK, complete thefollowing procedure:1. Start the Visual Studio Tools SDK installer.Start the installer by running the VSToolsSDK.exe.2. Acknowledge the license agreement.Read and acknowledge the license agreement. Click Next to continue.3. Specify the features to install.Choose the features that will be installed:FeatureDescriptionVisual Studio 2010 TemplatesThe C# and Visual Basic templates for projects and forms.Visual Studio 2010 is required to install this feature.Visual Studio 2012 TemplatesThe C# and Visual Basic templates for projects and forms.Visual Studio 2012 is required to install this feature.DocumentationThe Visual Studio Tools for Microsoft Dynamics GPProgrammer’s Guide.SamplesSample integrations that demonstrate Visual StudioTools.Assemblies and AssemblyGeneratorThe Dictionary Assembly Generator (Dag.exe) and thedictionary assemblies for the products that ship withMicrosof

Studio Tools for Microsoft Dynamics GP. Prerequisites You must be using Microsoft Dynamics GP 2013. 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.