DI UI API SAPB1

SAP Business One UI API Samples

Appl Ap pl ies to : Business One For more information, visit the Business One homepage. homepage.

Summary This article includes several samples of code for SAP® Business One Software Development Kit (SDK) for Visual Basic 6.0 and Visual Basic .NET development environments. The samples demonstrate typical work with the User Interface API Au th or :

SAP Business One Product Management

Company: SAP Created on: 13 May 2009

SAP COMMUNITY NETWORK

© 2009 SAP AG

SDN - sdn.sap.com | BPX - bpx.sap.com | BOC - boc.sap.com

1


Table of Contents Introduction ......................................................................................................................................................... 3 Where Applicable ............................................................................................................................................3 Developer

Audience........................................................................................................................................3

General Information ............................................................................................................................................3 Hello World Sample ............................................................................................................................................3 Catching Events Sample ....................................................................................................................................4 Simple Form Sample.......................................................................................................................................4 Working With XML Sample .............................................................................................................................4 AddingMenuItems Sample..............................................................................................................................4 Matrix and Cells Sample .................................................................................................................................5 Events Filter Sample...........................................................................................................................................6 System Form Manipulation Sample ................................................................................................................6 Complex Form Sample ...................................................................................................................................6 Related Contents ................................................................................................................................................7 Copyright.............................................................................................................................................................8


© 2009 SAP AG


2


Introduction The SAP Business One User Interface API (UI API) is a set of development tools that enable SAP partners to enhance and extend SAP Business One as well as integrate external solutions with SAP Business One (release 6.5) Where Applicable

The UI API can be used to access the user interface level of the SAP Business One application in order to extend its functionality, to interface with third-party tools and to create industry-specific functionality. Developer Audience

The SAP Business One UI API is implemented as a Distributed Component Object Model (DCOM) and designed primarily for Microsoft Visual C/C++®, Microsoft Visual Basic®, and Microsoft .NET developers. Familiarity with "SAP Business One Standards and Guidelines for User Interface" is also required.

General Infor mation In preparation: 1. Add reference to SAP Business One UI API. In Visual Basic, choose Project -> References and select the SAP Business One UI API option. 2. Insert the development connection string to the command line argument. a) In Visual Basic, choose ProjectProperties and choose the Make folder. b) Place the following connection string in the Command Line Arguments field: 0030002C0030002C00530041005000420044005F00440061007400650076002C0050004C006F00 6D0056004900490056 3. To run all the programs, you must have a running SAP Business One application on the desktop.

Hello World Sample This sample program establishes a connection to the SAP Business One application and displays a simple message box with the text "Hello World".

Hello World Sample VB6 source files Hello World Sample vb.net source files


© 2009 SAP AG


3


Catching Events Sample This sample program catches all the events triggered by the SAP Business One application. These include: •

Application events - events triggered by actions on the Company database of the SAP Business One application.

•

MenuEvent events - events triggered by actions on the main menu and the menu bar.

•

ItemEvent events - events triggered by actions on forms and items.

For each event, the sample program displays a message box including the name of the event and the form (or item) name and ID. Note: The Before and After events of the ItemEvent are displayed in the status bar and not on a message box.

CatchingEvents Sample VB6 source files CatchingEvents Sample vb.net source files Simple Form Sample

This sample program shows you how to add a user form and how to add different items to your form. The form includes the following elements: StaticText, EditText, ComboBox, and Button. The ComboBox and the EditText elements are bound to UserDataSource objects in order to manage data on these elements. Finally, the program shows how to save your new form as an XML file.

SimpleForm Sample VB6 source files SimpleForm Sample vb.net source files Working With XML Sample

This sample program demonstrates the proper way of loading a form to the SAP Business One application from an XML file. After running the SimpleForm Sample, a file named SimpleForm.xml is created in the following path: C:\Program Files\SAP Manage\XML\. You can change this path in the code of the WorkingWithXML sample. When you run the sample, the SimpleForm opens in the SAP Business One application. WorkingWithXML Sample VB6 source files WorkingWithXML Sample vb.net source files Ad di ng Menu Item s Sampl e

This sample program adds a new menu item to the main menu and to the Module menu of the SAP Business One application. The new menu item also includes a submenu item that opens a typical form by clicking on it. To activate the form, the sample catches the MenuEvent event, and if the MenuUID equals the unique ID of the new menu item, the form is displayed. In terms of error handling, the program also checks if the new menu item has already been added, and if so, a message box will appear.


© 2009 SAP AG


4


AddingMenuItems Sample VB6 source files AddingMenuItems Sample vb.net source files

Matrix and Data Source Sample This sample program demonstrates how to create a form with a matrix item, create data sources, bind the data source to the matrices columns, and fill the matrix with data. When running the sample, the Matrix Form form opens in the SAP Business One application, and the matrix is filled with user information (name, email, and phone number) taken from the OUSR table. MatrixAndDataSource Sample VB6 source files MatrixAndDataSource Sample vb.net source files Matrix and Cells Sample

This sample program demonstrates how to create a form with a matrix item, fill the matrix with data, and then change specific cell values within the matrix. When running the sample, the Matrix Form form opens in the SAP Business One application. You can change the value of cells in columns A or B and the value in column C recalculates accordingly.

MatrixAndCells Sample VB6 source files


© 2009 SAP AG


5


Events Filter Sample This program performs event filtering on the Order and Purchase forms. At run time, the sample will present a message box whenever one of the specified events occurred on one of these forms. Events on other forms will be ignored by the program.

EventsFilter Sample VB6 source files System Form Manipulation Sample

This is an example of system form manipulation for the User Interface. SystemFormManipulation Sample VB6 source files Complex Form Sample

These are the Complex Form samples. ComplexForm Sample VB6 source files ComplexForm Sample vb.net source files


© 2009 SAP AG


6


Related Contents Documentation for SAP Business One SDK UI API Documentation for SAP Business One UI Objects, Methods, Properties and Events. For more information, visit the Business One homepage.


© 2009 SAP AG


7


Copyright © Copyright 2009 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for t echnology invented and implemented by Netscape. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SA P products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the United States and in other countries. B usiness Objects is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These mat erials are provided by SAP AG and it s affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.


© 2009 SAP AG


8

DI UI API SAPB1

Recommend Documents