Teklynx Discover ActiveX Programmer's Manual

DOC--OEM6--ActiveX-- US--06/00

P

PP

Prrrro

oo

og

gg

grrrra

aa

am

mm

mm

mm

me

ee

errrr’’’’s

ss

s

G

GG

Gu

uu

uiiiid

dd

de

ee

e

The information in this documentation is not contractual in
nature. It is subject to modification without notice.

The software described in this manual is supplied under a
user license. Its use, duplication, or reproduction on any
media whatsoever, except as provided for under the terms
of the license, is not authorized.

No part of the manual may be copied, reproduced or
transmitted by any means whatsoever (unless it is for the
purchaser’s personal use) without the written permission of
Teklynx International.

E 2000 Teklynx International Co.

All rights reserved

Windowstttt is a registered trademark of Microsoftâ Corpora-
tion.
IBM, PC, AT PS/2 are registered trademarks of International
Business Machines,Inc.

Table of Contents

About this manual vii........................................

Welcome! vii............................................

The Programmer’s Guide vii..........................

Typographical conventions viii.........................

Discover ActiveX Automation

foryourlabelingsoftware Chapter1-1......................

Introduction Chapter 1 - 1..........................................

What is an ActiveX object? Chapter 1 - 2............................

What is the type library? Chapter 1 - 3..............................

Mechanisms Chapter 1 - 4..........................................

Server Activation Chapter 1 - 4.....................................

Create Object function Chapter 1 - 4.............................

GetObject function Chapter 1 - 5................................

New

function Chapter 1 - 6...........................................

Server Deactivation Chapter 1 - 7...................................

Quit method Chapter 1 - 8......................................

Data Type Chapter 1 - 8............................................

Application Object Chapter 1 - 8.................................

Document Object Chapter 1 - 9..................................

Collection Object Chapter 1 - 9..................................

Event management Chapter 1 - 11...................................

Handling an Object’s Events Chapter 1 - 11.......................

Connecting a WithEvents variable to an object Chapter 1 - 13.....

Compatibility with the previous version Chapter 1 - 14...............

Particularity about access rights Chapter 1 - 14.......................

1

Programmer’s Guideii

Reference Guide Chapter 2 - 15.....................................

Hierarchy diagram Chapter 2 - 15....................................

Application Object Chapter 2 - 17....................................

Object Properties Chapter 2 - 18..................................

Object Methods Chapter 2 - 23...................................

PrinterSystem Object Chapter 2 - 26.................................

Object Methods Chapter 2 - 26...................................

Options Object Chapter 2 - 29........................................

Object Properties Chapter 2 - 29..................................

Dialogs Collection Chapter 2 - 34.....................................

Object Properties Chapter 2 - 34..................................

Object Methods Chapter 2 - 35...................................

Dialog Object Chapter 2 - 36.........................................

Object Properties Chapter 2 - 36..................................

Object

Methods Chapter 2 - 37..........................................

RecentFiles Collection Chapter 2 - 38.................................

Object Properties Chapter 2 - 38..................................

Object Methods Chapter 2 - 39...................................

RecentFile Object Chapter 2 - 41.....................................

Object Properties Chapter 2 - 41..................................

Object Methods Chapter 2 - 42...................................

Documents Collection Chapter 2 - 43.................................

Object Properties Chapter 2 - 43..................................

Object Methods Chapter 2 - 44...................................

Document Object Chapter 2 - 46.....................................

Object Properties Chapter 2 - 46..................................

Object Methods Chapter 2 - 50...................................

Database Object Chapter 2 - 54......................................

Object Properties Chapter 2 - 54..................................

Object Methods Chapter 2 - 56...................................

Printer Object Chapter 2 - 58.........................................

Object Methods Chapter 2 - 58...................................

Object Properties Chapter 2 - 60..................................

Format Object Chapter 2 - 63........................................

Object Properties Chapter 2 - 63..................................

Object Methods Chapter 2 - 67...................................

DocumentProperties Collection Chapter 2 - 68........................

Object Properties Chapter 2 - 68..................................

Object Methods Chapter 2 - 69...................................

DocumentProperty Object Chapter 2 - 70.............................

Object Properties Chapter 2 - 70..................................

DocObjects Collection Chapter 2 - 72.................................

Object Properties Chapter 2 - 72..................................

Object Methods Chapter 2 - 74...................................

2

iiiTable of Contents

DocObject Object Chapter 2 - 76.....................................

Object Properties Chapter 2 - 76..................................

Object Methods Chapter 2 - 79...................................

Images Collection Chapter 2 - 80.....................................

Object Properties Chapter 2 - 80..................................

Object Methods Chapter 2 - 80...................................

Image Object Chapter 2 - 82.........................................

Object Properties Chapter 2 - 82..................................

Barcodes Collection Chapter 2 - 84...................................

Object Properties Chapter 2 - 84..................................

Object Methods Chapter 2 - 85...................................

Barcode Object Chapter 2 - 86.......................................

Object Properties Chapter 2 - 86..................................

Code2D Object Chapter 2 - 93.......................................

Object Properties Chapter 2 - 93..................................

Object Methods Chapter 2 - 94...................................

Texts Collection Chapter 2 - 95.......................................

Object properties Chapter 2 - 95..................................

Object Methods Chapter 2 - 95...................................

Text Object Chapter 2 - 97...........................................

Object Properties Chapter 2 - 97..................................

Object Methods Chapter 2 - 99...................................

TextSelection Object Chapter 2 - 102..................................

Object Properties Chapter 2 - 102..................................

Object Methods Chapter 2 - 103...................................

OLEObjects Collection Chapter 2 - 104.................................

Object Properties Chapter 2 - 104..................................

Object Methods Chapter 2 - 104...................................

OLEObject Object Chapter 2 - 106.....................................

Object Properties Chapter 2 - 106..................................

Object Methods Chapter 2 - 106...................................

Shapes Collection Chapter 2 - 108.....................................

Object Properties Chapter 2 - 108..................................

Object Methods Chapter 2 - 109...................................

Shape Object Chapter 2 - 113.........................................

Object Properties Chapter 2 - 113..................................

Object Methods Chapter 2 - 113...................................

Variables Collection Chapter 2 - 114...................................

Object Properties Chapter 2 - 114..................................

Object Methods Chapter 2 - 116...................................

Variable Object Chapter 2 - 118.......................................

Object Porperties Chapter 2 - 118..................................

TableLoockups Collection Chapter 2 - 120..............................

Object Properties Chapter 2 - 120..................................

Object Methods Chapter 2 - 120...................................

TableLoockup Object Chapter 2 - 122..................................

Programmer’s Guideiv

Object Properties Chapter 2 - 122..................................

Object Methods Chapter 2 - 123...................................

Formulas Collection Chapter 2 - 125...................................

Object Properties Chapter 2 - 125..................................

Object Methods Chapter 2 - 125...................................

Formula Object Chapter 2 - 127.......................................

Object Properties Chapter 2 - 127..................................

Object Methods Chapter 2 - 128...................................

Dates Collection Chapter 2 - 129......................................

Object Properties Chapter 2 - 129..................................

Object Methods Chapter 2 - 129...................................

Date Object Chapter 2 - 131..........................................

Object Properties Chapter 2 - 131..................................

Counters Collection Chapter 2 - 133...................................

Object Properties Chapter 2 - 133..................................

Object Methods Chapter 2 - 133...................................

Counter Object Chapter 2 - 135.......................................

Object Properties Chapter 2 - 135..................................

FreeVariables Collection Chapter 2 - 139...............................

Object Properties Chapter 2 - 139..................................

Object Methods Chapter 2 - 140...................................

Free Object Chapter 2 - 141...........................................

Object Properties Chapter 2 - 141..................................

DatabaseVariables Collection Chapter 2 - 143..........................

Object Properties Chapter 2 - 143..................................

Object Methods Chapter 2 - 144...................................

FormVariables Collection Chapter 2 - 145..............................

Object Properties Chapter 2 - 145..................................

Object Methods Chapter 2 - 146...................................

Strings Collection Chapter 2 - 147.....................................

Object Properties Chapter 2 - 147..................................

Object Methods Chapter 2 - 147...................................

Document Events Chapter 2 - 149.....................................

Object Methods Chapter 2 - 149...................................

Application Events Chapter 2 - 151....................................

Object Methods Chapter 2 - 151...................................

Appendix Chapter 3 - 152.............................................

InformationonVisualC++DataType Chapter3-152.................

Index Chapitre 4 - 155.................................................

3

4

About this manual

Welcome!

Welcome to the number one Windows based label design and
printing software. It provides the simplest, yet highest
performance solution for your labeling req uirements.

This version of this labeling software integrates the ActiveX
technology offering you the possibility toe easily create a
program to control your labeling software.

The purpose of this manual is to help you program your own
application to control your labeling software. All you should know
about using ActiveX with your labeling software is described in
this manual. However, to get more information about the
ActiveX technology, refer to the Microsoft reference manuals.

The Programmer’s Guide is divided into three parts:

S Discover ActiveX for your labeling software:thispart

gives the bases for programming with ActiveX.

S Reference Guide: this part gives all the object, method and

property definitions integrated by your labeling software.

S Appendix: this part gives you information on Visual C++

Data Type.

The
Programmer’s
Guide

viii

Programmer’s Guide

This manual distinguishes different types of information by using
the following conventions:

S terms taken from the interface itself, such as commands,

appear in bold;

S keys appear in small caps, as in the following example:

”Press the

SHIFT key”;

S numbered lists mean there is a procedure to follow;

S when the conjunction ”or” appears next to a paragraph it

means there is another procedure available for performing a
given task;

S When a menu command contains submenus, the menu name

followed by the command to select appears in bold. Thus,
”Choose File Open” means choose the File menu, then the
Open command.

This symbol provides tips for optimizing certain tasks, speeding
up the execution of commands, etc.

This symbol highlights important information about a particular
function or procedure.

This symbol highlights an example or an exercise.

Typographical
conventions

Discover ActiveX
Automation for your
labeling softw are

Introduction

Using ActiveX Automation, you can control almost anything
you create with your labeling software — even your labeling
software itself.

The ActiveX technology lets you easily integrate your labeling
software as a printing module or a designer module in your own
organization.

ActiveX is object oriented and all of the ActiveX objects a re
programmable from any languages such as Visual Basic. So the
user can control his labeling software using your own program.

Your labeling software b ecomes the server and your program is
the client application.

Through this manual, you will find examples and references
using Visual Basic 6.0.

