Combit List & Label - Programmer´s Manual

[Pages:433]Programmer's Manual

The information in this document is subject to change without notice. Companies, names and data used in examples herein are fictitious unless otherwise noted. The availability of functions described in this manual depends on the version, the release level, the installed service packs and other features of your system (e.g. operating system, word processing software, email software etc.) as well as the general configuration. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of combit GmbH. The license agreement can be found at and is displayed in the setup application. JPEG coding and encoding is done with help of the JPEG Library of the IJG (Independent JPEG Group). Avery and all Avery brands, product names and codes are trademarks of Avery Dennison Corporation. PDF creation utilizes wPDF3 (c) wpCubed GmbH - . DataMatrix and QRCode generation is done using RDataMatrix abd QRCode (c) J4L Components. Aztec Barcode creation utilizes free code from Hand Held Inc. Not all features are available in all editions. Please note the hints on LL_ERR_LICENSEVIOLATION.

Copyright ? combit GmbH 1991-2014; Rev. 20.000 All rights reserved.

Contents

Contents

1. Introduction .............................................................................................. 9 1.1 Before Installation ....................................................................................... 9 1.1.1 System Requirements.................................................................... 9 1.1.2 Licensing ........................................................................................ 9 1.2 After Installation .......................................................................................... 9 1.2.1 Start Menu ...................................................................................... 9 1.2.2 Designer Quick Start via Sample Application ............................... 9 1.2.3 Programming Samples ................................................................ 10 1.2.4 Documentation............................................................................. 11 1.3 Important Concepts .................................................................................. 11 1.3.1 Basic Principles ............................................................................ 11 1.3.2 Project Types................................................................................ 13 1.3.3 Variables and Fields ..................................................................... 13 1.3.4 Available User Interface Languages ............................................ 13 1.4 Getting Started With Programming ......................................................... 14 1.4.1 Overview ...................................................................................... 14 1.4.2 Integration With .NET................................................................... 14 1.4.3 Integration With Visual Basic ....................................................... 14 1.4.4 Integration With Delphi ................................................................ 14 1.4.5 Integration With C++ Builder ...................................................... 14 1.4.6 Integration With C/C++ ............................................................... 15 1.4.7 Integration With Java ................................................................... 15 1.4.8 Integration With Other Programming Languages ....................... 15 1.4.9 Hints on Variable and Field Names ............................................. 15 1.4.10 Debugging Support...................................................................... 15

2. Programming With .NET........................................................................ 16 2.1 Introduction ............................................................................................... 16 2.1.1 Integration in Visual Studio.......................................................... 16 2.1.2 Components ................................................................................. 17 2.2 A component that can be directly bound to a ListLabel instance as a data source. A description can be found in section " ........................... 17 2.3 First Steps .................................................................................................. 18 2.3.1 Integrate List & Label .................................................................... 18 2.3.2 License Component ..................................................................... 19 2.3.3 Binding to a Data Source ............................................................. 20 2.3.4 Design........................................................................................... 20 2.3.5 Print .............................................................................................. 21 2.3.6 Export ........................................................................................... 22 2.3.7 Important Properties of the Component ..................................... 23 2.3.8 Web Reporting ............................................................................. 24 2.4 Other Important Concepts ........................................................................ 25 2.4.1 Data Providers .............................................................................. 25

3

Contents

2.4.2 Variables, Fields and Data Types .................................................31 2.4.3 Events ...........................................................................................33 2.4.4 Project Types ................................................................................34 2.4.5 Varying Printers and Printing Copies ...........................................35 2.4.6 Edit and Extend the Designer.......................................................36 2.4.7 Objects in the Designer ................................................................37 2.4.8 Report Container ..........................................................................39 2.4.9 Object Model (DOM) ....................................................................40 2.4.10 List & Label in WPF Applications..................................................41 2.4.11 Error Handling With Exceptions...................................................41 2.4.12 Debugging ....................................................................................42 2.5 Examples ....................................................................................................43 2.5.1 Simple Label .................................................................................43 2.5.2 Simple List ....................................................................................44 2.5.3 Invoice Merge ...............................................................................44 2.5.4 Print Card With Simple Placeholders ...........................................45 2.5.5 Sub Reports ..................................................................................46 2.5.6 Charts............................................................................................47 2.5.7 Cross Tables .................................................................................47 2.5.8 Database Independent Contents..................................................47 2.5.9 Export............................................................................................50 2.5.10 Extend Designer by Custom Function .........................................51 2.5.11 Join and Convert Preview Files....................................................53 2.5.12 Sending E-Mail..............................................................................54 2.5.13 Store Project Files in a Database .................................................55 2.5.14 Network Printing...........................................................................55

