Label Gallery Programming Guide

COPYRIGHTS Rev: 20120308 Copyright 2012 SATO CORPORATION. All rights reserved. www.satoworldwide.com

Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement or nondisclosure agreement. The software may be used or copied only in accordance with the terms of those agreements. No part of the publication may be reproduced, stored in a retrieval system, or transmitted in any form or any means electronically or mechanically, including photocopying and recording for any purpose other than the purchaser's personal use without the written permission of SATO CORPORATION. SATO assumes no responsibilities for any errors that may appear.

Trademarks SATO Label Gallery is a registered trademark of SATO Corporation. Microsoft, Visual Studio, Visual C#, Visual Basic, Windows, and the Windows logo are trademarks or registered trademarks of Microsoft Corporation. Other brands and their products are trademarks or registered trademark of their respective holders and should be noted as such.

Table of Contents
1. Introduction................................................................................................... 1
1.1 Overview of software integration............................................................................... 1 1.2 Introduction to DDE and ActiveX ............................................................................... 2 1.2.1 What is Dynamic Data Exchange (DDE)? .................................................................... 2 1.2.2 What is COM / ActiveX? ............................................................................................... 3 1.2.3 What is a Type Library? ............................................................................................... 3 1.2.4 The OLE/COM Object Viewer ...................................................................................... 4 1.3 1.4 1.5 What is Visual Basic ................................................................................................... 5 What is Visual Studio .NET......................................................................................... 5 What is ASP? ............................................................................................................... 5

2.

ActiveX interface .......................................................................................... 6

2.1 Introduction.................................................................................................................. 6 2.2 How to use Label Gallery ActiveX interface ............................................................. 6 2.2.1 Basic Method ................................................................................................................ 7 2.2.2 Advanced Method ........................................................................................................ 7 2.2.3 Differences between early and late binding ................................................................. 7 2.3 Label Gallery Wrapper .............................................................................................. 10 2.3.1 What is Label Gallery Wrapper? ................................................................................ 10 2.3.2 Label Gallery Wrapper Features: ............................................................................... 10 2.3.3 Label Gallery Wrapper Functionality .......................................................................... 10 2.3.4 Usage of Label Gallery Wrapper ................................................................................ 10 2.3.5 Where to get Label Gallery Wrapper? ........................................................................ 11 2.4 Label Gallery Engine Wrapper ................................................................................. 11 2.4.1 What is Label Gallery Engine Wrapper? .................................................................... 11 2.4.2 Label Gallery Engine Wrapper Features: ................................................................... 11 2.4.3 Label Gallery Engine Wrapper Functionality .............................................................. 12 2.4.4 Usage of Label Gallery Engine Wrapper .................................................................... 12 2.4.5 Where to get Label Gallery Engine Wrapper? ........................................................... 12 2.5 2.6 2.7 Create instance of the installed Label Gallery ....................................................... 13 Functional comparison between Label Gallery Engine version 3 and Label Gallery Plus version 3 ............................................................ 13 Logging support for Label Gallery SDK version 3 ................................................. 13

2.8 Label Gallery SDK version 3.2 Unit Based licensing ............................................. 14 2.8.1 Sofware key licensing ................................................................................................. 14 2.9 Label Gallery ActiveX common interfaces ............................................................. 17 2.9.1 Class Application ........................................................................................................ 17 2.9.2 Hierarchy diagram ...................................................................................................... 34 2.9.3 Class IBarcode (Advanced only) ................................................................................ 35 2.9.4 Class IDatabase (Advanced Only) ............................................................................. 49

2.9.5 2.9.6 2.9.7 2.9.8 2.9.9 2.9.10 2.9.11 2.9.12 2.9.13 2.9.14 2.9.15 2.9.16 2.9.17 2.9.18 2.9.19 2.9.20 2.9.21 2.9.22 2.9.23 2.9.24 2.9.25 2.9.26 2.10 2.10.1 2.10.2 2.10.3 2.10.4 2.10.5 2.10.6 2.10.7 2.10.8

Class IDatabaseList (Advanced Only) ....................................................................... 57 Class IDBDef .............................................................................................................. 58 Class IDBField ............................................................................................................ 60 Class IDBParameter (Advanced Only) ....................................................................... 62 Class IEXTFunction (Advanced Only) ........................................................................ 63 Class IFieldList (Advanced Only) ............................................................................... 67 Class IFunction (Advanced Only) ............................................................................... 68 Class IFunctionList (Advanced Only) ......................................................................... 71 Class IGraphics (Advanced Only) .............................................................................. 72 Class ILabel (Advanced Only) .................................................................................... 82 Class ILGLabel (Advanced Only) ............................................................................. 102 Class IObject (Advanced Only) ................................................................................ 124 Class IObjectList (Advanced Only)........................................................................... 133 Class IOleObject (Advanced Only)........................................................................... 134 Class IParagraph (Advanced Only) .......................................................................... 143 Class IParameterList (Advanced Only) .................................................................... 158 Class IRectangle (Advanced Only) .......................................................................... 159 Class IRTFText (Advanced Only) ............................................................................. 171 Class IText (Advanced Only) .................................................................................... 186 Class IVar (Advanced Only) ..................................................................................... 201 Class IVariableList (Advanced Only) ........................................................................ 219 Class ILabelSettings (Advanced Only) ..................................................................... 223 Label Gallery ActiveX interfaces for advanced users ......................................... 238 Class Application ...................................................................................................... 238 Class IDatabase ....................................................................................................... 241 Class IEXTFunction (Advanced Only) ...................................................................... 242 Class IFunction ......................................................................................................... 243 Class ILabel .............................................................................................................. 245 Class IParagraph ...................................................................................................... 246 Class IRTFText......................................................................................................... 247 Class IVar ................................................................................................................. 247

2.11 Nlog5 ActiveX Interfaces ........................................................................................ 248 2.11.1 How to use Nlog5 Interface ...................................................................................... 248 2.11.2 Class IPrintJobFactory ............................................................................................. 249 2.12 2.12.1 2.12.2 2.12.3 2.12.4 2.12.5 2.12.6 2.12.7 2.13 2.13.1 2.13.2 2.13.3 LabelServices ActiveX Interfaces .......................................................................... 250 Introduction to LabelServices Interface .................................................................... 250 Class TPQPrinter...................................................................................................... 250 Class TPQPrinterList ................................................................................................ 253 Class TPQPrinterJob ................................................................................................ 253 Class TPQPrinterJobList .......................................................................................... 257 Types ........................................................................................................................ 257 Methods .................................................................................................................... 259 GalleryForm ActiveX Interfaces ............................................................................. 269 Introduction ............................................................................................................... 269 GalleryForm ActiveX Interface - Design mode ......................................................... 269 GalleryForm ActiveX Interface - Run mode ............................................................. 271

3.

DDE Communication ................................................................................ 273

3.1 Introduction.............................................................................................................. 273 3.2 DDE Commands ...................................................................................................... 273 3.2.1 DDEInitiate ............................................................................................................... 273 3.2.2 DDEExecute ............................................................................................................. 273 3.2.3 DDETerminate .......................................................................................................... 274 3.3 GalleryCommands ................................................................................................... 274 3.3.1 COMMON ................................................................................................................. 274 3.3.2 FILE .......................................................................................................................... 276 3.3.3 PRINTING ................................................................................................................ 278 3.3.4 DATABASE .............................................................................................................. 280

4.

Programming Samples............................................................................. 282

4.1 4.2 4.3 4.4 4.5 4.6 DDE ........................................................................................................................... 282 ActiveX interface ..................................................................................................... 282 ActiveX Hints ........................................................................................................... 282 Active Server Pages ................................................................................................ 285 ASP.NET ................................................................................................................... 287 Visual Basic Script (VBScript) ............................................................................... 288

5.

FAQ ............................................................................................................ 289

5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 How to choose different printer for label printing not the one than is selected in the label? ................................................................................. 289 How to close the label, if you do not have Label ID? .......................................... 289 How to print label, if you do not have Label ID? .................................................. 289 How to save the label with Label Gallery API? ..................................................... 290 How can I put Label Gallery in the foreground when I control it with ActiveX interface? ........................................................................................ 290 How can I use Label Gallery API in .NET environment? ..................................... 290 Where can I get programming samples for different environments? ......................................................................................................... 290 Can I Control GalleryForm through the ActiveX Interface? ................................ 291

6. 7. 8.

Glossary .................................................................................................... 292 Appendix ................................................................................................... 294 Technical Support .................................................................................... 295

9.

Contact Information ................................................................................. 296

Regional HQ ........................................................................................................................ 296 AMERICAS ........................................................................................................................... 296 EUROPE ............................................................................................................................... 296 ASIA PACIFIC ...................................................................................................................... 298

Introduction

1. Introduction
1.1 Overview of software integration
The most common method of label print is directly from Label Gallery software using its GUI (graphic user interface). But sometimes there might be other requirements for label production. Label Gallery has a wide variety of connectivity and integration options so you do not need to use Label Gallery interactively, but through an ActiveX interface or Dynamic Data Exchange connectivity. Label Gallery can be used as a "print-engine" totally integrated to your custom application and invisible to the end-user eyes.

Basically, the end user sees only your custom application that connects to Label Gallery and uses Label Gallery label printing power in the background. The purpose of this manual is to show you how you can control the Label Gallery software from your own application that will be deployed to the end-user. Everything you must know about integration of Label Gallery into your application is described in this manual. The information in this manual is for advanced users and application developers only. If you do not plan to write applications that use integrated Label Gallery to print labels, you can skip reading this manual entirely. If you are interested in Label Gallery connectivity and integration options in general, please refer to the White Paper covering these options or visit SATO Office website at http://www.satoworldwide.com.

Introduction

All methods and properties of Label Gallery ActiveX object described in this document are available in Label Gallery Plus application. Label Gallery Plus application is available in many Label Gallery editions, like Label Gallery Plus, Label Gallery Plus Print-Only, Label Gallery TruePro, Label Gallery TruePro Print-Only, Label Gallery TruePro Network, Label Gallery SDK and other. Label Gallery Easy and Label Gallery Free editions do not have the ActiveX interface. This manual contains a FAQ section where most frequently asked questions are answered.

1.2 Introduction to DDE and ActiveX

1.2.1 What is Dynamic Data Exchange (DDE)?
Microsoft Windows allows multiple programs to run at the same time. Part of power of the Windows environment lies in the ability of these programs to communicate with each other. Various methods of inter-process communication are available in Windows, including the "clipboard," Object Linking and Embedding (OLE), and Dynamic Data Exchange (DDE). The Dynamic Data Exchange mechanism is one way for software applications to communicate with each other. This communication has two forms: data and commands. Data are identified by the application name and by individual topic and item names within that application. It is also possible to create hot links, so that one application can notify another when information has changed. Applications can also execute commands in other applications. From the user's perspective, establishing a DDE link is often no different from cutting and pasting non-dynamic data between applications. The user can often establish a DDE link by "copying" the data from one application, and then, in a second application choosing a command like "Paste Link..." from a menu. The DDE link then continues to exist without further action on the user's part. The developer's view of DDE is quite different. At its most basic level, DDE is simply a message-based protocol, which applications can use to share data in global memory. Applications can share data on a one-time basis or on an ongoing basis in which new data is automatically sent from one application to another when it becomes available. Dynamic Data Exchange or DDE is a Windows feature that allows Windows applications to communicate with each other. DDE is based on the messaging system built into Windows. Two Windows programs can carry on a DDE "conversation" by posting messages to each other. These two programs are known as the "server" and the "client". A DDE server is the program that has access to data that may be useful to other Windows programs. A DDE client is the program that obtains this data from the server.

Introduction

1.2.2 What is COM / ActiveX?

The Component Object Model (COM) is a binary standard designed to support reusable, language-independent and multi-platform components. With COM, it is possible for one component to communicate with another component. These components can be on different threads, processes, or even machines. ActiveX is Microsofts implementation of COM. COM and ActiveX are often used interchangeably in different technical documentation. An ActiveX control is just a special user interface ActiveX (COM) object designed for use on forms. COM objects define interfaces that expose methods and properties by which clients (user applications) can manipulate the object. In fact, objects can only be manipulated via an interface. Interfaces are immutable, which means that once an interface has been published, it can never change. In other words, methods should never be added, removed, or have their signatures changed. A new version of the object could be provided by a new interface to expose any new functionality while keeping the original interface intact. Objects typically have many interfaces. A method of one interface may access, use, or return another interface.

1.2.3 What is a Type Library?

A Type Library is a file that contains descriptions of a components classes, interfaces, data types, and methods. The type library may be a stand-alone file (usually with an .OLB extension) or may be embedded within the runtime file (DLL or executable). The contents of a type library may be inspected with a type library browser such as OLEVIEW.EXE that can be downloaded from the Microsoft web site. The type library supplied by the Label Gallery labeling software is a file called lgplus3.OLB that describes the type of all of the ActiveX objects. For Label Gallery version 2 suitable file is lgplus2.OLB , for Label Gallery version 1 suitable file is lgplus.OLB The type library does not store objects, but it stores type information. By accessing the type library, your application can determine the characteristics of an object, such as the interfaces supported by the object and its names and parameters. This library helps you to write your program because it contains all of definitions of object methods and properties that you can access. Using the type library you can optimize your job. The name of the type library is LabelGalleryPlus3. The following procedures show how to install and use the type library with Visual Basic 6.0 , Delphi. Visual Basic To install the type library: Choose Project -> References. Activate Label Gallery in the list of available references and validate the dialog box.

To display the methods and properties: Use the Object Explorer

Introduction

In the library list select Label Gallery

You can run Object Explorer anytime with pressing F2 button on your keyboard. To use the type library While writing code, you have just to enter a period after an object to get the associated methods and properties, or after a method to get the associated properties. Delphi Choose Project -> Import Type Library Activate Label Gallery in the list of available references and validate the dialog box.

1.2.4 The OLE/COM Object Viewer

The OLE/COM Object Viewer is a developer- and power user-oriented administration and testing tool. With the OLE/COM Object Viewer you can view the Label Gallery type library contents. Use the Viewer to figure out what methods, properties, and events Label Gallery supports. To create the Label Gallery type library go to the command prompt and type the following command (you have to be positioned in the folder where Label Gallery main file lgplus2.EXE is stored) For version 1 lgplus.exe file must be executed. Valid for version 3: LGPLUS3.EXE /typelib Valid for version 2: LGPLUS2.EXE /typelib Valid for version 1: LGPLUS.EXE /typelib

This produces the file lgplus3.OLB. You can view this file with the OLE/COM Object Viewer. OLE/COM Object Viewer is available to download from: http://www.microsoft.com/com/resources/oleview.asp

Introduction

1.3

What is Visual Basic

Visual Basic (VB) is a RAD (Rapid Application Development) tool that enables programmers to create Windows applications in a very short period of time. It is the most popular programming language in the world, and has more programmers and lines of code than any other competitive development language.

1.4 What is Visual Studio .NET

Visual Studio .NET is the comprehensive, multi-language development tool for rapidly building and integrating applications. Visual Studio .NET offers a highly productive environment in which to develop a broad range of Microsoft .NET connected applications and technologies. Using the high-performance Microsoft .NET Framework run-time environment, Visual Studio .NET provides you with powerful tools for designing, building, testing, and deploying applications.

1.5 What is ASP?

Active Server Pages are HTML pages that contain embedded scripts. IIS (Internet Information Server) and third party providers offer server software that interprets Active Server code and displays the result in the user's internet browser application. ASP pages contain either server side or client side scripts, which performs functions such as database access, page personalization, or interactive functions. On In the same way the Label Gallery labeling software can be controlled. For more technical details and samples please refer to the chapter Active Server Pages on the page 285

ActiveX interface

2. ActiveX interface
2.1 Introduction
ActiveX is a technology used within Windows that allows the programs to interact with one another through a pre-defined interface. ActiveX was previously known as OLE Automation and is still referred to as such in the documentation of many programming languages that can make use of it. An ActiveX interface is made up of 'exposed objects and methods'. The objects can be looked upon as the containers for the methods that provide the interface functionality. The methods perform specific tasks using parameters you pass to the method to specify the detail of the task. ActiveX interface available in Label Gallery software allows you to take remote control over label printing. You can embed the functionality of Label Gallery Plus into your application and use Label Gallery as print engine. Before you start developing your custom application you should know, how to use LabelGallery ActiveX interface in your software.

Visible to the End User

Printed labels
Your Application Database Active X Interface

Label production LabelGallery

Not Visible to the End User

Figure 1: Schematic view on communication paths when using Label Gallery ActiveX interface

2.2 How to use Label Gallery ActiveX interface

Integration of Label Gallery can be done using two methods. Each of them has different approach for accessing Label Gallery through ActiveX and must be understood, otherwise you can experience troubles with the ActiveX interface. The most important thing to remember is that you can use only one method at a time. The two methods must never be mixed so you must decide which method you will use for the integration and then stick with it.

ActiveX interface

2.2.1 Basic Method

The basic method is suitable for simple operations such as: Opening labels Setting variables Setting printers Printing

The basic connection to the label must be done with the method LabelOpen. When accessing Label Gallery with LabelOpen command, you will get the ID of the label. All further operations that are done with the label are then managed with this ID. The basic method allows you to use the basic operations, but they are quite sufficient for label printing. It is not possible to use any of the labels interfaces, their properties and/or methods as with the advanced method. If you need more power over your label, you have the advanced method available.

2.2.2 Advanced Method

The advanced method is suitable for simple and also advanced operations such as: Opening labels Setting variables Setting printers Printing Getting label preview Changing the label design on-the-fly

The advanced connection to the label must be done with the LabelOpenEx command. When accessing Label Gallery with LabelOpenEx command then you get the interface to the label. Label interface can be used to access all available Label Gallery ActiveX interfaces and their properties and/or methods described in this manual Please refer to the figure 2 for the hierarchy of the interfaces. IMPORTANT! The commands LabelOpen and LabelOpenEx are not equivalents and must not be mixed. Use only one method at a time. When using LabelOpen, you interact with the label using label ID, when using LabelOpenEx, you interact with the label base on the label interface.

2.2.3 Differences between early and late binding

There are two methods for using ActiveX interface to control Label Gallery, late binding and early binding.

ActiveX interface

Late binding Late binding uses the CreateObject command to create an instance of the Label Gallery object that you then control from your application. For example, to create a new instance of Label Gallery using late binding you would use the command: Dim oLG As Object Set oLG = CreateObject("LabelGalleryPlus3.Application") Valid for Label Gallery 1 Dim oLG As Object Set oLG = CreateObject("LabelGalleryPlus.Application") Valid for Label Gallery 2 Dim oLG As Object Set oLG = CreateObject("LabelGalleryPlus2.Application") Valid for Label Gallery 3 Dim oLG As Object Set oLG = CreateObject("LabelGalleryPlus3.Application")

Early binding To use early binding, you must first set a reference to Label Gallery ActiveX interface. The reference is stored in the type library file. For more information refer to the chapter What is a Type Library? If you need to integrate Label Gallery print engine to application running in .NET environment, you will have to add Label Gallery Wrapper DLL to your development environment in the same ways as the type library. To create a new instance of Label Gallery using early binding use the command: Dim oLG As LGApp Set oLG = New LGApp LGApp class is part of LabelGallery Wrapper. More about LabelGallery Wrapper please read in its section in this document. In either case, you can first try to get an existing instance of Label Gallery. If Label Gallery is not already running, the action will return an error message, so you will have to run a new instance of Label Gallery.

ActiveX interface