1

Chapter 1 -- 2

Programmer’s Guide

What is an ActiveX object?

An ActiveX object is an instance of a class that exposes
properties, methods, and events to ActiveX clients. ActiveX
objects support the COM (Component Object Model) - Microsoft
technology. An ActiveX component is an application or library
that is able to create one or more ActiveX objects. In this case,
your labeling software exposes many objects that you can use to
create new applications and programming tools. Within your
labeling software, objects are organized hierarchically, with an
object named Application at the top of the hierarchy (see
Chapter 2 - 15: the hierarchy diagram).

Each ActiveX object has its own member function definition.
When the member functions are exposed, it makes the object
programmable by an ActiveX client. Three types of members can
be exposed for an object:

S Methods are actions that an object can perform. For exam-

ple, the Document object in your labeling software provides
a Close method that closes the current document.

S Properties are functions that access information about the

state of an object. The Application object’s Visible property
determines whether the labeling software is visible or not.

S Events are actions recognized by an object, such as clicking

the mouse or pressing a key. You can write code to respond
to such actions. In Automation, an ev ent is a method that is
called, rather than implemented, by an object (see also
Chapter 1 - 11).

Your labeling software often works with several instances of an
object which together make up a Collection object.For
example, since your labeling software is a multiple-document
interface (MDI), it might have multiple documents. To provide an
easy way to access and program the documents, your labeling
software exposes an object named Documents, which refers to
all of the already opened document objects. Documents is a
collection object.

A Collection object lets you work as a group with the objects it
manage (see Chapter 1 - 9).

All the methods, properties and events are defined in
Chapter 2 - 17: Reference Guide.

Chapter 1 -- 3

Discover ActiveX Automation for your labeling software

What is the type library?

The type library supplied by the labeling software is a file
(Lppx2.tlb) that describes the type of all the ActiveX objects.
The type library does not store objects, it stores type informa­tion. By accessing the type library, your application can
determine the characteristics of an object, such as the interfaces
supported by the object and the names and parameters.

This library helps you to write your program because it contains
all the definitions of object methods and properties that you can
access. Using this library you optimize your job.

ThenameofthistypelibraryisLabelManager2 with the
TK Labeling ActiveX 6.0 reference.

The procedures below show how to install and use the type
library with Visual Basic 6.0.

"""" To install the type library

1 Choose Project References.

2 Activate TK Labeling ActiveX 6.0 in the list of available ref-

erences then validate the dialog box.

"""" To display the methods and properties

1 Use the Object Explorer by pressing the

F2 key.

2 In the library list, select LabelManager2.

"""" To use the type library

S 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.

Chapter 1 -- 4

Programmer’s Guide

Mechanisms

Your labeling software offers you two main objects: the

Application object that is at the top of the hierarchy and the
Document object. These main objects provide access to the

subordinated objects (see Chapter 2 - 15: the hierarchy
diagram).

The first step to activate the server is the main object creation,
in this case, the Application object.

The last step is the deactivation of the server with the Quit
method.

Server Activation

SeveralmethodsareavailabletocreateanActiveXobject.

This function creates and returns a reference to the Application
object.

Syntax CreateObject(server name)

Defines an object variable. This object variable is meant to con­tain the object reference. Dim as Object creates a link at exe­cution.

Dim MyApp as Object
Set MyApp = CreateObject(”Lppx2.Application”)

This code launches the application that creates the object. In this
case, the labeling software. As soon as the object is created, you
reference it in the code with the object variable that you have
defined, i.e. MyApp.

Note

If you define an object variable with “As Object”, a variable
containing a reference for any object type is created. However,
the access to an object via this variable is realized by a late
bind, i.e. the link is created during the execution of your pro­gram. To create an object variable that induces an early bind,
i.e. a link during the compilation of your program, define the
object variable with a specific identifier (see below).

Create Object
function

Chapter 1 -- 5

Discover ActiveX Automation for your labeling software

For example, you can define and create the reference using the
code below:

Dim MyApp As Lppx2.Application
Set MyApp = CreateObject(”Lppx2.Application”)

The variable reference creating an early bind increases the
performance but must only contain one reference.

This function returns a reference to an ActiveX object from a file.

Syntax GetObject([pathname],[server name])

The syntax of the GetObject function includes the following
arguments:

Item Description

pathname Optional. Variable of Variant

type (String). Complete path­name with the name of the
file containing the object to
get. If you don’t define the
pathname, you have to define
the server name.

servername Optional. Variable of Variant

type (String). Name of the
application that gives the
object.

Note

Use the GetObject function to access an ActiveX object from a
file and to assign this object, an object variable. Use the Set
instruction to assign the object that is returned by the GetOb-
ject functionattheobjectvariable(seebelow).

Below are several examples showing the variations of the
GetObject syntax.

Dim MyDoc As Object
Set MyDoc = GetObject(”c:\ProgramFile\document.lab”)

When this code is executed, the application associated with the
pathname argument is launched and the object included in the
file is activated.

Note

In the case where the server automation is already loaded in
the system memory, the ActiveX mechanism selects it, then the
document is activated.

GetObject
function

Chapter 1 -- 6

Programmer’s Guide

Intheexamplebelow,theservernameisspecified.Usethis
parameter if you have several versions of your labeling software
to open the document.lab with the correct version.

Dim MyApp As Object
Set MyApp = GetObject (”c:\ProgramFile\docu­ment.lab”,”Lppx2.Application”)

Note that in the example below the Visual Basic for Application
expression GetObject(,”Lppx2.Application) will fail unless the

Application (the labeling software) is already running. If the
Application is not already running, a new instance will not be

launched.

Dim MyApp As Object
Set MyApp = GetObject (,”Lppx2.Application”)

In this example, the variation of the GetObject syntax varies
from the previous example in that a new instance of the applica­tion will always be launched even if the application is already
running. This variation is equivalent to a CreateObject state­ment.

Dim MyApp As Object
Set MyApp = GetObject (””,”Lppx2.Application”)

The key word New can only be used if you work with the Type
Library (see: What is the type library).

New assigns an object reference to a variable or to a property.

Syntax

SetMyApp={[New]objectexpression}

This example demonstrates reation of the MyApp object that
represents Application. This is the standard access to get the
subordinated objects of Application.

Dim MyApp As LabelManager2.Application
Set MyApp = New LabelManager2.Application

New
function

Chapter 1 -- 7

Discover ActiveX Automation for your labeling software

The syntax of the Set instruction contains the following items:

Item Description

objectvar Nameofthevariableorprop-

erty.

New Optional. This key word is

generally used in the declara­tions to allow the implicit cre­ationofanobject.Usedwith
Set, the New key word
creates a new instance of the
class. If the objectvar argu­ment contains a reference to
an object, this reference is
lost when a new association is
created.

Note

The objectvar must have an object type compatible with the
object to which it is assigned.

Server Deactivation

The last step of your program is the deactivation of the server
with the Quit method.

To correctly deactivate the server, you must:

a. Close all the documents with the CloseA ll method on the

Documents collection.

b. Call the Quit method of the Application object. This method

meanstheprocessisended.

c. Ask Visual Basic to delete the Application from the system

memory by setting the va lue of the variable to Nothing.

Chapter 1 -- 8

Programmer’s Guide

The Quit method is used to end the process. Before using this
method, you must close all the documents.

Thefollowingexampleshowshowtodeactivatetheserver.Use
the CloseAll method on the Documents collection to close all
the documents. Then, use the Quit method on the Application
object to end the process. At the end, the Set instruction delete
the Application from the system memory.

MyApp.Documents.CloseAll False
MyApp.Quit
Set MyApp = Nothing

Data Type

There are three data types corresponding to the three main
objects: Application, Document and Collection.

The Application object represents the labeling software. The
Application object contains the properties and the methods that
return the first level objects. For example, the ActiveDocument
property returns a Document object.

"""" Using the Application object

To return the Application object, use the Application property.
The following sample shows how to display the path defined for
the labeling software.

Dim MyApp As LabelManager2.Application
Set MyApp = New LabelManager2.Application

MsgBox MyApp.Path

Most of the properties and methods that return the common user
interface objects, such as the active document (ActiveDocu-

ment property), can be used without the identifier of the
Application object by using the With keyword.

Quit method

Application
Object

Chapter 1 -- 9

Discover ActiveX Automation for your labeling software

Dim MyApp As LabelManager2.Application
...

With MyApp

.ActiveDocument
.Print

end With

The properties and methods that can be used without the
Application object are called “global.”

S To display the global properties and methods in the object

explorer (

F2 key), click on global at the beginning of the list

displayed in the Classes zone.

The Document object represents an open document. Each open
document in the labeling software is represented by a Docu-
ment object. This object has members (properties, methods,
and events) that you can use to manipulate the document.

You can access the current document if there is an open
document by using the ActiveDocument property of the
Application object.

All open documents that belong to the documents collection are
represented by the Documents object. You can find a particular
document by moving through this collection.

A Collection object is an ordered set of items that can be
referred to a unit.

Note

The Collection object provides a convenient way to refer to a
related group of items as a single object. The items, or mem­bers, in a collection need only be related by the fact that they
exist in the collection. Members or items of a collection don’t
have to share the same da ta type (see Chapter 1 - 8).

A collection can be created the same way other objects are
created. For example:

Dim X As New Collection

Once a collection is created, members can be added using the
Add method and removed using the Remove method. Specific
members can be returned from the collection using the Item
method, while the entire collection can be returned using the For

Each...Next statement.

Document
Object

Collection
Object

Chapter 1 -- 10

Programmer’s Guide

"""" Collection methods

Methods for collection are described in the following table. The

Item method is required; other methods are optional.

Method name Return type Description

Add VT_DISPATCH

or VT_EMPTY

Adds an item to a collec­tion. Returns VT_DISPATCH
if object is created (object
cannot exist outside the
collection) or VT_EMPTY if
no object is created (object
can exist outside the collec­tion).

Item Varies with

type of collec­tion

Returns the indicated item
in the collection. Required.
The Item method may
take one or more argu­ments to indicate the ele­ment within the collection
to return. This method is
the default member for the
collection object.

Remove VT_EMPTY Removesanitemfroma

collection. Uses indexing
arguments in the same way
as the Item method.

The Item method takes one or more arguments to indicate the
index. Indexes can be numbers or strings.

Because Item is the default method, you could write either:

MyObject.Item(3).Name

-Or-

MyObject(3).Name

"""" Count Property