3. Programming With the OCX Component ............................................ 57 3.1 Integration of the Component ..................................................................57 3.2 Simple Print and Design Methods ............................................................57 3.2.1 Working Principle .........................................................................57 3.2.2 Using the UserData Parameter.....................................................58 3.3 Transferring Unbound Variables and Fields ............................................58 3.3.1 Pictures .........................................................................................59 3.3.2 Barcodes .......................................................................................59 3.4 Language Selection ...................................................................................59 3.5 Working With Events.................................................................................59 3.6 Displaying a Preview File ..........................................................................60 3.7 Working With Preview Files ......................................................................60 3.7.1 Opening a Preview File.................................................................60 3.7.2 Merging Multiple Preview Files....................................................60 3.7.3 Debugging ....................................................................................61 3.8 Extending the Designer .............................................................................61 3.8.1 Using the Formula Wizard to Add Your Own Functions .............61 3.8.2 Adding Your Own Objects to the Designer .................................62 3.9 The Viewer OCX Control...........................................................................63

4

Contents

3.9.1 Overview ...................................................................................... 63 3.9.2 Registration .................................................................................. 64 3.9.3 Properties ..................................................................................... 64 3.9.4 Methods........................................................................................ 65 3.9.5 Events ........................................................................................... 66 3.9.6 Visual C++ Hint ........................................................................... 67 3.9.7 CAB Files Packaging..................................................................... 67 3.9.8 Inserting the OCX Into Your Internet Page .................................. 67 3.10 The Designer OCX Control ....................................................................... 68 3.10.1 Overview ...................................................................................... 68 3.10.2 Registration .................................................................................. 68 3.10.3 Properties ..................................................................................... 68 3.10.4 Methods........................................................................................ 69 3.10.5 CAB Files Packaging..................................................................... 69 3.10.6 Inserting the OCX Into Your Internet Page .................................. 69

4. Programming With the VCL Component ............................................. 70 4.1 Integration of the Component .................................................................. 70 4.2 Data Binding .............................................................................................. 70 4.2.1 Binding List & Label to a Data Source ......................................... 70 4.2.2 Working With Master Detail Records .......................................... 71 4.2.3 Additional Options for Data Binding............................................ 72 4.3 Simple Print and Design Methods............................................................ 73 4.3.1 Working Principle ......................................................................... 73 4.3.2 Using the UserData Parameter .................................................... 73 4.4 Transferring Unbound Variables and Fields ............................................ 74 4.4.1 Pictures ......................................................................................... 74 4.4.2 Barcodes....................................................................................... 74 4.5 Language Selection ................................................................................... 75 4.6 Working With Events ................................................................................ 75 4.7 Displaying a Preview File .......................................................................... 75 4.8 Working With Preview Files...................................................................... 75 4.8.1 Opening a Preview File ................................................................ 75 4.8.2 Merging Multiple Preview Files ................................................... 76 4.8.3 Debugging .................................................................................... 76 4.9 Extending the Designer............................................................................. 76 4.9.1 Using the Formula Wizard to Add Your Own Functions............. 76 4.9.2 Adding Your Own Objects to the Designer ................................. 78

5. Programming Using the API .................................................................. 81 5.1 Programming Interface ............................................................................. 81 5.1.1 Dynamic Link Libraries................................................................. 81 5.1.2 General Notes About the Return Value ....................................... 83 5.2 Programming Basics.................................................................................. 83 5.2.1 Database Independent Concept .................................................. 83 5.2.2 The List & Label Job ..................................................................... 84

5

Contents

5.2.3 Variables, Fields and Data Types .................................................84 5.3 Invoking the Designer................................................................................89

5.3.1 Basic Scheme ...............................................................................89 5.3.2 Annotations ..................................................................................90 5.4 The Print Process .......................................................................................92 5.4.1 Supplying Data .............................................................................92 5.4.2 Real Data Preview or Print? ..........................................................92 5.4.3 Basic Procedure............................................................................92 5.4.4 Annotations ..................................................................................96 5.5 Printing Relational Data ............................................................................98 5.5.1 API Functions Needed ..................................................................99 5.5.2 Calling the Designer .....................................................................99 5.5.3 Controlling the Print Engine .......................................................101 5.5.4 Handling 1:1 Relations ...............................................................106 5.6 Callbacks and Notifications.....................................................................107 5.6.1 Overview.....................................................................................107 5.6.2 User Objects ...............................................................................108 5.6.3 Definition of a Callback Routine .................................................109 5.6.4 Passing Data to the Callback Routine ........................................109 5.6.5 Passing Data by Messages.........................................................110 5.6.6 Further Hints ...............................................................................111 5.7 Advanced Programming ..........................................................................111 5.7.1 Direct Print and Export From the Designer................................112 5.7.2 Drilldown Reports in Preview.....................................................115 5.7.3 Supporting the Report Parameter Pane in Preview...................119 5.7.4 Supporting Expandable Regions in Preview .............................120 5.7.5 Supporting Interactive Sorting in Preview.................................121 5.7.6 Handling Chart and Crosstab Objects........................................121 5.8 Using the DOM-API (Professional/Enterprise Edition Only) .................123 5.8.1 Basic Principles...........................................................................123 5.8.2 Examples ....................................................................................127