To connect to an already running instance of Label Gallery you would use GetObject (regardless whether you're using early or late binding). If existing Label Gallery is not found in memory, the error handler will be returned for your evaluation. Dim oXL As Object Set oXL = GetObject("LabelGalleryPlus3.Application") Valid for Label Gallery 1 Dim oXL As Object Set oXL = GetObject("LabelGalleryPlus.Application") Valid for Label Gallery 2 Dim oXL As Object Set oXL = GetObject("LabelGalleryPlus2.Application") Valid for Label Gallery 3 Dim oXL As Object Set oXL = GetObject("LabelGalleryPlus3.Application")

Advantages of Early Binding vs. Late Binding When using early binding, your code will run considerably faster, because it can all be compiled up front. With late binding, the code relating to an application you declared as an object has to be compiled as it runs. It slows the overall speed of your application. Because your code can all be compiled up front, debugging of the code is far easier. You need to select Debug + Compile option in your development environment and the compiler will be able to spot syntax errors which would have been missed had you used late binding. When using early binding in your project you also have the full access to intellisense. IntelliSense provides an array of options that make language references easily accessible. When coding, you do not need to leave the Code Editor or the Immediate Mode command window to perform searches on the language elements. You can keep your context, find the information you need, insert language elements directly into your code, and even have IntelliSense complete your typing for you. With intellisense you can enter the program code faster than without it. You can type a keyword followed by a dot to get a popup list of properties and methods supported by that keyword. The access to the help for specified keyword is also simplified with early binding. When you type a keyword and press F1 the online help topic for that keyword is automatically displayed. You have the full access to the application's object model via the Object Browser and VBA Help.

ActiveX interface

Additionally, you have access to the application's built-in constants. Furthermore, while typing a source code for an object, you will get a pop-up list of the supported methods or properties. All these advantages make programming using early binding immeasurably easier than using late binding.

2.3 Label Gallery Wrapper

2.3.1 What is Label Gallery Wrapper?
Label Gallery Wrapper is a dynamic link library that helps you integrate Label Gallery ActiveX interface in .NET and VB Applications better and with more power. Label Gallery Wrapper has some additional approaches that are not present in the Label Gallery ActiveX interface alone.

2.3.2 Label Gallery Wrapper Features:

Early binding available Possible Usage in .NET environment

2.3.3 Label Gallery Wrapper Functionality

Label Gallery Wrapper is the library you interact with from your application. Using the Wrapper you no longer connect directly to Label Gallery ActiveX interface, but leave this job to the Wrapper. Label Gallery Wrapper is practically completely transparent with Label Gallery ActiveX. All interfaces, methods and properties available in the Label Gallery Wrapper have the same name and functionality as in the original Label Gallery ActiveX interface. There are only two differences. 1. Additional Free methods in all classes (except LGApp class, which already had Quit method). These methods should be used in .NET environment to ensure that no longer needed Label Gallery objects are correctly released from the memory. 2. Some class names are different: WRVar instead of Var WRObject instead of Object WRFunction instead of Function

2.3.4 Usage of Label Gallery Wrapper

Visual Basic You must include Label Gallery wrapper in your project: Choose Project -> References.

10

ActiveX interface

Activate LabelGalleryPlus3WR (LabelGalleryPlus2WR) in the list of available references and validate the dialog box.

.After that you have the possibility to use Label Gallery ActiveX types (LGApp, LGLabel, etc), methods and properties from your application. Early binding is also available. .Net Microsoft Visual Studio You must include Label Gallery wrapper in your project: Choose Project -> Add References. Activate LabelGalleryPlus3WR (LabelGalleryPlus2WR) in the list of available references in .COM tab

After that use of Label Gallery ActiveX types (LGApp, LGLabel, etc), methods and properties is possible (early binding). After the certain object is no longer needed you must use the proper Free method to ensure that no longer needed Label Gallery objects are released correctly (otherwise garbage collector may not dispose them immediately).

2.3.5 Where to get Label Gallery Wrapper?

Label Gallery Wrapper version 3 dll file is installed together with the Label Gallery itself. Default location of the file is C:\Program Files\SATO\Gallery 3\Bin Label Gallery Wrapper version 2 dll file is installed together with the Label Gallery itself. Default location of the file is C:\Program Files\SATO\Gallery 2\Bin

2.4 Label Gallery Engine Wrapper

2.4.1 What is Label Gallery Engine Wrapper?
Label Gallery Engine Wrapper is a dynamic link library that helps you integrate Label Gallery Engine interface in .NET and VB Applications better and with more power. Label Gallery Engine Wrapper has some additional approaches that are not present in the Label Gallery Engine interface alone.

2.4.2 Label Gallery Engine Wrapper Features:

Early binding available Possible Usage in .NET environment

11

ActiveX interface

2.4.3 Label Gallery Engine Wrapper Functionality

Label Gallery Engine Wrapper is the library you interact with from your application. Using the Wrapper you no longer connect directly to Label Gallery Engine interface, but leave this job to the Wrapper. The Wrapper runs between your application and the Label Gallery Engine. Label Gallery Engine is practically completely transparent with Label Gallery Engine. All interfaces, methods and properties available in the Label Gallery Engine Wrapper have the same name and functionality as in the original Label Gallery Engine interface.

2.4.4 Usage of Label Gallery Engine Wrapper

Visual Basic You must include Label Gallery Engine wrapper in your project: Choose Project -> References. Activate LabelGalleryPlus3WR (LabelGalleryPlus2WR) in the list of available references and validate the dialog box.

After that you have the possibility to use GalleryEngine ActiveX types (LGApp, LGLabel, etc), methods and properties from your application. Early binding is also available. .Net Microsoft Visual Studio You must include Label Gallery Engine wrapper in your project: Choose Project -> Add References. Activate LabelGalleryPlus3WR (LabelGalleryPlus2WR) in the list of available references in .COM tab

After that use of Label Gallery Engine ActiveX types (LGApp, LGLabel, etc), methods and properties is possible (early binding). After the certain object is no longer needed you must use the proper Free method to ensure that no longer needed Label Gallery objects are released correctly (otherwise garbage collector may not dispose them immediately).

2.4.5 Where to get Label Gallery Engine Wrapper?

Label Gallery Engine Wrapper version 3 dll file is installed together with the Label Gallery itself. Default location of the file is C:\Program Files\Common Files\EuroPlus Shared\LGEngine Label Gallery Engine Wrapper version 2 dll file is installed together with the Label Gallery itself. Default location of the file is C:\Program Files\Sato\Gallery 2\Bin

12

ActiveX interface

2.5 Create instance of the installed Label Gallery

Label Gallery ActiveX interface supports version 1, version 2 and version 3. Version 3 ActiveX Interface includes all methods and properties described below. Previous versions (1 and 2) do not include all methods and properties. To connect to an installed of Label Gallery it is advised to use following code. If existing Label Gallery version is not installed, object variable reference is nothing and another version of the Label Gallery has to be choosing. Check Version Availability for each method or property. Dim oXL As Object Set oXL = CreateObject("LabelGalleryPlus3.Application") If oXL is Nothing then Set oXL = CreateObject("LabelGalleryPlus2.Application") If oXL is Nothing then Set oXL = CreateObject("LabelGalleryPlus.Application")

2.6 Functional comparison between Label Gallery Engine version 3 and Label Gallery Plus version 3
Label Gallery Engine Label Gallery Plus

Create labels Print labels Needs custom application for initiating of label printing? ActiveX programming interface Class Name

NO YES YES

YES YES NO

YES

YES

LabelGalleryPlus3.Engine

LabelGalleryPlus3.Application

2.7 Logging support for Label Gallery SDK version 3

Label Gallery SDK version 3 has built-in support for logging of label printing operations. Whenever a label print even occurs all information about the events are stored in the log file. By default logging functionality is disabled.

13

ActiveX interface

If you want to log the information about every printed label, you just need to enable the logging functionality. For more information refer to the Label Gallery SDK User Guide.

2.8 Label Gallery SDK version 3.2 Unit Based licensing

Label Gallery SDK version 3.2 Unit Based can licensing by: Hardware key Software key

For hardware key licensing refer to Label Gallery SDK User Guide.

2.8.1 Sofware key licensing

Following options are available: During product (third party application) installation, user could enter the product key number, and the install program can call the procedure to activate the license on-line. During product uninstallation, the install program can call the procedure to deactivate license on-line. When on-line internet connection is not available, products installation can call a routine, that will start the Activation Wizard. Using the SDKs activation WebPage, product can be fully activated using Registration Number and Activation Code. Prior to calling the on-line activation routine, install program can verify the entered key number (just for validity of the key). Status of the activation can also be verified (if the product is already installed or not). SDKLicense.dll needs for Software key licensing. It is installed together with Label Gallery SDK deployment package. Third party application can call this DLL to achieve activation/deactivation of the SDK package. The DLL is located in the location, where LGEngine is installed. This is normally on C:\Program Files\Common Files\EuroPlus Shared\LGEngine Function SLInit SLActivateLicense SLDeactivateLicense SLGetLicense SLManageLicense SLValidateKeyNumber Version Availability 3.2 3.2 3.2 3.2 3.2 3.2

14

ActiveX interface

SLInit Description: Function must be called prior to all other functions. It sets the language of the library, error messages will be returned in desired languages. Possible values for the languages: English =1 Slovenian =2 Croatian =3 German =4 Danish =5 French =6 Spanish =7 Italian =8 Finish =9 Dutch = 10 Portuguese = 11 Czech = 12 Polish = 13 Hungarian = 14 Russian = 15 Greek = 16 Swedish = 18 Hebrew = 19 Slovak = 20 Lithuanian = 21 Chinese (Traditional) = 22 Chinese (Simplified) = 23 Thai = 24 Korean = 25 Japanese = 26 Ukrainian = 27 Norwegian = 29 Return Value is 0. Syntax: Function SLInit (Language: integer) : integer

SLActivateLicense Description: Function will perform on-line activation of the key number provided in the KeyNumber parameter. To perform the activation, Name, Company, Country and Email parameters must be provided. Reason parameter needs to be provided, if the key number is activated not for the first time. See return codes for more explanation. In case of an error, the buffer provided by ErrorMessage parameter is filled with the message, up to MaxMsgLen length.

15

ActiveX interface

Return value of the call: 0 success 2 Reason needs to be provided to the call 3 Country was not provided 4 Email was not provided Other non-zero value unknown error happened. Detailed description of the error is provided in ErrorMessage parameter Syntax: Function SLActivateLicense (Name, Company, Country, EMail, Reason, KeyNumber: PChar; ErrorMessage: PChar; MaxMsgLen: integer) : integer

SLDeactivateLicense Description: Function will perform on-line deactivation of the key number provided in the KeyNumber parameter. In case of an error, the buffer provided by ErrorMessage parameter is filled with the message, up to MaxMsgLen length. Return value of the call: 0 success -1 Error happened. Detailed description of the error is provided in ErrorMessage parameter Syntax: Function SLDeactivateLicense (KeyNumber: PChar; ErrorMessage: PChar; MaxMsgLen: integer)

SLGetLicense Description: Function verifies the status of activation on the system. When the product is already activated, the KeyNumber is returned in KeyNumber parameter (buffer of 26 or more bytes needs to be provided. When SolutionID parameter is provided, it will be filled with the SolutionID parameter of the Key (refer to Label Gallery SDK User Guide for more information)

Return value: 0 product is activated -1 product is not activated Syntax:

16

ActiveX interface

Function SLGetLicense (KeyNumber: PChar; SolutionID: PWORD): integer SLManageLicense Description: Function is called to perform activation of the product (product is not activated yet) or show the license information (when product is already activated). Function will show the activation wizard, which will guide the user through the process of license activation.

Return value: 0 success Syntax: function SLManageLicense (hParent: THandle) : integer SLValidateKeyNumber Description: Function verifies the key, provided in KeyNumber parameter. Return value: 0 Key is valid -1 Key is not valid. Syntax: Function SLValidateKeyNumber (KeyNumber: PChar) : integer

2.9 Label Gallery ActiveX common interfaces

This section contains description of the common methods and properties.

2.9.1 Class Application

Methods ExecuteMacro GetOpenedLabels GetVersion GetLabelDownloadVariablesList IsLabelExportable JobRun LabelClose Version Availability 1,2,3 2 3 3 1,2,3 1,2,3 1,2,3 Properties Application DetailedMessage ErrorID Errormessage ErrorMessage IsDemo ProcessID Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 2,3

17

ActiveX interface

LabelCreate LabelExportToPocket LabelGeneralExport LabelGetVarCount LabelGetVarName LabelGetVarProperty LabelOpen LabelOpenEx LabelOpenExForPrinter LabelOpenForPrinter LabelPrint LabelSessionEnd LabelSessionPrint LabelSessionStart LabelSetPrinter LabelSetPrintJobName LabelSetVar LabelTestConnection Login Quit SetApplicationProperty SetDefaultPrinter

1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 3 2,3

Application Description: Application method returns an interface to the LGApp. Syntax: Property Application As LGLabel Access Rights: read-only Method: Advanced

18

ActiveX interface

DetailedMessage Description: This is a read-only property, which holds additional information (if they exist) about the error (if it has occurred). Syntax: Property DetailedMessage As String Access Rights: read-only Method: Basic, Advanced See also: ErrorID, ErrorMessage ErrorID Description: This is a read-only property that contains last error code (if error occurred). Syntax: Property ErrorID As Long Access Rights: read-only Method: Basic, Advanced See also: DetailedMessage, ErrorMessage

ErrorMessage Description: This is a read-only property that holds the last error message (if the error has occurred). Syntax: Property ErrorMessage As String

19

ActiveX interface

Access Rights: read-only Method: Basic, Advanced See also: DetailedMessage, ErrorID

ExecuteMacro Description: This function executes a Macro (DDE) command. Syntax; Function ExecuteMacro(LabelID As Long, Macro As String) As Boolean Method: Basic GetOpenedLabels Description: The LGApp interface is extended to support returning a list of opened labels. The command is defined as: Method returns a multiline text string, each line containing the path name of the opened label. In case the label is not saved yet (path name does not exist), the title of the label is returned. Syntax: GetOpenedLabels() Method: Advanced See also: LabelOpenEx GetVersion Description: GetVersion method can be used to check Label Gallery version.

20

ActiveX interface

Method returns a string value regarding to VersionID value. VersionID value can be of the following: 0 complete info 1 - Major version 2 - Minor version 3 - Release version 4 - Build number Syntax: Function GetVersion(VersionID As Integer) As String Method: Advanced

GetLabelDownloadVariablesList Description: GetLabelDownloadVariablesList method returns list of label variables. It has to be set before using metods like ExportToPrinter or DownloadToPrinter. Method returns interface to the variable list of label variables.

Syntax: Function GetLabelDownloadVariablesList(LabelID As Long) As VariableList Method: Advanced See also: ExportToPrinter, DownloadToPrinter

IsDemo Description: This property tells the client application whether the server is running in DEMO mode or not. Syntax: Property IsDemo As Boolean Access Rights: read-only

21

ActiveX interface

Method: Basic, Advanced

IsLabelExportable Description: IsLabelExportable method can be used to check in advance, if the label can be exported. This function can be used from applications, which later use the ExportToPocketPC ActiveX method. When label can be exported, the method returns TRUE. Syntax: Function IsLabelExportable() As Boolean Method: Advanced See also: LabelExpotToPocket

JobRun Description: Function executes specified JOB file. Syntax: Function JobRun(FileName As String) As Boolean Method: Basic, Advanced LabelClose Description: Closes the label with specified ID. If it succeeds TRUE is returned. Syntax: Function LabelClose(LabelID As Long) As Boolean Method: Basic See also:

22

ActiveX interface

LabelOpen

LabelCreate Description: Creates new label document and returns interface as a result Syntax: Function LabelCreate() As ILGLabel Method: Advanced LabelExportToPocket Description: Function executes the same action as choosing the command File|Export|Export to terminal. All the necessary files are created in directory specified as second parameter. Syntax: Function LabelExportToPocket(LabelID As Long, ExportDir As String) As Boolean Method: Basic, Advanced See also: IsLabelExportable LabelGeneralExport Description: Performs an export of the label specified by LabelID (this label has to be open with LabelOpen call where you retrieve the ID of the label), the exported files are placed into the ExportDir folder Syntax: Function LabelGeneralExport(LabelID As Long, ExportDir As String) As Boolean Method: Basic LabelGetVarCount Description:
23

ActiveX interface

Function returns number of variables on the label with specified label ID The returned value is zero based index. To get an actual number of variables on the label you have to add up 1. Syntax: Function LabelGetVarCount(LabelID As Long) As Long Example: Label has 5 variables. LabelGetVarCount will return number 4. Label has 17 variables. LabelGetVarCount will return number 16. Method: Basic See also: LabelGetVarName, LabelGetVarProperty, LabelSetVar

LabelGetVarName Description: Function returns the variable name with the specified variable number (VarID) on the label with specified label ID. VarID is a number of variable from 1 to number of variables on the label (returned by LabelGetVarCount function). Syntax: Function LabelGetVarName(LabelID As Long, VarID As Long) As String Method: Basic See also: LabelGetVaCount, LabelGetVarProperty, LabelSetVar

LabelGetVarProperty Description: Function returns a property of a variable with the name VarName. PropName specifies name of the property to be returned. Possible values for PropName are: Value Name

24

ActiveX interface

ID Used VarQuantity InputType Description Prefix Suffix Length FixedLength MultiLine LineCount LineLength FormatID Justification PadChar WordWrap MinValue MaxValue HasMinValue HasMaxValue InputPicture OutputPicture PictureType

InputType has the following values: Value 1 2 3 4 5 6 Description Prompt System clock PrinterClock Global Generated Database

For prompted variables:

25

ActiveX interface

"Prompt" "PromptType" "DefValue" "DefType" "IsDynamic" "IsRequired" Variable types are self-explanatory. If the type is boolean, then the return value is either TRUE or FALSE. Otherwise the value is string or number. Syntax: Function LabelGetVarProperty(LabelID As Long, VarName As String, PropName As String) As String Method: Basic See also: LabelGetVarName, LabelGetVarCount, LabelSetVar LabelOpen Description: Opens an existing label. As a parameter the label file name (LabelName) should be specified. If the label is successfully opened, a label ID is returned, which will later be used in other functions. If it doesn't succeed -1 if is returned. The reason for failure can be obtained from ErrorMessage and DetailedMessage functions. PrinterName is optional parameter, and means that the label will be opened with that printer. Syntax: Function LabelOpen(FileName As String, [PrinterName as String]) As Long Method: Basic See also: LabelClose

LabelOpenEx Description:

26

ActiveX interface

LabelOpenEx method returns the interface of label selected with the filename. For more information about ILGLabel please read ILGLabel chapter. PrinterName is optional parameter, and means that the label will be opened with that printer. Syntax: Function LabelOpenEx(FileName As String, [PrinterName As String]) As ILGLabel Method: Advanced LabelOpenExForPrinter Description: This method is the same as LabelOpenEx just that it opens the label with the specified printer (if the printer does not exist then the label is not opened) Syntax: Function LabelOpenExForPrinter(FileName As String, PrinterName As String) As ILGLabel Method: Advanced LabelOpenForPrinter Description: This method is the same as LabelOpen just that it opens the label with the specified printer (if the printer does not exist then the label is not opened) Syntax: Function LabelOpenForPrinter(FileName As String, PrinterName As String) As Long Method: Basic

LabelPrint Description: This function prints the label with the specified label ID. Quantity must be represented as a string.

27

ActiveX interface

The quantity parameter is the print quantity of the labels; it can be a number, or one of following words: VARIABLE UNLIMITED

The first parameter means printing on the base of the variable quantity (one of the variables sets the quantity), the second one means unlimited printing (printing from the whole database file for example). Skip, Identical and LabelSets are optional parameters. Skip parameter must be provided in order you want to skip a number of labels before printing. Identical parameter defines the amount of identical copies of the label. LabelSets is the number of label sets which you want to print. Syntax: Function LabelPrint(LabelID As Long, Quantity As String, Skip As String, Identical As String, LabelSets As String) As Boolean Example Success = LabelPrint(1, 1) Method: Basic See also: LabelSessionPrint, LabelSessionStart, LabelSessionEnd, LabelSetPrinter

LabelSessionEnd Description: The function ends print session. Syntax: Function LabelSessionEnd(LabelID As Long) As Boolean

See also: LabelSessionStart, LabelSessionPrint, LabelPrint, LabelSetPrinter Method: Basic

28

ActiveX interface

LabelSessionPrint Description: You send the data stream to printer using this function. This function prints the label with the specified label ID. Quantity must be represented as a string. The quantity parameter is the print quantity of the labels; it can be a number, or one of following words: VARIABLE UNLIMITED

The first parameter means printing on the base of the variable quantity (one of the variables sets the quantity), the second one means unlimited printing (printing from the whole database file for example). You can use multiple LabelSessionPrint commands one after another and join them in single data stream. The stream is not closed until the LabelSessionEnd occurs. Syntax: Function LabelSessionPrint(LabelID As Long, Quantity As String) As Boolean

See also: LabelSessionStart, LabelSessionEnd, Labelprint, LabelSetPrinter Method: Basic LabelSessionStart Description: All three functions (LabelSessionStart, LabelSessionPrint, LabelSessionEnd) are used together. If ordinary command LabelSessionPrint is used, every time a complete data stream for printer is sent to printer. If you want to join multiple Print commands into one data stream, you can use the LabelSessionStart command followed with any number of LabelSessionPrint commands and in the end use the LabelSessionEnd command. The stream is not closed until the LabelSessionEnd occurs. These commands offer optimal printing ,because and it is not necessary to generate a complete data stream for each print session. SessionStart method clean label variables. LabelSetVar has to be used after LabelSessionStart method.

Syntax: Function LabelSessionStart(LabelID As Long) As Boolean

29

ActiveX interface

Method: Basic

See also: LabelSessionPrint, LabelSessionEnd, LabelPrint, LabelSetPrinter LabelSetPrinter Description: This function changes the printer on which the label will be printed. Syntax: Function LabelSetPrinter(LabelID As Long, PrinterName As String) As Boolean Method: Basic See also: LabelSessionPrint, LabelSessionEnd, LabelSessionStart, LabelPrint LabelSetPrintJobName Description: Using this function you can set the Print job name that Label Gallery will use at the next print command. After printing the name is returned in normal state. Syntax: Function LabelSetPrintJobName(LabelID As Long, PrinterName As String) As Boolean Method: Basic LabelSetVar Description: The function sets the value of the specified variable. Label ID, variable name and its desired value must be specified. If you want, you can also set the Step and Count options for the automatic incrementing of variable. If you don't want to change that, specify -9999 for Count and Step. Quantity: Function LabelSetVar(LabelID As Long, Name As String, Value As String, Step As Long, Count As Long) As Boolean

30

ActiveX interface

Method: Basic See also: LabelGetvarCount, LabelGetVarName, LabelGetVarProperty

LabelTestConnection Description: With this function you can check the current link between LabelID and name of the loaded label file. In case the OLE connection was broken or Label Gallery application was closed, you can use this function as a tester for OLE server activity. If function returns false, this means that somebody has closed the label file and current LabelID should be discarded. You should also call LabelOpen function again. Syntax: Function LabelTestConnection(LabelID As Long, FileName As String) As Boolean Method: Basic Login Description: Performs login into Label Gallery if it has not been executed already. Syntax: Function Login(UserName As String, Level As Long) As Boolean Method: Basic, Advanced ProcessID Description: Returns the process id of the application (in case user needs to "kill" it) Syntax: Property ProcessID As Long, Access Rights: read-only

read-only

31

ActiveX interface

Method: Basic, Advanced

Quit Description: This procedure closes the Label Gallery if it was opened with the client application. Syntax: Quit Method: Basic, Advanced SetDefaultPrinter Description: This method set the default printer for Label Gallery. Returned result : 1 - the printer could not be set 0 - the printer could be set

Syntax: Function SetDefaultPrinter(DefaultPrinterName As String) As Long Method: Basic, Advanced

32

ActiveX interface

SetApplicationProperty Description: Function enables dialogs to be shown when application is run under system service. Syntax: Function SetApplicationProperty(PropertyName As String, PropertyValue As String) As Long Explanation of the parameters: PropertyName
Name of the property that you want to set, only one property is available at this time: 'ShowDialogsDuringAutomation'

PropertyValue
Value of the property, for the property 'ShowDialogsDuringAutomation' value '1' means that the dialogs will be shown when application is run through ActiveX, any other value means that the dialogs will not be shown

33

ActiveX interface

2.9.2 Hierarchy diagram

The diagram below shows the connection between all interfaces included in lgplus3.olb:
NiceLabel

INiceLabel Objects As IObjectsList

Item As IObject

IBarcode IRectangle IText IParagraph IOLEObject IRTF IGraphics

Variable As IVar Variable As IVar Variable As IVar Variable As IVar Variable As IVar Variable As IVar Variable As IVar

FindByID As IVar

Variables As IVariablesList

FindByName As IVar Item As IVar CreatePrompted As IVar

GlobalVariables As IVariablesList Functions As IFunction List

CreateExternalFunction As IEXTFunction FindByID As IFunction FindByName As IFunction Item As IFunction

Create As IVar

InputVars As IVariableList OutputVars As IVariableList

FindByID As IVar FindByName As IVar Item As IVar CreatePrompted As IVar Create As IVar

Databases As IDatabaseList
FindByID As IDatabase FindByName As IDatabase Item As IDatabase

Fields As IFieldList FindByName As IDBField Item As IDBField Variable As IVar

InputVars As IVariableList OutputVars As IVariableList

FindByID As IVar FindByName As IVar Item As IVar CreatePrompted As IVar Create As IVar

Parameters As IParameterList Item As IParameter Create As IParameter Variable As IVar

Figure 2: ActiveX interface hierarchy

34

ActiveX interface

2.9.3 Class IBarcode (Advanced only)

Methods GetProperty Move Resize SetContents SetVariable Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 Properties AnchorElementID AnchorLevel AnchorPoint AutoCDCalculation BarcodeType Color Contents ContentsMask FormatID HasQuietZone Height ID IncludeCD IsLocked Kind Left MaxLength Name PageNumber PrintAsGraphics ResizeFlag RotateFlag Rotation Selected Status Top Variable Width ZOrder AnchorElementID Description: Version Availability 1,2 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2 1,2,3 1,2,3

35

ActiveX interface

Currently not used. Intended to be used, when position of one element can be dependant on position/size of another element. Syntax: AnchorElementID As Long AnchorLevel Description: Currently not used. Syntax: AnchorLevel As Long AnchorPoint Description: Identifies the point of the object, which is fixed on the label. If the object size is changed, the specified AnchorPoint remains on the same position. Possible values are: Value 0 1 2 3 4 5 6 7 8 Syntax: AnchorPoint As Long See also: Hight, Left, Top, Width Description top left top center top right mid left mid center mid right bottom left bottom center bottom right

36

ActiveX interface

AutoCDCalculation Description: When this property is true, CheckDigit for the barcode is calculated automatically only the contents should be provided. When the property value is false, Label Gallery will verify the contents of the barcode, as the checkdigit is provided together with the data. Syntax: AutoCDCalculation As Boolean See also: IncludeCD BarcodeType Description: Returns the Barcode Type. Possible values are: Value 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 Description EAN13 EAN8 UPC_A UPC_E I2OF5 CODE39 CODE128A CODE128B CODE128C CODABAR CODE128 GS1-128 POSTNET32 POSTNET37 POSTNET52 POSTNET62 BOOKLAND DISTRIBUTION

37

ActiveX interface

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 55 56

CODE93 NG_EAN13 NG_EAN8 PDF417 BC412 DATAMATRIX MAXICODE EAN128 AZTEC QR SSCC MSI CBLOCK_F PHARMACODE EXTCODE39 EAN14 KIX ITF14 2DPHARMACODE CODE32 EAN13+2 EAN13+5 EAN8+2 EAN8+5 UPC_A+2 UPC_A+5 UPC_E+2 UPC_E+5 ITF16 MICROPDF GS1 Databar Addon 2 Addon 5 Code 39 Tri Optik Plessy Anker MicroQR

38

ActiveX interface

60 61 62 63 66 Syntax:

UPC Case Code Dun 14 InfoGlyph UPC E (tip 1) SSCC18

Property BarcodeType As String Access Rights: read-only See also: Color, ContentsMask Color Description: With 32-bit value you can specify any RGB color. The color value has the following hexadecimal form: 0x00bbggrr The low-order byte (rr) contains a value for the relative intensity of red; the second byte (gg) contains a value for green; and the third byte (bb) contains a value for blue. The fourth byte byte must be zero. Each color parameter can range from 0x0 to 0xFF. Syntax: Color As Long See also: BarcodeType, ContentsMask Contents Description: Returns the current contents of the element. Syntax: Property Contents As String

39

ActiveX interface

Access Rights: read-only ContentsMask Description:

Sets and gets the ContentsMask attribute.

Syntax: ContentsMask As String See also: BarcodeType, Color FormatID Description: This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Value 0 1 2 3 4 5 6 7 Description All Numeric Alphanumeric Letters 7 bit Hex Date Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory. Syntax: FormatID As Long GetPropery Description: Returns the property of a barcode.

40

ActiveX interface

Possible names are: IsStructured used for MaxiCode barcode Syntax: Function GetProperty(Name As String) As String HasQuietZone Description: If this property is true, the size of the barcode object is enlarged by the quiet zone. Syntax: HasQuietZone As Boolean Height Description: Height of the element (in 0.01 mm units). Syntax: Property Height As Long Access Rights: read-only See also: AnchorPoint, Left, Top, Width ID Description: ID of the element Syntax: Property ID As Long

IncludeCD Description: For some barcode symbologies, CheckDigit is optional (Code39, I2of5). This property specifies, if checkdigit is to be included in the barcode or not.

41

ActiveX interface

Syntax: IncludeCD As Boolean See also: AutoCDCalculation IsLocked Description: When the elements position is locked on the label, this property has the value TRUE Syntax: IsLocked As Boolean

Kind Description: Element kind. Possible values are: Value 301 302 303 304 305 306 307 308 309 312 313 Syntax: Property Kind As Long Access Rights: Description TextObject RectangleObject BitmapObject BarcodeObject LineObject InverseObject OleObject Downloaded Graphic Object ParagraphObject RTFTextObject EllipseObject

42

ActiveX interface

read-only Left Description: Left position of the element (in 0.01 mm units). Syntax: Property Left As Long Access Rights: read-only See also: Hight, AnchorPoint, Top, Width

MaxLenght Description:

Returns the maximum data length available for this barcode.

Syntax: MaxLenght As Long See also: Name Name Description: Name property represents the name of the barcode. Syntax: Name As String See also: MaxLenght Move Description:

43

ActiveX interface

Move the element to the location X, Y Syntax: Move(X As Long, Y As Long) PageNumber Description: The Page index, where the element is located. When Duplex print is used, this index can have the value 0 (first page) or 1 (second page). When duplex printing is not enabled, this property is ignored (the value should always be 0). Syntax: PageNumber As Long See also: PrintAsGraphics PrintAsGraphics Description: When this property is set to TRUE, the barcode will always be printed as graphics, even if the printer supports printing it with an internal command. Syntax: PrintAsGraphics As Boolean See also: PageNumber Resize Description: Resize the element to the size Width, Height. The element is resized to the closest size in case, that all sizes are not possible. Syntax: Resize(Width As Long, Height As Long) See also: ResizeFlag

44

ActiveX interface

ResizeFlag Description: Flag, which defines, how the object can be resized. Possible values are: Value 0 0x88 0x22 0x55 Syntax: Property ResizeFlag As Long Access Rights: read-only See also: Resize RotateFlag Description: Flag, which defines, how the object can be rotated. Possible values are: Value 0 0x07 0x02 0xFF Syntax: Property RotateFlag As Long Access Rights: read-only See also: Description no rotation 90 degrees rotation 180 degrees rotation 0-360 degrees rotation in steps of 1 degree Description no resizing resizing is possible only in horizontal direction resizing is possible only in vertical direction resizing is possible only in both directions at the same time

45

ActiveX interface

Rotation

Rotation Description: Specifies the elements rotation. When the element can be rotated only in steps of 90 degrees. The valid values for the property are: Value 0 1 2 3 Description 0 deg. 90 deg. 180 deg. 270 deg.

When the element can be rotated in steps of 1 degree, the property has the value from 0 to 359. Syntax: Rotation As Long See also: Rotation Selected Description: When the element is selected, this property is TRUE. Syntax: Selected As Boolean SetContents Description: When the contents of an element should be changed, SetContents method should be called. In case of success (the Value is valid for the element), the function returns 0. In case of an error, the function returns 1. Syntax:

46

ActiveX interface

Function SetContents(Value As String) As Long

SetVariable Description: Connects the element to the variable with ID. If the return value of the function is 1, then some error occured during the connection. The best example for this is that you want connect variable with fixed length to an element which requires different fixed lenght. (EAN13 barcode). In such case element is not connected to any variable it is fixed. Syntax: Function SetVariable(ID As Long) As Long See also: Variable

Status Description: Status of the object. Possible values are : Value 0 1 2 Description OK Error condition Phantom

Syntax: Property Status As Long Access Rights: read-only

Top Description:

47

ActiveX interface

Top position of the element (in 0.01 mm units). Syntax: Property Top As Long Access Rights: read-only See also: Hight, Left, AnchorPoint, Width Variable Description: Returns the interface to the variable, which is attached to the element. Syntax: Property Variable As IVar Access Rights: read-only See also: SetVariable Width Description: Width of the element (in 0.01 mm units). Syntax: Property Width As Long Access Rights: read-only See also: Hight, Left, Top, AnchorPoint ZOrder Description:

48

ActiveX interface

Value of Z order of the object position. When the Zorder value is the highest, the element is placed on the top of all others. Syntax: ZOrder As Long Access Rights: read-only

2.9.4 Class IDatabase (Advanced Only)

Methods SelectRecords Version Availability 2,3 Alias DBPassword Delimiter Description DriverType EPDSConnection Fields ID InputVars IsDelimited IsUsed Kind Name Navigation Order OutputVars Parameters ReviewBeforePrint SelectedRecordCount Separator SQL Table Properties Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3

49

ActiveX interface

Alias Description: Alias represents the name of the alias for the database. See BDE Administrator. Syntax: Alias As String

DBPassword Description: DBPassword property represents the password for the database. Syntax: DBPassword As String

Delimiter Description: With this property you can select the Delimiter character that is used when separator character is used in the text field itself. The delimiter should be used to enclose such field. Text between two delimiter characters is treated as one field although it contains the field separator character. Syntax: Delimiter As String Description: With this property you can select the Separator character that is used for a border between two fields in a text file. Syntax: Separator As String See also: Separator, IsDelimited DriverType Description:

50

ActiveX interface

DriverType is in main driver name. You can find suitable names in BDE Administrator and also in Label Gallery Plus in Database dialog box under the driver selection. Syntax: DriverType As String See also: Name, Table, Order, ReviewBeforePrint EPDSConnection Description: This property is defining the database connection, as is internally used by Label Gallery programs. Syntax: Property EPDSConnection As String

Fields Description: Returns the interface to the fields which are present in the database. Syntax: Property Fields As IFieldList Access Rights: read-only ID Description: ID of the database. Syntax: Property ID As Long Access Rights: read-only

51

ActiveX interface

InputVars Description: Returns the interface to the variable list for input variables. Syntax: Property InputVars As IVariableList Access Rights: read-only See also: OutputVars

IsDelimited Description: If data fields in your text file are separated with some special character, you should set this property to TRUE value. In case that your data fields always occupy the same number of characters this property should be set to FALSE. Syntax: IsDelimited As Boolean See also: Separator, Delimiter

IsUsed Description: If this property is true then this function is used on the label Syntax: IsUsed As Boolean

Kind Description: Kind property for the database is always set to 4.

52

ActiveX interface

Value 1 2 3 4 5 6 7 8 9 10 Syntax:

Description Concatenate Subset Linear Function Database EAN 128 CD Algo Date Addition Euro External SSCC

Property Kind As Long Access Rights: read-only Name Description: In the Name property name of the database is stored. This property can be set in Label Gallery Plus on General tab of Database dialog box. Syntax: Name As String See also: DriverType, Table, Order, ReviewBeforePrint

Navigation Description: Navigation property represents how record retrieving will be set for selected database access. Possible values for the Navigation property are: Value Description

53

ActiveX interface

0 1 2 3

First Select All Last

Syntax: Navigation As Long See also: SelectRecords, SelectRecordsCount Order Description: Order property represents the name of the field which is used for sorting records. Syntax: Order As String See also: Name, Table, DriverType, ReviewBeforePrint OutputVars Description: Returns the interface to the variable list for output variables. Syntax: Property OutputVars As IVariableList Access Rights: read-only See also: InputVars Parameters Description: Returns the interface to the parameters (filters) which are present in the database.

54

ActiveX interface

Syntax: Property Parameters As IParameterList Access Rights: read-only See also: SQL

ReviewBeforePrint Description: ReviewBeforePrint property's value is TRUE, if ReviewBeforePrint option is enabled in Database Access definition. This option makes it possible to change the result of a function just before using its results on the label. Syntax: ReviewBeforePrint As Boolean See also: Name, Table, Order, DriverType SelectRecords Description: Execute this method if you would like to show Label Gallerys Record Selection dialog box, where the user has possibility to select which records from the database will be printed. Parent parameter, which must be passed to the SelectRecords function is a handle to the parent window on which the Record Selection dialog box will appear. Syntax: Function SelectRecords(Parent As Long) As Long Access Rights: read-only See also: Navigation, SelectRecordsCount

55

ActiveX interface

SelectedRecordCount Description: Returns the number of selected records for the database, which is associated with this IDatabase interface. If no records are selected or database connection does not exists the property contains - 1 Syntax: Property SelectedRecordCount As Long Access Rights: read-only See also: SelectRecords, Navigation Separator Description: With this property you can select the Separator character that is used for a border between two fields in a text file. Syntax: Separator As String See also: IsDelimited, Delimiter SQL Description: With SQL property you can select SQL statements for the database. Changing SQL statements can lead to failure in reading data from table. Syntax: SQL As String Access Rights: read-only See also: Parameters

56

ActiveX interface

Table Description: Table property represents the name of the table, which is used on this database access. Syntax: Table As String See also: Name, DriverType, Order, ReviewBeforePrint

2.9.5 Class IDatabaseList (Advanced Only)

Methods Item FindByID FindByName Count Description: Count property returnts the number of databases connected to the label. Syntax: Property Count As Long Access Rights: read-only Item Description: Returns the interface to the database. Database is selected with Index. Syntax: Function Item(Index As Long) As IDatabase Version Availability 1,2,3 1,2,3 1,2,3 Count Properties Version Availability 1,2,3

57

ActiveX interface

FindByName Description: Returns the interface to the database. Database is selected with the name of the database. Syntax: Function FindByName(Name As String) As IDatabase See also: FindByID FindByID Description: Returns the interface to the database. Database is selected with database ID. Syntax: Function FindByID(ID As Long) As IDatabase See also: FindByname

2.9.6 Class IDBDef

Methods Version Availability Alias DBPassword Delimiter DriverType IsDelimited Separator Alias Description: Alias represents the name of the alias for the database. See BDE Administrator. Syntax: Alias As String Properties Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

58

ActiveX interface

DBPassword Description: DBPassword property represents the password for the database. Syntax: DBPassword As String Delimiter Description: Property for setting or retrieving the delimiter char that is used in the text database. Syntax: Delimiter As String

DriverType Description: DriverType is in main driver name. You can find suitable names in BDE Administrator and also in Label Gallery Plus in Database dialog box under the driver selection. Syntax: DriverType As String IsDelimited Description: If data fields in your text file are separated with some special character, you should set this property to TRUE value. In case that your data fields always occupy the same number of characters this property should be set to FALSE. Syntax: IsDelimited As Boolean See also: Separator

59

ActiveX interface

Separator Description: With this property you can select the Separator character that is used for a border between two fields in a text file. Syntax: Separator As String See also: IsDelimited

2.9.7 Class IDBField

Methods <none> Version Availability Length Name Number Offset Variable IsSelected Description: When the field is selected for usage on the label, this property is TRUE. Syntax: Property IsSelected As Boolean Access Rights: read-only Length Description: Length property represents the length of the field. Syntax: Property Length As Long Properties IsSelected Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

60

ActiveX interface

Access Rights: read-only Name Description: Name property represents the name of the field. Syntax: Property Name As String Access Rights: read-only Number Description: Number property represents the number of the field. Syntax: Property Number As Long Access Rights: read-only Offset Description: Offset property represents the offset of the beggining of the line. This property is available only for text files. Syntax: Property Offset As Long Access Rights: read-only Variable Description: Returns the interface to the variable, which is connected with the database field. Syntax:

61

ActiveX interface

Property Variable As IVar Access Rights: read-only

2.9.8 Class IDBParameter (Advanced Only)

Methods SetVariable Version Availability 1,2,3 Field Relation Variable Field Description: Field property represents the name of the field which is used for filter. Syntax: Field As String Relation Description: Relation property represents relation between field and a variable. Possible values for Relation are: Value 0 1 2 3 4 5 6 Description == > >= < <= <> LIKE Properties Version Availability 1,2,3 1,2,3 1,2,3

Syntax: Relation As Long

62

ActiveX interface

SetVariable Description: Connects the element to the variable with ID. If the return value of the function is 1, then some error occured during the connection. The best example for this is that you want connect variable with fixed length to an element which requires different fixed lenght. (EAN13 barcode). In such case element is not connected to any variable it is fixed. Syntax: Function SetVariable(ID As Long) As Long See also: Variable Variable Description: Returns the interface to the variable, which is connected with the database field. Syntax: Property Variable As IVar Access Rights: read-only See also: SetVariable

2.9.9 Class IEXTFunction (Advanced Only)

Methods Version Availability Properties Definition Description ID InputVars IsContentsProvider IsUsed Kind Name Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3

63

ActiveX interface

OutputVars ProviderName ReviewBeforePrint Definition Description:

1,2,3 2,3 1,2,3

Definition property represents a string, which consists a definiton for the function. Because of proper initialization of the label, this string is saved in a label file. Syntax: Definition As String Description Description: In the Description property description of the function is stored. Syntax: Description As String See also: Name, ReviewBeforePrint

ID Description: ID of the element Syntax: Property ID As Long

InputVars Description: Returns the interface to the variable list for input variables. Syntax: Property InputVars As IVariableList

64

ActiveX interface

Access Rights: read-only IsContentsProvider Description: If the function is contents provider for the element, then ISContentsProvider property has value TRUE. Syntax: Property IsContentsProvider As Boolean Access Rights: read-only ProviderName IsUsed Description: If this property is true then this function is used on the label Syntax: Property IsUsed As Boolean Access Rights: read-only ProviderName

Kind Description: This property represents the value for the type of the function. Possible values are: Value 1 2 3 4 5 Description Concatenate Subset Linear Function Database EAN 128

65

ActiveX interface

6 7 8 9 10

CD Algo Date Addition Euro External SSCC

Syntax: Property Kind As Long Acces Rights: read-only Name Description: Name property represents the name of the function. Syntax: Name As String See also: Description, ReviewBeforePrint OutputVars Description: Returns the interface to the variable list for output variables. Syntax: Property OutputVars As IVariableList Access Rights: read-only ProviderName Description: ProviderName represents the name of the component, which manage the execution and definition of the content's provider. Syntax:

66

ActiveX interface

Property ProviderName As String Access Rights: read-only See also: IsContentsProvider ReviewBeforePrint Description: ReviewBeforePrint property's value is TRUE, if ReviewBeforePrint option is enabled in function definition. This option makes it possible to change the result of a function just before using its results on the label. Syntax: ReviewBeforePrint As Boolean Access Rights: read-only See also: Name, Description

2.9.10 Class IFieldList (Advanced Only)

Methods FindByName Item Count Description: Count property returns the number of fields, which are defined in the database. Syntax: Property Count As Long Access Rights: read-only Version Availability 1,2,3 1,2,3 Count Properties Version Availability 1,2,3

67

ActiveX interface

FindByName Description: Returns the interface to the field. Field is selected with the name of the field. Syntax: Function FindByName(Name As String) As IDBField Item Description: Returns the interface to the field of the database. Field is selected with Index. Syntax: Function Item(Index As Long) As IDBField

2.9.11 Class IFunction (Advanced Only)

Methods Version Availability 2,3 ID InputVars Kind Name OutputVars ReviewBeforePrint Description Description: In the Description property description of the function is stored. Syntax: Description As String See also: Name, ReviewBeforePrint Properties Description Version Availability 1,2,3 1,2,3 1,2,3 1,2 1,2 1,2 1,2

68

ActiveX interface

ID Description: ID of the element Syntax: Property ID As Long Access Rights: read-only InputVars Description: Returns the interface to the variable list for input variables. Syntax: Property InputVars As IVariableList Access Rights: read-only Kind Description: This property represents the value for the type of the function. Possible values are: Value 1 2 3 4 5 6 7 8 9 10 Description Concatenate Subset Linear Function Database EAN 128 CD Algo Date Addition Euro External SSCC

69

ActiveX interface

Syntax: Property Kind As Long Acces Rights: read-only Name Description: Name property represents the name of the function. Syntax: Name As String See also: Description, ReviewBeforePrint

OutputVars Description: Returns the interface to the variable list for output variables. Syntax: Property OutputVars As IVariableList Access Rights: read-only

ReviewBeforePrint Description: ReviewBeforePrint property's value is TRUE, if ReviewBeforePrint option is enabled in function definition. This option makes it possible to change the result of a function just before using its results on the label. Syntax: ReviewBeforePrint As Boolean See also: Name, Description

70

ActiveX interface

2.9.12 Class IFunctionList (Advanced Only)

Methods CreateExternalFunction FindByID FindByName Item Count Description: Count property returns the number of functions, which are defined on the label. Syntax: Property Count As Long Access Rights: read-only CreateExternalFunction Description: This method creates an external function. Output is an interface to the new function. Syntax: Function CreateExternalFunction() As IExtFunction FindByID Description: Returns the interface to the function. Function is selected with the ID of the function. Syntax: Function FindByID(ID As Long) As IFunction See also: FindByName FindByName Description: Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 Count Properties Version Availability 1,2,3

71

ActiveX interface

Returns the interface to the function. Function is selected with the name of the function. Syntax: Function FindByName(Name As String) As IFunction See also: FindByID Item Description: Returns the interface to the function. Function is selected with Index. Syntax: Function Item(Index As Long) As IFunction

2.9.13 Class IGraphics (Advanced Only)

Methods Load Move Resize SetVariable Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 Properties AnchorElementID AnchorLevel AnchorPoint FileName FormatID Height HorzMirror ID ImageType IsLocked Kind Left Name OnMemoryCard PageNumber ResizeFlag ResizeMode RotateFlag Rotation Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

72

ActiveX interface

Selected Status Top Variable VertMirror Width ZOrder AnchorElementID Description: Currently not used. Intended to be used, when position of one element can be dependant on position/size of another element. Syntax: AnchorElementID As Long AnchorLevel Description: Currently not used. Syntax: AnchorLevel As Long AnchorPoint Description: Identifies the point of the object, which is fixed on the label. If the object size is changed, the specified AnchorPoint remains on the same position. Possible values: Value 0 1 2 3 4 5 Description top left top center top right mid left mid center mid right

1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

73

ActiveX interface

6 7 8 Syntax:

bottom left bottom center bottom right

AnchorPoint As Long See also: Hight, Left, Top, Width FileName Description: FileName property represents the file name of the graphics file. Syntax: Property FileName As String Access Rights: read-only FormatID Description: This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Value 0 1 2 3 4 5 6 7 Description All Numeric Alphanumeric Letters 7 bit Hex Date Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory.

74

ActiveX interface

Syntax: FormatID As Long Height Description: Height of the element (in 0.01 mm units). Syntax: Property Height As Long Access Rights: read-only See also: Left, AnchorPoint, Top, Width HorzMirror Description: In case that HorzMirror property has value TRUE picture is mirrored horizontally. In the other case picture remains unmirrored. Syntax: HorzMirror As Boolean See also: VertMirror ID Description: ID of the element Syntax: Property ID As Long Access Rights: read-only ImageType Description:

75

ActiveX interface

The method returns the type of the graphics (0 , GF_UNKNOWN 1, GF_DIB - device independant bitmap 2, GF_METAFILE - metafile 3, GF_IMK - memory card picture 4, GF_E_METAFILE - enhanced metafile ) Syntax: Property ImageType As Long Access Rights: read-only IsLocked Description: When the elements position is locked on the label, this property has the value TRUE Syntax: IsLocked As Boolean Kind Description: Element kind. Possible values are: Value 301 302 303 304 305 306 307 308 309 312 313 Description TextObject RectangleObject BitmapObject BarcodeObject LineObject InverseObject OleObject Downloaded Graphic Object ParagraphObject RTFTextObject EllipseObject

76

ActiveX interface

Syntax: Property Kind As Long Access Rights: read-only Left Description: Left position of the element (in 0.01 mm units). Syntax: Property Left As Long Access Rights: read-only See also: Hight, AnchorPoint, Top, Width Load Description: With Load method you can load the graphics. Filename is used for setting the file name of the graphics file. Syntax: Function Load(FileName As String) As Long

Move Description: Move the element to the location X, Y Syntax: Move(X As Long, Y As Long)

Name Description: Name property represents the name of the graphics.

77

ActiveX interface

Syntax: Name As String OnMemoryCard Description: In case that graphics is stored on a memory card then OnMemoryCard propery has value TRUE. Syntax: OnMemoryCard As Boolean PageNumber Description: The Page index, where the element is located. When Duplex print is used, this index can have the value 0 (first page) or 1 (second page). When duplex printing is not enabled, this property is ignored (the value should always be 0). Syntax: PageNumber As Long ResizeFlag Description: Flag, which defines, how the object can be resized. Possible values are: Value 0 0x88 0x22 0x55 Syntax: Property ResizeFlag As Long Access Rights: read-only Description no resizing resizing is possible only in horizontal direction resizing is possible only in vertical direction resizing is possible only in both directions at the same time

78

ActiveX interface

ResizeMode Description: With ResizeMode it is possible to set the way of resizing the graphics. Possible values for ResizeMode are: Value 0 1 2 Syntax: ResizeMode As Long RotateFlag Description: Flag, which defines, how the object can be rotated. Possible values are: Value 0 0x07 0x02 0xFF Syntax: Property RotateFlag As Long Access Rights: read-only See also: Rotation Rotation Description: Specifies the elements rotation. When the element can be rotated only in steps of 90 degrees. Description no rotation 90 degrees rotation 180 degrees rotation 0-360 degrees rotation in steps of 1 degree Description Original si1ze Proportional resize Fit to size.

79

ActiveX interface

The valid values for the property are: Value 0 1 2 3 Description 0 deg. 90 deg. 180 deg. 270 deg.

When the element can be rotated in steps of 1 degree, the property has the value from 0 to 359. Syntax: Rotation As Long See also: RotateFlag Selected Description: When the element is selected, this property is TRUE. Syntax: Selected As Boolean SetVariable Description: Connects the element to the variable with ID. If the return value of the function is 1, then some error occured during the connection. The best example for this is that you want connect variable with fixed length to an element which requires different fixed lenght. (EAN13 barcode). In such case element is not connected to any variable it is fixed. Syntax: Function SetVariable(ID As Long) As Long See also: Variable

80

ActiveX interface

Status Description: Status of the object. Possible values are : Value 0 1 2 Description OK Error condition Phantom

Syntax: Property Status As Long Access Rights: read-only Top Description: Top position of the element (in 0.01 mm units). Syntax: Property Top As Long Access Rights: read-only See also: Hight, AnchorPoint, Left, Width

Variable Description: Returns the interface to the variable, which is connected with the database field. Syntax: Property Variable As IVar

81

ActiveX interface

Access Rights: read-only See also: SetVariable VertMirror Description: In case that VertMirror property has value TRUE picture is mirrored vertically. In the other case picture remains unmirrored. Syntax: VertMirror As Boolean See also: HorzMirror Width Description: Width of the element (in 0.01 mm units). Syntax: Property Width As Long Access Rights: read-only See also: Hight, AnchorPoint, Top, Left ZOrder Description: Value of Z order of the object position. When the Zorder value is the highest, the element is placed on the top of all others. Syntax: ZOrder As Long

2.9.14 Class ILabel (Advanced Only)

82

ActiveX interface

Methods DatabaseProperties DeleteDatabase DeleteFunction DeleteObject DeleteVariable DownloadVariablesList DownloadToPrinter ExportToPrinter FunctionProperties GetDownloadLocations List GetDownloadLocations ListForPrinter GeneralExport GetCurrentState GetDependantFilesList GetLabelPreviewEx GetPrinterDarknessList GetPrintParamEx GetPrintParamList GetPrinterSpeedList GetPrinterSpeedUnit GetPrintParam NewDatabase NewDatabaseWiz NewFunction NewVariable NewVariableWiz ObjectProperties PrintAndGetJobID SelectDatabase SelectVariable SetDirty SetPrintJobName SetPrintParam

Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 3 3 2,3 1,2,3 3 3 2,3 2,3 1,2,3 1,2,3 1,2,3 3 3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 5 1,2,3 1,2,3 2,3 2,3 1,2,3

Properties AspectRatio CurrUnit Databases Functions GlobalVariables IsLabelReadOnly IsLinkedToStock IsStoreRecallPrintingAv ailable IsStoreRecallSupported LabelSettings LastRevisionID Objects PrinterName PrinterPort PrintType ResX ResY StockName StockType SynchronizedPrinting Variables

Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 3 3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 3 1,2,3 1,2,3 1,2,3 3 1,2,3 1,2,3

83

ActiveX interface

VariableProperties AspectRatio Description:

1,2,3

AspectRatio is a Boolean property which returns TRUE if aspect ratio is used otherwise FALSE is returned. Syntax: AspectRatio As Boolean

CurrUnit Description: CurrUnit represent the current measurement unit used in the label. Possible values for are: Value 0 1 2 3 Syntax: Property CurrUnit As Long Access Rights: read-only DatabaseProperties Description: DatabaseProperties method opens a dialog box with properties for the database selected with ID. Syntax: Function DatabaseProperties(ID As Long) As Boolean See also: Databases, Deletedatabase, NewDatabase, NewDatabaseWiz, SelectDatabase Description Cm Inch Dot Mm

84

ActiveX interface

Databases Description: Returns the interface to the database list. Syntax: Property Databases As IDatabaseList Access Rights: read-only See also: DatabaseProperties, Deletedatabase, NewDatabase, NewDatabaseWiz, SelectDatabase DeleteDatabase Description: DeleteDatabase method deletes a database connection from the label. In case of success method returns value TRUE. Syntax: Function DeleteDatabase(ID As Long) As Boolean Avaliabilty: Label Gallery Plus only See also: DatabaseProperties, DataBases, NewDatabase, NewDatabaseWiz, SelectDatabase DeleteFunction Description: DeleteFunction method deletes a function from the label. In case of success method returns value TRUE. Syntax: Function DeleteFunction(ID As Long) As Boolean Avaliabilty: Label Gallery Plus only

85

ActiveX interface

See also: Functions, FunctionProperties DeleteObject Description: DeleteObject method deletes an object from the label. In case of success method returns value TRUE. Syntax: Function DeleteObject(ID As Long) As Boolean Avaliabilty: Label Gallery Plus only See also: Objects, ObjectProperties DeleteVariable Description: DeleteVariable method deletes a variable from the label. In case of success method returns value TRUE. Syntax: Function DeleteVariable(ID As Long) As Boolean Avaliabilty: Label Gallery Plus only DownloadVariablesList Description: This method is set a list of variables whose value must be set if we wish to call any export or Store to printer. If this is not done Export or Store to printer will fail. Syntax: Function DownloadVariablesList() As IVariableList Avaliabilty: Label Gallery Plus only

86

ActiveX interface

DownloadToPrinter Description: This method store label to printer. It is essential that we set all the variables in the list using DownloadVariablesList method or method will fail. Syntax: Function DownloadToPrinter() As Boolean Avaliabilty: Label Gallery Plus only ExportToPrinter Description: Use ExportToPrinter function when you want export the label directly to the printer or to a file. When ExportFile parameter is blank exporting is done directly to the printer otherwise it is done to the file. With CreateLVR parameter you are defining whether you want export also the LVR file, which contains the descriptions of the variables. The ExportVariant defines how it is exported. This parameter depends on the printer (Default = 1, other values represent for example: export to RAM, export to Flash, export to PCMCIA, ...) Syntax: Function ExportToPrinter(ExportVariant As Long, ExportFile As String, CreateLVR As Boolean) As Boolean Functions Description: Returns the interface to the function list. Syntax: Property Functions As IFunctionList Access Rights: read-only See also: DeleteFunctions, FunctionProperties FunctionProperties Description:

87

ActiveX interface

FunctionProperties method opens a dialog box with properties for the function selected with ID. Syntax: Function FunctionProperties(ID As Long) As Boolean See also: DeleteFunctions, Functions GetDownloadLocationsList Description: Returns available slot names for recall printing. Current printer name of the selected label is used. Syntax: Function GetDownloadLocationsList() As String GetDownloadLocationsListForPrinter Description: Returns available slot names for recall printing. PrinterName is used as printer name Syntax: Function GetDownloadLocationsListForPrinter(PrinterName As String) As String

General Export Description: Performs export of the current label to the ExportDir folder Syntax:
Function GeneralExport(ExportDir As String) As Boolean

GetCurrentState Description: Use GetCurrentState function when you want to get the state of Label Gallery. Return result can be of the following: 1 - printing 2 - print preview

88

ActiveX interface

0 - other (label design) This method is especially useful for VBScript actions, where the code can check current state and do some actions only in certain modes (printing for example) Syntax: Function GetCurrentState() As Long

GetDependantFilesList Description: GetDependantFilesList function returns you the list of files, which are in use with opened file.

As ListType you can set , which types of the file you wish to get. Below you can find all possible ListType parameters: ListType = 0 ListType = 1 ListType = 2 ListType = 3 All files GalleryForm files Graphics files only Database files only

Returned string is a comma delimited string. This means that in one string there are names of all files in use. Return result is like this:
C:\program files\EuroPlus\formsample1.off, C:\program files\EuroPlus\formsample2.off

Syntax: Function GetDependantFilesList(ListType As Long) As String GetLabelPreviewEx Description: Use this function to generate the preview of the label. With this function it is possible to create label previews for the header and tail labels also. Also two sided labels are supported. The extension of the FileName parameter defines in which format the preview will be stored. Possible formats are BMP, JPG, PNG and GIF.

89

ActiveX interface

Based on the parameters suitable preview is generated. Syntax: Function GetLabelPreviewEx(FileName As String, Width As Long, Height As Long, LabelKind As Long, LabelSide As Long, HasBorder As Boolean) As Boolean Explanation of the parameters: FileName Represents the file name. Width Width of picture in pixels. Height Height of picture in pixels. LabelKind With this parameter you specify which kind of label you want to preview. Possible values are 0, 1 and 2. 0 means header label, 1 means normal label and 1 means footer label. LabelSide With this parameter you specify which side of label you want to preview. Possible values are 0 and 1. 0 means front side of the label and 2 means the back side of the label. HasBorder If you specify this parameter the preview will have a border around the preview. GetPrinterDarknestList Description: This function returns the available darkness for the printer. The name of the printer must be provided as a parameter. Syntax: Function GetPrinterDarknessList(PrinterName As String) As String See also: GetPrinterSpeedList, GetPrinterSpeedUnit, GetPrintParam, PrinterName, PrinterPort

90

ActiveX interface

GetPrinterParamEX Description: This function retrieve the value of printing parameter. Explanation of the parameters: PrinterName Defines for which printer you want to retrieve the parameter, blank value means that default printer will be taken. ParamName Defines which parameter should be retrieved : PRINTSPEED speed parameter as string value PRINTDARKNESS - darkness parameter as string value PRINTROTATION - rotation parameter as string value PRINTDARKNESS1, PRINTDARKNESS2, PRINTDARKNESS3, PRINTDARKNESS4, PRINTDARKNESS5 - darkness on specific print head on the printer with multiple print heads NUMBER_OF_FRONT_PAGE_COLORS - number of colors for the specified page side for the printers with multiple print heads NUMBER_OF_BACK_PAGE_COLORS - number of colors for the specified page side for the printers with multiple print heads

Syntax: Function GetPrintParamEx(PrinterName As String, ParamName As String) As String See also: GetPrinterSpeedList, GetPrinterSpeedUnit, GetPrintParam, PrinterName, PrinterPort GetPrinterParamList Description: This method returns comma separated list of values/names for specified ParamName and specified PrinterName and the data you desire Explanation of the parameters: PrinterName Defines for which printer you want to retrieve the parameter, blank value means that default printer will be taken. ParamName

91

ActiveX interface

It can be one of : PRINTSPEED speed parameter as string value PRINTDARKNESS - darkness parameter as string value PRINTROTATION - rotation parameter as string value PRINTDARKNESS1, PRINTDARKNESS2, PRINTDARKNESS3, PRINTDARKNESS4, PRINTDARKNESS5 - darkness on specific print head on the printer with multiple print heads FRONT_PAGE_COLOR_LIST - comma separated list of color values
represented in integers(COLORREF) BACK_PAGE_COLOR_LIST - comma separated list of color values represented in integers(COLORREF)

DataType
Parameter is used for parameters PRINTSPEED, PRINTDARKNESS, PRINTDARKNESS1, PRINTDARKNESS2, PRINTDARKNESS3, PRINTDARKNESS4, PRINTDARKNESS5 and it means whether you want to retrieve values list or names list for the specified parameter. Values are actual values for the speed/darkness while names are string representations for those items (for example you use names when displaying this data to user)

Syntax: Function GetPrintParamList(PrinterName As String, ParamName As String, DataType As Long) As String See also: GetPrinterSpeedList, GetPrinterSpeedUnit, GetPrintParam, PrinterName, PrinterPort GetPrinterSpeedList Description: This function returns the available speeds for the printer. The name of the printer must be provided as a parameter. Syntax: Function GetPrinterSpeedList(PrinterName As String) As String See also: GetPrinterDarknessList, GetPrinterSpeedUnit, GetPrintParam, PrinterName, PrinterPort GetPrinterSpeedUnit Description:

92

ActiveX interface

This function returns the available speed units for the printer. The name of the printer must be provided as a parameter. Syntax: Function GetPrinterSpeedUnit(PrinterName As String) As String See also: GetPrinterDarknessList, GetPrinterSpeedList, GetPrintParam, PrinterName, PrinterPort GetPrintParam Description: GetPrintParam function returns the value for provided printing parameter. Possible values for Name parameter are: PRINTSPEED Function will return the speed parameter as string value. PRINTDARKNESS Function will return the darkness parameter as string value. Syntax: Function GetPrintParam(Name As String) As String See also: GetPrinterDarknessList, GetPrinterSpeedList, Get PrinterSpeedUnit, PrinterName, PrinterPort GlobalVariables Description: Returns the interface to the variable list for global variables. Syntax: Property GlobalVariables As IVariableList Access Rights: read-only IsLabelReadOnly Description: IsLabelReadOnly property returns TRUE if label is opened in read only mode, otherwise return value is FALSE.

93

ActiveX interface

Syntax: Property IsLabelReadOnly As Boolean Access Rights: read-only IsLinkedToStock Description: IsLinkedToStock property returns TRUE if label is linked with some stock or FALSE if none of the stocks are used. Syntax: Property IsLinkedToStock As Boolean Access Rights: read-only

IsStoreRecallPrintingAvailable Description: If store recall printing is avaliable value of the IsStoreRecallPrintingAvaliable property is TRUE. Syntax: Property IsStoreRecallPrintingAvailable As Boolean Access Rights: read-only

IsStoreRecallSupported Description: If current printer supports store/recall value of the IsStoreRecallSupported property is TRUE. Syntax: Property IsStoreRecallSupported As Boolean Access Rights: read-only

94

ActiveX interface

LabelSettings Description: Returns an interface to IlabelSettings class. See more in the Ilabel Chapter. Syntax: Property LabelSettings As ILabelSettings Access Rights: read-only

LastRevisionID Description: Returns the ID of the last revision, which was made to the label. Syntax: Property LastRevisionID As Long Access Rights: read-only NewDatabase Description: This method creates a new database access on the label. Syntax: Function NewDatabase() As Boolean See also: DatabaseProperties, DataBases, DeleteDatabases, NewDatabaseWiz, SelectDatabase NewDatabaseWiz Description: NewDatabaseWiz method opens Database Wizard. In case of success method returns value TRUE.

95

ActiveX interface

Syntax: Function NewDatabaseWiz() As Boolean See also: DatabaseProperties, DataBases, DeleteDatabases, NewDatabase, SelectDatabase NewFunction Description: This method creates a new function on the label. Syntax: Function NewFunction() As Boolean NewVariable Description: This method creates a new variable on the label. Syntax: Function NewVariable() As Boolean See also: NewVariableWiz, Variables, VariableProperties NewVariableWiz Description: NewVariableWiz method opens Variable Wizard. In case of success method returns value TRUE. Syntax: Function NewVariableWiz() As Boolean See also: NewVariable, Variables, VariableProperties Objects Description: Returns the interface to the object list. Syntax:

96

ActiveX interface

Property Objects As IObjectList Access Rights: read-only See also: DeleteObjects, ObjectProperties ObjectProperties Description: ObjectProperties method opens a dialog box with properties for the object selected with ID. Syntax: Function ObjectProperties(ID As Long) As Boolean See also: Objects, DeleteObject PrintAndGetJobID Description: When printing from Label Gallery user can retrieve an exact status of the print job. Parameter Quantity : Specifies the quantity that should be used when printing AdditionalParam: Reserved for future use, must be Return Value : Job ID of the print Job. In case of error, return value can contain the following strings: Logging Disabled - Logging is not enabled, retrieving of ID not possible. Print Failed - Print Job failed to print. Syntax: Function PrintAndGetJobID(Quantity As String, AdditionalParams As String) As String

PrinterName Description: PrinterName represents the name of the printer to which label will be printed. Syntax: PrinterName As String See also:

97

ActiveX interface

GetPrinterDarknessList, GetPrinterSpeedList, GetPrintParam, PrinterPort, GetPrintParam PrinterPort Description: Command PrinterPort allows you to set different printer port than specified in the label file. Syntax: PrinterPort As String Access Rights: read-write See also: GetPrinterDarknessList, GetPrinterSpeedList, GetPrintParam, PrinterName, GetPrintParam PrintType Description: Label mode can be obtained by calling PrintType property O = PRINT_TYPE_NORMAL 1 = PRINT_TYPE_RECALL Syntax: PrintType As Long Access Rights: read ResX Description: Returns the current printer resolution in horizontal direction. Result is in DPI. Syntax: Property ResX As Long Access Rights: read-only

98

ActiveX interface

See also: ResY ResY Description: Returns the current printer resolution in vertical direction. Result is in DPI. Syntax: Property ResY As Long Access Rights: read-only See also: ResX SelectDatabase Description: SelectDatabase method selects a database on the label. In case of success method returns value TRUE. Syntax: Function SelectDatabase(ID As Long) As Boolean See also: DatabaseProperties, DataBases, DeleteDatabases, NewDatabase, NewDatabaseWiz SelectVariable Description: SelectVariable method selects a variable on the label. In case of success method returns value TRUE. Syntax: Function SelectVariable(ID As Long) As Boolean SetDirty Description: With this method you can set the dirty flag of the label document to true, if you do this

99

ActiveX interface

means that the label has been modifed and the user will be prompted to save the label when he will try to close the label Syntax: Function SetDirty(flag As Boolean)

SetPrintJobName Description: The ILGLabel interface is extended to support setting the PrintJobName for next print command. The command is defined as: Parameter JobName must contain the name of the print job. function returns true if successful. The parameter set is used only for the first print command. After that it is reset to use default print job names. Application should set the print job name each time before executing print commands. SetPrintParam Description: With SetPrintParam function it is possible to set the following printing parameters: SPEED Name parameter : PRINTSPEED DARKNESS Name parameter : PRINTDARKNESS PAPERBIN Name parameter : PAPERBIN PRINTROTATION Name parameter : PRINTROTATION Value : 0 - no rotation Value : 1 - 180 rotation

The name of the printing parameter should be stored in the functions Name parameter and the value of the parameter in the Value parameter. Both parameters should be represented as a string. If function is able to set the required printing parameters, the return value will be TRUE otherwise something was wrong and the return result will be FALSE. Syntax: Function SetPrintParam(Name As String, Value As String) As Boolean StockName Description:

100

ActiveX interface

Returns the name of the stock, which is used on the label. Syntax: Property StockName As String Access Rights: read-only See also: StockType StockType Description: Returns the type of the stock, which is used on the label. Syntax: Property StockType As String Access Rights: read-only See also: StockName SynchronizedPrinting Description: This property defines wether the synchronized printing should be used or not. If you try to set this property to true when the current printer does not support this then the property will be false and error will be set in NiceLabel. Syntax: Property SynchronizedPrinting As Boolean Variables Description: Returns the interface to the variable list for input variables. Syntax: Property Variables As IVariableList Access Rights:

101

ActiveX interface

read-only See also: NewVariable, NewVariableWiz, VariableProperties UpdateVariableData Description: UpdateVariableData method change global variable setup. Syntax: VariableProperties Description: VariableProperties method opens a dialog box with properties for the variable selected with ID. Syntax: Function VariableProperties(ID As Long) As Boolean See also: NewVariable, NewVariableWiz, Variables

2.9.15 Class ILGLabel (Advanced Only)

Methods CustomExport DatabaseProperties DeleteDatabase DeleteFunction DeleteObject DeleteVariable DownloadVariablesList DownloadToPrinter ExecuteMacro ExportToPocket ExportToPrinter Version Availability 3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 3 3 1,2,3 1,2,3 1,2,3 Properties Application CurrUnit Databases Functions GlobalVariables IsLabelReadOnly IsLinkedToStock IsStoreRecallPrintingAv ailable IsStoreRecallSupported LabelFileName LabelSettings Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 3 3 1,2,3 1,2,3

102

ActiveX interface

FunctionProperties GeneralExportEX GeneralExport GetCurrentState GetDependantFilesList GetDownloadLocations List GetDownloadLocations ListForPrinter GetLabelPreview GetLabelPreviewEx GetPrintParam GetPrintParamEx GetPrintParamList NewDatabase NewDatabaseWiz NewFunction NewVariable NewVariableWiz ObjectProperties Print PrintAndGetJobID Save SelectDatabase SelectVariable SessionEnd SessionPrint SessionStart SetDirty SetObjectVisible SetPrintJobName SetPrintParam VariableProperties Application Description:

1,2,3 3 1,2,3 2,3 1,2,3 3 3 1,2,3 2,3 1,2,3 3 3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 5 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 3 2,3 1,2,3 1,2,3

LastRevisionID Objects PrinterName PrinterPort PrintType StockName StockType SynchronizedPrinting Variables

1,2,3 1,2,3 1,2,3 1,2,3 3 1,2,3 1,2,3 3 1,2,3

Application method returns an interface to the LGApp.

103

ActiveX interface

Syntax: Property Application As LGLabel Access Rights: read-only CustomExport Description: This method enables label export using custom export definition. Definition has to be previous defined via Export Print system menu Syntax: Function CustomExport(ExportName As String, ExportDir As String) As Boolean Explanation of the parameters: ExportName custom export definition name ExportDir folder path of the exported file

CurrUnit Description: CurrUnit represent the current measurement unit used in the label. Possible values are: Value 0 1 2 3 Description Cm Inch Dot Mm

Syntax: Property CurrUnit As Long Access Rights: read-only

104

ActiveX interface

Databases Description: Returns the interface to the database list. Syntax: Property Databases As IDatabaseList Access Rights: read-only See also: DatabaseProperties, DeleteDatabase, NewDatabase, NewDatabaseWiz, SelectDatabase DatabaseProperties Description: DatabaseProperties method opens a dialog box with properties for the database selected with ID. Syntax: Function DatabaseProperties(ID As Long) As Boolean See also: Databases, DeleteDatabase, NewDatabase, NewDatabaseWiz, SelectDatabase DeleteDatabase Description: DeleteDatabase method deletes a database connection from the label. In case of success method returns value TRUE. Syntax: Function DeleteDatabase(ID As Long) As Boolean Avaliabilty: Label Gallery Plus only See also: Databases, DatabaseProperties, NewDatabase, NewDatabaseWiz, SelectDatabase

105

ActiveX interface

DeleteFunction Description: DeleteFunction method deletes a function from the label. In case of success method returns value TRUE. Syntax: Function DeleteFunction(ID As Long) As Boolean Avaliabilty: Label Gallery Plus only See also: Functions, FunctionProperties, NewFunction DeleteObject Description: DeleteObject method deletes an object from the label. In case of success method returns value TRUE. Syntax: Function DeleteObject(ID As Long) As Boolean Avaliabilty: Label Gallery Plus only See also: Objects, ObjectPropeties DeleteVariable Description: DeleteVariable method deletes a variable from the label. In case of success method returns value TRUE. Syntax: Function DeleteVariable(ID As Long) As Boolean Avaliabilty: Label Gallery Plus only See also: GlobalVariables, NewVariable, SelectVariable, Variables, VariableProperties, NewVariableWiz

106

ActiveX interface

DownloadVariablesList Description: This method is set a list of variables whose value must be set if we wish to call any export or Store to printer. If this is not done Syntax: Function DownloadVariablesList() As IVariableList Avaliabilty: Label Gallery Plus only DownloadToPrinter Description: This method store label to printer. It is essential that we set all the variables in the list using DownloadVariablesList method or method will fail. Syntax: Function DownloadToPrinter() As Boolean Avaliabilty: Label Gallery Plus only

ExecuteMacro Description: This function executes a macro. Macro parameter represents GalleryCommand. Syntax: Function ExecuteMacro(Macro As String) As Boolean ExportToPocket Description: Function executes the same action as choosing the command File|Export|Export to terminal. All the necessary files are created in directory specified in ExportDir parameter. Function is not supported in DEMO mode. Syntax: Function ExportToPocket(ExportDir As String) As Boolean See also:

107

ActiveX interface

ExportToPrinter

ExportToPrinter Description: Use ExportToPrinter function when you want export the label directly to the printer or to a file. When ExportFile parameter is blank exporting is done directly to the printer otherwise it is done to the file. With CreateLVR parameter you are defining whether you want export also the LVR file, which contains the descriptions of the variables. The ExportVariant defines how it is exported. This parameter depends on the printer (Default = 1, other values represent for example: export to RAM, export to Flash, export to PCMCIA, ...). Function is not supported in DEMO mode. Syntax: Function ExportToPrinter(ExportVariant As Long, ExportFile As String, CreateLVR As Boolean) As Boolean

See also: ExportToPocket Functions Description: Returns the interface to the function list. Syntax: Property Functions As IFunctionList Access Rights: read-only See also: DeleteFunction, FunctionProperties, NewFunction FunctionProperties Description: FunctionProperties method opens a dialog box with properties for the function selected with ID. Syntax:

108

ActiveX interface

Function FunctionProperties(ID As Long) As Boolean See also: DeleteFunction, Functions, NewFunction GetDependandFilesList Description:

GetDependandFilesList function returns you the list of files, which are in use with opened file. As ListType you can set , which types of the file you wish to get. Below you can find all possible ListType parameters: ListType = 0 ListType = 1 ListType = 2 ListType = 3 All files GalleryForm files Graphics files only Database files only

Returned string is a comma delimited string. This means that in one string there are names of all files in use. Return result is like this:
C:\program files\EuroPlus\formsample1.off, C:\program files\EuroPlus\formsample2.off

Syntax: Function GetDependandFilesList(FileName As String, Width as Long, Height as Long) As Boolean GetDownloadLocationsList Description: Returns available slot names for recall printing. Current printer name of the selected label is used. Syntax: Function GetDownloadLocationsList() As String GetDownloadLocationsListForPrinter Description:

109

ActiveX interface

Returns available slot names for recall printing. PrinterName is used as printer name Syntax: Function GetDownloadLocationsListForPrinter(PrinterName As String) As String GeneralExport Description: Performs export of the current label to the ExportDir folder. Function is not supported in DEMO mode.

Syntax: Function GetLabelPreview(ExportDir As String) As Boolean GetCurrentState Description: Use GetCurrentState function when you want to get the state of Label Gallery. Return result can be of the following: 1 - printing 2 - print preview 0 - other (label design) This method is especially useful for VBScript actions, where the code can check current state and do some actions only in certain modes (printing for example) Syntax: Function GetCurrentState() As Long GetLabelPreview Description: GetLabelPreview method saves a preview of the label in the file specified with the FileName. Other two parameters are for defining the size of preview. If file is created sucessfully return value is TRUE. The extension of the FileName parameter defines in which format the preview will be stored. Possible formats are BMP, JPG, PNG and GIF.

Syntax:

110

ActiveX interface

Function GetLabelPreview(FileName As String, Width As Long, Height As Long) As Boolean

GetLabelPreviewEx Description: Use this function to generate the preview of the label. With this function it is possible to create label previews for the header and tail labels also. Also two sided labels are supported. The extension of the FileName parameter defines in which format the preview will be stored. Possible formats are BMP, JPG, PNG and GIF. Based on the parameters suitable preview is generated. Syntax: Function GetLabelPreviewEx(FileName As String, Width As Long, Height As Long, LabelKind As Long, LabelSide As Long, HasBorder As Boolean) As Boolean Explanation of the parameters: FileName Represents the file name. Width Width of picture in pixels. Height Height of picture in pixels. LabelKind With this parameter you specify which kind of label you want to preview. Possible values are 0, 1 and 2. 0 means header label, 1 means normal label and 2 means footer label. LabelSide With this parameter you specify which side of label you want to preview. Possible values are 0 and 1. 0 means front side of the label and 2 means the back side of the label. HasBorder If you specify this parameter the preview will have a border around the preview.

111

ActiveX interface

GetPrintParam Description: GetPrintParam function returns the value for provided printing parameter. Possible values for Name parameter are: SPEED Function will return the speed parameter as string value. DARKNESS Function will return the darkness parameter as string value. Syntax: Function GetPrintParam(Name As String) As String Explanation of the parameters: Name Defines which parameter should be retrieved : PRINTSPEED speed parameter as string value PRINTDARKNESS - darkness parameter as string value PRINTROTATION - rotation parameter as string value PRINTDARKNESS1, PRINTDARKNESS2, PRINTDARKNESS3, PRINTDARKNESS4, PRINTDARKNESS5 - darkness on specific print head on the printer with multiple print heads NUMBER_OF_FRONT_PAGE_COLORS - number of colors for the specified page side for the printers with multiple print heads NUMBER_OF_BACK_PAGE_COLORS - number of colors for the specified page side for the printers with multiple print heads See also: Print, PrintePort, PrinterName, SetPrintParam GetPrintParamEX Description: This function retrieve the value of printing parameter. Explanation of the parameters: PrinterName Defines for which printer you want to retrieve the parameter, blank value means that default printer will be taken. ParamName Defines which parameter should be retrieved : PRINTSPEED speed parameter as string value PRINTDARKNESS - darkness parameter as string value PRINTROTATION - rotation parameter as string value PRINTDARKNESS1, PRINTDARKNESS2, PRINTDARKNESS3, PRINTDARKNESS4, PRINTDARKNESS5 - darkness on specific print head on the printer with multiple print heads

112

ActiveX interface

NUMBER_OF_FRONT_PAGE_COLORS - number of colors for the specified page side for the printers with multiple print heads NUMBER_OF_BACK_PAGE_COLORS - number of colors for the specified page side for the printers with multiple print heads

Syntax: Function GetPrintParamEx(PrinterName As String, ParamName As String) As String See also: GetPrinterSpeedList, GetPrinterSpeedUnit, GetPrintParam, PrinterName, PrinterPort

GetPrintParamList Description: This method returns comma separated list of values/names for specified ParamName and specified PrinterName and the data you desire Explanation of the parameters: PrinterName Defines for which printer you want to retrieve the parameter, blank value means that default printer will be taken. ParamName It can be one of : PRINTSPEED speed parameter as string value PRINTDARKNESS - darkness parameter as string value PRINTROTATION - rotation parameter as string value PRINTDARKNESS1, PRINTDARKNESS2, PRINTDARKNESS3, PRINTDARKNESS4, PRINTDARKNESS5 - darkness on specific print head on the printer with multiple print heads FRONT_PAGE_COLOR_LIST - comma separated list of color values
represented in integers(COLORREF) BACK_PAGE_COLOR_LIST - comma separated list of color values represented in integers(COLORREF)

DataType
Parameter is used for parameters PRINTSPEED, PRINTDARKNESS, PRINTDARKNESS1, PRINTDARKNESS2, PRINTDARKNESS3, PRINTDARKNESS4, PRINTDARKNESS5 and it means whether you want to retrieve values list or names list for the specified parameter. Values are actual values for the speed/darkness while names are string representations for those items (for example you use names when displaying this data to user)

113

ActiveX interface

Syntax: Function GetPrintParamList(PrinterName As String, ParamName As String, DataType As Long) As String See also: GetPrinterSpeedList, GetPrinterSpeedUnit, GetPrintParam, PrinterName, PrinterPort

GlobalVariables Description: Returns the interface to the variable list for global variables. Syntax: Property GlobalVariables As IVariableList Access Rights: read-only See also: DeleteVariable, NewVariable, SelectVariable, Variables, VariableProperties, NewVariableWiz IsLabelReadOnly Description: IsLabelReadOnly property returns TRUE if label is opened in read only mode, otherwise return value is FALSE. Syntax: Property IsLabelReadOnly As Boolean Access Rights: read-only IsLinkedToStock Description: IsLinkedToStock property returns TRUE if label is linked with some stock or FALSE if none of the stocks are used. Syntax:

114

ActiveX interface

Property IsLinkedToStock As Boolean Access Rights: read-only IsStoreRecallSupported Description: If current printer supports store/recall value of the IsStoreRecallSupported property is TRUE. Syntax: Property IsStoreRecallSupported As Boolean Access Rights: read-only LabelFileName Description: LabelFileName represents the name of the label file. Syntax: LabelFileName As String LabelSettings Description: Returns an interface to IlabelSettings class. See more in the Ilabel Chapter. Syntax: Property LabelSettings As ILabelSettings Access Rights: read-only LastRevisionID Description: Returns the ID of the last revision, which was made to the label. Syntax: Property LastRevisionID As Long

115

ActiveX interface

Access Rights: read-only NewDatabase Description: This method creates a new database access on the label. Syntax: Function NewDatabase() As Boolean See also: Databases, DatabaseProperties, DeleteDatabase, NewDatabaseWiz, SelectDatabase NewDatabaseWiz Description: NewDatabaseWiz method opens Database Wizard. In case of success method returns value TRUE. Syntax: Function NewDatabaseWiz() As Boolean See also: Databases, DatabaseProperties, DeleteDatabase, NewDatabase, SelectDatabase NewFunction Description: This method creates a new function on the label. Syntax: Function NewFunction() As Boolean See also: DeleteFunction, Functions, FunctionProperties NewVariable Description: This method creates a new variable on the label.

116

ActiveX interface

Syntax: Function NewVariable() As Boolean See also: DeleteVariable, GlobalVariables, SelectVariable, Variables, VariableProperties, NewVariableWiz NewVariableWiz Description: NewVariableWiz method opens Variable Wizard. In case of success method returns value TRUE. Syntax: Function NewVariableWiz() As Boolean See also: DeleteVariable, GlobalVariables, SelectVariable, Variables, VariableProperties, NewVariable Objects Description: Returns the interface to the object list. Syntax: Property Objects As IObjectList Access Rights: read-only See also: DeleteObject, ObjectPropeties ObjectProperties Description: ObjectProperties method opens a dialog box with properties for the object selected with ID. Syntax: Function ObjectProperties(ID As Long) As Boolean See also:

117

ActiveX interface

DeleteObject, Objects PrintAndGetJobID Description: When printing from Label Gallery user can retrieve an exact status of the print job. Parameter Quantity : Specifies the quantity that should be used when printing AdditionalParam: Reserved for future use, must be Return Value : Job ID of the print Job. In case of error, return value can contain the following strings: Logging Disabled - Logging is not enabled, retrieving of ID not possible. Print Failed - Print Job failed to print. Syntax: Function PrintAndGetJobID(Quantity As String, AdditionalParams As String) As String

Print Description: Print method prints as many labels as selected in Quantity. The quantity parameter is the print quantity of the labels; it can be a number, or one of following words: VARIABLE UNLIMITED

The first parameter means printing on the base of the variable quantity (one of the variables sets the quantity), the second one means unlimited printing (printing from the whole database file for example). Labels are printed to the printer which is selected in PrinterName property. If PrintType is: - Simulate (value = "Simulate") : the whole printing process will be just simulated. All variable values, functions and database access will be performed, but no actual printing will be done. This parameter can be used to perform a printing validation (validation of the data) prior to real printing. - NormalPrinting (value = " NormalPrinting ") : normal printing is selected. - RecallPrinting (value = " RecallPrinting ") : recall printing is selected. If Location is: - Stopupdate (value = " Stopupdate ") : he contens of the objects stay unchanged after the print or preview so that the real properties of the object can be retrieved .- StoreLocation (value = " StoreLocation=XXX") : XXX is slot name. Avaliable slot names can be obtained by calling GetDownloadLoactionsList or GetDownloadLoactionsListForPrinter..

118

ActiveX interface

Syntax: Function Print(Quantity [, SkipLabels [, Identical [, Sets]] [, PrintType] [, Location]]As String) As Boolean See also: GetPrintParam, PrintePort, PrinterName, SetPrintParam PrinterName Description: PrinterName represents the name of the printer to which label will be printed. Syntax: PrinterName As String See also: GetPrintParam, Print, PrinterPort, SetPrintParam PrinterPort Description: Command PrinterPort allows you to set different printer port than specified in the label file. Syntax: PrinterPort As String Access Rights: read-write See also: GetPrintParam, Print, PrinterName, SetPrintParam PrintType Description: Label mode can be obtained by calling PrintType property O = PRINT_TYPE_NORMAL 1 = PRINT_TYPE_RECALL Syntax: PrintType As Long Access Rights:

119

ActiveX interface

Read Save Description: Save method saves the selected label. Please note that Save command is not supported in LabelGallery Engine edition of Label Gallery. Syntax: Function Save() As Boolean SelectDatabase Description: SelectDatabase method selects a variable on the label. In case of success method returns value TRUE. Syntax: Function SelectDatabase(ID As Long) As Boolean See also: Databases, DatabaseProperties, DeleteDatabase, NewDatabase, NewDatabaseWiz SelectVariable Description: SelectVariable method selects a variable on the label. In case of success method returns value TRUE. Syntax: Function SelectVariable(ID As Long) As Boolean See also: DeleteVariable, GlobalVariables, NewVariableWiz, Variables, VariableProperties, NewVariable SessionEnd Description: The function closes data stream. Syntax: Function SessionEnd() As Boolean

120

ActiveX interface

See also: SessionStart SessionPrint SessionPrint Description: You send the data stream to printer using this function. You can use multiple SessionPrint commands one after another and join them in single data stream. The stream is not closed until the command SessionEnd occurs. Syntax: Function SessionPrint(Quantity As String) As Boolean See also: SessionStart SessionEnd SessionStart Description: All three functions (SessionStart, SessionPrint, SessionEnd) are used together. If ordinary command SessionPrint is used, every time a complete data stream for printer is sent. If you want to join multiple Print commands into one data stream, you can use the command SessionStart followed with any number of SessionPrint and in the end use the command SessionEnd. The stream is not closed until the command SessionEnd occurs. These commands offer a way of optimal printing through GalleryCommands and it is not necessary to generate a complete data stream for each print session. Syntax: Function SessionStart() As Boolean See also: SessionPrint SessionEnd SetPrintJobName Description: The ILGLabel interface is extended to support setting the PrintJobName for next print command. The command is defined as:

121

ActiveX interface

Parameter JobName must contain the name of the print job. function returns true if successful. The parameter set is used only for the first print command. After that it is reset to use default print job names. Application should set the print job name each time before executing print commands. Syntax: SetPrintJobName(JobName As String) SetPrintParam Description: With SetPrintParam function it is possible to set the following printing parameters: SPEED Name parameter : PRINTSPEED DARKNESS Name parameter : PRINTDARKNESS PAPERBIN Name parameter : PAPERBIN PRINTROTATION Name parameter : PRINTROTATION Value : 0 - no rotation Value : 1 - 180 rotation

The name of the printing parameter should be stored in the functions Name parameter and the value of the parameter in the Value parameter. Both parameters should be represented as a string. If function is able to set the required printing parameters, the return value will be TRUE otherwise something was wrong and the return result will be FALSE. Syntax: Function SetPrintParam(Name As String, Value As String) As Boolean See also: GetPrintParam, Print, PrinterPort, PrinterName SetDirty Description: With this method you can set the dirty flag of the label document to true, if you do this means that the label has been modifed and the user will be prompted to save the label when he will try to close the label Syntax: Function SetDirty(flag As Boolean)

122

ActiveX interface

SetObjectVisible Description: With this method you can set object visibility on the label.
When the method succeeds, the return value is true. If it fails, the return value is false. The reasons for failing can be: - Object with specified name is not found (Error 1610). - Object is in error state. If object is found on the label, but it is in error state (not OK or Phantom), the visible property can not be changed (Error 1611)

Syntax: Function SetObjectVisible(ObjectName As String, Visible As Boolean) As Boolean Parameters: Objectname

Name of the object, for which the visible property should be changed

Visible
Visible status after the call. If parameter is false, the object will get status Phantom

StockName Description: Returns the name of the stock, which is used on the label. Syntax: Property StockName As String Access Rights: read-only See also: StockType

StockType Description: Returns the type of the stock, which is used on the label. Syntax: Property StockType As String Access Rights: read-only See also:
123

ActiveX interface

StockName SynchronizedPrinting Description: This property defines wether the synchronized printing should be used or not. If you try to set this property to true when the current printer does not support this then the property will be false and error will be set in NiceLabel. Syntax: Property SynchronizedPrinting As Boolean Variables Description: Returns the interface to the variable list for input variables. Syntax: Property Variables As IVariableList Access Rights: read-only See also: DeleteVariable, GlobalVariables, NewVariableWiz, SelectVariable, VariableProperties, NewVariable VariableProperties Description: VariableProperties method opens a dialog box with properties for the variable selected with ID. Syntax: Function VariableProperties(ID As Long) As Boolean See also: DeleteVariable, GlobalVariables, NewVariableWiz, SelectVariable, Variables, NewVariable

2.9.16 Class IObject (Advanced Only)

Methods Version Properties Version

124

ActiveX interface

Availability Move Resize SetVariable 1,2,3 1,2,3 1,2,3 AnchorElementID AnchorLevel AnchorPoint FormatID Height ID IsLocked Kind Left Name PageNumber ResizeFlag RotateFlag Rotation Selected Status Top Variable Width ZOrder AnchorElementID Description:

Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

Currently not used. Intended to be used, when position of one element can be dependant on position/size of another element. Syntax: AnchorElementID As Long AnchorLevel Description: Currently not used. Syntax: AnchorLevel As Long

125

ActiveX interface

AnchorPoint Description: Identifies the point of the object, which is fixed on the label. If the object size is changed, the specified AnchorPoint remains on the same position. Possible values are: Value 0 1 2 3 4 5 6 7 8 Syntax: AnchorPoint As Long See also: Height, Left, Top, Width FormatID Description: This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Values 0 1 2 3 4 5 6 Description All Numeric Alphanumeric Letters 7 bit Hex Date Description top left top center top right mid left mid center mid right bottom left bottom center bottom right

126

ActiveX interface

Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory. Syntax: FormatID As Long Height Description: Height of the element (in 0.01 mm units). Syntax: Property Height As Long Access Rights: read-only See also: AnchorPoint, Left, Top, Width ID Description: ID of the element Syntax: Property ID As Long IsLocked Description: When the elements position is locked on the label, this property has the value TRUE Syntax: IsLocked As Boolean Kind Description:

127

ActiveX interface

Element kind. Possible values are: Value 301 302 303 304 305 306 307 308 309 312 313 Syntax: Property Kind As Long Access Rights: read-only Left Description: Left position of the element (in 0.01 mm units). Syntax: Property Left As Long Access Rights: read-only See also: AnchorPoint, Height, Top, Width Move Description: Move the element to the location X, Y Description TextObject RectangleObject BitmapObject BarcodeObject LineObject InverseObject OleObject Downloaded Graphic Object ParagraphObject RTFTextObject EllipseObject

128

ActiveX interface

Syntax: Move(X As Long, Y As Long) Name Description: Name property represents the name of the object. Syntax: Name As String PageNumber Description: The Page index, where the element is located. When Duplex print is used, this index can have the value 0 (first page) or 1 (second page). When duplex printing is not enabled, this property is ignored (the value should always be 0). Syntax: PageNumber As Long Access Rights: read-only Resize Description: Resize the element to the size Width, Height. The element is resized to the closest size in case, that all sizes are not possible. Syntax: Resize(Width As Long, Height As Long) See also: ResizeFlag SetVariable Description: Connects the element to the variable with ID. If the return value of the function is 1, then some error occured during the connection. The best example for this is that you want connect variable with fixed length to an element which requires different fixed lenght. (EAN13 barcode). In such case element is not connected to any variable it is fixed.

129

ActiveX interface

Syntax: Function SetVariable(ID As Long) As Long ResizeFlag Description: Flag, which defines, how the object can be resized. Possible values are: Value 0 0x88 0x22 0x55 Syntax: Property ResizeFlag As Long Access Rights: read-only See also: Resize RotateFlag Description: Flag, which defines, how the object can be rotated. Possible values are: Value 0 0x07 0x02 0xFF Syntax: Property RotateFlag As Long Description no rotation 90 degrees rotation 180 degrees rotation 0-360 degrees rotation in steps of 1 degree Description no resizing resizing is possible only in horizontal direction resizing is possible only in vertical direction resizing is possible only in both directions at the same time

130

ActiveX interface

Access Rights: read-only See also: Rotation Rotation Description: Specifies the elements rotation. When the element can be rotated only in steps of 90 degrees. The valid values for the Rotation property are: Value 0 1 2 3 Description 0 deg. 90 deg. 180 deg. 270 deg.

When the element can be rotated in steps of 1 degree, the property has the value from 0 to 359. Syntax: Rotation As Long See also: RotateFlag Selected Description: When the element is selected, this property is TRUE. Syntax: Selected As Boolean SetVariable Description: With this method you can set an object to be fixed or assign it a variable, if ID is -1 then

131

ActiveX interface

the object will be set to be fixed, if the ID is the ID of the variable on this label then the object will use this variable as a data source. If the variable will be successufly set to this object then the return value will be 0 if not then return value will be -1 Syntax: Function SetVariable(ID As Long) As Long Status Description: Status of the object. Possible values are: Value 0 1 2 Description OK Error condition Phantom

Syntax: Property Status As Long Top Description: Top position of the element (in 0.01 mm units). Syntax: Property Top As Long Access Rights: read-only See also: AnchorPoint, Height, Left, Width Variable Description: Returns the interface to the variable, which is connected to the OLE object.

132

ActiveX interface

Syntax: Property Variable As IVar Access Rights: read-only Width Description: Width of the element (in 0.01 mm units). Syntax: Property Width As Long Access Rights: read-only See also: AnchorPoint, Height, Left, Top ZOrder Description: Value of Z order of the object position. When the Zorder value is the highest, the element is placed on the top of all others. Syntax: ZOrder As Long

2.9.17 Class IObjectList (Advanced Only)

Free Item

Version Availability 1,2,3

Properties
Count

Version Availability 1,2,3

Count Description: Count property returns the number of objects, which are defined on the label. Syntax: Property Count As Long

133

ActiveX interface

Access Rights: read-only Item Description: Returns the interface to the object. Object is selected with Index. Syntax: Function Item(Index As Long) As IObject

2.9.18 Class IOleObject (Advanced Only)

Methods Move Resize SetVariable Version Availability 1,2,3 1,2,3 1,2,3 Properties AnchorElementID AnchorLevel AnchorPoint FormatID Height ID IsLocked Kind Left Name PageNumber ResizeFlag RotateFlag Rotation Selected Status Top Variable Width ZOrder AnchorElementID Description: Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

134

ActiveX interface

Currently not used. Intended to be used, when position of one element can be dependant on position/size of another element. Syntax: AnchorElementID As Long AnchorLevel Description: Currently not used. Syntax: AnchorLevel As Long AnchorPoint Description: Identifies the point of the object, which is fixed on the label. If the object size is changed, the specified AnchorPoint remains on the same position. Possible values: Value 0 1 2 3 4 5 6 7 8 Syntax: AnchorPoint As Long See also: Height, Left, Top, Width Description top left top center top right mid left mid center mid right bottom left bottom center bottom right

135

ActiveX interface

FormatID Description: This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Value 0 1 2 3 4 5 6 7 Description All Numeric Alphanumeric Letters 7 bit Hex Date Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory. Syntax: FormatID As Long Height Description: Height of the element (in 0.01 mm units). Syntax: Property Height As Long Access Rights: read-only See also: AnchorPoint, Left, Top, Width ID Description: ID of the element

136

ActiveX interface

Syntax: Property ID As Long Access Rights: read-only IsLocked Description: When the elements position is locked on the label, this property has the value TRUE Syntax: IsLocked As Boolean Kind Element kind. Possible values are: Value 301 302 303 304 305 306 307 308 309 312 313 Syntax: Property Kind As Long Access Rights: read-only Description TextObject RectangleObject BitmapObject BarcodeObject LineObject InverseObject OleObject Downloaded Graphic Object ParagraphObject RTFTextObject EllipseObject

137

ActiveX interface

Left Description: Left position of the element (in 0.01 mm units). Syntax: Property Left As Long Access Rights: read-only See also: AnchorPoint, Height, Top, Width Name Description: Name property represents the name of the OLE object. Syntax: Name As String Move Description: Move the element to the location X, Y Syntax: Move(X As Long, Y As Long) NumberOfLines Description: This property returns the number of lines in text object for the current contents. Syntax: NumberOfLines As Long Access Rights: read-only

138

ActiveX interface

PageNumber Description: The Page index, where the element is located. When Duplex print is used, this index can have the value 0 (first page) or 1 (second page). When duplex printing is not enabled, this property is ignored (the value should always be 0). Syntax: PageNumber As Long Resize Description: Resize the element to the size Width, Height. The element is resized to the closest size in case, that all sizes are not possible. Syntax: Resize(Width As Long, Height As Long) See also: ResizeFlag

ResizeFlag Description: Flag, which defines, how the object can be resized. Possible values are: Value 0 0x88 0x22 0x55 Description no resizing resizing is possible only in horizontal direction resizing is possible only in vertical direction resizing is possible only in both directions at the same time

Syntax: Property ResizeFlag As Long Access Rights: read-only

139

ActiveX interface

See also: Resize RotateFlag Description: Flag, which defines, how the object can be rotated. Possible values are: Value 0 0x07 0x02 0xFF Syntax: Property RotateFlag As Long Access Rights: read-only See also: Rotation Rotation Description: Specifies the elements rotation. When the element can be rotated only in steps of 90 degrees. The valid values for the property are: Value 0 1 2 3 Description 0 deg. 90 deg. 180 deg. 270 deg. Description no rotation 90 degrees rotation 180 degrees rotation 0-360 degrees rotation in steps of 1 degree

When the element can be rotated in steps of 1 degree, the property has the value from 0 to 359.

140

ActiveX interface

Syntax: Rotation As Long See also: RotateFlag Selected Description: When the element is selected, this property is TRUE. Syntax: Selected As Boolean SetVariable Description: Connects the element to the variable with ID. If the return value of the function is 1, then some error occured during the connection. The best example for this is that you want connect variable with fixed length to an element which requires different fixed lenght. (EAN13 barcode). In such case element is not connected to any variable it is fixed. Syntax: Function SetVariable(ID As Long) As Long

Status Description: Status of the object. Possible values are : Value 0 1 2 Description OK Error condition Phantom

Syntax: Property Status As Long

141

ActiveX interface

Access Rights: read-only Top Description: Top position of the element (in 0.01 mm units). Syntax: Property Top As Long Access Rights: read-only See also: AnchorPoint, Height, Left, Width Variable Description: Returns the interface to the variable, which is connected to the OLE object. Syntax: Property Variable As IVar Access Rights: read-only Width Description: Width of the element (in 0.01 mm units). Syntax: Property Width As Long Access Rights: read-only See also: AnchorPoint, Height, Left, Top

142

ActiveX interface

ZOrder Description: Value of Z order of the object position. When the Zorder value is the highest, the element is placed on the top of all others. Syntax: ZOrder As Long

2.9.19 Class IParagraph (Advanced Only)

Methods Move Resize SetContents SetVariable Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 Properties AnchorElementID AnchorLevel AnchorPoint BestFit Color Contents ContentsMask FontName FormatID Height ID IsBold IsInverse IsItalic IsLocked IsMirror IsStacked IsStrikeOut IsUnderlined Justification Kind Left MaskCharacter MaxSizeX MaxSizeY MinSizeX Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3

143

ActiveX interface

MinSizeY Name PageNumber PtSizeX PtSizeY ResizeFlag RotateFlag Rotation Selected SpacingX SpacingY Status Top Variable Width ZOrder AnchorElementID Description: Currently not used. Intended to be used, when position of one element can be dependant on position/size of another element. Syntax: AnchorElementID As Long AnchorLevel Description: Currently not used. Syntax: AnchorLevel As Long AnchorPoint Description: Identifies the point of the object, which is fixed on the label. If the object size is changed, the specified AnchorPoint remains on the same position.

1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

144

ActiveX interface

Possible values: Value 0 1 2 3 4 5 6 7 8 Syntax: AnchorPoint As Long See also: Height, Left, Top, Width BestFit Description: This property is TRUE if BestFit option for font resizing is enabled. Syntax: BestFit As Boolean See also: MaxSizeX, MaxSizeY, MinSizeX, MinSizeY, SpacingX, SpacingY Color Description: With 32-bit value you can specify any RGB color. The color value has the following hexadecimal form: 0x00bbggrr The low-order byte (rr) contains a value for the relative intensity of red; the second byte (gg) contains a value for green; and the third byte (bb) contains a value for blue. The fourth byte byte must be zero. Description top left top center top right mid left mid center mid right bottom left bottom center bottom right

145

ActiveX interface

Each color parameter can range from 0x0 to 0xFF. Syntax: Color As Long See also: Fontname, IsBold, IsInverse, IsItalic, PtSizeX, PtSizeY

Contents Description: Returns the current contents of the element. Syntax: Property Contents As String Access Rights: read-only ContentsMask Description:

Sets and gets the ContentsMask attribute.

Syntax: ContentsMask As String FontName Description: FontName property represents the name of the font used within paragraph. Syntax: FontName As String See also: Color, IsBold, IsInverse, IsItalic, PtSizeX, PtSizeY FormatID Description:

146

ActiveX interface

This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Value 0 1 2 3 4 5 6 7 Description All Numeric Alphanumeric Letters 7 bit Hex Date Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory. Syntax: FormatID As Long Height Description: Height of the element (in 0.01 mm units). Syntax: Property Height As Long Access Rights: read-only See also: AnchorPoint, Left, Top, Width ID Description: ID of the element Syntax: Property ID As Long

147

ActiveX interface

Access Rights: read-only IsBold Description: When the font for the Paragraph element has enabled Bold property then this property is TRUE. Syntax: IsBold As Boolean See also: Color, Fontname, IsInverse, IsItalic, PtSizeX, PtSizeY IsInverse Description: This property is TRUE if Inverse efect is enabled. Syntax: IsInverse As Boolean See also: Color, Fontname, IsBold, IsItalic, PtSizeX, PtSizeY IsItalic Description: When the font for the Paragraph element has enabled Italic property then this property is TRUE. Syntax: IsItalic As Boolean See also: Color, Fontname, IsBold, IsInverse, PtSizeX, PtSizeY IsMirror Description: This property is TRUE if Mirror efect is enabled.

148

ActiveX interface

Syntax: IsMirror As Boolean IsStacked Description: The property defines if the text is normal or stacked Syntax: IsStacked As Boolean IsStrikeOut Description: The property defines if the text is striked out Syntax: IsStrikeOut As Boolean IsUnderLined Description: The property defines if the text is underlined Syntax: IsUnderlined As Boolean IsLocked Description: When the elements position is locked on the label, this property has the value TRUE Syntax: IsLocked As Boolean Justification Description: Justification proprety represents how the contents of the text object will be justified. Possible values are:

149

ActiveX interface

Value 0 1 2 3 4

Description None Right Left Center Full

Syntax: Justification As Long Kind Element kind. Possible values are: Value 301 302 303 304 305 306 307 308 309 312 313 Syntax: Property Kind As Long Access Rights: read-only Left Description: Description TextObject RectangleObject BitmapObject BarcodeObject LineObject InverseObject OleObject Downloaded Graphic Object ParagraphObject RTFTextObject EllipseObject

150

ActiveX interface

Left position of the element (in 0.01 mm units). Syntax: Property Left As Long Access Rights: read-only See also: AnchorPoint, Height, Top, Width MaskCharacter This property defines the mask character for the contents mask of the text object Syntax: MaskCharacter as String MaxSizeX MaxSizeX property represents the maximim size of the font size in horizontal direction which is allowed when BestFit is enabled. Syntax: MaxSizeX As Long See also: BestFit, MaxSizeY, MinSizeX, MinSizeY, SpacingX, SpacingY MaxSizeY MaxSizeY property represents the maximim size of the font size in vertical direction which is allowed when BestFit is enabled. Syntax: MaxSizeY As Long See also: BestFit, MaxSizeX, MinSizeX, MinSizeY, SpacingX, SpacingY MinSizeX Description: MinSizeX property represents the minimum size of the font size in horizontal direction which is allowed when BestFit is enabled.

151

ActiveX interface

Syntax: MinSizeX As Long See also: BestFit, MaxSizeX, MaxSizeY, MinSizeY, SpacingX, SpacingY MinSizeY Description MinSizeY property represents the minimum size of the font size in vertical direction which is allowed when BestFit is enabled. Syntax: MinSizeY As Long See also: BestFit, MaxSizeX, MaxSizeY, MinSizeX, SpacingX, SpacingY Move Description: Move the element to the location X, Y Syntax: Move(X As Long, Y As Long) NumberOfLines Description: This property returns the number of lines in text object for the current contents. Syntax: NumberOfLines As Long Access Rights: read-only Name Description: Name property represents the name of the paragraph.. Syntax:

152

ActiveX interface

Name As String PaheNumber Description: The Page index, where the element is located. When Duplex print is used, this index can have the value 0 (first page) or 1 (second page). When duplex printing is not enabled, this property is ignored (the value should always be 0). Syntax: PageNumber As Long PtSizeX Description: PtSizeX represents font size in horizontal direction. Default size is 0. In this case default size for selected font is set. Syntax: PtSizeX As Long See also: Color, Fontname, IsBold, IsItalic, IsInverse, PtSizeY PtSizeY Description: PtSizeY represents vertical font size. Syntax: PtSizeY As Long See also: Color, Fontname, IsBold, IsItalic, IsInverse, PtSizeX Resize Description: Resize the element to the size Width, Height. The element is resized to the closest size in case, that all sizes are not possible. Syntax: Resize(Width As Long, Height As Long)

153

ActiveX interface

See also: ResizeFlag ResizeFlag Description: Flag, which defines, how the object can be resized. Possible values are: Value 0 0x88 0x22 0x55 Syntax: Property ResizeFlag As Long Access Rights: read-only See also: Resize RotateFlag Description: Flag, which defines, how the object can be rotated. Possible values are: Value 0 0x07 0x02 0xFF Syntax: Property RotateFlag As Long Description no rotation 90 degrees rotation 180 degrees rotation 0-360 degrees rotation in steps of 1 degree Description no resizing resizing is possible only in horizontal direction resizing is possible only in vertical direction resizing is possible only in both directions at the same time

154

ActiveX interface

Access Rights: read-only See also: Rotation Rotation Description: Specifies the elements rotation. When the element can be rotated only in steps of 90 degrees. The valid values for the property are: Value 0 1 2 3 Description 0 deg. 90 deg. 180 deg. 270 deg.

When the element can be rotated in steps of 1 degree, the property has the value from 0 to 359. Syntax: Rotation As Long See also: RotateFlag Selected Description: When the element is selected, this property is TRUE. Syntax: Selected As Boolean SetContents Description:

155

ActiveX interface

When the contents of an element should be changed, SetContents method should be called. In case of success (the Value is valid for the element), the function returns 0. In case of an error, the function returns 1. Syntax: Function SetContents(Value As String) As Long SetVariable Description: Connects the element to the variable with ID. If the return value of the function is 1, then some error occured during the connection. The best example for this is that you want connect variable with fixed length to an element which requires different fixed lenght. (EAN13 barcode). In such case element is not connected to any variable it is fixed. Syntax: Function SetVariable(ID As Long) As Long

SpacingX Description: With SpacingX property you select spacing between each character. Syntax: SpacingX As Long See also: BestFit, MaxSizeX, MaxSizeY, MinSizeX, MinSizeY, SpacingY SpacingY Description: With SpacingY property you select spacing between each line. Syntax: SpacingY As Long See also: BestFit, MaxSizeX, MaxSizeY, MinSizeX, MinSizeY, SpacingX

156

ActiveX interface

Status Description: Status of the object. Possible values are: Value 0 1 2 Description OK Error condition Phantom

Syntax: Property Status As Long Access Rights: read-only Top Description: Top position of the element (in 0.01 mm units). Syntax: Property Top As Long Access Rights: read-only See also: AnchorPoint, Height, Left, Width Variable Description: Returns the interface to the variable, which is connected to the paragraph. Syntax: Property Variable As IVar Access Rights:

157

ActiveX interface

read-only Width Description: Width of the element (in 0.01 mm units). Syntax: Property Width As Long Access Rights: read-only See also: AnchorPoint, Height, Left, Top ZOrder Description: Value of Z order of the object position. When the Zorder value is the highest, the element is placed on the top of all others. Syntax: ZOrder As Long PageNumber

2.9.20 Class IParameterList (Advanced Only)

Methods Create Item Item Description: Returns the interface to the parameter. Function is selected with Index. Syntax: Function Item(Index As Long) As IDBParameter Version Availability 1,2 1,2 Properties Count Version Availability 1,2

158

ActiveX interface

Count Description: Count property returns the number of parameters (filters) defined for a database. Syntax: Property Count As Long Access Rights: read-only Create Description: Create method creates a new filter on the existing database access. Input parameter is a name of the field on which filtering will be executed. Outputi is an interface to the new created filter. Syntax: Function Create(Field As String) As IDBParameter

2.9.21 Class IRectangle (Advanced Only)

Methods Move Resize SetVariable Version Availability 1,2,3 1,2,3 1,2,3 Properties AnchorElementID AnchorLevel AnchorPoint Color FillColor FillStyle FormatID Height ID IsLocked IsRounded Kind Left LineStyle Name PageNumber Version Availability 1,2,3 1,2,3 1,2,3 2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

159

ActiveX interface

PrintAsGraphics Radius ResizeFlag RotateFlag Rotation Selected Status ThicknessX ThicknessY Top Variable Width ZOrder AnchorElementID Description: Currently not used. Intended to be used, when position of one element can be dependant on position/size of another element. Syntax: AnchorElementID As Long AnchorLevel Description: Currently not used. Syntax: AnchorLevel As Long AnchorPoint Description: Identifies the point of the object, which is fixed on the label. If the object size is changed, the specified AnchorPoint remains on the same position. Possible values: Value Description

1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

160

ActiveX interface

0 1 2 3 4 5 6 7 8 Syntax:

top left top center top right mid left mid center mid right bottom left bottom center bottom right

AnchorPoint As Long See also: Height, Left, Top, Width Color Description: With 32-bit value you can specify any RGB color. The color value has the following hexadecimal form: 0x00bbggrr The low-order byte (rr) contains a value for the relative intensity of red; the second byte (gg) contains a value for green; and the third byte (bb) contains a value for blue. The fourth byte byte must be zero. Each color parameter can range from 0x0 to 0xFF. Syntax: Color As Long See also: FillColor, FillStyle, LineStyle, ThicknessX, ThicknessY FillColor Description: With 32-bit value you can specify any RGB color. The color value has the following hexadecimal form:

161

ActiveX interface

0x00bbggrr The low-order byte (rr) contains a value for the relative intensity of red; the second byte (gg) contains a value for green; and the third byte (bb) contains a value for blue. The fourth byte byte must be zero. Each color parameter can range from 0x0 to 0xFF. Syntax: FillColor As Long See also: Color, FillStyle, LineStyle, ThicknessX, ThicknessY FillStyle Description: FillStyle property represents the fill sytle for the rectangle. Possible values are: Value 0 1 2 3 4 8 16 32 64 128 256 512 Description None Clear Solid Right diagonal Left diagonal Vertical Horizontal Cross Cross diagonal 25 % of color 50 % of color 75 % of color

Syntax: FillStyle As Long See also: Color, FillColor, LineStyle, ThicknessX, ThicknessY

162

ActiveX interface

FormatID Description: This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Value 0 1 2 3 4 5 6 7 Description All Numeric Alphanumeric Letters 7 bit Hex Date Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory. Syntax: FormatID As Long Height Description: Height of the element (in 0.01 mm units). Syntax: Property Height As Long Access Rights: read-only See also: AnchorPoint, Left, Top, Width ID Description: ID of the element

163

ActiveX interface

Syntax: Property ID As Long Access Rights: read-only IsLocked Description: When the elements position is locked on the label, this property has the value TRUE Syntax: IsLocked As Boolean IsRounded Description: When this property is set to TRUE, the rectangle be rounded with radius specified in Radius property. Syntax: IsRounded As Boolean Kind Possible values are: Value 301 302 303 304 305 306 307 308 309 312 313 Description TextObject RectangleObject BitmapObject BarcodeObject LineObject InverseObject OleObject Downloaded Graphic Object ParagraphObject RTFTextObject EllipseObject

164

ActiveX interface

Syntax: Property Kind As Long Access Rights: read-only Left Description: Left position of the element (in 0.01 mm units). Syntax: Property Left As Long Access Rights: read-only See also: AnchorPoint, Height, Top, Width LineStyle Description: LineStyle property represents the line sytle for the rectangle. Possible values are: Value 0 1 2 4 8 16 32 Description None Solid Dash Dot Dash + Dot Datsh + Dot + Dot Clear

Syntax: LineStyle As Long See also: Color, FillColor, FillStyle, ThicknessX, ThicknessY

165

ActiveX interface

Move Description: Move the element to the location X, Y Syntax: Move(X As Long, Y As Long) Name Description: Name property represents the name of the rectangle. Syntax: Name As String PageNumber Description: The Page index, where the element is located. When Duplex print is used, this index can have the value 0 (first page) or 1 (second page). When duplex printing is not enabled, this property is ignored (the value should always be 0). Syntax: PageNumber As Long PrintAsGraphics Description: When this property is set to TRUE, the rectangle will always be printed as graphics, even if the printer supports printing it with an internal command. Syntax: PrintAsGraphics As Boolean Radius Description: Radius property represents the radius of the rectangle corners. Syntax: Radius As Long

166

ActiveX interface

Resize Description: Resize the element to the size Width, Height. The element is resized to the closest size in case, that all sizes are not possible. Syntax: Resize(Width As Long, Height As Long) See also: ResizeFlag ResizeFlag Description: Flag, which defines, how the object can be resized. Possible values are: Value 0 0x88 0x22 0x55 Syntax: Property ResizeFlag As Long Access Rights: read-only See also: Resize RotateFlag Description: Flag, which defines, how the object can be rotated. Possible values are: Value Description Description no resizing resizing is possible only in horizontal direction resizing is possible only in vertical direction resizing is possible only in both directions at the same time

167

ActiveX interface

0 0x07 0x02 0xFF Syntax:

no rotation 90 degrees rotation 180 degrees rotation 0-360 degrees rotation in steps of 1 degree

Property RotateFlag As Long Access Rights: read-only See also: Rotation Rotation Description: Specifies the elements rotation. When the element can be rotated only in steps of 90 degrees. The valid values for the property are: Value 0 1 2 3 Description 0 deg. 90 deg. 180 deg. 270 deg.

When the element can be rotated in steps of 1 degree, the property has the value from 0 to 359. Syntax: Rotation As Long See also: RotateFlag Selected Description: When the element is selected, this property is TRUE.

168

ActiveX interface

Syntax: Selected As Boolean Status Description: Status of the object. Possible values are : Value 0 1 2 Description OK Error condition Phantom

Syntax: Property Status As Long Access Rights: read-only ThicknessX Description: ThicknessX property represents the thickness of the horizontal lines of the rectangle. Syntax: ThicknessX As Long See also: Color, FillColor, FillStyle, LineStyle, ThicknessY ThicknessY Description: ThicknessY property represents the thickness of the vertical lines of the rectangle. Syntax: ThicknessY As Long

169

ActiveX interface

See also: Color, FillColor, FillStyle, LineStyle, ThicknessX Top Description: Top position of the element (in 0.01 mm units). Syntax: Property Top As Long Access Rights: read-only See also: AnchorPoint, Height, Left, Width Variable Description: Returns the interface to the variable, which is attached to the element. Syntax: Property Variable As IVar Access Rights: read-only Width Description: Width of the element (in 0.01 mm units). Syntax: Property Width As Long Access Rights: read-only See also: AnchorPoint, Height, Left, Top

170

ActiveX interface

ZOrder Description: Value of Z order of the object position. When the Zorder value is the highest, the element is placed on the top of all others. Syntax: ZOrder As Long

2.9.22 Class IRTFText (Advanced Only)

Methods Move Resize SetContents SetVariable Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 Properties AnchorElementID AnchorLevel AnchorPoint BestFit Color Contents ContentsMask FontName FormatID Height ID IsBold IsInverse IsItalic IsLocked IsMirror IsStacked IsStrikeOut IsUnderlined Justification Kind Left MaskCharacter MaxSizeX Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 2,3 1,2,3

171

ActiveX interface

MaxSizeY MinSizeX MinSizeY Name PageNumber PtSizeX PtSizeY ResizeFlag RotateFlag Rotation ScaleFactor Selected SpacingX SpacingY Status Top Variable Width ZOrder AnchorElementID Description: Currently not used. Intended to be used, when position of one element can be dependant on position/size of another element. Syntax: AnchorElementID As Long AnchorLevel Description: Currently not used. Syntax: AnchorLevel As Long

1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

172

ActiveX interface

AnchorPoint Description: Identifies the point of the object, which is fixed on the label. If the object size is changed, the specified AnchorPoint remains on the same position. Possible values: Value 0 1 2 3 4 5 6 7 8 Syntax: AnchorPoint As Long See also: Width, Height, Left, Top BestFit Description: This property is TRUE if BestFit option for font resizing is enabled. Syntax: BestFit As Boolean Color Description: With 32-bit value you can specify any RGB color. The color value has the following hexadecimal form: 0x00bbggrr Description top left top center top right mid left mid center mid right bottom left bottom center bottom right

173

ActiveX interface

The low-order byte (rr) contains a value for the relative intensity of red; the second byte (gg) contains a value for green; and the third byte (bb) contains a value for blue. The fourth byte byte must be zero. Each color parameter can range from 0x0 to 0xFF. Syntax: Color As Long Contents Description: Returns the current contents of the element. Syntax: Property Contents As String Access Rights: read-only ContentsMask Description:

Sets and gets the ContentsMask attribute.

Syntax: ContentsMask As String FontName Description: FontName property represents the name of the font used within paragraph. Syntax: FontName As String FormatID Description: This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Value Description

174

ActiveX interface

0 1 2 3 4 5 6 7

All Numeric Alphanumeric Letters 7 bit Hex Date Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory. Syntax: FormatID As Long Height Description: Height of the element (in 0.01 mm units). Syntax: Property Height As Long Access Rights: read-only See also: Width, AnchorPoint, Left, Top ID Description: ID of the element Syntax: Property ID As Long Access Rights: read-only

175

ActiveX interface

IsBold Description: When the font for the Paragraph element has enabled Bold property then this property is TRUE. Syntax: IsBold As Boolean IsInverse Description: This property is TRUE if Inverse efect is enabled. Syntax: IsInverse As Boolean IsItalic Description: When the font for the Paragraph element has enabled Italic property then this property is TRUE. Syntax: IsItalic As Boolean IsLocked Description: When the elements position is locked on the label, this property has the value TRUE Syntax: IsLocked As Boolean IsMirror Description: This property is TRUE if Mirror efect is enabled. Syntax: IsMirror As Boolean

176

ActiveX interface

IsStacked Description: The property defines if the text is normal or stacked Syntax: IsStacked As Boolean IsStrikeOut Description: The property defines if the text is striked out Syntax: IsStrikeOut As Boolean IsUnderLined Description: The property defines if the text is underlined Syntax: IsUnderlined As Boolean Justification Description: Justification proprety represents how the contents of the text object will be justified. Possible values are:

Value 0 1 2 3 4

Description None Right Left Center Full

Syntax: Justification As Long

177

ActiveX interface

Kind Element kind. Possible values are: Value 301 302 303 304 305 306 307 308 309 312 313 Syntax: Property Kind As Long Access Rights: read-only Left Description: Left position of the element (in 0.01 mm units). Syntax: Property Left As Long Access Rights: read-only See also: Width, AnchorPoint, Hight, Top MaskCharacter This property defines the mask character for the contents mask of the text object Description TextObject RectangleObject BitmapObject BarcodeObject LineObject InverseObject OleObject Downloaded Graphic Object ParagraphObject RTFTextObject EllipseObject

178

ActiveX interface

Syntax: MaskCharacter as String MaxSizeX MaxSizeX property represents the maximim size of the font size in horizontal direction which is allowed when BestFit is enabled. Syntax: MaxSizeX As Long See also: BestFit, MaxSizeY, MinSizeX, MinSizeY, SpacingX, SpacingY MaxSizeY MaxSizeY property represents the maximim size of the font size in vertical direction which is allowed when BestFit is enabled. Syntax: MaxSizeY As Long See also: BestFit, MaxSizeX, MinSizeX, MinSizeY, SpacingX, SpacingY MinSizeX Description: MinSizeX property represents the minimum size of the font size in horizontal direction which is allowed when BestFit is enabled. Syntax: MinSizeX As Long See also: BestFit, MaxSizeX, MaxSizeY, MinSizeY, SpacingX, SpacingY MinSizeY Description MinSizeY property represents the minimum size of the font size in vertical direction which is allowed when BestFit is enabled. Syntax: MinSizeY As Long

179

ActiveX interface

See also: BestFit, MaxSizeX, MaxSizeY, MinSizeX, SpacingX, SpacingY Move Description: Move the element to the location X, Y Syntax: Move(X As Long, Y As Long) Name Description: Name property represents the name of the RTF text. Syntax: Name As String PageNumber Description: The Page index, where the element is located. When Duplex print is used, this index can have the value 0 (first page) or 1 (second page). When duplex printing is not enabled, this property is ignored (the value should always be 0). Syntax: PageNumber As Long PtSizeX Description: PtSizeX represents font size in horizontal direction. Default size is 0. In this case default size for selected font is set. Syntax: PtSizeX As Long See also: Color, Fontname, IsBold, IsItalic, IsInverse, PtSizeY

180

ActiveX interface

PtSizeY Description: PtSizeY represents vertical font size. Syntax: PtSizeY As Long See also: Color, Fontname, IsBold, IsItalic, IsInverse, PtSizeX Resize Description: Resize the element to the size Width, Height. The element is resized to the closest size in case, that all sizes are not possible. Syntax: Resize(Width As Long, Height As Long) See also: ResizeFlag ResizeFlag Description: Flag, which defines, how the object can be resized. Possible values are: Value 0 0x88 0x22 0x55 Syntax: Property ResizeFlag As Long Access Rights: read-only Description no resizing resizing is possible only in horizontal direction resizing is possible only in vertical direction resizing is possible only in both directions at the same time

181

ActiveX interface

See also: Resize RotateFlag Description: Flag, which defines, how the object can be rotated. Possible values are: Value 0 0x07 0x02 0xFF Syntax: Property RotateFlag As Long Access Rights: read-only See also: Rotation Rotation Description: Specifies the elements rotation. When the element can be rotated only in steps of 90 degrees. The valid values for the property are: Value 0 1 2 3 Description 0 deg. 90 deg. 180 deg. 270 deg. Description no rotation 90 degrees rotation 180 degrees rotation 0-360 degrees rotation in steps of 1 degree

When the element can be rotated in steps of 1 degree, the property has the value from 0 to 359.

182

ActiveX interface

Syntax: Rotation As Long See also: RotateFlag Selected Description: When the element is selected, this property is TRUE. Syntax: Selected As Boolean SetContents Description: When the contents of an element should be changed, SetContents method should be called. In case of success (the Value is valid for the element), the function returns 0. In case of an error, the function returns 1. Syntax: Function SetContents(Value As String) As Long SetVariable Description: Connects the element to the variable with ID. If the return value of the function is 1, then some error occured during the connection. The best example for this is that you want connect variable with fixed length to an element which requires different fixed lenght. (EAN13 barcode). In such case element is not connected to any variable it is fixed. Syntax: Function SetVariable(ID As Long) As Long SpacingX Description: With SpacingX property you select spacing between each character. Syntax: SpacingX As Long

183

ActiveX interface

See also: BestFit, MaxSizeX, MaxSizeY, MinSizeX, MinSizeY, SpacingY SpacingY Description: With SpacingY property you select spacing between each line. Syntax: SpacingY As Long See also: BestFit, MaxSizeX, MaxSizeY, MinSizeX, MinSizeY, SpacingX Status Description: Status of the object. Possible values are : Value 0 1 2 Description OK Error condition Phantom

Syntax: Property Status As Long Access Rights: read-only Top Description: Top position of the element (in 0.01 mm units). Syntax: Property Top As Long Access Rights:

184

ActiveX interface

read-only See also: Width, AnchorPoint, Left, Height Variable Description: Returns the interface to the variable, which is attached to the element. Syntax: Property Variable As IVar Access Rights: read-only Width Description: Width of the element (in 0.01 mm units). Syntax: Property Width As Long Access Rights: read-only See also: Top, AnchorPoint, Left, Height

ZOrder Description: Value of Z order of the object position. When the Zorder value is the highest, the element is placed on the top of all others. Syntax: ZOrder As Long

185

ActiveX interface

2.9.23 Class IText (Advanced Only)

Methods Move Resize SetContents SetVariable Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 Properties AnchorElementID AnchorLevel AnchorPoint BestFit CharSet Color Contents ContentsMask FontName FormatID Height ID IsBold IsInverse IsItalic IsLocked IsMirror IsRTL IsStacked IsStrikeOut IsUnderlined Justification Kind Left MaskCharacter MaxSizeX MaxSizeY MinSizeY MinSizeY Name PageNumber PtSizeX PtSizeY Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

186

ActiveX interface

ResizeFlag RotateFlag Rotation ScaleFactor Selected SpacingX SpacingY Status Top Variable Width ZOrder AnchorElementID Description: Currently not used. Intended to be used, when position of one element can be dependant on position/size of another element. Syntax: AnchorElementID As Long AnchorLevel Description: Currently not used. Syntax: AnchorLevel As Long AnchorPoint Description: Identifies the point of the object, which is fixed on the label. If the object size is changed, the specified AnchorPoint remains on the same position. Possible values: Value 0 Description top left

1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

187

ActiveX interface

1 2 3 4 5 6 7 8 Syntax:

top center top right mid left mid center mid right bottom left bottom center bottom right

AnchorPoint As Long See also: Top, Hight, Left, Height BestFit Description: This property is TRUE if BestFit option for font resizing is enabled. Syntax: BestFit As Boolean See also: MaxSizeX, MaxSizeY, MinSizeX, MinSizeY, SpacingX, SpacingY

CharSet Description: This property sets character set for text element and selected font. Possible values are: Language Chinese (Trad.) Croatian Czech Danish Dutch English CharSet 136 238 238 0 0 0

188

ActiveX interface

Finnish French German Greek Hebrew Hungarian Italian Lithuanian Polish Russian Serbian Slovak Slovene Spanish Swedish Turkish Chinese (Simpl.) Japanese Thai Portuguese Ukrainian Norwegian Syntax: Property CharSet As Long

0 0 0 161 177 238 0 186 238 204 238 238 238 0 0 162 134 128 222 0 204 0

Access Rights: read-write

Color Description: With 32-bit value you can specify any RGB color. The color value has the following hexadecimal form: 0x00bbggrr

189

ActiveX interface

The low-order byte (rr) contains a value for the relative intensity of red; the second byte (gg) contains a value for green; and the third byte (bb) contains a value for blue. The fourth byte byte must be zero. Each color parameter can range from 0x0 to 0xFF. Syntax: Color As Long See also: FontName, IsBold, IsInverse, IsItalic, IsMirror, IsRTL, SpacingX, SpacingY, PtSizeX, PtSizeY Contents Description: Returns the current contents of the element. Syntax: Property Contents As String Access Rights: read-only ContentsMask Description:

Sets and gets the ContentsMask attribute.

Syntax: ContentsMask As String FontName Description: FontName property represents the name of the font used within paragraph. Syntax: FontName As String See also: Color, IsBold, IsInverse, IsItalic,IsMirror, SpacingY, PtSizeX, PtSizeY IsRTL, SpacingX,

190

ActiveX interface

FormatID Description: This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Value 0 1 2 3 4 5 6 7 Description All Numeric Alphanumeric Letters 7 bit Hex Date Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory. Syntax: FormatID As Long Height Description: Height of the element (in 0.01 mm units). Syntax: Property Height As Long Access Rights: read-only See also: Top, AnchorPoint, Left, Width ID Description: ID of the element

191

ActiveX interface

Syntax: Property ID As Long Access Rights: read-only IsBold Description: When the font for the Paragraph element has enabled Bold property then this property is TRUE. Syntax: IsBold As Boolean See also: Color, FontName, IsInverse, IsItalic, IsMirror, IsRTL, SpacingX, SpacingY, PtSizeX, PtSizeY IsInverse Description: This property is TRUE if Inverse efect is enabled. Syntax: IsInverse As Boolean See also: Color, FontName, IsBold, IsItalic, IsMirror, IsRTL, SpacingX, SpacingY, PtSizeX, PtSizeY IsItalic Description: When the font for the Paragraph element has enabled Italic property then this property is TRUE. Syntax: IsItalic As Boolean See also: Color, FontName, IsBold, IsInverse, IsMirror, IsRTL, SpacingX, SpacingY, PtSizeX, PtSizeY

192

ActiveX interface

IsLocked Description: When the elements position is locked on the label, this property has the value TRUE Syntax: IsLocked As Boolean IsMirror Description: This property is TRUE if Mirror efect is enabled. Syntax: IsMirror As Boolean See also: Color, FontName, IsBold, IsInverse, IsItalic, IsRTL, SpacingX, SpacingY, PtSizeX, PtSizeY IsRTL Description: The client application can check the possibility to set this property by setting it to another value. If the property value (after reading) still has the old value, this means it can not be set. In this case the user interface involved can be disabled. Syntax: Property IsRTL As Boolean See also: Color, FontName, IsBold, IsInverse, IsItalic, IsMirror, SpacingX, SpacingY, PtSizeX, PtSizeY IsStacked Description: Sets and gets the Stacked text attribute. Syntax: Property IsStacked As Boolean

193

ActiveX interface

Justification Description: Justification proprety represents how the contents of the text object will be justified. Possible values are:

Value 0 1 2 3 4

Description None Right Left Center Full

Syntax: Justification As Long

Kind Element kind. Possible values are: Value 301 302 303 304 305 306 307 308 309 312 313 Description TextObject RectangleObject BitmapObject BarcodeObject LineObject InverseObject OleObject Downloaded Graphic Object ParagraphObject RTFTextObject EllipseObject

194

ActiveX interface

Syntax: Property Kind As Long Access Rights: read-only Left Description: Left position of the element (in 0.01 mm units). Syntax: Property Left As Long Access Rights: read-only See also: Top, AnchorPoint, Width, Height MaskCharacter Description: With MaskCharacter you can define the mask character for the Text object. Syntax: MaskCharacter As String Move Description: Move the element to the location X, Y Syntax: Move(X As Long, Y As Long) Name Description: Name property represents the name of the RTF text. Syntax: Name As String

195

ActiveX interface

Selected PageNumber Description: The Page index, where the element is located. When Duplex print is used, this index can have the value 0 (first page) or 1 (second page). When duplex printing is not enabled, this property is ignored (the value should always be 0). Syntax: PageNumber As Long PtSizeX Description: PtSizeX represents font size in horizontal direction. Default size is 0. In this case default size for selected font is set. Syntax: PtSizeX As Long See also: Color, FontName, IsBold, IsInverse, IsItalic, IsMirror, SpacingX, SpacingY, IsRTL, PtSizeY PtSizeY Description: PtSizeY represents vertical font size. Syntax: PtSizeY As Long See also: Color, FontName, IsBold, IsInverse, IsItalic, IsMirror, SpacingX, SpacingY, IsRTL, PtSizeX Resize Description: Resize the element to the size Width, Height. The element is resized to the closest size in case, that all sizes are not possible. Syntax:

196

ActiveX interface

Resize(Width As Long, Height As Long See also: ResizeFlag

ResizeFlag Description: Flag, which defines, how the object can be resized. Possible values are: Value 0 0x88 0x22 0x55 Syntax: Property ResizeFlag As Long Access Rights: read-only See also: Resize RotateFlag Description: Flag, which defines, how the object can be rotated. Possible values are: Value 0 0x07 0x02 0xFF Description no rotation 90 degrees rotation 180 degrees rotation 0-360 degrees rotation in steps of 1 degree Description no resizing resizing is possible only in horizontal direction resizing is possible only in vertical direction resizing is possible only in both directions at the same time

197

ActiveX interface

Syntax: Property RotateFlag As Long Access Rights: read-only See also: Rotation Rotation Description: Specifies the elements rotation. When the element can be rotated only in steps of 90 degrees. Possible valuesThe valid values for the property are: Value 0 1 2 3 Description 0 deg. 90 deg. 180 deg. 270 deg.

When the element can be rotated in steps of 1 degree, the property has the value from 0 to 359. Syntax: Rotation As Long See also: RotateFlag ScaleFactor Description:

Sets an gets the Scaling factor. Setting this property does not always result in a change - depends on the font type
Syntax: ScaleFactor As Long

198

ActiveX interface

Selected Description: When the element is selected, this property is TRUE. Syntax: Selected As Boolean SetContents Description: When the contents of an element should be changed, SetContents method should be called. In case of success (the Value is valid for the element), the function returns 0. In case of an error, the function returns 1. Syntax: Function SetContents(Value As String) As Long SetVariable Description: Connects the element to the variable with ID. If the return value of the function is 1, then some error occured during the connection. The best example for this is that you want connect variable with fixed length to an element which requires different fixed lenght. (EAN13 barcode). In such case element is not connected to any variable it is fixed. Syntax: Function SetVariable(ID As Long) As Long

SpacingX Description: With SpacingX property you select spacing between each character. Syntax: SpacingX As Long See also: Color, FontName, IsBold, IsInverse, IsItalic, IsMirror, PtSizeY, SpacingY, IsRTL, PtSizeX

199

ActiveX interface

SpacingY Description: With SpacingY property you select spacing between each line. Syntax: SpacingY As Long See also: Color, FontName, IsBold, IsInverse, IsItalic, IsMirror, PtSizeY, SpacingX, IsRTL, PtSizeX Status Description: Status of the object. Possible values are : Value 0 1 2 Description OK Error condition Phantom

Syntax: Property Status As Long Access Rights: read-only Top Description: Top position of the element (in 0.01 mm units). Syntax: Property Top As Long Access Rights: read-only

200

ActiveX interface

See also: Width, AnchorPoint, Left, Height Variable Description: Returns the interface to the variable, which is connected to the text. Syntax: Property Variable As IVar Access Rights: read-only Width Description: Width of the element (in 0.01 mm units). Syntax: Property Width As Long Access Rights: read-only See also: Top, AnchorPoint, Left, Height ZOrder Description: Value of Z order of the object position. When the Zorder value is the highest, the element is placed on the top of all others. Syntax: ZOrder As Long

2.9.24 Class IVar (Advanced Only)

Methods Version Properties Version

201

ActiveX interface

Availability DependsOnFunction GetPureValue GetValue SetValue ShouldTraceNow Undefine 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 AutoTrim BreakLines Default DefaultValue DefType Description DynamicValue FixedLength FormatID HasMaxValue HasMinValue ID IncrementCount IncrementKind IncrementStep IncrementStep2 IncrementStep3 IncrementType InputPicture IsBasedOnQuantity IsDisabled IsInternal IsMultiLine IsUsed IsVarQuantity JustificationType Length LineCount LineLength MaxValue MinValue Name OutputPicture PadCharacter PickList PictureType

Availability 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

202

ActiveX interface

Prefix Prompt PromptCount PromptOrder RollOver StrictChecking Suffix Tag TraceOn ValueRequired VarType WordWrap AutoTrim Description:

1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3

AutoTrim property defines the behaviour of SetContents function of IVar interface. When AutoTrim is TRUE the value assinged to the variable is first trimmed to the length of the variable - this prevents errors when the provided value is too long. Default value is false. Syntax: Propery AutoTrim As Boolean

BreakLines Description: If variable has BreakLines option enabled then value of the WordWrap property is TRUE. Syntax: BreakLines As Boolean Default Description: Default method returns the current value of the variable. Syntax: Property Default As String

203

ActiveX interface

Access Rights: read-only DefaultValue Description: In DefaultValue property is stored a default value for the variable. Syntax: DefaultValue As String See also: DynamicValue, FixedLenght, IsBasedonQuantity, ValueRequired DefType Description: DefType property represents the case on which default value for the variable will be selected. Possible values are: Value 0 1 2 Description None No default value Prompt You are prompted for default value No prompt Default value is stored in Default value property

Syntax: DefType As Long DependsOnFunction Description: DependsOnFunction method is used for checking if variable is dependet of the function. For input parameter is used function ID. In case that variable is dependet of the function then return value is TRUE. Syntax: Function DependsOnFunction(FunctionID As Long) As Boolean

204

ActiveX interface

Description Description: Description property represents the description of the variable. Syntax: Description As String DynamicValue Description: DynamicValue has value TRUE, if "Dynamic value" option for default value is enabled. Syntax: DynamicValue As Boolean See also: DefaultValue, FixedLenght, IsBasedonQuantity, ValueRequired FixedLength Description: If variable has fixed lenght then FixedLength property has value TRUE. Syntax: FixedLength As Boolean See also: DefaultValue, DynamicValue, IsBasedonQuantity, ValueRequired FormatID Description: This is the ID of a contents format, which specifies the character set, which is allowed to be used for the element. The following IDs are valid: Value 0 1 2 Description All Numeric Alphanumeric

205

ActiveX interface

3 4 5 6 7

Letters 7 bit Hex Date Time

Details about the characters in each format can be found in formats.def file, located on BIN\SYSTEM directory. Syntax: FormatID As Long GetPureValue Description: This function returns a pure value of the variable without any prefix or suffix in case they are defined. Syntax: Function GetPureValue() As String

See also: GetValue, SetValue GetValue Description: GetValue method returns the current value of the variable. Syntax: Function GetValue() As String See also: GetPureValue, SetValue

HasMaxValue Description: HasMaxValue property has value TRUE, if range check option Max value is enabled.

206

ActiveX interface

Syntax: HasMaxValue As Boolean See also: HasMinValue, MaxValue, MinValue, RollOver HasMinValue Description: HasMinValue property has value TRUE, if range check option Min value is enabled. Syntax: HasMinValue As Boolean See also: HasMaxValue, MaxValue, MinValue, RollOver ID Description: ID of the element Syntax: Property ID As Long Access Rights: read-only IncrementCount Description: IncrementCount property represents the number on how many printed labels counter will be incremented. Syntax: IncrementCount As Long See also: IncrementKind, IncrementStep, IncrementStep2, IncrementStep3, IncrementType

207

ActiveX interface

IncrementKind Description: IncrementKind property represents the kind of the increment. Increment can be performed on several types of variables. Possible values are: Value 0 1 2 Description Integer Date Time

Syntax: Property IncrementKind As Long Access Rights: read-only See also: IncrementCount, IncrementStep, IncrementStep2, IncrementStep3, IncrementType IncrementStep Description: IncrementStep property represents the step of the increment. Please Note: Incrementing depends on the type of the variable. If variable type is Integer then only IncrementStep property is used. For all other types such as Time or Date there are IncrementStep2 and IncrementStep3. In each of them there is only one number. Date: Days are stored in IncrementStep Months are stored in IncrementStep2 Years are stored in IncrementStep3 Time: Hours are stored in IncrementStep Minutes are stored in IncrementStep2 Seconds are stored in IncrementStep3

208

ActiveX interface

Syntax: IncrementStep As Long See also: IncrementCount, IncrementKind, IncrementStep2, IncrementStep3, IncrementType IncrementStep2 Description: See IncrementStep Syntax: IncrementStep2 As Long See also: IncrementCount, IncrementKind, IncrementStep, IncrementStep3, IncrementType

IncrementStep3 Description: See IncrementStep Syntax: IncrementStep3 As Long See also: IncrementCount, IncrementKind, IncrementStep, IncrementStep2, IncrementType IncrementType Description: IncrementType property represents the type of incrementation. Possible values are: Value 0 1 Description None Increment

209

ActiveX interface

2 3

Decrement Offset

Syntax: Property IncrementType As Long Access Rights: read-only See also: IncrementCount, IncrementKind, IncrementStep, IncrementStep2, IncrementStep3

InputPicture Description: InputPicture property is represents a string (Input format), which can be set in Variable dialog box under Format tab. Each type of variable has it's own possibilites for input pictures. Syntax: InputPicture As String IsBasedOnQuantity Description: IsBasedOnQuantity property has value TRUE, if "Based on var. quantity" is enabled. Syntax: IsBasedOnQuantity As Boolean See also: DefaultValue, DynamicValue, FixedLenght, ValueRequired IsDisabled Description: This property sets (or gets) the variables disabled attribute. When this attribute is set, the variable is not shown in the variables selection lists. Syntax:

210

ActiveX interface

Property IsDisabled As Boolean IsInternal Description: ReadOnly property, which tells the client if this is an internal variable the variable, which gets the value from the system rather than from the label data. Syntax: Property IsInternal As Boolean Access Rights: read-only IsMultiLine Description: If variable has MultiLine option enabled then value of the IsMultiLine property is TRUE. Syntax: IsMultiLine As Boolean See also: IsVarQuantity, Length, PickList IsUsed Description: IsUsed has value TRUE, if variable is connected with an element on the label. In the other case IsUsed has value FALSE. Syntax: property IsUsed As Boolean Access Rights: read-only IsVarQuantity Description: IsVarQuantity property has value TRUE, if "Treat as variable quantity" is enabled. Syntax:

211

ActiveX interface

IsVarQuantity As Boolean See also: IsMultiLine, Length, PickList JustificationType Description: JustificationType proprety represents how the contents of the variable will be justified. Possible values are: Value 0 1 2 3 4 Description None Right Left Center Full

For the variables full justification type is not used. Syntax: JustificationType As Long Length Description: Lenght propery represents the lenght of the variable. Length can have value between 1 and 4096. Syntax: Length As Long See also: IsMultiLine, IsVarQuantity, PickList LineCount Description: LineCount property represents the number of lines in one variable. LineCount can have value between 1 and 100.

212

ActiveX interface

Syntax: LineCount As Long LineLength Description: LineLength property represents the lenght of the one line. LineLength can have value between 1 and 4096. Syntax: LineLength As Long MaxValue Description: MaxValue represents the minimal value for rangechecking. Syntax: MaxValue As String See also: HasMaxValue, HasMinValue, MinValue, RollOver MinValue Description: MinValue represents the minimal value for rangechecking. Syntax: MinValue As String See also: HasMaxValue, HasMinValue, MaxValue, RollOver Name Description: Name property represents the name of the variable. Name can be only 12 characters long. Syntax: Name As String

213

ActiveX interface

OutputPicture Description: OutputPicture property is represents a string (Output format), which can be set in Variable dialog box under Format tab. Each type of variable has it's own possibilites for output pictures. Syntax: OutputPicture As String PadCharacter Description: PadCharacter property represents the PadCharacter of the variable. Syntax: PadCharacter As String See also: Prefix, Suffix PickList Description: This property retrieves the pick list for the current variable. Syntax: Property PickList As String Access Rights: read-only See also: IsMultiLine, IsVarQuantity, Length PictureType Description: Picture type property represents, which picture for the variable is selected. Possible values are: Value 0 Description None

214

ActiveX interface

1 2 3 4 5 6

Date Time Floating point Money List Binary

Syntax: PictureType As Long Prefix Description: Prefix property represents the prefix of the variable. Syntax: Prefix As String See also: PadCharacter, Suffix Prompt Description: In Prompt property is stored a prompt string. Syntax: Prompt As String PromptCount Description: PromptCount property represents the number on how many printed labels it will be prompted. Syntax: PromptCount As Long PromptOrder Description:

215

ActiveX interface

ReadWrite property, with which you can get or set the prompt order of the variable. Syntax: Property PromptOrder As Integer Access Rights: read-write

RollOver Description: RollOver has value TRUE, if "RollOver" option is enabled. Syntax: RollOver As Boolean See also: HasMaxValue, HasMinValue, MaxValue, MinValue SetValue Description: SetValue method is used for setting the value for the variable. Syntax: Function SetValue(Value As String) As Long See also: GetPureValue, GetValue ShouldTraceNow Description: In case that you want save value of the variable to the log file you should use ShouldTraceNow method. Syntax: Function ShouldTraceNow(bStart As Boolean) As Boolean StrictChecking Description:

216

ActiveX interface

StrictChecking property has value TRUE, if strict checking flag is enabled. Strict checking flag prevents to connect a variable, with different length that is required by element, to an element. Syntax: StrictChecking As Boolean Suffix Description: Suffix property represents the suffix of the variable. Syntax: Suffix As String See also: PadCharacter, Prefix Tag Description: Tag property is a simple integer property, that the client application can use for any kind of internal processing. Syntax: Propery Tag As Long

TraceOn Description: TraceOn has value TRUE, if variable tracing is enabled. Syntax: TraceOn As Boolean

Undefine Description: Sets the InputType back to original. Intended Use:

217

ActiveX interface

When one database variable is set, its value is never read again from the database until the label is closed. With the Undefine call, the variable gets original state. This means that its value will be retrieved from the database although the label is not closed in between. Syntax: Function Undefine() As Boolean ValueRequired Description: ValueRequired has value TRUE, if "ValueRequired" option for prompted variable is enabled. Syntax: ValueRequired As Boolean See also: DefaultValue, DynamicValue, FixedLenght, IsBasedonQuantity VarType Description: Vartype property represents the type of the variable. Vartype property can have following values: Value 1 2 3 4 5 6 7 8 Please note: Overload type of the variable is internal type of the variable. It is used, when external application sets value for the variable. Contents provider is variable type, which is invisible to the user. Contents provider variable is the result of contents provider. Description Prompt System clock Printer clock Global Generated Overload Database Contents provider

218

ActiveX interface

Syntax: Property VarType As Long Access Rights: read-only WordWrap Description: If variable has WordWrap option enabled then value of the WordWrap property is TRUE. Syntax: WordWrap As Boolean

2.9.25 Class IVariableList (Advanced Only)

Methods Add Create CreatePrompted Delete FindByID FindByName FlushList Item Remove SetValues Add Description: Add method adds a variable with specific ID to the variable list. In case of success TRUE result is returned. Syntax: Version Availability 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 2,3 Properties Count Version Availability 1,2,3

219

ActiveX interface

Function Add(ID As Long) As Boolean Count Description: Count property returns the number of variables, which are defined on the label. Syntax: Property Count As Long Access Rights: read-only Create Description: Create method creates new variable. Output result is interface to the new variable and input parameter is the name of the new variable. Syntax: Function Create(Name As String) As IVar See also: Create, CreatePrompted, Delete, Remove CreatePrompted Description: Create method creates new prompted variable. Output result is interface to the new variable and input parameter is the name of the new variable. Syntax: Function CreatePrompted(Name As String) As IVar See also: Create, Delete, Remove

Delete Description: Delete method deletes a variable with specific ID. In case of success TRUE result is returned.

220

ActiveX interface

Syntax: Function Delete(ID As Long) As Boolean See also: Create, CreatePrompted, Remove FindByID Description: Returns the interface to the existing variable. Variable is selected with ID. Syntax: Function FindByID(ID As Long) As IVar See also: FindByName FindByName Description: Description: Returns the interface to the existing variable. Variable is selected with Name. Syntax: Function FindByName(Name As String) As IVar See also: FindByID

FlushList Description: FlushList method erases the whole variable list. If the operation was sucessfull TRUE value is returned. Syntax: Function FlushList() As Boolean Item Description:

221

ActiveX interface

Returns the interface to the existing variable. Variable is selected with Index. Syntax: Function Item(Index As Long) As IVar Remove Description: Remove method removes a variable with specific ID from the variable list. In case of success TRUE result is returned. Syntax: Function Remove(ID As Long) As Boolean See also: Create, CreatePrompted, Delete SetValues Description: The IVariableList interface is extended to support setting multiple variable values with a single command. The command is defined as: Parameter Values should contain multiline value (one line for each variable). Each line must be defined in format: VariableName=VariableValue The command will process each line and set the value for the variable. In case the variable name is invalid (variable with that name does not exist), the function will return an error. In case the value is not valid for a variable, the function returns an error. If en error is encountered, the processing of the functon will be terminated (remaining lines will not be processed). Functon returns 0 if the processing completes successfully. If not, an error code is returned and calling application can use ErrorID and ErrorMessage properties of the LGApp interface to process the error. Syntax: SetValues(Values As String)

222

ActiveX interface

2.9.26 Class ILabelSettings (Advanced Only)

Methods SetLabelSize Version Availability 2,3 Properties Author DefaultQuantity Description GapX GapY IsMultiband LabelDimensions Unit LabelOffsetX LabelOffsetY LabelSizeX LabelSizeY NumberOfBands Overlap PageOffsetX PageOffsetY PageSizeX PageSizeY PaperFormat PaperSizeX PaperSizeY PhysPageSizeX PhysPageSizeY PrintPages RadiusX RadiusY Title UGapX UGapY ULabelOffsetB Version Availability 1,2,3 2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

223

ActiveX interface

ULabelOffsetR ULabelOffsetX ULabelOffsetY ULabelSizeX ULabelSizeY UOverlap UPaperSizeX UPaperSizeY URadiusX URadiusY UGapY WebX WebY

1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3 1,2,3

Common to all properties: All sizes are measured in the unit that is set in LabelDimensionsUnit if the property name has "U" as the first letter of the name. Author Description: Returns the name of the author of the label

Syntax: Property Author As String DefaultQuantity Description: Returns the default quantity, which is suggested before label production. Syntax: Property DefaultQuantity As Long Access Rights: read-only

224

ActiveX interface

Description Description: Returns the description of the label. Syntax: Property Description As String Access Rights: read-only GapX Description: Returns the gap between the labels in mm/100 for the X axis. UGapX - gap between the labels in LabelDimensionsUnit (X axis) Syntax: Property GapX As Long Access Rights: read-only See also: GapY

GapY Description: Returns the gap between the labels in mm/100 for the Y axis. UGapY - gap between the labels in LabelDimensionsUnit (Y axis) Syntax: Property GapY As Long Access Rights: read-only See also:

225

ActiveX interface

GapX IsMultiband Description: Returns true if the label is desinged for multiband printing, otherwise result of the property is false. Syntax: Property IsMultiBand As Boolean Access Rights: read-only See also: NumberOfBands

LabelDimensionsUnit Description: Returns the unit of measure used for the label settings. Syntax: Property LabelDimensionsUnit As String Access Rights: read-only

LabelOffsetX Description: Returns the left offset, which is defined in the label. ULabelOffsetR - right offset (calculated by LGLabel) Syntax: Property LabelOffsetX As Long Access Rights: read-only

226

ActiveX interface

See also: LabelOffsetY LabelOffsetY Description: Returns the top offset, which is defined in the label. ULabelOffsetB - bottom offset (calculated by LGLabel) Syntax: Property LabelOffsetY As Long Access Rights: read-only See also: LabelOffsetX

LabelSizeX Description: Returns the height of the label. ULabelSizeX represents the width of the label in defined units. See also: LabelSizeX

Syntax: Property LabelSizeX As Long Access Rights: read-only

LabelSizeY Description: Returns the width of the label.

227

ActiveX interface

ULabelSizeY represents the width of the label in defined units. Syntax: Property LabelSizeY As Long Access Rights: read-only See also: LabelSizeY

NumberOfBands Description: Returns the number of bands, which are used in the label when multi-band label printing is enabled. Syntax: Property NumberOfBands As Long Access Rights: read-only See also: IsMultiband

Overlap Description: Overlapping of the labels when using multi-band label printing in mm/100 Syntax: Property Overlap As Long Access Rights: read-only

228

ActiveX interface

PageOffsetX Description: Offset for the unprintable area (X axis) Syntax: Property PageOffsetX As Long Access Rights: read-only See also: PageOffsetX

PageOffsetY Description: Offset for the unprintable area (Y axis) Syntax: Property PageOffsetY As Long Access Rights: read-only See also: PageOffsetY

PageSizeX Description: Returns the width of the printable page. Syntax: Property PageSizeX As Long Access Rights: read-only See also:

229

ActiveX interface

PageSizeY

PageSizeY Description: Returns the height of the printable page. Syntax: Property PageSizeY As Long Access Rights: read-only See also: PageSizeX PaperFormat Description: Returns the format of the paper. This is the dmPaperSize property from the DEVMODE structure of the printer driver. Syntax: Property PaperFormat As Long Access Rights: read-only PaperSizeX Description: Returns the paper size. This is the dmPaperWidth * 10 property from the DEVMODE structure of the printer driver. UPaperSizeX - the information expressed in LabelDimensionsUnit Syntax: Property PaperSizeX As Long Access Rights: read-only

230

ActiveX interface

See also: PaperSizeY

PaperSizeY Description: Returns the paper size. This is the dmPaperHeight * 10 property from the DEVMODE structure of the printer driver. UPaperSizeY - the information expressed in LabelDimensionsUnit Syntax: Property PaperSizeX As Long Access Rights: read-only See also: PaperSizeX

PhysPageSizeX Description: Returns the whole width of the page. Syntax: Property PhysPageSizeX As Long Access Rights: read-only See also: PhysPageSizeY

PhysPageSizeY Description: Returns the whole height of the page.

231

ActiveX interface

Syntax: Property PhysPageSizeY As Long Access Rights: read-only See also: PhysPageSizeX PrintPages Description: Property returns true if the Print pages option is used in print dialog otherwise it returns false. This option can be selected when printing multiple labels across. Syntax: Property RadiusX As Long Access Rights: read-only

RadiusX Description: Returns the radius value for the X axis of the label. UradiusX in LabelDimensionsUnit (X axis) Syntax: Property RadiusX As Long Access Rights: read-only See also: RadiusX

RadiusY Description:

232

ActiveX interface

Returns the radius value for the Y axis of the label. UradiusY in LabelDimensionsUnit (Y axis) Syntax: Property RadiusY As Long Access Rights: read-only See also: RadiusY

SetLabelSize Description: Use this method if you want to change the label size and other label settings. What is possible to set can be seen in the parameters. Syntax: Function SetLabelSize(LabelWidth As Long, LabelHeight As Long, LeftOffset As Long, TopOffset As Long, RightOffset As Long, BottomOffset As Long) As Boolean Access Rights: read-write Title Description: Property retrieves the title of the label. Syntax: Property Title As String Access Rights: read-write

233

ActiveX interface

UGapX Description: Property retrieves the GapX label setting in users measurment unit. Syntax: Property UGapX As String Access Rights: read-write

UGapY Description: Property retrieves the GapY label setting in users measurment unit.

Syntax: Property UGapY As String Access Rights: read-write

ULabelOffsetB Description: Property retrieves bottom label offset setting in users measurment unit. Syntax: Property ULabelOffsetB As String Access Rights: read-write

ULabelOffsetR Description: .

234

ActiveX interface

Syntax: Property ULabelOffsetR As String Access Rights: read-write

ULabelOffsetX Description: Property retrieves left label offset setting in users measurment unit. Syntax: Property ULabelOffsetX As String Access Rights: read-write

ULabelOffsetY Description: Property retrieves top label offset setting in users measurment unit. Syntax: Property ULabelOffsetY As String Access Rights: read-write

ULabelOffsetR Description: Property retrieves right label offset setting in users measurment unit. Syntax: Property ULabelOffsetR As String Access Rights: read-write

235

ActiveX interface

ULabelSizeX Description: Property retrieves label width setting in users measurment unit. Syntax: Property ULabelSizeX As String Access Rights: read-write ULabelSizeY Description: Property retrieves label height setting in users measurment unit. Syntax: Property ULabelSizeY As String Access Rights: read-write UOverlap Description: Property retrieves multiband overlaping setting in users measurment unit. Syntax: Property UOverlap As String Access Rights: read-write

UPaperSizeX Description: Property retrieves paper width setting in users measurment unit. Syntax:

236

ActiveX interface

Property UPaperSizeX As String Access Rights: read-write

UPaperSizeY Description: Property retrieves paper height setting in users measurment unit. Syntax: Property UPaperSizeY As String Access Rights: read-write

URadiusX Description: Property retrieves horizontal label radius setting in users measurment unit. Syntax: Property URadiusX As String Access Rights: read-write

URadiusY Description: Property retrieves vertical label radius setting in users measurment unit. Syntax: Property URadiusY As String Access Rights: read-write WebX Description:

237

ActiveX interface

Returns the number of labels on the page (X axis) Syntax: Property WebX as Long Access Rights: read-only See also: WebY

WebY Description: Returns the number of labels on the page (Y axis) Syntax: Property WebY as Long Access Rights: read-only See also: WebX

2.10 Label Gallery ActiveX interfaces for advanced users

In certain cases additional methods and properties can be used by advanced users.

2.10.1 Class Application

Methods JobRunEx LabelImport SetControlEvent TestConnection Version Availability 2,3 2,3 2,3 1,2,3 Properties ReadWriteOpen IsPrintOnly Version Availability 1,2,3 3

238

ActiveX interface

IsPrintOnly Description: This property returns true if the NiceLabel/NiceEngine is running in print only mode. When in print only mode some activex methods are not working or are working in different manner. Syntax: IsPrintOnly As Boolean JobRunEx Description: With this method LGLabel is able to read the third-party job file, and execute the printing. LGLabel will use the Variable import filter DLLs to be able to execute third party job files. This method identifies the DLL based on the JobType parameter. In case the Variable import filter DLL with specified JobType is not registered an error will be produced. When appropriate filter DLL will be identified, LGLabel will call the Conversion function in the DLL, which converts the third-party job file to LGLabels native job file format. In order to support UNICODE values of the job file, LGLabel will be updated to support UTF-8 formatted JOB files (UTF8 boom must be included at the beginning of the JOB file). For implementation of the method check Oracle XML filter in the LGlabel.

Syntax; Function JobRunEx(FileName As String, JobType As Long) As Boolean Explanation of the parameters: FileName Represents the Job file name. JobType Number of Job types that DLL supports LabelImport Description: This method is used to import label files from another labeling software. Import filter has to be design on the user side. Import filter is a DLL, which is loaded on runtime when user requests to import labels from another labeling software. The DLL is registered in the registry. When used, it passes information about available import file types, which can be imported using the selected filter. LGLabel is using the import filter DLL interface to retrieve the available file types that can be used with the filter. After user of LGLabel browses the file, LGLabel

239

ActiveX interface

passes this file name to the filter, and the filter creates LGLabels LBT file format. LBT is a text-formatted file, which LGLabel recognizes and can directly load. Syntax: Function LabelImport(FilterID As Long, FormatID As Long, ImportFile As String, ExportFile As String, EmbedGraphics As Boolean) As Boolean Explanation of the parameters: FilterID Name of the import filter (1,2,...) FormatID Name of the import filter function (1,2,...) ImportFile Path name to the original file. ExportFile Pathname to the destination file. EmbedGraphics Background picture embedded in the label: True: embedded False: not embedded ReadWriteOpen Description: With this property you can control wether the labels opened through ActiveX are opened in read only mode or not. If this property is true then the label is opened in read/write mode and if modified it can be saved. Syntax: ReadWriteOpen As Boolean SetControlEvent Description: Event objects provide means to synchronize between the caller application and the server application. PrintEvent handling is implemented on Application level. The Event can be set from calling application (ControlEvent). The setting method also defines, if the ControlEvent should be released immediately after the first printing action (creation of print job), or the ControlEvent will be released by calling application (calling the event setting method with NULL parameter). Syntax: Function SetControlEvent(Event As Unknown, AutoRelease As Boolean) As Boolean Explanation of the parameters: Event It pass the Controlling event to Label Gallery application. If this parameter is NULL, any existing controlling event will be

240

ActiveX interface

released. AutoRelease TRUE: after the print action is completed, the event will be released. Subsequent print events will not have a control event (new control event should be set from the caller application) FALSE: after the printing is completed, the control event will not be released. If new print actions will be called, they will be logged under the same print event. TestConnection Description: Method test if the connection to ILGApp is established. Syntax: Function TestConnection() As Boolean

2.10.2 Class IDatabase

Methods Check Version Availability 2,3 HasFilter IsChecked Level Check Description: If the IsChecked property is set to false then the call to this method performs calculation of the function based on current data and return 0 if successfull or non 0 if not successfull. Also the IsChecked property is set to true after this call. Syntax: Function Check() As Long HasFilter Description: This property returns true if the database definition uses filter. Syntax: Property HasFilter As Boolean Properties Version Availability 1,2,3 2,3 2,3

241

ActiveX interface

IsChecked Description: If this property is set to false then the call to method Check performs calculation of the function based on current data and return 0 if successfull or non 0 if not successfull. Also this property is set to true after this call. . Syntax: Property IsChecked As Boolean Level Description: If the function is used in some other function then this function will have level 2 while its parent function will have level 1, this goes in depth depending on how many dependant function you have. It is needed when calculating the functions because those functions with higher level need to be calculated first in order that functions with lower level are calculated properly.

Syntax: Property Level As Long Explanation of the parameters: FilterID level number

2.10.3 Class IEXTFunction (Advanced Only)

Methods Check Version Availability 2,3 Properties IsChecked Level Check Description: If the IsChecked property is set to false then the call to this method performs calculation of the function based on current data and return 0 if successfull or non 0 if not successfull. Also the IsChecked property is set to true after this call. Version Availability 2,3 2,3

242

ActiveX interface

Syntax: Function Check() As Long IsChecked Description: If this property is set to false then the call to method Check performs calculation of the function based on current data and return 0 if successfull or non 0 if not successfull. Also this property is set to true after this call. . Syntax: Property IsChecked As Boolean Level Description: If the function is used in some other function then this function will have level 2 while its parent function will have level 1, this goes in depth depending on how many dependant function you have. It is needed when calculating the functions because those functions with higher level need to be calculated first in order that functions with lower level are calculated properly.

Syntax: Property Level As Long Explanation of the parameters: FilterID level number

2.10.4 Class IFunction

Methods Check Version Availability 2,3 Properties IsChecked IsUsed Level Version Availability 2,3 2,3 2,3

243

ActiveX interface

Check Description: If the IsChecked property is set to false then the call to this method performs calculation of the function based on current data and return 0 if successfull or non 0 if not successfull. Also the IsChecked property is set to true after this call. Syntax: Function Check() As Long IsChecked Description: If this property is set to false then the call to method Check performs calculation of the function based on current data and return 0 if successfull or non 0 if not successfull. Also this property is set to true after this call. . Syntax: Property IsChecked As Boolean IsUsed Description: Property tells you if this function is used on the label in some other function, element, . Syntax: Property IsUsed As Boolean Level Description: If the function is used in some other function then this function will have level 2 while its parent function will have level 1, this goes in depth depending on how many dependant function you have. It is needed when calculating the functions because those functions with higher level need to be calculated first in order that functions with lower level are calculated properly.

Syntax: Property Level As Long Explanation of the parameters:

244

ActiveX interface

FilterID level number

2.10.5 Class ILabel

Methods GetPrinterDarknessList Values GetPrinterList GetPrinterSpeedListVal ues GetPrinterDraknessListValues Description: Method retrieves commma separated list of darkness values for specified printer. Syntax: Function GetPrinterDarknessListValues(PrinterName As String) As String GetPrinterList Description: Method retrieves comma separated list of printer names. Syntax: Function GetPrintersList() As String Version Availability 1,2,3 2,3 2,3 Properties OriginalPrintID Version Availability 5

GetPrinterSpeedListValues Description: Method retrieves commma separated list of speed values for specified printer. Syntax: Function GetPrinterSpeedListValues(PrinterName As String) As String

245

ActiveX interface

OriginalPrintID Description: With this property you can set the original print id for the print job before print action. It is usually used for reprint when you want to set the original print id so that you know from which print job this print job was reprinted. Syntax: OriginalPrintID As String

2.10.6 Class IParagraph

Methods Version Availability Properties CharSet IsRTL ScaleFactor CharSet Description: Property returns character set for this object. Syntax: Property CharSet As Long Version Availability 1,2,3 1,2,3 1,2,3

IsRTL Description: Property returns true if the text is in "right to left" mode. Syntax: Property IsRTL As Boolean

ScaleFactor Description: Returns font scaling percentage. Syntax:

246

ActiveX interface

Property ScaleFactor As Long

2.10.7 Class IRTFText

Methods Version Availability Properties CharSet IsRTL CharSet Description: Property returns character set for this object. Syntax: Property CharSet As Long Version Availability 1,2,3 1,2,3

IsRTL Description: Property returns true if the text is in "right to left" mode. Syntax: Property IsRTL As Boolean

2.10.8 Class IVar

Methods GetFormatChars GetSelectedListElement GetFormatChars Description: Method returns allowed characters for this variable. Syntax: Function GetFormatChars() As String Version Availability 2,3 2,3 Properties HasPickList Version Availability 2,3

247

ActiveX interface

GetSelectedListElement Description: If the HasPickList property is true then the variable has a picklist and this method returns the curently selected item in the picklist. Syntax: Function GetSelectedListElement() As String HasPickList Description: Property returns true if the variable is defined as pick list, otherwise returns false. Syntax: Property HasPickList As Boolean

2.11 Nlog5 ActiveX Interfaces

2.11.1 How to use Nlog5 Interface
You must include Nlog5 type library in your project. It is installed together with Label Gallery itself. Deafult location is C:\Program Files\Common Files\EuroPlus Shared\ file Nlog5.dll. Nlog5.dll and NLog5_TLB.pas are included in the Label Gallery Integration Documents and Samples package which is a part Label Gallery 3 distribution CD The following procedures show how to install and use the type library with Visual Basic, Delphi and Visual Studio.
Visual Basic You must include Nlog5 in your project: Choose Project -> References. Activate Nlog5 in the list of available references and validate the dialog box.

Delphi You must include Nlog5 in your project: Choose Project -> Import Type Library

248

ActiveX interface

Activate Nlog5 in the list of available references and validate the dialog box.

.Net Microsoft Visual Studio You must include Nlog5 in your project: Choose Project -> Add References. Activate Nlog5.dll in the list of available references in .COM tab

With PrintAndGetJobID (refer to LGlabel Application Class) and GetPrintJob (refer to Nlog5 IPrintJobFactory Class) calls user can retrieve an exact status of the print job. The first one prints the label and returns the ID for the corresponding print job. The second one returns an interface to a PrintJob object. This object contains a member called Status, detailed status of a print job

2.11.2 Class IPrintJobFactory

Methods GetPrintJob Version Availability 5 Properties Version Availability

GetPrintJob Description: This method returns an interface to a PrintJob object. This object contains a member called Status. This is an integer field containing the detailed status of a print job. Status is returned as flags, meaning one job can have multiple values for example it can be in state Printing, Error and Deleting at the same time. For more information refer to MSDN Spooler statuses. Statuses and their meaning:
Status Name StartSpooling PartiallySpooled SpoolOk SpoolFailed Deleting Deleted Error Paused Printed Printing Status Flag 1 2 4 8 16 32 64 128 256 512 Meaning Print Job is being sent to Spooler Part of the Print Job is already sent to Spooler Print Job was sent to Spooler with no errors Print Job failed while sending it to Spooler Print Job is marked for deletion in Spooler Print Job was deleted from Spooler Print Job is in error state in Spooler Print Job is paused in Spooler Print Job was sent to Printer Print Job is being sent to Printer

249

ActiveX interface

Restarting Spooling Queued

1024 2048 4069

Print Job is restarting Print Job is Spooling Print Job is Queued

Syntax: Function GetPrintJob(ID As String) As PrintJob

2.12 LabelServices ActiveX Interfaces

2.12.1 Introduction to LabelServices Interface
LabelServices ActiveX interface allows a 3rd party application to supervise printer statuses. A service called Label Services (LblServices.EXE) is installed and started on each client after the Label Gallery Plus installation. Label Services also runs a sub-process NDH.EXE. Both services are monitoring the local printer and its print job statuses and can report the statuses back to the labeling application where the statues are continuously updated in the log file. For Label Gallery SDK Users: Label Gallery SDK now includes the option of a Printer Status Monitoring Service. This adds Label Gallery Services (with externals) to the system. If you stop the Label Service, the functionality will not be available. To access print queue soap interface application should connect to http://localhost:6758/wsdl/PrintQueueSOAP

2.12.2 Class TPQPrinter

Properties Attributes DriverName HasWebBrowser Name NiceStatus PrintJobList ShareName Status Version Availability 3 3 3 3 3 3 3 3

250

ActiveX interface

Updated WebAddress Attributes Description: Specifies the printer attributes. Type: Integer Possible values:

3 3

PQ_PRINTER_ATTRIBUTE_NETWORK = $00000001 Printer is a network printer connection. PQ_PRINTER_ATTRIBUTE_NICE = PQ_PRINTER_ATTRIBUTE_SHARED = Printer is shared. $00000002 $00000004
Printer was installed using nice drivers.

PQ_PRINTER_ATTRIBUTE_OFFLINE = $00000008 Indicates whether the printer is currently connected. PQ_PRINTER_ATTRIBUTE_DEFAULT = $00000020 Indicates that the printer is the default printer on the system.

DriverName Description: Printer driver name. Type: String HasWebBrowser Description: True - printer has built in web server. False - printer has not built in web server. Type: Boolean

251

ActiveX interface

Name Description: Specifies the printer name. Type: String NiceStatus Description: List of string representing advanced errors on printers such as head open, out of ribbon,. Type: TPQNiceStatus PrintJobList Description: List of the currently queued print jobs. Type: TPQPrintJobList ShareName Description: Identifies share name of the printer. Only used if PQ_PRINTER_ATTRIBUTE_SHARED is set for attributes member. Type: String Status Description: Specifies the printer status. Type: Integer Possible values:
PQ_PRINTER_STATUS_PAUSED = $00000001 Printer is paused.

252

ActiveX interface

PQ_PRINTER_STATUS_PRINTING = $00000002 Printer is currently printed.

PQ_PRINTER_STATUS_ERROR = $00000004 Printer is in error state. PQ_PRINTER_STATUS_NOT_AVAILABLE = $00000008

The printer is not available for printing.

PQ_PRINTER_ATTRIBUTE_DEFAULT = $00000020 Indicates that the printer is the default printer on the system. Updated Description: True - any of the members were updated. False no members were updated Type: Boolean

2.12.3 Class TPQPrinterList

Properties
PrinterArray

Version Availability 5

PrinterArray Description: List of TPQPrinter classes. Type: TPQPrinterArray

2.12.4 Class TPQPrinterJob

Properties
OEM ID Name Pages PagesPrinted

Version Availability 5 5 5 5 5

253

ActiveX interface

Position PrinterName Priority Quantity Status Owner Submitted

5 5 5 5 5 5 5

OEM Description: Has to be 0. Type: Integer ID Description: Specifies a print job identifier. Type: Integer Name Description: Specifies the name of print job. Type: String Pages Description: Specifes number of pages the print job contains. Type: Integer

254

ActiveX interface

PagesPrinted Description: Specifies the number of pages that have printed. Type: Integer Position Description: Specifies the print jobs position in the print queue. Type: Integer PrinterName Description: Specifies the name of the printer for which the print job was spooled. Type: String Priority Description: Specifies the priority of the print job. Type: TPQPrintJobPriority Quantity Description: Specifies the number of labels that will be printed. Type: Integer Status Description:

255

ActiveX interface

Specifies the print job status. Type: Integer Possible values:

PRINTJOB_STATUS_PARTIALLY_SPOOLED = $00000002 User cancelled print job aused. PRINTJOB_STATUS_SPOOL_OK = $00000004 Print job was successfully spooled. PRINTJOB_STATUS_SPOOL_FAILED = $00000008 There was an error in label production such as wrong barcode value. PRINTJOB_STATUS_DELETING = $00000010 Print job is being deleting. PRINTJOB_STATUS_DELETED = $00000020 Print job has been deleted. PRINTJOB_STATUS_ERROR = $00000040 An error is associated with print job. PRINTJOB_STATUS_PAUSED = $00000080 Print job is paused. PRINTJOB_STATUS_PRINTING = $00000100 Print job is printing. PRINTJOB_STATUS_PRINTED = $00000200 Print job is printed. PRINTJOB_STATUS_RESTART = $00000400 Print job has been restarted. PRINTJOB_STATUS_SPOOLING = Print job is spooling. PRINTJOB_STATUS_QUEUED = Print job is queued. $00000800 $00001000

PRINTJOB_STATUS_MOVED = $00002000 Print job has been moved to another printer. PRINTJOB_STATUS_PREPARING = $00004000 Language monitor is preparing job to be sent to printer. PRINTJOB_STATUS_SENDING = $00008000 Language monitor is sending the print job to printer. PRINTJOB_STATUS_SENT_OK = $00010000 Language monitor successfully sent the print job to the printer. PRINTJOB_STATUS_SEND_FAILED = $00020000 Language monitor failed at sending print job to printer.

256

ActiveX interface

Owner Description: Specifies the name of the user that owns the print job. Type: String Submitted Description: Specifies the time that this print job was spooled. Type:
TXSDateTime

2.12.5 Class TPQPrinterJobList

Properties
PrinterArray

Version Availability 3

PrintJobArray Description: List of TPQPrintJob classes. Type: TPQPrintJobArray

2.12.6 Types
Properties
TPQPrintJobPriority TPQPrintJobMoveDirection TPQPrinterArray TPQNiceStatus TPQPrintJobArray TPrinterNames TPrintJobIds

Version Availability 3 3 3 3 3 3 3

257

ActiveX interface

TPQPrintJobPriority Description:
Print job priority.

Type: Enum:(pjpHigh, pjpNormal, pjpLow) TPQPrintJobMoveDirection Description:

Print job move direction.

Type: Enum:(pjmvup, pjmvDown)

TPQPrinterArray Description:
List of TPQPrinter classes.

Type:
Array of TPQPrinter

TPQNiceStatus Description:
List of advanced printer.

Type:
Array of String

TPQPrintJobArray Description:
List of TPQPrintJob classes.

Type:
Array of TPQPrintJob

258

ActiveX interface

TPrinterNames Description:
List of printer names.

Type:
Array of String

TPrintJobIds Description:
List of print job identifiers.

Type:
Array of Integer

2.12.7 Methods
Methods ChangePrintJobPosition ChangePrintJobPriority DeleteAllPrintJobs DeletePrintJobs GetPrinters GetPrintersInErrorState GetPrinterInfo GetPrintJobs GetPrinterNames GetPrinterJobsCount GetSpecifiiedPrinters GetSpecifiiedPrintersInErrorState MovePrintJobs PausePrintJobs PausePrinters ProcessJob RenamePrinter RestartPrintJobs Version Availability 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3

259

ActiveX interface

SharePrinter UsePrintersOffline UsePrintersOnline ChangePrintJobPosition

3 3 3

Description: Moves print jobs one position up or down in queue list. Syntax: procedure ChangePrintJobsPosition(const APrintJobIDs: TPrintJobIds; AMoveDirection: TPQPrintJobMoveDirection) Parameters:
APrintJobIDs Print job ids list. Only the print jobs specified in this list will be used. AMoveDirection Set this to pjmvUp to move it one position up or set it to pjmvDown to move it one position down

ChangePrintJobPriority Description: Change the priority of specified print jobs. Print job with higher priority will be printed before the ones with lower priority no matter the position in the queue. Syntax: procedure ChangePrintJobsPriority(const APrintJobIDs: TPrintJobIds; APriority: TPQPrintJobPriority) Parameters:
APrintJobIDs Print job ids list. Only the print jobs specified in this list will be used. APriority Possible values are: pjpHigh, pjpNormal, pjpLow. Default priority is pjpLow.

DeleteAllPrintJobs Description: Delete all print jobs currently in queue for the specified printers.

260

ActiveX interface

Syntax:
procedure DeleteAllPrintJobs(const APrinterNames: TPrinterNames)

Parameters:
APrinterNames Printer names list. Only the printers specified in this list will be used.

DeletePrintJobs Description: Deletes specified print jobs. Syntax:

procedure DeletePrintJobs(const APrintJobIDs: TPrintJobIds)

Parameters:
APrintJobIDs Print job ids list. Only the print jobs specified in this list will be used

GetPrinters Description: Retrieves all installed printers. Note that this function does not retrieve the printers that are connected from other machines, it retrieves only locally installed printers. Syntax:
function GetPrinters(const ALastUpdate: TDateTime; var AAllPrinterNames: WideString; const ANicePrintersOnly: Boolean): TPQPrinterList)

Parameters:
ALastUpdate If not 0 then it retrieves only the printers that were modified after the time specified in ALastUpdate. For example if ALastUpdate is 12:00 and printer was modified at 11:55 then this printer will not be added to the printer list. AAllPrinterNames Returns names of all installed printers separated by comma. ANicePrintersOnly Set this to TRUE to specify that only the printers that were installed using nice drivers should be returned.

261

ActiveX interface

GetPrintersInErrorState Description: Returns printers that meet the following conditions: - printers status is ERROR - printer have job(s) in queue and it is paused or offline Syntax:
function GetPrintersInErrorState(): TPQPrinterList

262

ActiveX interface

GetPrinterInfo Description: Returns printers that meet the following conditions: - printers status is ERROR - printer have job(s) in queue and it is paused or offline Syntax:
function GetPrinterInfo(const APrinterName: WideString; out ASpoolerStatus: Integer; out APrinterStatus: TPQNiceStatus): Boolean

Parameters:
APrinterName Name of printer for which info should be retrieved.. ASpoolerStatus Current status of the printer as seen in the spooler. APrinterStatus List of string representing advanced printer errors.

GetPrintJobs Description: Returns print jobs for specified printers. Syntax:

function GetPrintJobs(const ALastUpdate: TDateTime; const APrinterNames: TPrinterNames; var AAllPrintJobIDs: WideString): TPQPrintJobList

Parameters:
ALastUpdate If not 0 then it returns only the print jobs that were modified after the time specified. APrinterNames Comma separated string of printer names for which print jobs should be returned. AAllPrintJobIDs Return ids of all print jobs for specified printers, separated by comma.

263

ActiveX interface

GetPrinterNames

Description: Retreives all installed printer names . Syntax:

function GetPrinterNames():WideString

GetPrinJobsCount Description: Returns count of all print jobs for all printers. Syntax:
function GetPrinterJobsCount(): WideString

GetSpecifiedPrinters

Description: Returns count of all print jobs for specified printers. Syntax:
function GetSpecifiedPrinters(var APrinterNames: WideString): TPQPrinterList

Parameters:
APrinterNames Comma separated string of printer names for which print jobs should be returned.

GetSpecifiedPrintersErrorState Description: Returns for specified printers that meet the following conditions: - printers status is ERROR - printer have job(s) in queue and it is paused or offline

Syntax:

264

ActiveX interface

function GetSpecifiedPrintersInErrorState(var APrinterNames: WideString): TPQPrinterList

Parameters:
APrinterNames Comma separated string of printer names for which print jobs should be returned.

MovePrintJobs Description: Moves print jobs to another printer.

Syntax:
function MovePrintJobs(const APrintJobIDs: TPrintJobIds; APrinterName: WideString): Boolean

Parameters:
APrinteJobIDs Print job ids list. Only the print jobs specified in this list will be used. APrinterName Name of printer to which print jobs should be moved.

MovePrintJobsEx Description: Moves print jobs to another printer and returns list of generated errors in TMoveErrors array of TMoveError(class TRemoteable) Syntax:
function MovePrintJobsEx(const APrintJobIDs: TPrintJobIds; APrinterName: WideString): TMoveErrors

Parameters:
APrinteJobIDs Print job ids list. Only the print jobs specified in this list will be used. APrinterName Name of printer to which print jobs should be moved.

265

ActiveX interface

PausePrintJobs

Description: Pauses / resumes specified print jobs. Syntax:

procedure PausePrintJobs(const APrintJobIDs: TPrintJobIds; APause: Boolean)

Parameters:
APrinteJobIDs Print job ids list. Only the print jobs specified in this list will be used. APause If TRUE print jobs will be paused else they will be resumed.

PausePrinters

Description: Pauses / resumes specified printers. Syntax:

procedure PausePrinters(const APrinterNames: TPrinterNames; APause: Boolean)

Parameters:
APrinterNames Printer names list. Only the printers specified in this list will be used. APause If TRUE printers will be paused else they will be resumed.

ProcessJob

Description: Generates JOB File for specified OEM Syntax:

function ProcessJob(const AOEM: Integer; const AJobContents: WideString): Boolean

266

ActiveX interface

Parameters:
AOEM OEM value, use 0 for NiceLabel. AJobContents JOB file contents.

RenamePrinter

Description: Renames specified printer. Syntax:

procedure RenamePrinter(const APrinterName: WideString; ANewPrinterName: WideString)

Parameters:
APrinterName Existing printer name. ANewPrinterName New printer name

RestartPrintJobs

Description: Restarts print jobs. This means that the spooler will resend whole job again. Syntax:
procedure RestartPrintJobs (AprintJobIDs: array of Integer)

Parameters:
APrintJObIDs Print job ids list. Only the print jobs specified in this list will be used.

SharePrinter

Description: Sets/Removes share mode for the specified printer.

267

ActiveX interface

Syntax:
procedure SharePrinter(const APrinterName: WideString; const AShare: Boolean; const AShareName: WideString)

Parameters:
APrinterName Name of the printer that will be shared. AShare If TRUE printer will be shared, else shared flag will be removed. AShareName Name displayed to the remote computers that will connect to this printer.

UsePrintersOfflLine

Description: Sets OffLine mode for specified printers. Syntax:

procedure UsePrintersOffline(const APrinterNames: TPrinterNames)

Parameters:
APrinterName Name of the printer that will be shared.

UsePrintersOnLine

Description: Sets OnLine mode for specified printers. Syntax:

procedure UsePrintersOnline(const APrinterNames: TPrinterNames)

Parameters:
APrinterName Name of the printer that will be shared.

268

ActiveX interface

2.13 GalleryForm ActiveX Interfaces

2.13.1 Introduction
GalleryForm has two types of ActiveX interfaces. Each of them has specific purpose, the first interface is meant for design mode and the second is meant for the run mode. Design mode: Main purpose of using ActiveX for design mode is to open form in one of the possible ways which offers you different possibilities of designing the form. For more information refer to the GalleryForm ActiveX Interface Design mode chapter. Run mode: The only purpose of the run mode is to run desired form directly from your application. There is also possibility to execute the form also from the design mode interface, but if you just need to run the form without design operation this interface is recommended. For more information refer to the GalleryForm ActiveX Interface Run mode chapter.

2.13.2 GalleryForm ActiveX Interface - Design mode

To use GalleryForm ActiveX Interface in design mode use the following class in your application: Class name GalleryForm3.Designer Class IApplication

Methods Design Login Run Design Description:

Version Availability 1,2,3 1,2,3 1,2,3

Properties FormID

Version Availability 1,2,3

Design method opens GalleryForm in design mode. There are two available parameters and therefore four combinations how this method can be used:

269

ActiveX interface

1. FormFileName and LabelFileName are specified. In this case New Form Wizard in GalleryForm is started. Wizard takes the specified label and store the form as the FormFileName parameter. 2. Only LabelFileName is specifed and FormFileName is empty In this case New Form Wizard in GalleryForm is started. Wizard takes the specified label and store the form as specified manually in the wizard. 3. Only FormFileName is specified and LabelFileName is empty If provided FormFileName exist then this form is opened, otherwise new form is created and FormFileName is set as form file name. 4. Both FormFileName and LabelFileName are empty When you do not specify both FormFileName and LabelFileName then empty form is opened. Syntax: Function Design(FormFileName As String, LabelFileName As String) As Boolean Login Description: Login method is used, when login is required. As Username you must specify the user, with which you want to open GalleryForm. If Login is successful the TRUE result is returned. Syntax: Function Login(UserName As String) As Boolean Run Description: GalleryForm can be started in the run mode. For this you can use Run method. As a parameter you must provide the file name to the form you wish to run. If form was ran ok then TRUE result is retured. Syntax: Function Run(FormFileName As String) As Boolean FormID Description: FormID property returns the ID of the opened form.

270

ActiveX interface

Syntax: Property FormID As Long

2.13.3 GalleryForm ActiveX Interface - Run mode

To use GalleryForm ActiveX Interface in run mode use the following class in your application: Class Name GalleryForm3.Engine Class IApplication Methods Login Open Open Description: To run a form in run mode use the Open method. As a parameter you must provide the file name to the form you wish to run. If form was running ok then TRUE result is retured. Syntax: Function Open(FormFileName As String) As Boolean Login Description: Login method is used, when login is required. As Username you must specify the user, with which you want to open GalleryForm. If Login is successful the TRUE result is returned. Syntax: Function Login(UserName As String) As Boolean FormID Description: Version Availability 1,2,3 1,2,3 Properties FormID Version Availability 1,2,3

271

ActiveX interface

FormID property returns the ID of the executed form. Syntax: Property FormID As Long

272

DDE Communication

3. DDE Communication
3.1 Introduction
To create the DDE communication, the client application must use the following DDE parameters: Service = LabelGallery Topic = LINE or JOB When you are using the JOB topic, the content is the name of the command file that must be run. When you are using the LINE topic, the content is one of the Label Gallery commands. When you want to use DDE communication to control Label Gallery, it is probably best, when the user doesn't know for the background running of this application. For this purpose you can use this command parameter: LGPLUS3.EXE <label_name> /s The parameter s (silent) prevents Label Gallery from being visible on the screen. It will run in a minimized form.

3.2 DDE Commands

3.2.1 DDEInitiate
Description: DDEInitiate command initiates a link between Label Gallery and your application. Syntax: DDEInitiate(Service, Topic)

3.2.2 DDEExecute
Description: DDEExecute command executes a command on your label. For list of available commands please see GalleryCommands chapter of this manual. Syntax: DDEExecute Channel Command

273

DDE Communication

3.2.3 DDETerminate
Description: DDETerminate command terminates a link between Label Gallery and your application. Syntax: DDETerminate Channel

3.3 GalleryCommands
Printing with Label Gallery can accomplished automatically. There are several methods for automation. The first method is with the use of command files (JOB file), which is used with the Automatic print command from the File menu or directly from the shell. Another way is with the help of any other Windows application, which enables DDE communication between the applications. In both methods, the same commands may be used. When you are using the automatic print, the commands must be written one per line in the command file (JOB file). With DDE communication, the commands are sent through the DDE channel. All GalleryCommands are presented in four main groups: COMMON FILE PRINTING DATABASE GalleryCommands which are used for common use. GalleryCommands which are used for file operations. GalleryCommands which are used for printing operations. GalleryCommands which are used for database operations.

3.3.1 COMMON
SET Description: Name is the name of the variable defined on the label. If the variable isn't on the label, an error will occur. Step and Quantity_of_repetition are optional

274

DDE Communication

parameters. These parameters specify the increment of the variable and the number of the labels before change. If variable value contains space characters or commas, you have to enclose the text in quotation marks. Syntax: SET name = value_of_the_variable, [,step[, quantity_of_repetition]] COMMENT Description: When developing program code or scripts it is very wise to well document your commands. This will help you decode what the script really performs, when you will look at the code after some time. Use semicolon (;) on the beginning of the line. Everything following it will be treated as script comment and will not be processed by Label Gallery. Syntax: ; LOGIN Description: Performs login procedure into Label Gallery program. This is necessary when login into Label Gallery is required. NOTE. This is DDE command and cannot be used in .JOB files. Syntax: LOGIN <username> RETURN Description: This command returns to the Label Gallery program after printing. Syntax: Return QUIT Description: This command stops the Label Gallery program after printing. The application is closed.

275

DDE Communication

Syntax: Quit MESSAGEBOX Description: Print the message. The second parameter represents the title of the message dialog box. If variable value contains space characters or commas, you have to enclose the text in quotation marks (e.g. MESSAGEBOX "Insert labels in printer", Warning). Syntax: MESSAGEBOX message , caption OEMTOANSI Description: This command works in conjunction with command SET. It puts the text that follows the command SET in proper codepage, so that variable is assigned the proper value. Use it to put the values following SET command to the proper codepage, so correct values will be transferred to Label Gallery at print time. Syntax: OEMTOANSI ON|OFF

3.3.2 FILE
CREATEFILE Description: This command lets you create the file with the contents Label Gallery. The purpose of creating or deleting files is that the client application knows when will be printing stopped. The example of usage is printing from the file. First the application prepares variable data for the labels into particular file. Now Label Gallery is activated and printing starts. To inform application, that the printing process is finished, file with data could be deleted at the end. This could be a signal to application, that new "job" could be started. See also: DELETEFILE

276

DDE Communication

Syntax: CREATEFILE <name_of_the_file>

DELETEFILE Description: This command deletes the file. See also: CREATEFILE Syntax: DELETEFILE <name_of_the_file> LABEL Description: The LABEL command opens the working label. If the label is already opened, the program will use this instance. It is recommended to write the full path name along with the file name. Note, if the variable value contains space characters or commas, you will need to enclose the whole path in quotation marks (e.g. LABEL "C:\Program Files\Sato\Labels\sample3.lbl"). If you use the LABEL command with GalleryWatch running in service mode, use the UNC quotation instead of the mapped drives (e.g. LABEL "\\SERVER\MY LABELS\LABEL.LBL" instead of "G:\MY LABELS\LABEL.LBL"). Syntax: LABEL <name_of_the_file> FILECLOSE Description: The FILECLOSE command closes the currently active label. Label Gallery will stay opened. Syntax: FILECLOSE LABELCLOSE Description:

277

DDE Communication

The LABELCLOSE command closes the currently active label. Label Gallery will stay opened. This command is introduced as a synonym for FILECLOSE command. Syntax: LABELCLOSE EXPORTLABEL Description: The EXPORTLABEL command exports currently active label. Label Gallery will stay opened. Syntax: EXPORTLABEL

3.3.3 PRINTING
PRINT Description: The Print command starts the form or label printing. The first parameter is the print quantity of the labels; it can be a number, or one of following words: VARIABLE UNLIMITED

The first parameter means printing on the base of the variable quantity (one of the variables sets the quantity), the second one means unlimited printing (printing from the whole database file for example). Second parameter in the command represents the number of the labels you want to omit before first printed label on the page. The parameter can be used when the part of the page is already printed. The rest of the unused labels on the page can be printed with the help of this parameter. Syntax: PRINT quantity[, skip] PORT Description: This command overrides the printer's port name. Next PRINT command will print to the port specified. Usually this command is used to print the label to a file. In this case you must specify name of file in parameter port_name before using the PRINT command.

278

DDE Communication

Syntax: PORT <port_name> PRINTER Description: Normally the PRINT command prints the label using the printer specified in the label file. With this command you can override the printer and print the labels using different printer. If printer name contains space characters, you have to enclose it in quotation marks. For printer_name always use the system printer name as is displayed in the status line in the Label Gallery Plus application. System printer names are usually the same as the printer names in Printers folder from Control Panel. They differ only when you are using network-connected printers, when you should use "\\server\share" syntax and not a printer friendly name. Syntax: PRINTER <printer_name> PRINTJOBNAME Description: Specifies the print job name that will be used in print manager when using PRINT command. After printing the name is returned in normal state. If variable value contains space characters or commas, you have to enclose the text in quotation marks (e.g. PRINTJOBNAME "Label for printing"). Syntax: PRINTJOBNAME <job_name> SESSIONSTART Description: All three commands(SessionStart, SessionPrint, SessionEnd) are used together. If ordinary command SessionPrint is used, every time a complete data stream for printer is sent. If you want to join multiple Print commands into one data stream, you can use the command SessionStart followed with any number of SessionPrint commands and in the end use the command SessionEnd. The stream is not closed until the command SessionEnd occurs. These commands offer a way of optimal printing through GalleryCommands and it is not necessary to generate a complete data stream for each print session. See also: SESSIONPRINT SESSIONEND

279

DDE Communication

SESSIONPRINT Description: SESSIONPRINT quantity [, skip] You send the data stream to printer using this function. You can use multiple SessionPrint commands one after another and join them in single data stream. The stream is not closed until the command SessionEnd occurs. The meaning of quantity and skip parameters is the same as with GalleryCommand PRINT. See also: PRINT SESSIONSTART SESSIONEND SESSIONEND Description: The function closes data stream. See also: SESSIONSTART SESSIONPRINT

3.3.4 DATABASE
SETDATABASE Description: Value database_name value Description The name of the currently used database as defined in the program The name of the new table that should be used as data source

This command allows you to use some other database with the label file and not the one that was connected to the label file at design time. This other database will only be used when printing labels, the label file will remain intact with connection to the original database. See also: SETTABLE Syntax:

280

DDE Communication

SETDATABASE <database_name> = <value>

SETTABLE Description:

Value table_name value

Description The name of the currently used table as defined in the program The name of the new table that should be used as data source

This command allows you to use some other table with the label file and not the one that was connected to the label file at design time. This other database table will only be used when printing labels, the label file will remain intact with connection to the original table. The new database table should be of the same type as original table. For example, you cannot change the table from dBase to Paradox. The structure of new table has to be identical to the original one. You can use table from the database that is already connected to the label or from some entirely different database. See also: SETDATABASE Syntax: SETTABLE <table_name> = <value>

281

Programming Samples

4. Programming Samples
4.1 DDE
DDE programming samples for Microsoft Excel, Microsoft Word are included in the Label Gallery Integration Documents and Samples package which is a part Label Gallery 3 distribution CD.

4.2 ActiveX interface

ActiveX programming samples for Visual Basic, Visual Studio and Borland Delphi are included in the Label Gallery Integration Documents and Samples package which is a part Label Gallery 3 distribution CD.

4.3 ActiveX Hints

Here is described how to speed up printing with Label Gallery through ActiveX interface. Following you will find four options how communication can be performed. They are sorted from the slowest to the fastest one. VERY VERY SLOW: Description: The main reason this option is the slowest one is that every time when label is going to be opened the new Label Gallery object is created. After that every label is opened and closed for every printout. At the end Label Gallery software is closed as well. Syntax:
createObject (LabelGalleryPlus3) LabelID = LGApp.LabelOpen("sample3.lbl") Success = LGApp.LabelSetVar(LabelID, "Bar Code", "11", 0, 0) Success = LGApp.LabelPrint(LabelID, 1) ' Print 1 label Success = LGApp.LabelClose(LabelID) LG.Quit

createObject (LabelGalleryPlus3) LabelID = LGApp.LabelOpen("sample3.lbl") Success = LGApp.LabelSetVar(LabelID, "Bar Code", "22", 0, 0) Success = LGApp.LabelPrint(LabelID, 1) ' Print 1 label Success = LGApp.LabelClose(LabelID) LG.Quit

282

Programming Samples

createObject (LabelGalleryPlus3) LabelID = LGApp.LabelOpen("sample3.lbl") Success = LGApp.LabelSetVar(LabelID, "Bar Code", "33", 0, 0) Success = LGApp.LabelPrint(LabelID, 1) ' Print 1 label Success = LGApp.LabelClose(LabelID) LG.Quit

SLOW: Description: This is a faster option than the previous one but it is still slow. Now the object LGLabel is created just once for the whole print process. This speeds us the response times and labels are printed faster. But every time the label is printed, it is also immediately closed. When the next print of the same label is required, it must be re-opened. The operation takes some time. Syntax:
createObject (LabelGalleryPlus3) LabelID = LGApp.LabelOpen("sample3.lbl") Success = LGApp.LabelSetVar(LabelID, "Bar Code", "11", 0, 0) Success = LGApp.LabelPrint(LabelID, 1) ' Print 1 label Success = LGApp.LabelClose(LabelID)

LabelID = LGApp.LabelOpen("sample3.lbl") Success = LGApp.LabelSetVar(LabelID, "Bar Code", "22", 0, 0) Success = LgApp.LabelPrint(LabelID, 1) ' Print 1 label Success = LGApp.LabelClose(LabelID)

LabelID = LGApp.LabelOpen("sample3.lbl") Success = LGApp.LabelSetVar(LabelID, "Bar Code", "33", 0, 0) Success = LGApp.LabelPrint(LabelID, 1) ' Print 1 label Success = LGApp.LabelClose(LabelID) LG.Quit

FAST: Description: This is one of the fastest options. Label Gallery software is started only once. The label is also opened only once and then just left opened in the Label Gallery software. When additional label printout is required, the already opened label will be used again. Syntax:
LabelID = LGApp.LabelOpen("sample3.lbl")

283

Programming Samples

Success = LGApp.LabelSetVar(LabelID, "Bar Code", "11", 0, 0) Success = LGApp.LabelPrint(LabelID, 1) ' Print 1 label

Success = LGApp.LabelSetVar(LabelID, "Bar Code", "22", 0, 0) Success = LGApp.LabelPrint(LabelID, 1) ' Print 1 label

Success = LGApp.LabelSetVar(LabelID, "Bar Code", "33", 0, 0) Success = LGApp.LabelPrint(LabelID, 1) ' Print 1 label

Success = LGApp.LabelClose(LabelID)

FASTEST: Description: In this case the label opening and closing procedures are performed only once. Additionally the LabelSessionPrint command is used. The main reason is the advantage in speed compared to the common LabelPrint command. The printing actions are defined within a LabelSessionStart and LabelSessionEnd commands. Any number of LabelSessionPrint commands can be used. The labels are cached in the computer memory and they are processed and printed at the same time, when the LabelSessionEnd command is encountered. There is no delay in the label printing as all labels are sent in one batch job. SessionPrint works for one label at a time, so you cannot change the printed label during on print session. See also: LabelSessionStart Syntax:
LabelID = LGApp.LabelOpen("sample3.lbl")

LGApp. LabelSessionStart

Success = LGApp.LabelSetVar(LabelID, "Bar Code", "11", 0, 0) Success = LGApp.LabelSessionPrint(LabelID, 1) ' Print 1 label

Success = LGApp.LabelSetVar(LabelID, "Bar Code", "22", 0, 0) Success = LGApp.LabelSessionPrint(LabelID, 1) ' Print 1 label

Success = LGApp.LabelSetVar(LabelID, "Bar Code", "33", 0, 0) Success = LGApp.LabelSessionPrint(LabelID, 1) ' Print 1 label

LGApp. LabelSessionEnd

Success = LGApp.LabelClose(LabelID)

284

Programming Samples

4.4 Active Server Pages

ActiveX interface of Label Gallery software gives you the opportunity to add label print functionality to Active Server Pages (ASP) on the internet. Therefore you can achieve true internet label printing capability in your internet solutions. Your internet application can accept the input values from the user, process the data, connect to Label Gallery running in the background and print the labels to some printer, either connected locally or somewhere in the network. Requirements To setup an ASP page that you will use to print labels you need to do the following: Design a label file Create an ASP file

Label file You have to prepare a label file that will be printed from ASP page. You can use Label Gallery Plus label editor for this task. The labels can be fixed or with variable values. If you have variable object on the label, they are always linked to some variables. The variables will need to be filled with some values before the printing can occur. Here is where your ASP file comes in. You need to know the names of the variables that are defined on the label so you can set their values. In the sample ASP script we use the variables Name, SurName, Address and Phone. ASP file ASP file can be created in any editor that is intended for such operations. ASP file is a text file with the programming commands that ASP web server can understand and execute. ASP file is actually a HTML formatted file enriched with the ASP capabilities. The web page using ASP is no longer static page, but is an output of the ASP program. When writing the ASP code, you are using the same ActiveX interface to connect to Label Gallery software as you would use when programming the application in Visual Basic, Delphi, C++ and similar development environments. Sample of the source code can be found in the next paragraph. Sample ASP file Here is a sample source code for the ASP web page. It connects to the label file LabelGallery.lbl, sets the values for the variables as the user has entered and prints one copy of the label to the default printer.
<%@ Language = VBScript %> <% Option Explicit %>

<HTML>

285

Programming Samples

<HEAD> <TITLE>LabelGallery using ASP</TITLE> </HEAD>

<BODY BGCOLOR="White" TOPMARGIN="10" LEFTMARGIN="10"> <FONT SIZE="4" FACE="ARIAL, HELVETICA"> </FONT><img src="LabelGallery.jpg" width="199" height="65"><BR> <P>&nbsp; <FORM NAME=Form1 METHOD=Post ACTION="LabelGallery.asp"> First Name.......... <INPUT TYPE=Text NAME=fname> <P> Last Name.......... <INPUT TYPE=Text NAME=lname> <P> Address Name.... <INPUT TYPE=Text NAME=address> <P> Phone................. <INPUT TYPE=Text NAME=phone> <P> <INPUT TYPE=Submit VALUE="Print">

</FORM>

<HR>

<% Dim ID, Result, LG

Set LG = CreateObject("LabelGalleryPlus3.Application")

ID = LG.LabelOpen("G:\tmp\ASP\LabelGallery.lbl") Result = LG.LabelSetVar(ID, "Name", Request.form("fname"), -9999, -9999) Result = LG.LabelSetVar(ID, "SurName", Request.form("lname"), -9999, -9999) Result = LG.LabelSetVar(ID, "Address", Request.form("address"), -9999, -9999) Result = LG.LabelSetVar(ID, "Phone", Request.form("phone"), -9999, -9999)

Result = LG.LabelPrint(ID, 1)

LG.Quit %>

</BODY> </HTML>

286

Programming Samples

Complete ASP sample files are installed together with the installation of Label Gallery software. The location for the ASP sample is the folder "..\SATO\Gallery 3\Samples\Integration". Permissions To successfully use Label Gallery integrated to ASP web page you must correctly set the access permissions on the web server. To set or check the web server permissions run the utility "DCOMCNFG" on the computer running the web server. 1. Expand the Component Services, Computers, My Computer, DCOM Config. 2. Locate Label Gallery in the list of applications with DCOM interface. 3. Right-click it then open its properties. 4. Go to Identity tab and select the option "The interactive user." 5. Go to Security tab ane select the option "Customize" for Launch and Activation Persmissions. Click the button Edit. 6. Select the users that are allowed to run Label Gallery software from the ASP website. These are not external users connecting to the web server, but Windows system users that can run Label Gallery software. Printing Label printing through ASP-enabled web server can be performed on all printer drivers that are installed on the server computer. By selecting different ports in the printer drivers, you can redirect printing to different locations. Those printer drivers can be redirected to the following locations. Printers attached directly to the server computer Printers attached to the client computer

If you want to print labels to the client computer you have to redirect printer driver on the server to the client printer port. The printer driver must be installed on the server and you have to make sure that the port the printer is using points to the client computer. Usually the client shares its printer port as (\\server\share), where "server" is the name of the client computer and "share" is the shared name of the port on the client. Printers attached to the network The port in the printer driver must be redirected to the printers IP address. In this case the printer has its own network interface card with the IP number and the port number. You need to be familiar with both numbers to correctly set up the network port properties in the printer driver.

4.5 ASP.NET
Label Gallery can be used also in the ASP.NET environment almost on the same way as regular ASP. Basically the only difference is that the local ASP user, which is created when ASP.NET environment is installed, has sufficient permissions to run Label Gallery. To achieve this you have to set the permissions for that user.

287

Programming Samples

4.6 Visual Basic Script (VBScript)

Label Gallery ActiveX interface can be used also in the Visual Basic (VBScript ) environment. Visual Basic function allows you to perform the most demanding and difficult data manipulation on the label. Available are all the functions, procedures and operands from Microsoft Visual Basic script. Classes Application and Label are accessible within VBScript function. All methods and properties of both classes are ready to use in VBScript function. Label class gives you opportunity to use more methods and properties of other classes.

Sample VBSCript Here is a sample script. VBscript function below sets Prompt variable value to 100. Method Variables of class Label is used to access VarableList class. With method FindByname class Var is accessed, variable Prompt located and SetValue method sets value 100 to variable Prompt a = 100 Result = label.variables.findbyname("Prompt").setvalue(a)

288

FAQ

5. FAQ
5.1 How to choose different printer for label printing not the one than is selected in the label?
There are two ways how to open the label and work with the Label Gallery ActiveX interface. If you decide to use Basic method then you will have a label ID and you can set printer with LabelSetPrinter command. Status = oLG.LabelSetPrinter(LabelID, "SATO CL408e") The other method is to open the label in Advanced mode. In this case you have opened an interface to the label and all label properties are stored in one object. You have to change the PrinterName property to the desired printer name. Status = oLabel.PrinterName = SATO CL408e

5.2 How to close the label, if you do not have Label ID?
If you do not have the Label ID then you have opened the label in the Advanced mode. You do not have the label ID but you have the interface the label. You have to use the proper command for label close as is available in the Advanced method. You have to close the application with the Quit method and set the variable to nothing. oLG.Quit Set oLG = Nothing

5.3 How to print label, if you do not have Label ID?

If you do not have the Label ID then you have opened the label in the Advanced mode. You do not have the label ID but you have the interface the label. You have to use the proper command for label print as is available in the Advanced method. The object you have created for storing of the label interface contains the method Print. Execute the method Print and the label will be printed. Status = oLabel.Print(1)

289

FAQ

5.4 How to save the label with Label Gallery API?

Label Gallery ActiveX interface gives you the print-only functionality of the Label Gallery Plus software. The main purpose of the interface is to provide you with the label printing power in your application. You will print already defined labels. Label Gallery API does not provide you with label design and save functionality. Labels must be designed in advance in Label Gallery label design environment.

5.5 How can I put Label Gallery in the foreground when I control it with ActiveX interface?
When you use Label Gallery through ActiveX interface it is always running in the background invisible to the user. But you can see it in the list of processes running on the system. But it is also possible to put Label Gallery in the foreground and then control it with ActiveX interface. Run Label Gallery using the function CreateProcess. The function is part of Windows API. The function returns a handle to Label Gallery print engine that is needed later when you want to close the application. When Label Gallery is started with the function CreateProcess, call the function GetObject and it will return the interface to the existing instance of Label Gallery.

5.6 How can I use Label Gallery API in .NET environment?

Label Gallery API can be used also in .NET environment. Label Gallery ActiveX on its own does not cooperate with .NET applications quite well. That is why the additional component Label Gallery Wrapper is available to smooth the communication between your .NET application on one end and Label Gallery Plus on the other end. Whenever the integration to .NET environment is necessary, use the Label Gallery Wrapper. For more information about Label Gallery Wrapper refer to the chapter Label Gallery Wrapper on page 10.

5.7 Where can I get programming samples for different environments?

ActiveX samples (label files and source code of the applications) for all programming environments can be found in the Integration sample folder. By default the location of the Integration folder is the following: ..\Program Files\SATO\Label Gallery v3 Integration Pack

290

FAQ

5.8 Can I Control GalleryForm through the ActiveX Interface?

GalleryForm has two ActiveX interfaces. Interfaces are divided in the design and run mode. Design mode is useful for designing the form on several ways and run mode is useful only for form execution directly from your software. For more information refer to the GalleryForm ActiveX interfaces chapter.

291

Glossary

6. Glossary
ActiveX Controls An ActiveX Control is a stand-alone software component whos function is pre-defined and performs in a standard way. It exemplifies component software. The ActiveX Control specification defines this standard and sets the stage for plug-in component architecture. An ActiveX Control is a component of functionality that can be purchased and added to a Windows application. In essence, an entire application can now be built from preexisting parts (reusable software components). Bear in mind that ActiveX Controls are not, by themselves, applications. They are service providers (servers) that plug into a control container. As with other ActiveX technologies, interactions between participating software units are specified by various interfaces supported by COM. In the case of ActiveX controls, the involved software units are the control and its container. An ActiveX Control may incorporate many other ActiveX technologies, all of which are COM-based. As an example, controls often support embedding interfaces as well as automation, allowing access to their methods. Automation is a means in which a developer can access an applications functionality through COM-object support. This is not source code exposure, but component exposure. Automation provides programmers with the means to pull a feature from an existing application and add the same feature to their own project. For instance, since Microsoft Excel supports automation, programmers can incorporate existing Excel features into their work. With automation, Excel is no longer just an end-user application, it has become a valuable, programming toolkit. A network architecture in which each computer or process on the network is either a client or a server. Servers are powerful computers or processes dedicated to managing disk drives (file servers), printers (print servers), or network traffic (network servers). Clients are PCs or workstations on which users run applications. Clients rely on servers for resources such as files, devices, and even processing power. Another type of network architecture is known as a peer-to-peer architecture because each node has equivalent responsibilities. Both client/server and peer-to peer architectures are widely used and each has unique advantages and disadvantages. Client/server architectures are sometimes called two-tier architectures. Compound document technology addresses the need for integration between applications, effectively allowing different applications to work together smoothly, producing what appears to be a single document. It

Automation

Client/Server architecture

Compound Documents

292

Glossary

allows using existing applications to work in various portions of a document, totally independent of each other. As previously mentioned, OLE defines the interface standards and allows this kind of interaction between a wide variety of applications and vendors. Distributed COM Distributed COM (DCOM) is mechanism for COM objects to provide their services across machine boundaries. Originally, COM implementation was restricted to a single machine. COM objects could be implemented on the same machine as their client but they couldnt reside on other machines in the network. DCOM removes this restriction with the remote procedure call (RPC), allowing a client to execute an object across a network. DCOM also provides support for security services by controlling which clients can use a COM object Short for Dynamic Link Library, a library of executable functions or data that can be used by a Windows application. Typically, a DLL provides one or more particular functions and a program accesses the functions by creating either a static or dynamic link to the DLL. A static link remains constant during program execution while a dynamic link is created by the program as needed. DLLs can also just contain data. DLL files usually end with the extension .dll, .exe, .drv, or .fon. A DLL can be used by several applications at the same time. Some DLLs are provided with the Windows operating system and are available for any Windows application. Other DLLs are written for a particular application and are loaded with the application. A property is an attribute of an object that defines one of the object's characteristics, such as size, color, or screen location, or an aspect of its behavior, such as whether it is enabled or visible. To change the characteristics of an object, you change the values of its properties. To set the value of a property, follow the reference to an object with a period, the property name, an equal sign (=), and the new property value. Object An object represents an element of an application, such as a worksheet, a cell, a chart, a form, or a report. In Visual Basic code, you must identify an object before you can apply one of the objects methods or change the value of one of its properties. A component model defines one or more required component interfaces, allowable patterns of interactions among components, communication behaviors among components and between components and the component runtime system, and, possibly, a programming model for component developers.

DLL

Property

Component Model

293

Appendix

7. Appendix
Label Gallery Product Overview
Label Gallery is a powerful and versatile software labeling tool designed by professionals for the professionals. No matter what your labeling needs are, Label Gallery is ready to boost your operational productivity and profitability. Available in affordable editions Easy, Plus and TruePro/Network/Pocket our software offers a scalable and versatile set of design tools, data handling functions and data integration possibilities.

Label Gallery Standard Series

Label Gallery TruePro The full featured modular labeling solution for label design, integration and professional printing requirements. Multiple connectivity options allow users to perform standalone printing or integrate label printing into any network environment. GalleryForm is a module in Label Gallery TruePro that allows creating data entry and printing applications to make label production simple and error free. Label Gallery TruePro includes Label Gallery Plus, GalleryWatch, GalleryForm, GalleryPrint, GalleryPrintQueue and Pocket Label Gallery for Windows CE support to create mobile printing applications. Label Gallery Plus The advanced label designer for professional bar code and RFID labelling including completed database support and integration options. A wide range of features and options make Label Gallery Plus a perfect and easy-to-use tool for any labeling requirement. Label Gallery Plus includes GalleryPrintQueue, GalleryData and GalleryMemMaster. Label Gallery Easy The basic label designer using wizards to fulfill basic bar code labelling needs. This entry-level software includes many design elements from the Plus edition with the emphasis on simplified user interaction. Pocket Label Gallery The label printing software for Windows CE mobile devices. Pocket Label Gallery enables Windows CE compatible computers and terminals to print bar code and RFID smart labels on any type of thermal printer that is supported by Label Gallery printer drivers.

Label Gallery Developer Series

Label Gallery SDK Enables software publishers to reduce label printing development costs and add additional value to their Windows applications. Label Gallery SDK can be embedded into existing applications or information systems to support label printing. Label Gallery PocketSDK Enables software publishers to integrate bar code and RFID smart label printing in Windows CE mobile applications. Software publishers deploy one application interface to print labels from a mobile device to many thermal printers.

294

Technical Support

8. Technical Support
Online Support
You can find latest documents, updates and workarounds for problems and Frequently Asked Questions (FAQ) under Label Gallery microsite at http://www.satoworldwide.com/label-gallery.aspx If you cannot solve the problem on your own, please contact your local vendor or representative offices listed in the topic Contact Information.

295

Technical Support

9. Contact Information
SATO GROUP OF COMPANIES Singapore SATO GLOBAL BUSINESS SERVICES PTE. LTD. (GBS) 438B, Alexandra Road, #09-01/02 Alexandra Technopark, Singapore 119968 TEL: +65 6271 5300 FAX: +65 6273 6011 Website: www.satoworldwide.com Regional HQ America SATO INTERNATIONAL AMERICA, INC. (SIA) 10350-A Nations Ford Road, Charlotte, NC 28273, U.S.A. TEL: +1 704 644 1650 FAX: +1 704 644 1662 Europe SATO INTERNATIONAL EUROPE N.V. (SIE) 5A Lambroekstraat, 1831 Diegem, Belgium TEL: +32 2 719 03 90 FAX: +32 2 719 03 99 Asia Pacific SATO INTERNATIONAL ASIA PACIFIC PTE. LTD. (SIP) 438B, Alexandra Road, #09-01/02 Alexandra Technopark, Singapore 119968 TEL: +65 6271 5300 FAX: +65 6273 6011 AMERICAS SATO AMERICA, INC. (SAI) 10350-A Nations Ford Road, Charlotte, NC 28273, U.S.A. TEL: +1 704 644 1650 FAX: +1 704 644 1662 Website: www.satoamerica.com Sales: [email protected] Technical Support: : [email protected]

EUROPE United Kingdom, Ireland SATO UK Valley Road, Harwich, Essex CO12 4RR, United Kingdom TEL: +44 1255 2400 00 FAX: +44 1255 2401 11 Website : www.satouk.com Sales: [email protected] Technical Support: [email protected]

296

Technical Support

Germany, Austria, Switzerland SATO GERMANY Frankfurter Strae 95, 65479 Raunheim, Germany TEL: +49 6142 60361 0 FAX: +49 6142 60361 333 Website : www.satoeurope.com/de Sales: [email protected] Technical Support: [email protected] Netherlands, Belgium, Luxemburg SATO BENELUX Techniekweg 1b, 3481 MK Harmelen, Netherlands TEL: +31 348 444437 FAX: +31 348 446403 Website : www.satoeurope.com/nl Sales: [email protected] Technical Support: [email protected] France, Algeria, Benin, Cameroon, Cte d'Ivoire, Democratic Republic of the Congo, Gabon, Monaco, Morocco, Senegal, Tunisia SATO FRANCE Parc d'Activits , Rue Jacques Messager, 59 175 Templemars, France TEL: +33 3 20 62 96 40 FAX: +33 3 20 62 96 55 Website : www.satoeurope.com/fr Sales: [email protected] Technical Support: [email protected] Poland, Czech Republic, Estonia, Hungary, Latvia, Lithuania, Russia, Slovakia, Ukraine SATO POLSKA Panattoni Park II, Ul. Ryszarda Chomicza 3, Nowa Wie Wrocawska, 55-080 Kty Wrocawskie, Poland TEL: +48 71 776 04 60 FAX: +48 71 776 04 68 Website : www.satoeurope.com/pl Sales: [email protected] Technical Support: [email protected] Spain, Portugal SATO IBERIA Dels Corrals Nous, 35-39, Pol. Can Roqueta, 08202 Sabadell, Barcelona, Spain TEL: +34 902 333 341 FAX: +34 902 333 349 Website : www.satoeurope.com/es Sales: [email protected] Technical Support: [email protected]

Sweden, Norway, Denmark, Finland, Iceland SATO NORDIC Mlndalsvgen 91, SE-412 63 Gteborg, Sweden TEL: +46 31 3511 500 FAX: +46 31 402 558 Website : www.satoeurope.com/nordic Sales: [email protected] Technical Support: [email protected]

297

Technical Support

Italy, Bulgaria, Croatia, Greece, Macedonia, Malta, Slovenia, Turkey, Vatican City, Yugoslavia SATO ITALY Via Mazzini, 12, 22070 Binago (CO) Italy Website : www.satoeurope.com/il Sales: [email protected] Technical Support: [email protected]

ASIA PACIFIC Singapore SATO ASIA PACIFIC PTE. LTD. (SAP) 438B, Alexandra Road, #09-01/02 Alexandra Technopark, Singapore 119968 TEL: +65 6271 5300 FAX: +65 6273 6011 Website : http://www.satoasiapacific.com/ Sales: [email protected] Technical Support: [email protected] Malaysia SATO AUTO-ID MALAYSIA SDN. BHD. (Sales) (SAM) SATO MALAYSIA SDN. BHD. (Production) (SMS) No.25, Jalan Pemberita U1/49, Temasya Industrial Park, Section U1, 40150 Shah Alam, Selangor Darul Ehsan, Malaysia TEL: +60 3 7620 8901 FAX: +60 3 5569 4977 Website : http://malaysia.satoworldwide.com/ Sales: [email protected] Technical Support: [email protected]

Thailand SATO AUTO-ID (THAILAND) CO., LTD. (STC) - Japanese Website / Thai Website 292/1 Moo 1 Theparak Road, Tumbol Theparak, Amphur Muang, Samutprakarn 10270, Thailand TEL: +662 736 4460 FAX: +662 736 4461 Website : http://www.satothailand.co.th/ Sales: [email protected] Technical Support: [email protected]

China SATO SHANGHAI CO., LTD. (SSC) - Chinese Website Room 1901-1903, International Corporate City, 3000 North Zhongshan Road, Putuo District, Shanghai 200063, China TEL: +86 21 3252 2777 FAX: +86 21 6309 1318 Website : http://www.satochina.com/ Sales: [email protected] Technical Support: [email protected]

298

Technical Support

Australia SATO AUSTRALIA PTY LTD. (SAU) 1/1 Nursery Avenue, Clayton Business Park, Clayton, VIC 3168, Australia TEL: +61 3 8814 5330 FAX: +61 3 8814 5335 Website : http://www.satoaustralia.com/ Sales: [email protected] Technical Support: [email protected] New Zealand SATO NEW ZEALAND LTD. (SNZ) 30 Apollo Drive, Mairangi Bay, Auckland, New Zealand TEL: +64 9 477 2222 FAX: +64 9 477 2228 Website : http://www.satonewzealand.com/ Sales: [email protected] Technical Support: [email protected]

Extensive contact information of worldwide SATO operations can be found on the Internet at http://www.satoworldwide.com/

299