Returns a Long (long integer) containing the number of objects
in a collection. Read-only.

Chapter 1 -- 11

Discover ActiveX Automation for your labeling software

Event management

When a program detects that something has happened, it can
notify its clients. For example, if a stock ticker program detects a
change in the price of a stock, it can notify all clients of the
change. This notification process is referred to as firing an event.

Client

Server: Lppx2

Application

Document

Events

Get or set properties.

Call methods.

Fire events

(event source)

Figure 1 Interaction between the Client and

the Labeling software

An object that triggers events is called an event source.To
handle the events trigg ered by an eve nt source, you can declare
a variable of the object’s class using the WithEvents keyword.

For example, to handle the ProgressPrinting event of a Docu-
ment, place the following code in the Declarations section:

Option Explicit
Private WithEvents MyDoc As LabelManager2.Document
Private mblnCancel As Boolean

In this case, the client application must set the EnableEvents
property of the application to True in order to trigger the events.

The WithEvents keyword specifies that the variable MyDoc will
be used to handle an object’s events. You specify the kind of
object by supplying the name of the class from which the object
will be created.

The variable MyDoc is declared in the Declarations section
because WithEvents variables must be module-level variables.
Thisistrueregardlessofthetypeofmoduleyouplacethemin.

The variable mblnCancel will be used to cancel the LongTask
method.

"""" Limitations on WithEvents variables

You should be aware of the following limitations on the use of

WithEvents variables:

Handling an
Object’s
Events

Chapter 1 -- 12

Programmer’s Guide

S A WithEvents variable cannot be a generic object variable.

Thatis,youcannotdeclareitAsObject-youmustspecify
the class name when you declare the variable.

S You cannot declare a WithEvents variable As New. The

event source object must b e explicitly created and assigned
to the WithEvents variable.

S You cannot declare WithEvents variables in a standard mod-

ule. You can declare them only in class modules, form mod­ules, and other modules that define classes.

S You cannot create arrays of WithEvents variables.

"""" Writing code to handle an event

As soon as you declare a variable WithEvents,thevariable
name appears in the left-hand drop down of the module’s code
window. When you select MyDoc,theDocument class events
will appear in the right-hand drop down, as shown in Figure 2
below:

Figure 2 An event associated with a WithEvents variable

Selecting an event will display the corresponding event
procedure, with the prefix MyDoc_. All the e vent procedures
associated with a WithEvents variable will have the variable
name as a prefix.

Chapter 1 -- 13

Discover ActiveX Automation for your labeling software

For example, add the following code to the

MyDoc_ProgressPrint event procedure:

Private Sub MyDoc_ProgressPrinting (ByVal Percent as
integer,Cancel as integer)

lblPercentDone.caption = CInt (100 * Percent) & “%”
DoEvents
If mblnCancel Then Cancel = True

End Sub

Whenever the ProgressPrinting event is raised, the event
procedure displays the percent complete in a Label control. The
DoEvent statement allows event processing to occur. The
module-level variable mblnCancel is set to True, and the
MyDoc_ProgressPrinting event then tests it and sets the
ByRef Cancel argument to True.

When you declare a variable WithEvents at design time, there
is no object associated with it. A WithEvents variable is just like
any other object variable. You hav e to create an object and
assign a reference to the object to the WithEvents variable.

Add the following cod e to the Form_Load event procedure to
create the LabelManager2.Application.

Private Sub Form_Load()

Set MyApp = New LabelManager2.Application
Set MyDoc = MyDoc.Documents.Add (”My Document”)
MyApp.EnableEvents = True

End Sub

When the code above is executed, Visual Basic creates a
LabelManager2.Application and a new document called “My
Document” then connects its events to the event procedures
associated with MyDoc. From that p oint on, wheneve r the

MyDoc raises its ProgressingPrinting event, the
MyDoc_PrintProgressing event procedure will be executed.

Connecting a
WithEvents
variable to an
object

Chapter 1 -- 14

Programmer’s Guide

Compatibility with the previous version

This version is compatible with the previous version of the label
design software.

However, the labeling software includes new features and certain
processes have changed.

To ensure your program can be executed with this version,
verify your code by referring to the User’s Guide for information
on the functions that have changed.

For example, the previous version of your labeling software uses
a simple-document interface (SDI) and, the ActiveDocument
property always refers to a document. This version is a multiple­document interface (MDI) and there isn’t a lways an open docu­ment. If you use this property, verify that there is an open docu­ment after the server is activated.

To remain compatible with the previous version :

S a document is automatically created at initialization,

S the Open method will close the current document (if one

exists), before a new document is created (The Close
method functions the same way).

However, if the Application object is visible, the user has con­trol of the active document management. For example, if the
user closes the active document, a new document is not auto­matically created.

Particularity about access rights

Certain versions of the labeling software include a User
manager module. This module controls access to certain

functions of the labeling software.

For example, if calling a function through your ActiveX interface
fails, verify your rights in the User manager module. An error
message is displayed and provides information about the nature
oftheerror(seetheReference Guide, Chapter 2 - 24: Error
code table).

Reference Guide

Hierarchy diagram

The diagram below shows the object hierarchy:

Strings

RecentFiles

RecentFile

PrinterSystem

Options

Dialogs

Dialog

Documents

Document

Database

Printer

Format

DocumentProperties

Application .

DocumentProperty

2

Chapter 2 -- 16

Programmer’s Guide

Text

Variables .

FormVariables

DocObjects

Document .

Variable

Free

FreeVariables

Free

DatabaseVariables

Free

Counters

Counter

Dates

Date

TableLookups

TableLookup

Formulas

Formula

DocObjects

Barcodes

Barcode

Code2D

Texts

TextSelection

Images

Image

Shapes

Shape

OLEObjects

OLEObject

Chapter 2 -- 17

Reference Guide

Application Object

Properties Methods

ActiveDocument ErrorMessage

ActivePrinterName GetLastError

Application ShowHelp

Caption Move

DefaultFilePath Resize

Dialogs Quit

Documents

EnableEvents

FullName

Height

Left

Locked

Name (Default)

Options

Parent

Path

PrinterSystem

RecentFiles

Top

UserControl

Version

Visible

Width

Chapter 2 -- 18

Programmer’s Guide

"""" Application.ActiveDocument

This property allows you to access the document object interface
(refer to the document which has the focus in the main
application).

Returns an error if no document in application.

Access Read-Only.

Type VT_DISPATCH or

Document.

"""" Application.ActivePrinterName

Returns the current pair <Printer, Port> of the active document,
if any, empty string if none.

Access Read-only.

Type VT_BSTR or

String.

"""" Application.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-only.

Type VT_DISPATCH or

Application.

"""" Application.Caption

Returns or sets the caption text for the application window. To
change the caption of the application window into the default
text, set this property to an empty string (””).

Access Read/Write.

Type VT_BSTR or

String.

Object
Properties

Chapter 2 -- 19

Reference Guide

"""" Application.DefaultFilePath

Sets or returns the default path specification used by the
application for opening document files.

Access Read/Write.

Type VT_BSTR or

String.

"""" Application.Dialogs

Returns the Dialogs

collection that represents all the built-in

dialog boxes of the application.

Access Read-only.

Type VT_DISPATCH or

Dialogs.

"""" Application.Documents

Returns the Documents

collection that represents all the open

documents.

Access Read-only.

Type VT_DISPATCH or

Documents.

"""" Application.EnableEvents

Enables or disables Automation events notification (Default:
False) (see Appendix).

Access Read/Write.

Type VT_BOOL or

Boolean.

"""" Application.FullName

Returns the file specification for the application, including path.
(Ex : c:\drawdir\scribble).

Access Read-Only.

Type VT_BSTR or

String.

Chapter 2 -- 20

Programmer’s Guide

"""" Application.Height

