1. Manuals
  2. Brands
  3. Teklynx Manuals
  4. Software
  5. Discover ActiveX
  6. Programmer's manual

Teklynx Discover ActiveX Programmer's Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

P P P P r r r r o o o o g g g g r r r r a a a a m m m m m m m m e e e e r r r r ' ' ' ' s s s s
G G G G u u u u i i i i d d d d e e e e
DOC- -OEM6- -ActiveX- -US- -06/00

Advertisement

Table of Contents
loading

Related Manuals for Teklynx Discover ActiveX

Summary of Contents for Teklynx Discover ActiveX

  • Page 1 P P P P r r r r o o o o g g g g r r r r a a a a m m m m m m m m e e e e r r r r ’ ’ ’ ’ s s s s G G G G u u u u i i i i d d d d e e e e DOC- -OEM6- -ActiveX- -US- -06/00...
  • Page 2 (unless it is for the purchaser’s personal use) without the written permission of Teklynx International. E 2000 Teklynx International Co. All rights reserved Windowst t t t is a registered trademark of Microsoftâ Corpora- tion.

  • Page 3: Table Of Contents

    Table of Contents About this manual ........Welcome! .
  • Page 4 Programmer’s Guide Reference Guide ........Chapter 2 - 15 Hierarchy diagram .
  • Page 5 Table of Contents DocObject Object ........Chapter 2 - 76 Object Properties .
  • Page 6 Programmer’s Guide Object Properties ........Chapter 2 - 122 Object Methods .

  • Page 7: About This Manual

    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 requirements. This version of this labeling software integrates the ActiveX technology offering you the possibility toe easily create a program to control your labeling software.
  • Page 8 viii Programmer’s Guide Typographical This manual distinguishes different types of information by using conventions the following conventions: terms taken from the interface itself, such as commands, appear in bold; keys appear in small caps, as in the following example: ”Press the key”;...

  • Page 9: Discover Activex Automation For Your Labeling Software

    Discover ActiveX Automation for your labeling software 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.

  • Page 10: What Is An Activex Object

    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.

  • Page 11: What Is The Type Library

    Discover ActiveX Automation for your labeling software Chapter 1 -- 3 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.

  • Page 12: Mechanisms

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

  • Page 13: Getobject Function

    Discover ActiveX Automation for your labeling software Chapter 1 -- 5 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.

  • Page 14: New Function

    Chapter 1 -- 6 Programmer’s Guide In the example below, the server name is specified. Use this 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...

  • Page 15: Server Deactivation

    Discover ActiveX Automation for your labeling software Chapter 1 -- 7 The syntax of the Set instruction contains the following items: Item Description objectvar Name of the variable or prop- erty. Optional. This key word is generally used in the declara- tions to allow the implicit cre- ation of an object.

  • Page 16: Quit Method

    Chapter 1 -- 8 Programmer’s Guide Quit method The Quit method is used to end the process. Before using this method, you must close all the documents. The following example shows how to deactivate the server. Use the CloseAll method on the Documents collection to close all the documents.

  • Page 17: Application Object

    Discover ActiveX Automation for your labeling software Chapter 1 -- 9 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.” To display the global properties and methods in the object explorer ( key), click on global at the beginning of the list displayed in the Classes zone.
  • Page 18 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 VT_DISPATCH Adds an item to a collec- or VT_EMPTY tion.

  • Page 19: Event Management

    Discover ActiveX Automation for your labeling software Chapter 1 -- 11 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.
  • Page 20 Chapter 1 -- 12 Programmer’s Guide A WithEvents variable cannot be a generic object variable. That is, you cannot declare it As Object - you must specify the class name when you declare the variable. You cannot declare a WithEvents variable As New. The event source object must be explicitly created and assigned to the WithEvents variable.
  • Page 21 Discover ActiveX Automation for your labeling software Chapter 1 -- 13 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...

  • Page 22: Compatibility With The Previous Version

    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.

  • Page 23: Reference Guide

    Reference Guide Hierarchy diagram The diagram below shows the object hierarchy: Application Options Strings RecentFiles Dialogs Dialog RecentFile Documents PrinterSystem Document Database Printer Format DocumentProperties DocumentProperty...
  • Page 24 Chapter 2 -- 16 Programmer’s Guide Document DocObjects Variables DocObjects Variable Barcodes FormVariables Barcode Free FreeVariables Code2D Free Texts DatabaseVariables Text Free TextSelection Counters Images Counter Dates Image Date Shapes TableLookups Shape TableLookup OLEObjects Formulas OLEObject Formula...

  • Page 25: Application Object

    Reference Guide Chapter 2 -- 17 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 UserControl Version Visible Width...

  • Page 26: Object Properties

    Chapter 2 -- 18 Programmer’s Guide Object Properties " " " " 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.
  • Page 27 Reference Guide Chapter 2 -- 19 " " " " 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.
  • Page 28 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_I4 or Long. " " " " 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).
  • Page 29 Reference Guide Chapter 2 -- 21 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.
  • Page 30 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). If the application is visible to the user, this property will always Note return True.

  • Page 31: Object Methods

    Reference Guide Chapter 2 -- 23 Object Methods " " " " 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. "...
  • Page 32 Chapter 2 -- 24 Programmer’s Guide Incorrect language enum value 1412 Incorrect symbology enum value 1413 Incorrect built in document property enum 1414 value Incorrect view orientation enum value 1415 Incorrect form prompt mode enum value 1416 Object not found 1500 Can’t create object 1501...
  • Page 33 Reference Guide Chapter 2 -- 25 " " " " 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.

  • Page 34: Printersystem Object

    Chapter 2 -- 26 Programmer’s Guide PrinterSystem Object Properties Methods (None) Families Models Printers Ports Remove Rename Object Methods " " " " 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.
  • Page 35 Reference Guide Chapter 2 -- 27 " " " " 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.
  • Page 36 Chapter 2 -- 28 Programmer’s Guide " " " " PrinterSystem.Rename VTS_NONE Rename (strPrinterName, strNewPrinter- Name). Renames a model. Parameters: strPrinterName Required VT_BSTR or String. Name of the installed printer to rename. strNewPrinterName Required VT_BSTR or String. New name to assign. Only models can be renamed.

  • Page 37: Options Object

    Reference Guide Chapter 2 -- 29 Options Object Properties Methods Application (None) CreateBackup DefaultDescriberPath DefaultSharedVarPath DefaultImagePath DefaultPrintOutFilePath DefaultQueryPath DefaultUserSettingsPath EuroConversionRate Language LoadPrinterSetup LoadPrinter MeasureSystem OpenMergeDatabase Parent OpenReadOnly SharedFileAccessTimeout TrayNotification Object Properties " " " " Options.Application This property returns the Application object that represents the root object of the hierarchy.
  • Page 38 Chapter 2 -- 30 Programmer’s Guide " " " " Options.CreateBackup Returns or sets the CreateBackup 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. "...
  • Page 39 Reference Guide Chapter 2 -- 31 " " " " Options. DefaultUserSettingsPath Returns or sets the DefaultUserSettingsPath option. Access Read/Write. Type VT_BSTR or String. " " " " Options. EuroConversionRate Returns or sets the EuroConversionRate option. (Default 6.55957). Access Read/Write. Type VT_R4 or Single.
  • Page 40 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.
  • Page 41 Reference Guide Chapter 2 -- 33 " " " " Options.Parent Returns the parent object of the specified object. Access Read-Only. Type VT_DISPATCH. " " " " Options.OpenReadOnly Returns or sets the OpenReadOnly option. (Default : False) Access Read/Write. Type VT_BOOL or Boolean.

  • Page 42: Dialogs Collection

    Chapter 2 -- 34 Programmer’s Guide Dialogs Collection Properties Methods Application Item (Default) Count Parent Object Properties " " " " 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. "...

  • Page 43: Object Methods

    Reference Guide Chapter 2 -- 35 Object Methods " " " " Dialogs.Item VTS_DISPATCH or Dialog Item( intIndex ). Returns a member of a collection, by position. If the value provided as Index does not match any existing Note member of the collection, no object is returned. Parameters: intIndex Required VT_I2 or Integer or enumDialogType.

  • Page 44: Dialog Object

    Chapter 2 -- 36 Programmer’s Guide Dialog Object Properties Methods Application Show Parent Type Object Properties " " " " Dialog.Application Returns the Application object that represents the root object of the hierarchy. Access Read-Only. Type VT_DISPATCH or Application object. "...
  • Page 45 Reference Guide Chapter 2 -- 37 Object Methods " " " " 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.

  • Page 46: Recentfiles Collection

    Chapter 2 -- 38 Programmer’s Guide RecentFiles Collection Properties Methods Application Count Item (Default) Maximum Clear Parent Remove Object Properties " " " " RecentFiles.Application This property returns the Application object that represents the root object of the hierarchy. Access Read-Only.

  • Page 47: Object Methods

    Reference Guide Chapter 2 -- 39 Object Methods " " " " 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.
  • Page 48 Chapter 2 -- 40 Programmer’s Guide " " " " RecentFiles.Remove VTS_NONE Remove( intIndex ). Deletes object with intIndex index.

  • Page 49: Recentfile Object

    Reference Guide Chapter 2 -- 41 RecentFile Object Properties Methods Application Open Parent Path Name Object Properties " " " " RecentFile.Application Returns the Application object that represents the root object of the hierarchy. Access Read-Only. Type VT_DISPATCH or Application object. "...

  • Page 50: Object Methods

    Chapter 2 -- 42 Programmer’s Guide Object Methods " " " " RecentFile.Open VTS_DISPACTCH or Document Open(). Opens the document associated with the current filename.

  • Page 51: Documents Collection

    Reference Guide Chapter 2 -- 43 Documents Collection Properties Methods Application Count CloseAll DefaultExt Item (Default) Parent Open SaveAll Object Properties " " " " Documents.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. "...

  • Page 52: Object Methods

    Chapter 2 -- 44 Programmer’s Guide Object Methods " " " " 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.
  • Page 53 Reference Guide Chapter 2 -- 45 " " " " 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).

  • Page 54: Document Object

    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 Object Properties "...
  • Page 55 Reference Guide Chapter 2 -- 47 " " " " 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.
  • Page 56 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... "...
  • Page 57 Reference Guide Chapter 2 -- 49 " " " " 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.

  • Page 58: Object Methods

    Chapter 2 -- 50 Programmer’s Guide Object Methods " " " " 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. "...
  • Page 59 Reference Guide Chapter 2 -- 51 " " " " Document. Merge VTS_I2 Merge (longLabelQuantity, longLabelCopy, longInterCut, longPageCopy, longLabelNoPrintedFrom, strFileName). Merges document with the associated Database. Parameters: longLabelQuantity Required VT_I4 or Long. longLabelCopy Optional VT_I4 or Long (default 1). longInterCut Optional VT_I4 or Long (default 1).
  • Page 60 Chapter 2 -- 52 Programmer’s Guide Parameters: longLabelQuantity Required VT_I4 or Long. longLabelCopy Optional VT_I4 or Long (default 1). longInterCut Optional VT_I4 or Long (default 1). longPageCopy Optional VT_I4 or Long (default 1). longLabelNoPrintedFrom Optional VT_I4 or Long (default 1). strFileName Optional VT_BSTR or String (default empty string).
  • Page 61 Reference Guide Chapter 2 -- 53 " " " " 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 Optional VT_I2 or Integer.

  • Page 62: Database Object

    Chapter 2 -- 54 Programmer’s Guide Database Object Properties Methods Application Close AutoVariables MoveFirst MoveLast MoveNext IsOpen MovePrevious Parent OpenASCII Name (Default) OpenODBC DocObjects OpenQuery Parent Save Object Properties " " " " Database.Application This property returns the Application object that represents the root object of the hierarchy.
  • Page 63 Reference Guide Chapter 2 -- 55 " " " " 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.

  • Page 64: Object Methods

    Chapter 2 -- 56 Programmer’s Guide Object Methods " " " " 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.
  • Page 65 Reference Guide Chapter 2 -- 57 " " " " 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.

  • Page 66: Printer Object

    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 Object Methods " " " " Printer.ShowSetup VTS_NONE ShowSetup(). Prompts the Printer Setup dialog box, in order to change the current printer settings.
  • Page 67 Reference Guide Chapter 2 -- 59 " " " " 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. "...

  • Page 68: Object Properties

    Chapter 2 -- 60 Programmer’s Guide Object Properties " " " " 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.
  • Page 69 Reference Guide Chapter 2 -- 61 " " " " 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.
  • Page 70 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.

  • Page 71: Format Object

    Reference Guide Chapter 2 -- 63 Format Object Properties Methods Application SaveStock AutoSize ColumnCount HorizontalGap LabelHeight LabelWidth MarginLeft MarginTop StockName StockType PageHeight PageWidth Parent Portrait Corner RowCount VerticalGap Object Properties " " " " Format.Application Returns the Application object that represents the root object of the hierarchy.
  • Page 72 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.
  • Page 73 Reference Guide Chapter 2 -- 65 " " " " Format.LabelHeight Retrieves or sets the height of the label (in MeasureSystem unit). Access Read/Write. Type VT_I4 or Long. " " " " Format.LabelWidth Retrieves or sets the width of the label (in MeasureSystem unit). Access Read/Write.
  • Page 74 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).

  • Page 75: Object Methods

    Reference Guide Chapter 2 -- 67 " " " " Format.Corner Retrieves or sets the radius corner of the document (in MeasureSystem unit). Access Read/Write. Type VT_I4 or Long. " " " " Format.RowCount Retrieves or sets the number of labels per column (vertical count).

  • Page 76: Documentproperties Collection

    Chapter 2 -- 68 Programmer’s Guide DocumentProperties Collection Properties Methods Application Item (Default) Count Parent Object Properties " " " " 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. "...

  • Page 77: Object Methods

    Reference Guide Chapter 2 -- 69 Object Methods " " " " DocumentProperties.Item VTS_DISPATCH or DocumentProperty Item( longIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 78: Documentproperty Object

    Chapter 2 -- 70 Programmer’s Guide DocumentProperty Object Properties Methods Application (None) Name Parent Type Value (Default Object Properties " " " " 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.
  • Page 79 Reference Guide Chapter 2 -- 71 " " " " DocumentProperty.Type Returns the type of the property. Access Read-Only. Type VT_I2 or Integer or enumProperty type. The value can be one of the following: lppxPropertyTypeNumber = 1 lppxPropertyTypeBoolean = 2 lppxPropertyTypeDate lppxPropertyTypeString lppxPropertyTypeFloat...

  • Page 80: Docobjects Collection

    Chapter 2 -- 72 Programmer’s Guide DocObjects Collection Properties Methods Application Count Item (Default) Parent Remove Barcodes Shapes OLEObjects Images Texts Object Properties " " " " DocObjects.Application This property returns the Application object that represents the root object of the hierarchy. Access Read-Only.
  • Page 81 Reference Guide Chapter 2 -- 73 " " " " 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.
  • Page 82 Chapter 2 -- 74 Programmer’s Guide Object Methods " " " " 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 Required VT_I4 or Long or enumDocObject.
  • Page 83 Reference Guide Chapter 2 -- 75 " " " " 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.

  • Page 84: Docobject Object

    Chapter 2 -- 76 Programmer’s Guide DocObject Object Properties Methods AnchorPoint Bound Application Move BackColor ForeColor Height Left Locked Name Parent Printable Rotation Type Width Object Properties " " " " DocObject.AnchorPoint Returns or sets the anchor point of the current object. Access Read/Write.
  • Page 85 Reference Guide Chapter 2 -- 77 " " " " 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).
  • Page 86 Chapter 2 -- 78 Programmer’s Guide " " " " DocObject.Rotation Sets or retrieves the rotation of the object. Access Read/Write. Type VT_I2 or Integer. 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.

  • Page 87: Object Methods

    Reference Guide Chapter 2 -- 79 Object Methods " " " " DocObject.Bound VTS_NONE Bound ( longLeftPosition, longTopPosition , longRightPosition , longBottomPosition). Sets the bounding rectangle of an object. Parameters: longLeftPosition Required VT_I4 or Long. Distance between the left edge of an object and the left edge of the document (in MeasureSystem unit).

  • Page 88: Images Collection

    Chapter 2 -- 80 Programmer’s Guide Images Collection Properties Methods Application Count Item (Default) Parent Object Properties " " " " Images.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " Images.Application This property returns the Application object that represents the root object of the hierarchy.

  • Page 89: Item( Varindex )

    Reference Guide Chapter 2 -- 81 " " " " Images.Item VTS_DISPATCH or Image Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, none object returned.

  • Page 90: Image Object

    Chapter 2 -- 82 Programmer’s Guide Image Object Properties Methods DocObject object properties DocObject object methods Brightness FileName HorzFlip VertFlip Negative VariableName VariableObject Object Properties " " " " Image.Brightness This adjustment influences the color reduction process. Use this property to print a color image on a noncolor printer. Access Read/Write.
  • Page 91 Reference Guide Chapter 2 -- 83 " " " " 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.

  • Page 92: Barcodes Collection

    Chapter 2 -- 84 Programmer’s Guide Barcodes Collection Properties Methods Application Count Item (Default) Parent Object Properties " " " " Barcodes.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " Barcodes.Application This property returns the Application object that represents the root object of the hierarchy.

  • Page 93: Object Methods

    Reference Guide Chapter 2 -- 85 Object Methods " " " " 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.

  • Page 94: Barcode Object

    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 Object Properties " " " " Barcode.BarHeight Retrieves or sets the bar height of the barcode (in MeasureSys- tem unit).
  • Page 95 Reference Guide Chapter 2 -- 87 " " " " Barcode.CheckMode Retrieves or sets the check control of the barcode (in enum- CheckMode type). Access Read/Write. Type VT_I4 or Long or enumCheckMode type. The value can be one of the following: lppxCheckModeNone lppxCheckMode1Digit lppxCheckMode2Digit...
  • Page 96 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.
  • Page 97 Reference Guide Chapter 2 -- 89 " " " " Barcode.HRPosition Sets or retrieves the position of the human readable. Access Read/Write. Type VT_I4 or Long or enumHRPosition type. The value can be one of the following: lppxHRPositionNone lppxHRPositionBelow lppxHRPositionAbove lppxHRPositionFree "...
  • Page 98 Chapter 2 -- 90 Programmer’s Guide The value can be one of the following (depending on product and printer): LppxCode11 lppx25Interleave LppxCode39 LppxCode49 LppxMaxicode LppxCode16K LppxGermanPostcode LppxEAN8 LppxUPCE LppxBC412 LppxMicroPDF LppxCode93 lppx25Beared LppxCode128 LppxEAN128 LppxEAN13 LppxCode39Full LppxCode128Auto LppxCodablockF lppx25Industrial lppx25Standard LppxCodabar LppxLogmars LppxMsi...
  • Page 99 Reference Guide Chapter 2 -- 91 LppxUPCEPLUS5 LppxUPCAPLUS2 LppxUPCAPLUS5 LppxEAN8PLUS2 LppxEAN8PLUS5 LppxEAN13PLUS2 LppxEAN13PLUS5 LppxITF lppx25MatrixEuropean lppx25MatrixJapan LppxDatamatrix lppxItf14 LppxPdf LppxQrcode LppxRss LppxComposite Depending on the product, not all symbologies are available. Note " " " " Barcode.Value Retrieves or sets the value of the barcode. Access Read/Write.
  • Page 100 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.

  • Page 101: Code2D Object

    Reference Guide Chapter 2 -- 93 Code2D Object Properties Methods Columns SetOption ModuleX ModuleY Rows Object Properties " " " " Code2D.Columns Sets or retrieves the column count of the current 2D code. Access Read/Write. Type VT_I2 or Integer. " " " " Code2D.ECC Sets or retrieves the Security attribute of the current 2D code (see annexes).

  • Page 102: Object Methods

    Chapter 2 -- 94 Programmer’s Guide " " " " Code2D.Rows Sets or retrieves the row count of the current 2D code. Access Read/Write. Type VT_I2 or Integer. Object Methods " " " " Code2D.SetOption VTS_NONE Code2D.SetOption( strOptionName, varOptionVa- lue). Sets option of the current 2D code.

  • Page 103: Texts Collection

    Reference Guide Chapter 2 -- 95 Texts Collection Properties Methods Application Count Item (Default) Parent Object properties " " " " Texts.Application This property returns the Application object that represents the root object of the hierarchy. Access Read-Only. Type VT_DISPATCH or Application object. "...
  • Page 104 Chapter 2 -- 96 Programmer’s Guide " " " " Texts.Item VTS_DISPATCH or Text Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 105: Text Object

    Reference Guide Chapter 2 -- 97 Text Object Properties Methods Alignment DocObject object methods FitToFrame AppendCRLF Font AppendString Value AppendTextObject VariableName AppendVariable VariableObject Copy WordHyphenation InsertCRLF WordWrap InsertString SelText InsertTextObject InsertVariable Paste Object Properties " " " " Text.Alignment Sets or retrieves current alignment (in enumAlignment type). Access Read/Write.
  • Page 106 Chapter 2 -- 98 Programmer’s Guide " " " " Text.Value Sets or retrieves global value of the object. Access Read/Write. Type VT_BSTR or String. " " " " Text.VariableName Retrieves or sets the current variable name associated with the text.

  • Page 107: Object Methods

    Reference Guide Chapter 2 -- 99 " " " " Text.SelText Retrieves the current selection of text if any. Access Read-Only. Type VT_DISPATCH or TextSelection object. Object Methods " " " " Text.AppendCRLF VTS_NONE AppendCRLF ( fntFont ). Appends a <CrLf> at the end of the text. Parameters: fntFont Optional VT_FONT or StdFont.
  • Page 108 Chapter 2 -- 100 Programmer’s Guide " " " " Text.AppendVariable VTS_NONE AppendVariable( objectVariable, fntFont ). Appends a Variable object at the end of the text. Parameters: objectVariable Required VT_DISPATCH or Variable object. Variable object to append. fntFont Optional VT_FONT or StdFont. Font associated with the Variable object.
  • Page 109 Reference Guide Chapter 2 -- 101 " " " " Text. InsertString VTS_NONE InsertString ( strString, longPosition, fntFont ). Inserts a string at the position longPosition. Parameters: strString Required VT_BSTR or String. String to insert. longPosition Optional VT_I4 or Long. Position to insert string. fntFont Optional VT_FONT or StdFont.

  • Page 110: Textselection Object

    Chapter 2 -- 102 Programmer’s Guide TextSelection Object Properties Methods BackColor Copy Font ForeColor Paste Value Select IsEmpty Object Properties " " " " TextSelection.BackColor Retrieves or sets back color of the selected text if any. Access Read/Write. Type VT_I4 or Long. "...

  • Page 111: Object Methods

    Reference Guide Chapter 2 -- 103 " " " " TextSelection.Value Retrieves or sets value of the selected text if any. Access Read/Write. Type VT_BSTR or String. Object Methods " " " " TextSelection.Copy VTS_NONE Copy(). Copies the selected text, if any, to the clipboard. "...

  • Page 112: Oleobjects Collection

    Chapter 2 -- 104 Programmer’s Guide OLEObjects Collection Properties Methods Application Count Item (Default) Parent Object Properties " " " " OLEObjects.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " OLEObjects.Application This property returns the Application object that represents the root object of the hierarchy.
  • Page 113 Reference Guide Chapter 2 -- 105 " " " " OLEObjects.Item VTS_DISPATCH or OLEObject Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 114: Oleobject Object

    Chapter 2 -- 106 Programmer’s Guide OLEObject Object Properties Methods DocObject object properties DocObject object methods Object EmbedFile LinkFile ConnectServer Object Properties " " " " OLEObject.Object Returns directly the IDispatch interface of the object. Access Read-Only. Type VT_DISPATCH. Object Methods "...
  • Page 115 Reference Guide Chapter 2 -- 107 " " " " OLEObject. ConnectServer VTS_BOOL or Boolean ConnectServer( strCLSIDorPROGID- ServerName ). Connects the object to an OLE server (see Insert OLE object dialog box). Return value: Returns the result of the connection. Parameters: strCLSIDorPROGIDServerName Required VT_BSTR or...

  • Page 116: Shapes Collection

    Chapter 2 -- 108 Programmer’s Guide Shapes Collection Properties Methods Application AddEllipse Count AddLine Parent AddOblique AddPolygon AddRectangle AddRoundRect Item (Default) Remove Object Properties " " " " Shapes.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer.

  • Page 117: Object Methods

    Reference Guide Chapter 2 -- 109 Object Methods " " " " Shapes.AddEllipse VTS_DISPATCH or Shape AddEllipse(longLeft, longTop, longRight, longBottom). Adds a new Shape object to the collection. Return value: Returns a Shape object. Parameters: longLeft Required VT_I4 or Long. Sets the left corner of the bounding rectangle of the object (in MeasureSystem unit).
  • Page 118 Chapter 2 -- 110 Programmer’s Guide " " " " Shapes.AddOblique VTS_DISPATCH or Shape AddOblique(longLeft, longTop, longRight, longBottom). Adds a new Shape object to the collection. Return value: Returns a Shape object. Parameters: longLeft Required VT_I4 or Long. Sets the left corner of the bounding rectangle of the object (in MeasureSystem unit).
  • Page 119 Reference Guide Chapter 2 -- 111 " " " " Shapes.AddRoundRect VTS_DISPATCH or Shape AddRoundRect(longLeft, longTop, longRight, longBottom, longCorner). Adds a new Shape object to the collection. Return value: Returns a Shape object. Parameters: longLeft Required VT_I4 or Long. Sets the left corner of the bounding rectangle of the object (in MeasureSystem unit).
  • Page 120 Chapter 2 -- 112 Programmer’s Guide " " " " Shapes.Item VTS_DISPATCH or Shape Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 121: Shape Object

    Reference Guide Chapter 2 -- 113 Shape Object Properties Methods DocObject object properties DocObject object methods LineWidth SetPoints Object Properties " " " " Shape.LineWidth Sets or retrieves the thickness of the bounds of the object. Access Read/Write. Type VT_I4 or Long. Object Methods "...

  • Page 122: Variables Collection

    Chapter 2 -- 114 Programmer’s Guide Variables Collection Properties Methods Application Count Item (Default) Parent Remove Counters DatabaseVariables Dates FormVariables Formulas FeeVariables TableLoockups Object Properties " " " " Variables.Application This property returns the Application object that represents the root object of the hierarchy. Access Read-Only.
  • Page 123 Reference Guide Chapter 2 -- 115 " " " " Variables.Counters Returns the Counters collection that represents all the created Counter variables in the document. Access Read-Only. Type VT_DISPATCH or Counters collection. " " " " Variables.DatabaseVariables Returns the DatabaseVariables collection that represents all the created Free variables with database link in the document.

  • Page 124: Object Methods

    Chapter 2 -- 116 Programmer’s Guide " " " " Variables.FreeVariables Returns the FreeVariables collection that represents all the created Free variables in the document. Access Read-Only. Type VT_DISPATCH or FreeVariables collection. " " " " Variables.TableLookups Returns the TableLookups collection that represents all the created TableLookup variables in the document.
  • Page 125 Reference Guide Chapter 2 -- 117 " " " " Variables.Item VTS_DISPATCH or Variable Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 126: Variable Object

    Chapter 2 -- 118 Programmer’s Guide Variable Object Properties Methods Application (None) DataSource Name Parent Value (Default) Object Porperties " " " " Variable.Application This property returns the Application object that represents the root object of the hierarchy. Access Read-Only. Type VT_DISPATCH or Application object.
  • Page 127 Reference Guide Chapter 2 -- 119 " " " " Variable.Value Returns the current value of the variable. Access Read/Write. Type VT_BSTR or String.

  • Page 128: Tableloockups Collection

    Chapter 2 -- 120 Programmer’s Guide TableLoockups Collection Properties Methods Application Count Item (Default) Parent Remove Object Properties " " " " TableLookups.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " TableLookups.Application This property returns the Application object that represents the root object of the hierarchy.
  • Page 129 Reference Guide Chapter 2 -- 121 " " " " TableLookups.Item VTS_DISPATCH or TableLookup Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 130: Tableloockup Object

    Chapter 2 -- 122 Programmer’s Guide TableLoockup Object Properties Methods Counter object properties Counter object methods CounterUse AddKey DatabaseSource DeleteKey ResultField Keys Length PadLength TableName Object Properties " " " " TableLookup.CounterUse Activates or not a counter on the object. Access Read/Write.

  • Page 131: Object Methods

    Reference Guide Chapter 2 -- 123 " " " " TableLookup.PadLength Sets or retrieves the number of characters to pad up to. Access Read/Write. Type VT_I4 or Long. " " " " TableLookup.ResultField Sets or retrieves the name of the linked output field. Access Read/Write.
  • Page 132 Chapter 2 -- 124 Programmer’s Guide " " " " TableLookup.DeleteKey VTS_NONE DeleteKey( strFieldName ). Deletes the search for the field strFieldName. Parameters: StrFieldName Required VT_BSTR or string. Fieldname to delete.

  • Page 133: Formulas Collection

    Reference Guide Chapter 2 -- 125 Formulas Collection Properties Methods Application Counte Item (Default) Parent Remove Object Properties " " " " Formulas.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " Formulas.Application This property returns the Application object that represents the root object of the hierarchy.
  • Page 134 Chapter 2 -- 126 Programmer’s Guide " " " " Formulas.Item VTS_DISPATCH or Formula Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 135: Formula Object

    Reference Guide Chapter 2 -- 127 Formula Object Properties Methods Counter object properties Counter object methods CounterUse Test method Expression Length PadLength Object Properties " " " " Formula.CounterUse Activates or not counting on the object. Access Read/Write. Type VT_BOOL or Boolean. "...

  • Page 136: Object Methods

    Chapter 2 -- 128 Programmer’s Guide Object Methods " " " " Formula.Test VTS_BOOL or Boolean Test(). Tests the validity of the formula. Return value: Returns a boolean which indicate if the Formula object format is valid or not.

  • Page 137: Dates Collection

    Reference Guide Chapter 2 -- 129 Dates Collection Properties Methods Application Count Item (Default) Parent Remove Object Properties " " " " Dates.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " Dates.Application This property returns the Application object that represents the root object of the hierarchy.
  • Page 138 Chapter 2 -- 130 Programmer’s Guide " " " " Dates.Item VTS_DISPATCH or Date Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 139: Date Object

    Reference Guide Chapter 2 -- 131 Date Object Properties Methods Variable object properties Variable object methods Device Format Object Properties " " " " Date.Device Determines if the date is generated by the printer or not. Access Read/Write. Type VT_BOOL or Boolean. "...
  • Page 140 Chapter 2 -- 132 Programmer’s Guide Followed by the real format: Commands Value ‘m’ month as 1...12 ‘mm’ month as 01¼12 ‘mmm’ month as Jan...Dec ‘mmmm’ month as January...December ‘d’ day of month as 1.31 ‘dd’ day of month as 01..31 ‘ddd’...

  • Page 141: Counters Collection

    Reference Guide Chapter 2 -- 133 Counters Collection Properties Methods Application Count Item (Default) Parent Remove Object Properties " " " " Counters.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " Counters.Application This property returns the Application object that represents the root object of the hierarchy.
  • Page 142 Chapter 2 -- 134 Programmer’s Guide " " " " Counters.Item VTS_DISPATCH or Counter Item( varIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned.

  • Page 143: Counter Object

    Reference Guide Chapter 2 -- 135 Counter Object Properties Methods Variable object properties Variable object methods NumberOfDecimals DecimalSeparator DecimalUse ThousandSeparator Increment BaseType CustomSet MaxValue ResetToValue PadCharacter Prefix Suffix TriggerMode TriggerParameter Object Properties " " " " Counter. NumberOfDecimals Sets or retrieves the number of digits after the decimal point. Access Read/Write.
  • Page 144 Chapter 2 -- 136 Programmer’s Guide " " " " Counter. DecimalUse Uses or not decimal formatting. Access Read/Write. Type VT_BOOL or Boolean. " " " " Counter. ThousandSeparator Sets or retrieves the thousand separator. Access Read/Write. Type VT_BSTR or String. "...
  • Page 145 Reference Guide Chapter 2 -- 137 " " " " Counter. TriggerMode Sets the Increment method: Access Read/Write. Type VT_I2 or Integer or enumTriggerMode type. The value can be one of the following: lppxNumberOfPrintedLabels lppxResetOfAnotherCounter (Default set to lppxNumberOfPrintedLabels) " " " " Counter. TriggerParameter Sets the parameter for the trigger mode.
  • Page 146 Chapter 2 -- 138 Programmer’s Guide " " " " Counter.ResetToValue Sets or retrieves the reset value. Access Read/Write. Type VT_VARIANT or Variant. " " " " Counter.PadCharacter Sets or retrieves the character used to pad the left of variable value.

  • Page 147: Freevariables Collection

    Reference Guide Chapter 2 -- 139 FreeVariables Collection Properties Methods Application Count item (Default) Parent Remove Object Properties " " " " FreeVariables.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " FreeVariables.Application This property returns the Application object that represents the root object of the hierarchy.

  • Page 148: Object Methods

    Chapter 2 -- 140 Programmer’s Guide Object Methods " " " " FreeVariables.Add VTS_DISPATCH or Free Add( strFreeName ). Adds a new Free object to the collection with no specific attribute. Return value: Returns a Free object. Parameters: strFreeName Optional VT_BSTR or String. The name of the object to add.

  • Page 149: Free Object

    Reference Guide Chapter 2 -- 141 Free Object Properties Methods Counter object properties Counter object methods CounterUse DisplayInForm FormOrder FormPrompt Inputmask Length PadLength Shared Object Properties " " " " Free.CounterUse Activates or not a counter on the object. Access Read/Write.
  • Page 150 Chapter 2 -- 142 Programmer’s Guide " " " " Free.FormPrompt Specifies the prompt associated in the Form grid. Access Read/Write. Type VT_BSTR or String. " " " " Free.InputMask Specifies the format prompt associated in the Form grid. Access Read/Write.

  • Page 151: Databasevariables Collection

    Reference Guide Chapter 2 -- 143 DatabaseVariables Collection Properties Methods Application Count Item (Default) Parent Remove Object Properties " " " " DatabaseVariables.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " DatabaseVariables.Application This property returns the Application object that represents the root object of the hierarchy.

  • Page 152: Object Methods

    Chapter 2 -- 144 Programmer’s Guide Object Methods " " " " DatabaseVariables.Add VTS_DISPATCH or Free Add( strFreeName ). Adds a new Free object to the collection with database attribute. Return value: Returns a Free object. Parameters: strFreeName Optional VT_BSTR or String. The name of the object to add.

  • Page 153: Formvariables Collection

    Reference Guide Chapter 2 -- 145 FormVariables Collection Properties Methods Application Count Item (Default) Parent Remove Object Properties " " " " FormVariables.Count Returns the number of items in the specified collection. Access Read-Only. Type VT_I2 or Integer. " " " " FormVariables.Application This property returns the Application object that represents the root object of the hierarchy.

  • Page 154: Object Methods

    Chapter 2 -- 146 Programmer’s Guide Object Methods " " " " FormVariables.Add VTS_DISPATCH or Free Add( strFreeName ). Adds a new Free object to the collection with form attribute. Return value: Returns a Free object. Parameters: strFreeName Optional VT_BSTR or String. The name of the object to add.

  • Page 155: Strings Collection

    Reference Guide Chapter 2 -- 147 Strings Collection Properties Methods Application Count Item (Default) Parent Remove Object Properties " " " " Strings.Application This property returns the Application object that represents the root object of the hierarchy. Access Read-Only. Type VT_DISPATCH or Application object.
  • Page 156 Chapter 2 -- 148 Programmer’s Guide " " " " Strings.Item VTS_BSTR Item( longIndex ). Returns a member of a collection, either by position or by name. If the value provided as Index does not match any existing Note member of the collection, no object is returned. Parameters: longIndex Required VT_14 or Variant.

  • Page 157: Document Events

    Reference Guide Chapter 2 -- 149 Document Events Properties Methods (None) Change BeginPrinting ProgressPrinting EndPrinting PausedPrinting Object Methods " " " " Document.BeginPrinting VTS_NONE BeginPrinting ( strDocName ). Informs the user when the printing process begins for document strDocName. Parameters: strDocName VT_BSTR or String Name of the document starting to print.
  • Page 158 Chapter 2 -- 150 Programmer’s Guide " " " " Document.EndPrinting VTS_NONE EndPrinting ( Reason ). Infoms the user of the end of the printing process for current document with anotification code. Reason VT_I2 or Integer or enumEndPrinting type. Code for the reason for the end of the process.

  • Page 159: Application Events

    Reference Guide Chapter 2 -- 151 Application Events Properties Methods (None) Close Quit DocumentClosed Object Methods " " " " ApplicationEvent. Close VTS_NONE Close (). Informs that a user has closed the application. " " " " ApplicationEvent. Quit VTS_NONE Quit ().

  • Page 160: Appendix

    Appendix Information on Visual C++ Data Type This section provides information on the data type used with Visual C For more information, refer to the Microsoft Visual C documentation. VARENUM usage key, [V] - may appear in a VARIANT [T] - may appear in a TYPEDESC [P] - may appear in an OLE property set [S] - may appear in a Safe Array Item...
  • Page 161 Appendix Chapter 3 -- 153 Item Value VT_BOOL True=-1, False=0 VT_VARIANT VARIANT VT_UNKNOWN IUnknown VT_DECIMAL 16 byte fixed point VT_RECORD user defined type VT_I1 signed char VT_UI1 unsigned char VT_UI2 unsigned short VT_UI4 unsigned short VT_I8 signed 64-bit int VT_UI8 unsigned 64-bit int VT_INT signed machine int...
  • Page 162 Chapter 3 -- 154 Programmer’s Guide Item Value VT_BLOB_OBJECT Blob contains an object VT_CF Clipboard format VT_CLSID A Class ID VT_VECTOR simple counted array VT_ARRAY SAFEARRAY* VT_BYREF void* for local use VT_BSTR_BLOB Reserved for system VT: data type of variable or function parameters. Note VTS: data type of the function return value...
  • Page 163 Index ActiveX , Chapter 1 - 1 Data Type, Chapter 1 - 8 ActiveX object, Chapter 1 - 2 Database Object , Chapter 2 - 54 Application, Chapter 1 - 2 DatabaseVariables Collection, Chapter 2 - 143 Application , Chapter 1 - 4 Date Object, Chapter 2 - 131 Application Events, Chapter 2 - 151 Dates Collection, Chapter 2 - 129...
  • Page 164 Programmer’s Guide Chapitre 4 -- 156 Format Object , Chapter 2 - 63 OLEObject Object, Chapter 2 - 106 Formula Object, Chapter 2 - 127 OLEObjects Collection, Chapter 2 - 104 Formulas Collection, Chapter 2 - 125 Options Object , Chapter 2 - 29 FormVariables Collection, Chapter 2 - 145 Free Object, Chapter 2 - 141 FreeVariables Collection, Chapter 2 - 139...
  • Page 165 Index Chapitre 4 --- 157 Variable Object, Chapter 2 - 118 WithEvents keyword, Chapter 1 - 11 Variables Collection, Chapter 2 - 114 WithEvents variables, Chapter 1 - 11...

Table of Contents