6. API Reference........................................................................................ 131 6.1 Function Reference ..................................................................................131 6.2 Callback Reference...................................................................................272 6.3 Managing Preview Files ..........................................................................302 6.3.1 Overview.....................................................................................302 6.3.2 The Preview API .........................................................................303

7. The Export Modules ............................................................................. 329 7.1 Overview ..................................................................................................329 7.2 Programming Interface............................................................................329 7.2.1 Global (De)activation of the Export Modules ............................329 7.2.2 Switching Specific Export Modules On/Off ...............................329 7.2.3 Selecting/Querying the Output Format......................................330 7.2.4 Setting Export-specific Options .................................................331

6

Contents

7.2.5 Export Without User Interaction ................................................ 332 7.2.6 Querying the Export Results ...................................................... 332 7.3 Programming Reference.......................................................................... 333 7.3.1 Excel Export ............................................................................... 333 7.3.2 HTML Export .............................................................................. 338 7.3.3 JQM Export ................................................................................ 347 7.3.4 MHTML Export ........................................................................... 350 7.3.5 Picture Export............................................................................. 350 7.3.6 PDF Export.................................................................................. 353 7.3.7 Powerpoint Export ..................................................................... 357 7.3.8 RTF Export.................................................................................. 360 7.3.9 SVG Export ................................................................................. 364 7.3.10 Text (CSV) Export....................................................................... 369 7.3.11 Text (Layout) Export................................................................... 371 7.3.12 TTY Export.................................................................................. 374 7.3.13 Windows Fax Export .................................................................. 375 7.3.14 Word Export ............................................................................... 376 7.3.15 XHTML/CSS Export.................................................................... 379 7.3.16 XML Export................................................................................. 386 7.3.17 XPS Export ................................................................................. 390 7.4 Digitally Sign Export Results .................................................................. 391 7.4.1 Start Signature ........................................................................... 391 7.4.2 Programming Interface .............................................................. 391 7.5 Send Export Results via E-Mail .............................................................. 394 7.5.1 Setting Mail Parameters by Code .............................................. 394 7.6 Export Files as ZIP Compressed Archive ............................................... 398

8. Miscellaneous Programming Topics................................................... 400 8.1 Passing NULL Values .............................................................................. 400 8.2 Rounding .................................................................................................. 400 8.3 Optimizing Speed .................................................................................... 400 8.4 Project Parameters .................................................................................. 401 8.4.1 Parameter Types ........................................................................ 401 8.4.2 Querying Parameter Values While Printing ............................... 402 8.4.3 Predefined Project Parameters .................................................. 402 8.4.4 Automatic Storage of Form Data ............................................... 403 8.5 Web Reporting ......................................................................................... 405 8.6 Hints for Usage in Multiple Threads (Multithreading) .......................... 405

9. Error Codes ........................................................................................... 407 9.1 General Error Codes ................................................................................ 407 9.2 Additional Error Codes of the Storage API ............................................ 410

10. Debug Tool Debwin ............................................................................. 412

11. Redistribution: Shipping the Application........................................... 413 11.1 System Requirements ............................................................................. 413

7

Contents

11.2 64 Bit Modules .........................................................................................413 11.3 The Standalone Viewer Application.......................................................413

11.3.1 Overview.....................................................................................413 11.3.2 Command Line Parameters........................................................413 11.3.3 Registration.................................................................................414 11.3.4 Necessary Files ...........................................................................414 11.4 List & Label Files ......................................................................................414 11.5 Other Settings..........................................................................................416 12. Update Information for Version 20 ..................................................... 417 12.1 Overview ..................................................................................................417 12.1.1 General/API .................................................................................417 12.1.2 New features...............................................................................417 12.2 Updating to List & Label 20.....................................................................418 12.2.1 General........................................................................................418 12.2.2 Updating .NET Projects ..............................................................418 12.2.3 What's New .................................................................................419 12.2.4 Changes Compared to the Previous Version.............................419 12.2.5 Updating Projects Using the OCX (e.g. Visual Basic) ................419 12.2.6 Updating Projects Using the VCL (e.g. Delphi) ..........................420 12.2.7 Updating Projects Using the API (e.g. C/C++)..........................420 13. Help and Support ................................................................................. 421 14. Index ...................................................................................................... 422

8

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download