Returns or sets the height of the main window of the application
(in pixel unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Application.Left

Returns or sets the distance between the left edge of the main
window of the application and the left edge of the screen (in
pixel unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Application.Locked

Locks the User Interface if True.

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Application.Name

Returns the name of the application (for example, ”Microsoft
Word”). Default property.

Access Read-Only.

Type VT_BSTR or String

.

"""" Application.Options

Represents application and general document options. Many of
the properties for the Options object correspond to items in the
Options dialog box (Tools menu). Use the Options property to
return the Options object.

The following example sets two application options:

With Options

.LoadPrinterSetup = True
.MeasureSystem = lppxInch

End With

Chapter 2 -- 21

Reference Guide

Access Read-only.

Type VT_DISPATCH or Options

.

"""" Application.Parent

Returns the parent object of the specified object.

Access Read-only.

Type VT_DISPATCH.

"""" Application.Path

Returns the path of the Application ( with « \ » character).

Access Read-only.

Type VT_BSTR or String

.

"""" Application.PrinterSystem

Returns the PrinterSystem

object that represents all printers in

the system.

Access Read-only.

Type VT_DISPATCH or PrinterSystem

.

"""" Application.RecentFiles

Returns the RecentFiles

collection that represents the list of last

recent files used (File menu in UI).

Access Read-only.

Type VT_DISPATCH or RecentFiles

.

"""" Application.Top

Returns or sets the distance between the top edge of the main
window of the application and the top edge of the screen (in
pixel unit).

Access Read/Write.

Type VT_I4orLong

.

Chapter 2 -- 22

Programmer’s Guide

"""" Application.UserControl

True if the application was created by the user.

False if the application was created in programming (with the

CreateObject or GetObject method in Visual Basic).

Note

If the application is visible to the user, this property will always
return True.

Access Read-Only.

Type VT_BOOL or Boolean

.

"""" Application.Version

Returns the software version number.

Access Read-Only.

Type VT_BSTR or String

.

"""" Application.Visible

True if the application is visible. (Default: False, if application
was launched with CreateObject).

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Application.Width

Returns or sets the width of the main window of the application
(in pixel unit).

Access Read/Write.

Type VT_I4orLong

.

Chapter 2 -- 23

Reference Guide

"""" Application.ErrorMessage

VTS_BSTR or String

ErrorMessage( intErrorCode )

Returns the string message error associated with the error code
parameter.

Return value: Message associated.

Parameters:

intErrorCode Required VT_I2 or Integer

. Error code to process.

"""" Application.GetLastError

VTS_I2 or Integer

GetLastError()

Returns the last error code generated.

Return value: Error code (see Error code table below).

Parameters:None.

No error 0

Can’t open data file 1200
Can’t open query file 1201
Can’t open descriptor file 1202
Can’t open label file 1203
Can’t open POC file 1204
Can’t open log file 1205

Printer not found 1300
Driver not found 1301

Incorrect Datasource enum value 1400
Incorrect Rotation enum value 1401
Incorrect HRAlign enum value 1402
Incorrect HRPosition enum value 1403
Incorrect HR check digit enum value 1404
Incorrect Anchor point enum value 1405
Incorrect counter base enum value 1406
Incorrect Label object enum value 1407
Incorrect view size enum value 1408
Incorrect view mode enum value 1409
Incorrect MeasureSystem enum value 1410
Incorrect dialog type enum value 1411

Object
Methods

Chapter 2 -- 24

Programmer’s Guide

Incorrect language enum value 1412
Incorrect symbology enum value 1413
Incorrect built in document property enum

value

1414

Incorrect view orientation enum value 1415
Incorrect form prompt mode enum value 1416

Object not found 1500
Can’t create object 1501
Variable not found 1502
Can’t create variable 1503
Invalid font object 1504
Invalid variable object 1505
Name of item already used 1506

Database not connected 1600
Database connection failed 1601

Number must be positive 2000
Data type must be a boolean 2001
Invalid path 2002
File already exists 2003
Can’t prompt dialog box (no active document) 2100

Not sufficient access rights to perform this
operation

3000

Figure 3 Error code table

Chapter 2 -- 25

Reference Guide

"""" Application.ShowHelp

VTS_NONE ShowHelp(strHelpFile, longHelpContext)

This method activates a help file.

Parameters:
strHelpFile Optional VT_BSTR or String

. Specifies the help
file to open (.HLP or .CHM). If not specified, associated help file
is opened.

longHelpContext Optional VT_I4 or Long

. Specifies the id context

to jump to. If not specified, general index is prompted.

"""" Application.Move

VTS_NONE Move( longposLeft, longposTop)

Moves the application window to the specified position (posLeft,
posTop), in pixel unit.

Parameters:

longposLeft RequiredVT_I4orLong

. Sets the distance
between the left edge of the main window of the application and
the left edge of the screen(in pixel unit).

longPosTop RequiredVT_I4orLong

. Sets the distance
between the top edge of the main window of the application and
the top edge of the screen (in pixel unit).

"""" Application.Resize

VTS_NONE Resize( longWidth, longHeight)

Resizes the application window (Width, Height), in pixel unit.

Parameters:
longWidth RequiredVT_I4orLong

. Sets the width of the
main window of the application (in pixel unit).

longHeight RequiredVT_I4orLong

. Sets the height of the
main window of the application (in pixel unit).

"""" Application.Quit

VTS_NONE Quit()

Quits the current application. No effect if the application has
been launched manually. First executes a Document.CloseAll
(True) then releases the application.

Chapter 2 -- 26

Programmer’s Guide

PrinterSystem Object

Properties Methods

(None) Families

Models

Printers

Ports

Add

Remove

Rename

"""" PrinterSystem.Families

VTS_DISPATCH or Strings

Families ()

Retrieves printer families list.

"""" PrinterSystem.Models

VTS_DISPATCH or Strings

Models ( strFamilyName)

Retrieves models associated with a family.

Parameters:

strFamilyName Optional VT_BSTR or String

.Itspecifiesthe
Family for which the models list is needed. If none, it returns the
full models list.

"""" PrinterSystem.Printers

VTS_DISPATCH or Strings

Printers ( intKindOfPrinters)

Retrieves installed printers as string pairs < Printer, Port >.

Parameters:

intKindOfPrinters OptionalVT_I2orInteger

or enumKindOf-

Printers

.(default lppxInternalPrinters).

Thevaluecanbeoneofthefollowing:
lppxInternalPrinters= 1
lppxWindowsPrinters= 2
lppxAllPrinters= 3

Object
Methods

Chapter 2 -- 27

Reference Guide

"""" PrinterSystem.Ports

VTS_DISPATCH or Strings

Ports ().

Retrieves all installed ports on the system.

"""" PrinterSystem.Add

VTS_BSTR or String

Add (strPrinterName, strPortName,

boolDirectAccess)

Installs a new printer and returns the full name assigned to it.

Parameters:

strPrinterName Required VT_BSTR or String

.PrinterName

to install (got with Printers.InternalPrinters).

strPortName Required VT_BSTR or String

.PortName

associated with the printer.

boolDirectAccess Optional VT_BOOL or Boolean

(default value

FALSE). Is the port used with direct access or not.

Note

Only models can be installed with this method.

"""" PrinterSystem.Remove

VTS_NONE Remove (strPrinterPortName).

Removes an installed printer.

Parameters:

strPrinterPortName Required VT_BSTR or String.

Full name of
an installed printer (got with PrinterSystem.Printers(lppxInter­nalPrinters) method).

Note

Only models can be removed.

If an active document uses this printer, the operation fails.

Chapter 2 -- 28

Programmer’s Guide

"""" PrinterSystem.Rename

VTS_NONE Rename (strPrinterName, strNewPrinter­Name).

Renames a model.

Parameters:

strPrinterName Required VT_BSTR or String

.Nameof the

installed printer to rename.

strNewPrinterName Required VT_BSTR or String

.New

name to assign.

Note

Only models can be renamed.

Chapter 2 -- 29

Reference Guide

Options Object

Properties Methods

Application (None)

CreateBackup

DefaultDescriberPath

DefaultSharedVarPath

DefaultImagePath

DefaultPrintOutFilePath

DefaultQueryPath

DefaultUserSettingsPath

EuroConversionRate

Language

LoadPrinterSetup

LoadPrinter

MeasureSystem

OpenMergeDatabase

Parent

OpenReadOnly

SharedFileAccessTimeout

TrayNotification

"""" Options.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

Object
Properties

Chapter 2 -- 30

Programmer’s Guide

"""" Options.CreateBackup

ReturnsorsetstheCreateBackup

option. (Default: True).

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Options.DefaultDescriberPath

Returns or sets the DefaultDescriberPath

option.

Access Read/Write.

Type VT_BSTR or String

.

"""" Options.DefaultSharedVarPath

Returns or sets the DefaultSharedVarPath

option.

Access Read/Write.

Type VT_BSTR or String

.

"""" Options.DefaultImagePath

Returns or sets the DefaultImagePath

option.

Access Read/Write.

Type VT_BSTR or String

.

"""" Options.DefaultPrintOutFilePath

Returns or sets the DefaultPrintOutPath

option.

Access Read/Write.

Type VT_BSTR or String

.

"""" Options.DefaultQueryPath

Returns or sets the DefaultQueryPath

option.

Access Read/Write.

Type VT_BSTR or String

.

Chapter 2 -- 31

Reference Guide

"""" Options. DefaultUserSettingsPath

Returns or sets the DefaultUserSettingsPath

option.

Access Read/Write.

Type VT_BSTR or String

.

"""" Options. EuroConversionRate

ReturnsorsetstheEuroConversionRate

option. (Default

6.55957).

Access Read/Write.

Type VT_R4orSingle

.

"""" Options.Language

Returns or sets the Language

option.

Access Read/Write.

Type VT_I4orLong

or enumLanguage type.

Thevaluecanbeoneofthefollowing:
lppxEnglish = 1
lppxFrench = 2
lppxGerman = 3
lppxItalian = 4
lppxSpanish = 5
lppxDanish = 6
lppxSwedish = 7
lppxJapanese = 8
lppxHungarian = 9
lppxDutch = 10
lppxCzech = 11
lppxNorwegian = 12
lppxFinnish = 13
lppxPortuguese = 14
lppxSimplifiedChinese = 15
lppxTraditionalChinese = 16
lppxKorean = 17

Note

Depending on the product, not all languages are available.

Chapter 2 -- 32

Programmer’s Guide

"""" Options.LoadPrinter

Returns or sets the LoadPrinter

option. (Default : False).

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Options.LoadPrinterSetup

Returns or sets the LoadPrinterSetup

option. (Default : True).

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Options.MeasureSystem

ReturnsorsetstheMeasureSystem

option. (Default : lppxMilli-

meter

).

Access Read/Write.

Type VT_I2orInteger

or enumMeasureSystem type.

Thevaluecanbeoneofthefollowing:
lppxMillimeter = 0
lppxInch = 1

Note

Using lppxMillimeter unit means that values entered are in
Millimeter per cent.
Using lppxInch unit means that values entered are in Inch per
thousand.

"""" Options.OpenMergeDatabase

Returns or sets the OpenMergeDatabase

option. (Default: False)

Access Read/Write.

Type VT_BOOL or Boolean

.

Chapter 2 -- 33

Reference Guide

"""" Options.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

"""" Options.OpenReadOnly

ReturnsorsetstheOpenReadOnly

option. (Default : False)

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Options. SharedFileAccessTimeout

Returns or sets the SharedFileAccessTimeout

option. (Default:

10000 ms)

Access Read/Write.

Type VT_I4orLong

.

"""" Options.TrayNotification

Enables or disables notification of printing in System Tray Bar.
(Default: True)

Access Read/Write.

Type VT_BOOL or Boolean

.

Chapter 2 -- 34

Programmer’s Guide

Dialogs Collection

Properties Methods

Application Item (Default)

Count

Parent

"""" Dialogs.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only

Type VT_DISPATCH or Application

object.

"""" Dialogs.Count

Returns the number of items in the specified collection.

Access Read-Only.

Type VT_I2orInteger

.

"""" Dialogs.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

Object
Properties

Chapter 2 -- 35

Reference Guide

"""" Dialogs.Item

VTS_DISPATCH or Dialog

Item( intIndex ).

Returns a member of a collection, by position.

Note

If the value provided as Index does not match any existing
member of the collection, no object is returned.

Parameters:

intIndex Required VT_I2 or Integer

or enumDialogType.The

index number of a member of the collection.

The index must be a numeric expression (a number from 1 to
the value of the collection’s Count property), or a constant.

Note

If the value provided as Index doesn’t match any existing
member of the collection, an error occurs.
The Item method is the default method for collections. There­fore, the following two lines of code are equivalent.

Object.Dialogs(1)
Object.Dialogs.Item(1)

Thevaluecanbeoneofthefollowing:
lppxPrinterSelectDialog= 1
lppxOptionsDialog= 2
lppxFormDialog= 3
lppxPrinterSetupDialog= 4
lppxPageSetupDialo g= 5
lppxDocumentPropertiesDialog= 6

Object
Methods

Chapter 2 -- 36

Programmer’s Guide

Dialog Object

Properties Methods

Application Show

Parent

Type

"""" Dialog.Application

Returns the Application

object that represents the root object

of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" Dialog.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

"""" Dialog.Type

Returns the type of the prompted dialog box.

Access Read-Only.

Type VT_I2orInteger

or enumDialogType type.

Object
Properties

Chapter 2 -- 37

Reference Guide

"""" Dialog.Show

VTS_I2 or Integer

Show().

Prompts the dialog box associated.

Return value 1 if the user has clicked on OK.

2 if the user has clicked on Cancel.

If application is not visible, dialog box is prompted at the top
level of all windows.

If there is no document open, the dialog boxes (except Options
dialog box) can’t be displayed because they depend on the
document.

Object
Methods

Chapter 2 -- 38

Programmer’s Guide

RecentFiles Collection

Properties Methods

Application Add

Count Item (Default)

Maximum Clear

Parent Remove

"""" RecentFiles.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" RecentFiles.Count

Returns the number of items in the specified collection.

Access Read-Only.

Type VT_I2orIntege

r.

"""" RecentFiles.Maximum

Returns or sets the maximum number of items in the specified
collection (from 0 to 16).

Access Read/Write.

Type VT_I2orIntege

r.

"""" RecentFiles.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

Object
Properties

Chapter 2 -- 39

Reference Guide

"""" RecentFiles.Add

VTS_DISPATCH or RecentFile

Add(DocumentReference,

boolReadOnly).

Adds a document reference to the collection and in the File
menu.

Parameters:

DocumentReference Required VT_VARIANT or Variant

.This

reference must be unique in the collection.

boolReadOnly Optional VT_BOOL or Boolean

.If
document must be opened, it will be opened with ReadOnly
attribute.

"""" RecentFiles.Clear

VTS_NONE Clear.

Resets the collection and clears menu.

"""" RecentFiles.Item

VTS_DISPATCH or RecentFile

Item( intIndex ).

Returns a member of a collection, by position (default method).

Note

If the value provided as Index does not match any existing
member of the collection, no object is returned.

Parameters:

Index Required VT_I2 or Integer

. The index number of a

member of the collection.

The index must be a numeric expression (a number from 1 to
the value of the collection’s Count property), or a constant.

Note

If the value provided as Index doesn’t match any existing
member of the collection, an error occurs.
The Item method is the default method for collections. There­fore, the following two lines of code are equivalent.

Object.RecentFiles(1)
Object.RecentFiles.Item(1)

Object
Methods

Chapter 2 -- 40

Programmer’s Guide

"""" RecentFiles.Remove

VTS_NONE Remove( intIndex ).

Deletes object with intIndex index.

Chapter 2 -- 41

Reference Guide

RecentFile Object

Properties Methods

Application Open

Parent

Path

Name

"""" RecentFile.Application

Returns the Application

object that represents the root object of

the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" RecentFile.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

"""" RecentFile.Path

Returns the path associated with the current filename (always
without « \ » character).

Access Read-Only.

Type VT_BSTR or String

.

"""" RecentFile.Name

Returns the name associated with the current filename.

Access Read-Only.

Type VT_BSTR or String

.

Object
Properties

Chapter 2 -- 42

Programmer’s Guide

"""" RecentFile.Open

VTS_DISPACTCH or Document

Open().

Opens the document associated with the current filename.

Object
Methods

Chapter 2 -- 43

Reference Guide

Documents Collection

Properties Methods

Application Add

Count CloseAll

DefaultExt Item (Default)

Parent Open

SaveAll

"""" Documents.Count

Returns the number of items in the specified collection.

Access Read-Only.

Type VT_I2orInteger

.

"""" Documents.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" Documents.DefaultExt

This property returns the default document filename extension
for the application.

Access Read-Only.

Type VT_BSTR or String

.

"""" Documents.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

Object
Properties

Chapter 2 -- 44

Programmer’s Guide

"""" Documents.Add

VTS_DISPATCH or Document

Add(strDocumentName).

Adds a new Document

to the collection.

Return value: Returns a Document

object if succeeded.

Parameters:

strDocumentName Optional VT_BSTR or String.
Specifies the name of the new document to add.
If none, system automatically assigns one.

"""" Documents.CloseAll

VTS_NONE CloseAll ( boolSaveChanges ).

Closes all documents.

Parameters:

boolSaveChanges Optional VT_BOOL or Boolean

.Specifies

the save action for all documents. (default: True).

If boolSaveChanges is True and a document has not been
previously saved, the Saves As dialog box is automatically
prompted.

"""" Documents.Item

VTS_DISPATCH or Document

Item( varIndex ).

Returns a Document

of a collection, either by position or by

name.

Note

If the value provided as Index does not match any existing
member of the collection, no object is returned.

Parameters:

varIndex Required VT_VARIANT or Variant

.Thenameor

index number of a member of the collection.

The index can be a numeric expression (a number from 1 to the
value of the collection’s Count property), a constant, or a string.

Note

If the value provided as Index doesn’t match any existing
member of the collection, an error occurs.
The Item method is the default method for collections. There­fore, the following two lines of code are equivalent.

Object.Documents(1)
Object.Documents.Item(1)

Object
Methods

Chapter 2 -- 45

Reference Guide

"""" Documents.Open

VTS_DISPATCH or Document

Open( strFileName,

boolReadOnly ).

Opens the specified document and adds it to the Documents
collection.

Return value: Returns a Document

object.

Parameters:

strFileName Required VT_BSTR or String

. The name of

the document (paths are accepted).

boolReadOnly Optional VT_BOOL or Boolean

.Truetoopen

the document as read-only. By default, set to False.

"""" Documents.SaveAll

VTS_NONE SaveAll( boolAlwaysPrompt ).

Saves all the documents in the Documents collection.

If a document hasn’t been previously saved, the Save As dialog
box is prompted even if the Prompt parameter is assigned to
False.

Parameters:

boolAlwaysPrompt Optional VT_BOOL or Boolean.

True if

user wants to prompt the save dialog box (default: False).

Chapter 2 -- 46

Programmer’s Guide

Document Object

Properties Methods

Application Close

BuiltInDocumentProperties CopyToClipboard

Database Merge

Format FormFeed

TriggerForm GeneratePOF

FullName Insert

Name (Default) PrintDocument

DocObjects PrintLabel

Parent Save

Printer SaveAs

ReadOnly Activate

Variables CopyImageToFile

ViewMode

ViewOrientation

WindowState

IsModified

"""" Document.Application

Returns the Application

object that represents the root object of

the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

Object.

"""" Document. BuiltInDocumentProperties

Returns the DocumentProperties

collection that represents

document properties.

Access Read-Only.

Type VT_DISPATCH or DocumentProperties

collection.

Object
Properties

Chapter 2 -- 47

Reference Guide

"""" Document.Database

Returns the Database

object associated with the document.

Access Read-Only.

Type VT_DISPATCH or Database

object.

"""" Document.Format

Returns the Format

object that represents the format of the

document.

Access Read-Only.

Type VT_DISPATCH or Format

object.

"""" Document.TriggerForm

Sets or returns the TriggerForm

in printing situation.

Access Read/Write.

Type VT_I2 or Integer or enumTriggerForm

type.

Thevaluecanbeoneofthefollowing:
lppxNever = 1
lppxForEachSerie = 2
lppxForEachLabel = 3

"""" Document.FullName

Returns the file specification for the document, including path.

Access Read-Only.

Type VT_BSTR or String

.

Ex : c:\drawdir\scribble.

"""" Document.Name

Returns the document’s name. Default property.

Access Read-Only.

Type VT_BSTR or String

.

Chapter 2 -- 48

Programmer’s Guide

"""" Document.IsModified

Tests that the document has been modified since the last save
operation.

Access Read-Only.

Type VT_BOOL or Boolean

.

The possible modifications are : creating, deleting and editing
DocObjects; creating and deleting variables...

"""" Document.DocObjects

Returns the DocObjects

collection that represents all the created

objects in the document.

Access Read-Only.

Type VT_DISPATCH or DocObjects

object.

"""" Document.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

"""" Document.Printer

Returns the Printer

object that represents the associated printer.

Access Read-Only.

Type VT_DISPATCH or Printer

object.

"""" Document.ReadOnly

True, if the changes of the current document cannot be saved to
the original document.

Access Read-Only.

Type VT_BOOL or Boolean

.

Chapter 2 -- 49

Reference Guide

"""" Document.Variables

Returns the Variables

collection that represents all the created

Variable

objects in the document.

Access Read-Only.

Type VT_DISPATCH or Variables

collection.

"""" Document.ViewMode

Sets or retrieves the current mode of visual display.

Access Read/Write.

Type VT_I2orInteger

or enumViewMode type.

The value can one of the following:
lppxViewModeName = 1
lppxViewModeSize = 2
lppxViewModeValue = 3
lppxViewModeForm = 4

"""" Document.ViewOrientation

Sets or retrieves the orientation of the view of the document.

Access Read/Write.

Type VT_I2orInteger

or enumRotation type.

Thevaluecanbeoneofthefollowing:
lppxNoRotation = 0
lppx90DegreeRight = 1
lppxUpSideDown = 2
lppx90DegreeLeft = 3

"""" Document.WindowState

Sets or retrieves the current size of the visual display of the
document.

Access Read/Write.

Type VT_I2 or Integer or enumWindowState

type.

The value can one of the following:
lppxNormal= 1
lppxMinimized= 2
lppxMaximized= 3

Chapter 2 -- 50

Programmer’s Guide

"""" Document.Close

VTS_I2 Close( boolSave ).

Closes document.

Parameters:

boolSave Optional VT_BOOL or Boolean

.(default false) If

True, saves document.

"""" Document.CopyToClipboard

VTS_BOOL CopyToClipboard().

Copies an image of the document to the Clipboard.

"""" Document.FormFeed

VTS_I2 FormFeed ().

Ends the process job.

"""" Document.GeneratePOF

VTS_I2 GeneratePOF (strDestinationFileName, strModelFile­Name ).

Generates a POF file.

Parameters:

strDestinationFileName Required VT_BSTR or String

.Nameof

the file to print to.

strModelFileName Optional VT_BSTR or String

.Nameor
FullName of Configuration file (.POC) to use.
If none, default POC file is used.

"""" Document.Insert

VTS_I2 Insert ( strDocumentFileName ).

Inserts a document in the current document.

Parameters:

strDocumentFileName Required VT_BSTR or String

.Nameof

the document to insert.

Object
Methods

Chapter 2 -- 51

Reference Guide

"""" Document. Merge

VTS_I2 Merge (longLabelQuantity, longLabelCopy,
longInterCut, longPageCopy, longLabelNoPrintedFrom,
strFileName).

Merges document with the associated Database

.

Parameters:

longLabelQuantity RequiredVT_I4orLong

.

longLabelCopy OptionalVT_I4orLong

(default 1).

longInterCut OptionalVT_I4orLong

(default 1).

longPageCopy OptionalVT_I4orLong

(default 1).

longLabelNoPrintedFrom OptionalVT_I4orLong

(default 1).

strFileName Optional VT_BSTR or String

(default

empty string).

Note

Parameters are described in the User’s Guide.

"""" Document.PrintDocument

VTS_I2 PrintDocument ( longLabelQuantity ).

Prints document and executes an automatic FormFeed.

Parameters:

longLabelQuantity OptionalVT_I4orLong

. Quantity of

labels to print (Default : 1).

"""" Document.PrintLabel

VTS_I2 PrintLabel (longLabelQuantity, longLabelCopy,
longInterCut, longPageCopy, longLabelNoPrintedFrom,
strFileName).

Prints document.

Chapter 2 -- 52

Programmer’s Guide

Parameters:

longLabelQuantity RequiredVT_I4orLong

.

longLabelCopy OptionalVT_I4orLong

(default 1).

longInterCut OptionalVT_I4orLong

(default 1).

longPageCopy OptionalVT_I4orLong

(default 1).

longLabelNoPrintedFrom OptionalVT_I4orLong

(default 1).

strFileName Optional VT_BSTR or String

(default

empty string).

Note

Parameters are described in the User’s Guide.

"""" Document.Save

VTS_I2 Save ().

Saves the document.

If the document has not been saved, a dialog box is prompted
automatically.

"""" Document.SaveAs

VTS_I2 SaveAs ( strDocumentFileName ).

Saves the document with a new name.

Parameters:

strDocumentFileName Required VT_BSTR or String

.

"""" Document.Activate

VTS_NONE Activate ().

Causes the document object to be activated, being the
ActiveDocument

.

Chapter 2 -- 53

Reference Guide

"""" Document.CopyImageToFile

VTS_BSTR or String

CopyImageToFile(Colors, Extension,

Rotation,Percent, strFilename).

Generates file that contains the Image of the document.

Return value: Returns a string that represents the full name of
the generated Bitmap file.

Parameters:

Colors OptionalVT_I2orInteger

. (Default 8). Specifies
the number of bits-per-pixel. Depending of the generated f ile,
the values must be : 1, 4, 8, 16, 24, 32.

Extension Optional VT_BSTR or String

(Default “BMP”).
Specifies the extension of the file to generate. For a complete
list of extensions, refer to the labeling software documentation.

Rotation OptionalVT_I2orInteger

(Default 0). Rotation in

geometrical degree. The values must be between 0 and 360.

Percent OptionalVT_I2orInteger

(Default 100). Scaling

factor. The values must be between 1 and 400.

strFileName Optional VT_BSTR or String

(Default “ “). If
specified: name of the generated Bitmap file.

Chapter 2 -- 54

Programmer’s Guide

Database Object

Properties Methods

Application Close

AutoVariables MoveFirst

BOF MoveLast

EOF MoveNext

IsOpen MovePrevious

Parent OpenASCII

Name (Default) OpenODBC

DocObjects OpenQuery

Parent Save

"""" Database.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" Database.AutoVariables

Automatic creation of database variables when database
connects. (Default: True).

Access Read/Write.

Type VT_BOOL or Boolean

.

Object
Properties

Chapter 2 -- 55

Reference Guide

"""" Database.BOF

Returns a value that indicates whether the current row position
is before the first row in the current recordset.

Return value:
True The current row position is before the first row.
False The current row position is on or after the first row.

Access Read-Only.

Type VT_BOOL or Boolean

.

"""" Database.EOF

Returns a value that indicates whether the current row position
is after the last row in the current recordset.

Return value:

True The current row position is after the last row.
False The current row position is on or before the last
row.

Access Read-Only.

Type VT_BOOL or Boolean

.

"""" Database.IsOpen

Tests if the Database object has been open successfully.

Access Read-Only.

Type VT_BOOL or Boolean

.

"""" Database.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

Chapter 2 -- 56

Programmer’s Guide

"""" Database.Close

VTS_NONE Close().

Closes an open database.

"""" Database.MoveFirst

VT_BOOL or Boolean

MoveFirst().

Repositions the current row pointer in the first

row of the current

recordset and makes that row the current row.

"""" Database.MoveLast

VT_BOOL or Boolean

MoveLast().

Repositions the current row pointer in the last

row of the current

recordset object and makes that row the current row.

"""" Database.MoveNext

VT_BOOL or Boolean

MoveNext().

Repositions the current row pointer in the next

row of the

current recordset object and makes that row the current row.

"""" Database.MovePrevious

VT_BOOL or Boolean

MovePrevious().

Repositions the current row pointer in the previous

row of the

current recordset object and makes that row the current row.

Object
Methods

Chapter 2 -- 57

Reference Guide

"""" Database.OpenASCII

VT_BOOL or Boolean

OpenASCII( strTextFileName,

strDescriberFileName ).

Opens ASCII database.

Return value: Returns a boolean that indicates whether the
opening fails or not.

Parameters:

strTextFileName Required VT_BSTR or String

.The

database text file.

strDescriberFileName Required VT_BSTR or string

.

Describer associated with the text file.

"""" Database.OpenQuery

VT_BOOL or Boolean

OpenQuery( strQueryFileName ).

Opens a CSQ query file.

Return value: returns a boolean that indicates whether the
opening fails or not.

Parameters:

strQueryFileName Required VT_BSTR o r String

. The file

which contains the query.

"""" Database.OpenODBC

VT_BOOL or Boolean

OpenODBC( strDatasourceConnex-

ion, strQueryString ).

Opens an ODBC database.

Return value: Returns a boolean that indicates whether the
opening fails or not.

Parameters:

strDatasourceConnexion Required VT_BSTR or String

.The
database string connection. For the strDatasourceConnexion
parameter, refer to Microsoft ODBC documentation.

strQueryString Required VT_BSTR or String

.SQL
query.

Chapter 2 -- 58

Programmer’s Guide

Printer Object

Properties Methods

Application ShowSetup

DeviceCodeNames Send

DeviceFontNames SetParameter

FullName (Default) SwichTo

Name

Parent

WindowsFontNames

WindowsCodeNames

XDPI

YDPI

"""" Printer.ShowSetup

VTS_NONE ShowSetup().

Prompts the Printer

Setup dialog box, in order to change the

current printer settings.

"""" Printer.Send

VTS_BOOL Send ( strEscapeSequence ).

Sends an escape sequence to the physical device.

Parameters:

EscapeSequence Required VT_BSTR or String

. Escape

sequence to send.

Object
Methods

Chapter 2 -- 59

Reference Guide

"""" Printer.SetParameter (not yet implemented)

VTS_BOOL or Boolean

SetParameter(strParameter,

varValue).

Changes the current printer settings.

Parameters:

strParameter Required VT_BSTR or String

. Parameter name to

use.

varValue Required VT_VARIANT or Variant

. Value to set.

"""" Printer.SwitchTo ()

VTS_BSTR or String SwitchTo( strPrinterName,
strPortName, boolDirectAccess ).

Changes the current printer.

Return value: Returns the name of the installed printer.

Automatically installs a printer if no printer is already installed.
You don’t need to add a printer through the user interface.

Parameters:

strPrinterName Required VT_BSTR or String

.Printer‘s

name to switch to.

strPortName Optional VT_BSTR or String

.Port’sname to

switch to.

boolDirectAccess Optional VT_BOOL or Boolean

. Is the

connection of the port direct or not.

Form 1

SwitchTo(« THTPrinter L-1234 », « LPT1: », FALSE).
Result of this instruction is « THTPrinter L-1234,LPT1: ».

Form 2

SwitchTo(« THTPrinter L-1234, ->COM3: »).
Result of this instruction is « Copy of THTPrinter
L-1234, ->COM3: » because printer’s name is unique.

You can either use form 1 or form 2.

Don’t insert spaces between the components in Form 2.
Notice that the names are case sensitive !

Chapter 2 -- 60

Programmer’s Guide

"""" Printer.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" Printer.DeviceFontNames

Returns the Strings

collection that represents all the printer

fonts names.

Access Read-Only.

Type VT_DISPATCH or Strings

collection.

"""" Printer.DeviceCodeNames

Returns the Strings

collection that represents all the printer code

names.

Access Read-Only.

Type VT_DISPATCH or Strings

collection.

"""" Printer.FullName

Returns the full name of the pair <Printer, Port>.

Access Read-Only.

Type VT_BSTR or String

.

Object
Properties

Chapter 2 -- 61

Reference Guide

"""" Printer.Name

Returns the simple name of the current printer.

Access Read/Write.

Type VT_BSTR or String

.

"""" Printer.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

"""" Printer.XDPI

Returns the horizontal resolution of the printer (in DPI).

Access Read-Only.

Type VT_I4orLong

.

"""" Printer.YDPI

Returns the vertical resolution of the printer (in DPI).

Access Read-Only.

Type VT_I4orLong

.

"""" Printer.WindowsFontNames

Returns the Strings

collection that represents all the windows

font names.

Access Read-Only.

Type VT_DISPATCH or Strings

collection.

Chapter 2 -- 62

Programmer’s Guide

"""" Printer.WindowsCodeNames

Returns the Strings

collection that represents all the windows

code names.

Access Read-Only.

Type VT_DISPATCH or Strings

collection.

Chapter 2 -- 63

Reference Guide

Format Object

Properties Methods

Application SaveStock

AutoSize

ColumnCount

HorizontalGap

LabelHeight

LabelWidth

MarginLeft

MarginTop

StockName

StockType

PageHeight

PageWidth

Parent

Portrait

Corner

RowCount

VerticalGap

"""" Format.Application

Returns the Application

object that represents the root object of

the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

Object
Properties

Chapter 2 -- 64

Programmer’s Guide

"""" Format. AutoSize

Automatically adjusts the page based on the dimension of the
label, the number of labels, margins, and the amount of space
between labels.

This option is available only for customized page formats.
However, it is always possible to disable the automatic option to
enter the Height and Width values manually.

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Format.ColumnCount

Retrieves or sets the number of labels per row (horizontal
count).

Access Read/Write.

Type VT_I4orLong

.

"""" Format. HorizontalGap

Retrieves or sets the amount of empty space between the
columns (Horizontal) of labels on a page. (in MeasureSystem
unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Format. VerticalGap

Retrieves or sets the amount of empty space between the rows
(Vertical) of labels on a page (in MeasureSystem

unit).

Access Read/Write.

Type VT_I4orLong

.

Chapter 2 -- 65

Reference Guide

"""" Format.LabelHeight

Retrieves or sets the height of the label (in MeasureSystem
unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Format.LabelWidth

Retrieves or sets the width of the label (in MeasureSystem

unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Format.MarginLeft

Retrieves or sets the left margin of the page (in MeasureSystem
unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Format.MarginTop

Retrieves or sets the top margin of the page (in MeasureSystem
unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Format.StockName

Retrieves or sets the name of the format model, if any.

Access Read/Write.

Type VT_BSTR or String

.

Chapter 2 -- 66

Programmer’s Guide

"""" Format.StockType

Retrieves or sets the type of the format type, if any.

Access Read/Write.

Type VT_BSTR or String

.

"""" Format.PageHeight

Retrieves or sets the height of the page (in MeasureSystem
unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Format.PageWidth

Retrieves or sets the width of the page (in MeasureSystem

unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Format.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

"""" Format.Portrait

Retrieves or sets the orientation of the document.

Access Read/Write.

Type VT_BOOL or Boolean

.

Chapter 2 -- 67

Reference Guide

"""" Format.Corner

Retrieves or sets the radius corner of the document (in
MeasureSystem

unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Format.RowCount

Retrieves or sets the number of labels per column (vertical
count).

Access Read/Write.

Type VT_I4orLong

.

"""" Format. SaveStock

VTS_NONE Format.SaveStock().

Saves the current stock Name/Type. (In order to reuse it with
others documents)

Object
Methods

Chapter 2 -- 68

Programmer’s Guide

DocumentProperties Collection

Properties Methods

Application Item (Default)

Count

Parent

"""" DocumentProperties.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" DocumentProperties.Count

Returns the number of items in the specified collection.

Access Read-Only.

Type VT_I2orInteger

.

"""" DocumentProperties.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

Object
Properties

Chapter 2 -- 69

Reference Guide

"""" DocumentProperties.Item

VTS_DISPATCH or DocumentProperty

Item( longIndex ).

Returns a member of a collection, either by position or by name.

Note

If the value provided as Index does not match any existing
member of the collection, no object is returned.

Parameters:

longIndex Required VT_VARIANT or Variant

.Thenameor

index number of a member of the collection.

The index can be a numeric expression (a number from 1 to the
value of the collection’s Count property), a constant, or a string.

Note

If the value provided as Index doesn’t match any existing
member of the collection, an error occurs.
The Item method is the default method for collections. There­fore, the following two lines of code are equivalent.

Object.DocumentProperties(1)
Object. DocumentProperties.Item(1)

An enumerated type enumBuiltInDocumentProperty is enabled:
lppxPropertyManager = 1
lppxPropertyCompany = 2
lppxPropertyCategory = 3
lppxPropertyTitle = 4
lppxPropertySubject = 5
lppxPropertyAuthor = 6
lppxPropertyKeywords = 7
lppxPropertyComments = 8

Object
Methods

Chapter 2 -- 70

Programmer’s Guide

DocumentProperty Object

Properties Methods

Application (None)

Name

Parent

Type

Value (Default

"""" DocumentProperty.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" DocumentProperty.Name

Returns the name of the variable.

Access Read-Only.

Type VT_BSTR or String

.

"""" DocumentProperty.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

Object
Properties

Chapter 2 -- 71

Reference Guide

"""" DocumentProperty.Type

Returns the type of the property.

Access Read-Only.

Type VT_I2 or Integer or enumProperty

type.

Thevaluecanbeoneofthefollowing:
lppxPropertyTypeNumber = 1
lppxPropertyTypeBoolean = 2
lppxPropertyTypeDate = 3
lppxPropertyTypeString = 4
lppxPropertyTypeFloat = 5

"""" DocumentProperty.Value

Returns the current value of the DocumentProperty.

Access Read-Only.

Type VT_VARIANT or Variant

.

Chapter 2 -- 72

Programmer’s Guide

DocObjects Collection

Properties Methods

Application Add

Count Item (Default)

Parent Remove

Barcodes

Shapes

OLEObjects

Images

Texts

"""" DocObjects.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" DocObjects.Count

Returns the number of items in the specified collection.

Access Read-Only.

Type VT_I2orInteger

.

"""" DocObjects.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

Object
Properties

Chapter 2 -- 73

Reference Guide

"""" DocObjects.Barcodes

Returns the Barcodes

collection that represents all the created

Barcode objects

in the document.

Access Read-Only.

Type VT_DISPATCH or Barcodes

collection.

"""" DocObjects.Shapes

Returns the Shapes

collection that represents all the created

Shape

objects in the document.

Access Read-Only.

Type VT_DISPATCH or Shapes

collection.

"""" DocObjects.OLEObjects

Returns the OLEObjects

collection that r epresents all the created

OLEObject objects

in the document.

Access Read-Only.

Type VT_DISPATCH o r OLEObjects

collection.

"""" DocObjects.Images

Returns the Images

collection that represents all the created

Image objects

in the document.

Access Read-Only.

Type VT_DISPATCH or Images

collection.

"""" DocObjects.Texts

Returns the Texts

collection that represents all the created Text

objects

in the document.

Access Read-Only.

Type VT_DISPATCH or Texts

collection.

Chapter 2 -- 74

Programmer’s Guide

"""" DocObjects.Add

VT_DISPATCH or DocObject

Add( longDocObjectType,

strDocObjectName ).

Adds a new DocObject

object to the current document.

Return value: Returns a DocObject

object.

Parameters:

longDocObjectType RequiredVT_I4orLong

or

enumDocObject

. The type of object to add.

Thevaluecanbeoneofthefollowing:
lppxObjectText = 1
lppxObjectBarCode = 2
lppxObjectImage = 3
lppxObjectLine = 4
lppxObjectRectangle = 5
lppxObjectEllipse = 6
lppxObjectPolygon = 7
lppxObjectOblique = 8
lppxObjectRoundRect = 9
lppxObjectOLEObject = 10

strDocObjectName Optional VT_BSTR or String

.The
name of the object to add.

"""" DocObjects.Item

VTS_DISPATCH or DocObject

Item( varIndex ).

Returns a member of a collection, either by position or by name.

Note

If the value provided as Index does not match any existing
member of the collection, no object is returned.

Parameters:

varIndex Required VT_VARIANT or Variant

.Thenameor

index number of a member of the collection.

The index can be a numeric expression (a number from 1 to the
value of the collection’s Count property), a constant, or a string.

Note

If the value provided as Index doesn’t match any existing
member of the collection, an error occurs.
The Item method is the default method for collections. There­fore, the following two lines of code are equivalent.

Object. DocObjects (1)
Object. DocObjects.Item(1)

Object
Methods

Chapter 2 -- 75

Reference Guide

"""" DocObjects.Remove

VTS_NONE Remove( varIndex ).

Removes a member from the DocObjects

object.

Parameters:

varIndex Required VT_VARIANT or Variant

. An expression
that specifies the position of a collection member. If numeric
expression: index must be a number from 1 to the value of the
collection’s Count property. If a string expression: index must
correspond to the key argument specified when this member
reffered to was added to the collection.

Chapter 2 -- 76

Programmer’s Guide

DocObject Object

Properties Methods

AnchorPoint Bound

Application Move

BackColor

ForeColor

Height

Left

Locked

Name

Parent

Printable

Rotation

Top

Type

Width

"""" DocObject.AnchorPoint

Returns or sets the anchor point of the current object.

Access Read/Write.

Type VT_I2 or Integer or enumAnchorPoint

type.

lppxTopLeft = 1
lppxTopCenter = 2
lppxTopRight = 3
lppxCenterLeft = 4
lppxCenter = 5
lppxCenterRight = 6
lppxBottomLeft = 7
lppxBottomCenter = 8
lppxBottomRight = 9

Object
Properties

Chapter 2 -- 77

Reference Guide

"""" DocObject.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" DocObject.Height

Returns or sets the height of the object (in MeasureSystem
unit).

Access Read/Write.

Type VT_I4 or

Long.

"""" DocObject.Left

Returns or sets the distance between the left edge of the anchor
point of the object and the left edge of the document (in
MeasureSystem

unit).

Access Read/Write.

Type VT_I4orLong

.

"""" DocObject.Name

ReturnsorsetsthenameoftheDocObject

.

Access Read/Write.

Type VT_BSTR or String

.

"""" DocObject.Printable

Sets or not whether the object is printable.

Access Read/Write.

Type VT_BOOL or Boolean

.

Chapter 2 -- 78

Programmer’s Guide

"""" DocObject.Rotation

Sets or retrieves the rotation of the object.

Access Read/Write.

Type VT_I2orInteger.

The value can be one of the following: 0, 900, 1800, 2700.

"""" DocObject.Top

Returns or sets the distance between the top edge of the anchor
point of the object and the top edge of the document. (in
MeasureSystem

unit).

Access Read/Write.

Type VT_I4orLong

.

"""" DocObject.Type

Returns the type of the object (in enumDocObject

type).

Access Read-Only.

Type VT_I2orInteger

.

"""" DocObject.Width

Returns or sets the width of the object (in enumMeasureSystem
unit).

Access Read/Write.

Type VT_I4orLong

.

Chapter 2 -- 79

Reference Guide

"""" DocObject.Bound

VTS_NONE Bound ( longLeftPosition, longTopPosition ,
longRightPosition , longBottomPosition).

Sets the bounding rectangle of an object.

Parameters:

longLeftPosition RequiredVT_I4orLong

.Distance
between the left edge of an object and the left edge of the
document (in MeasureSystem

unit).

longTopPosition RequiredVT_I4orLong

.Distance
between the top edge of an object and the top edge of the
document (in MeasureSystem

unit).

longRightPosition RequiredVT_I4orLong

.Distance
between the right edge of an object and the left edge ofthe
document (in MeasureSystem

unit).

longBottomPosition RequiredVT_I4orLong

.Distance
between the bottom edge of an object and the top edge ofthe
document (in MeasureSystem

unit).

"""" DocObject.Move

VTS_NONE Move (longLeftPosition, longTopPosition ).

Movesanobjectinitswindow.

Parameters:

longLeftPosition RequiredVT_I4orLong

.Distance
between the left edge of an object and the left edge of the
document (in MeasureSystem

unit).

longTopPosition RequiredVT_I4orLong

.Distance
between the top edge of an object and the top edge of the
document (in MeasureSystem

unit).

Object
Methods

Chapter 2 -- 80

Programmer’s Guide

Images Collection

Properties Methods

Application Add

Count Item (Default)

Parent

"""" Images.Count

Returns the number of items in the specified collection.

Access Read-Only.

Type VT_I2orInteger

.

"""" Images.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" Images.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

"""" Images.Add

VTS_DISPATCH or Image

Add(strImageName).

Adds a new Image

object to the collection.

Return value: Returns a Image

object.

Parameters:

strImageName Optional VT_BSTR or String

.Thenameof

the object to add.

Object
Properties

Object
Methods

Chapter 2 -- 81

Reference Guide

"""" Images.Item

VTS_DISPATCH or Image

Item( varIndex ).

Returns a member of a collection, either by position or by name.

Note

If the value provided as Index does not match any existing
member of the collection, none object returned.

Parameters:

varIndex Required VT_VARIANT or Variant

.Thenameor

index number of a member of the collection.

The index can be a numeric expression (a number from 1 to the
value of the collection’s Count property), a constant, or a string.

Note

If the value provided as Index doesn’t match any existing
member of the collection, an error occurs.
The Item method is the default method for collections. The
following two lines of code are equivalent.

Object. Images (1)
Object. Images.Item(1)

"""" Images.Remove

VTS_NONE Remove ( varIndex ).

Removes a member from the collection.

Parameters:

varIndex Required VT_VARIANT or Variant

. An expression
that specifies the position of a member of the collection. If a
numeric expression, index must be a number from 1 to the value
of the collection’s Count property. If a string expression, index
must correspond to the key argument specified when the
member referred to was added to the collection.

Chapter 2 -- 82

Programmer’s Guide

Image Object

Properties Methods

DocObject object properties DocObject object methods

Brightness

FileName

HorzFlip

VertFlip

Negative

VariableName

VariableObject

"""" Image.Brightness

This adjustment influences the color reduction process. Use this
property to print a color image on a noncolor printer.

Access Read/Write.

Type VT_I2orInteger

(between –255 and +255).

"""" Image.FileName

Retrieves or sets the filename of the image.

Access Read/Write.

Type VT_BSTR or String

.

"""" Image. VertFlip

Displays the image as if it is reflected in a mirror.

Reflection axis is vertical.

Access Read/Write.

Type VT_BOOL or Boolean

.

Object
Properties

Chapter 2 -- 83

Reference Guide

"""" Image. HorzFlip

Displays the image as if it is reflected in a mirror.

Reflection axis is horizontal.

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Image.Negative

Prints the image negatively.

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Image.VariableName

Retrieves or sets the current variable name associated with the
image.

Access Read/Write.

Type VT_BSTR or String

.

"""" Image.VariableObject

Retrieves or sets the current Variable

object associated with the

image.

Access Read/Write.

Type VT_DISPATCH or Variable

object.

Chapter 2 -- 84

Programmer’s Guide

Barcodes Collection

Properties Methods

Application Add

Count Item (Default)

Parent

"""" Barcodes.Count

Returns the number of items in the specified collection.

Access Read-Only.

Type VT_I2orInteger

.

"""" Barcodes.Application

This property returns the Application

object that represents the

root object of the hierarchy.

Access Read-Only.

Type VT_DISPATCH or Application

object.

"""" Barcodes.Parent

Returns the parent object of the specified object.

Access Read-Only.

Type VT_DISPATCH.

Object
Properties

Chapter 2 -- 85

Reference Guide

"""" Barcodes.Add

VTS_DISPATCH or Barcode

Add( strBarcodeName ).

Adds a new Barcode

object to the collection.

Return value: Returns a Barcode

object.

Parameters:

strBarcodeName Optional VT_BSTR or String

.The

name of the object to add.

"""" Barcodes.Item

VTS_DISPATCH or Barcode

Item( varIndex ).

Returns a member of a collection, either by position or by name.

Note

If the value provided as Index does not match any existing
member of the collection, no object is returned.

Parameters:

varIndex Required VT_VARIANT or Variant

.Thenameor
index number of a member of the collection.

The index can be a numeric expression (a number from 1 to the
value of the collection’s Count property), a constant, or a string.

Note

If the value provided as Index doesn’t match any existing
member of the collection, an error occurs.
The Item method is the default method for collections. The
following two lines of code are equivalent.

Object. Barcodes (1)
Object. Barcodes.Item(1)

"""" Barcodes.Remove

VTS_NONE Remove ( varIndex ).

Removes a member from the collection.

Parameters:
varIndex Required VT_VARIANT or Variant

. An expression
that specifies the position of a member of the collection. If a
numeric expression, index must be a number from 1 to the value
of the collection’s Count property. If a string expression, index
must correspond to the key argument specified when the
member referred to was added to the collection.

Object
Methods

Chapter 2 -- 86

Programmer’s Guide

Barcode Object

Properties Methods

DocObject object properties DocObject object methods

BarHeight

CheckMode

Code2D

Device

HRAlignment

HRCheckCharacter

HRFont

HRFreeTextObject

HRDevice

HRGap

HRPosition

NarrowBarWidth

Ratio

Symbology

Value

VariableName

VariableObject

"""" Barcode.BarHeight

Retrieves or sets the bar height of the barcode (in

MeasureSys-

tem

unit).

Access Read/Write.

Type VT_I4orLong

.

Object
Properties

Chapter 2 -- 87

Reference Guide

"""" Barcode.CheckMode

Retrieves or sets the check control of the barcode (in

enum-

CheckMode

type).

Access Read/Write.

Type VT_I4orLongorenumCheckMode

type.

Thevaluecanbeoneofthefollowing:
lppxCheckModeNone = 0
lppxCheckMode1Digit = 1
lppxCheckMode2Digit = 2
lppxCheckModeMod11Mod10 = 3

"""" Barcode.Code2D

Retrieves the Code2D

object for 2D barcodes.

Access Read-Only.

Type VT_DISPATCH or Code2D

object.

"""" Barcode.Device

Determines if the barcode is graphical or generated by the
printer.

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Barcode.HRAlignment

Retrieves or sets the current human readable alignment.

Access Read/Write.

Type VT_I4orLong

or enumAlignment type.

Thevaluecanbeoneofthefollowing:
lppxAlignLeft = 0
lppxAlignCenter = 1
lppxAlignRight = 2

Chapter 2 -- 88

Programmer’s Guide

"""" Barcode.HRCheckCharacter

Includes or not the check character control in the human
readable.

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Barcode.HRDevice

Determines if the human readable is printer generated or not.

Access Read/Write.

Type VT_BOOL or Boolean

.

"""" Barcode.HRFont

Retrieves or sets the font of the human readable.

Access Read/Write.

Type VT_FONT or StdFont

object.

"""" Barcode.HRFreeTextObject

Retrieves the Text

object representing the text of the human

readable.

Access Read-Only.

Type VT_DISPATCH or Text

object.

"""" Barcode.HRGap

Retrieves or sets the gap between the barcode and its human
readable (in MeasureSystem

unit).

Access Read/Write.

Type VT_I4orLong

.

Chapter 2 -- 89

Reference Guide

"""" Barcode.HRPosition

Sets or retrieves the position of the human readable.

Access Read/Write.

Type VT_I4orLongorenumHRPosition

type.

Thevaluecanbeoneofthefollowing:
lppxHRPositionNone = 0
lppxHRPositionBelow = 1
lppxHRPositionAbove = 2
lppxHRPositionFree = 3

"""" Barcode.NarrowBarWidth

Retrieves or sets the narrow bar width of the barcode (in
MeasureSystem

unit).

Access Read/Write.

Type VT_I4orLong

.

"""" Barcode.Ratio

Retrieves or sets the ratio of the barcode (between 20 and 35).

Access Read/Write.

Type VT_I4orLong

.

"""" Barcode.Symbology

Retrievesorsetsthesymbologyofbarcode.

Access Read/Write.

Type VT_I4orLongorenumSymbology

type.

Chapter 2 -- 90

Programmer’s Guide

The value can be one of the following (depending on product and
printer):

LppxCode11

49

lppx25Interleave 50

LppxCode39 51

LppxCode49 52

LppxMaxicode 53

LppxCode16K 54

LppxGermanPostcode 55

LppxEAN8 56

LppxUPCE 57

LppxBC412 58

LppxMicroPDF 59

LppxCode93 65

lppx25Beared 66

LppxCode128 67

LppxEAN128 68

LppxEAN13 69

LppxCode39Full 70

LppxCode128Auto 71

LppxCodablockF 72

lppx25Industrial 73

lppx25Standard 74

LppxCodabar 75

LppxLogmars 76

LppxMsi 77

LppxCodablockA 78

LppxPostnet 79

LppxPlessey 80

LppxCode128SSCC 81

LppxUPCExtended 83

LppxUPCA 85

LppxUPCEXT2 86

LppxUPCEXT5 87

LppxCode25PRDG 88

LppxUPCWEIGHT 89

LppxUPCEPLUS2 97

Chapter 2 -- 91

Reference Guide

LppxUPCEPLUS5 98

LppxUPCAPLUS2 99

LppxUPCAPLUS5 100

LppxEAN8PLUS2 101

LppxEAN8PLUS5 102

LppxEAN13PLUS2 103

LppxEAN13PLUS5 104

LppxITF 105

lppx25MatrixEuropean 106

lppx25MatrixJapan 107

LppxDatamatrix 120

lppxItf14 121

LppxPdf 122

LppxQrcode 123

LppxRss 124

LppxComposite 125

Note

Depending on the product, not all symbologies are available.

"""" Barcode.Value

Retrievesorsetsthevalueofthebarcode.

Access Read/Write.

Type VT_BSTR or String

.

"""" Barcode.VariableName

Retrieves or sets the current variable name associated with the
barcode.

Access Read/Write.

Type VT_BSTR or String

.

Chapter 2 -- 92

Programmer’s Guide

"""" Barcode.VariableObject

Retrieves or sets the current Variable

object associated with the

barcode.

Access Read/Write.

Type VT_DISPATCH or Variable

object.