Teklynx Discover ActiveX Programmer'S Manual Download Page 131

Page: 131 / 165

Chapter 2 -- 123

Reference Guide

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.

Type

VT_BSTR or String.

TableLookup.Keys

Returns strings collection for keys.

Access

Read-Only.

Type

VT_DISPATCH or Strings.

TableLookup.TableName

Sets or retrieves the linked table name of the current data
source.

Access

Read/Write.

Type

VT_BSTR or String.

TableLookup.AddKey

VTS_NONE

AddKey

(

strSearchFieldName, strSearchFieldVa-

lue

Adds a pair (<SearchFieldName>,<SearchFieldValue>) in the
Search Field List.

Parameters

strSearchFieldName

Required VT_BSTR or String. The field

name.

strSearchFieldValue

Required VT_BSTR or String. The

value of the field (must be the name of an other variable).

Object
Methods

Summary of Contents for Discover ActiveX

Page 1: ...DOC OEM6 ActiveX US 06 00 P P P Pr r r ro o o og g g gr r r ra a a am m m mm m m me e e er r r r s s s s G G G Gu u u ui i i id d d de e e e ...

Page 2: ...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 Windowst t t t is a registered trademark of Microsoftâ Corpora tion IBM PC AT PS 2 are register...

Page 3: ...tivation 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 Chap...

Page 4: ...ct 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 ...

Page 5: ...ect 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...

Page 6: ...bject 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 ...

Page 7: ...ur 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 this part gives the bases for programming with Activ...

Page 8: ...n 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 highlight...

Page 9: ...ate 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 are programmable from any languages such as Visual Basic So the user can control his labeling software using your own program Your labeling software becomes the server and your program is the client application Through this manual you will find exa...

Page 10: ...ct 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 actio...

Page 11: ...bject methods and properties that you can access Using this library you optimize your job The name of this type library is LabelManager2 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...

Page 12: ...ject 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 I...

Page 13: ...on 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 function at the object variable see below Bel...

Page 14: ...ject 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 Libr...

Page 15: ... 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 CloseAll method on the Documents collect...

Page 16: ...cument 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...

Page 17: ...t 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 ...

Page 18: ... 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 Removes an item from a collection Uses indexing arguments in the same way as the Item method The Item method takes one or more arguments to indicate ...

Page 19: ... 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 handl...

Page 20: ...s 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 the variable name appears in the left hand drop down of the module s code window When you select MyDoc the Document class events will appear in the right hand drop down as shown in Figure 2 below Figure 2 An ev...

Page 21: ...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 have to create an object and assign a reference to the object to the WithEvents variable Add the following code to the Form_Load event procedure to create the LabelManager2 Application Private Sub Form_Load Set MyApp New LabelManager2 Application Set M...

Page 22: ...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 ...

Page 23: ...rarchy diagram The diagram below shows the object hierarchy Strings RecentFiles RecentFile PrinterSystem Options Dialogs Dialog Documents Document Database Printer Format DocumentProperties Application DocumentProperty 2 ...

Page 24: ...riables 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 ...

Page 25: ...veDocument 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 ...

Page 26: ...urrent 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 applicat...

Page 27: ... 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 ...

Page 28: ...n 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 ...

Page 29: ...rinterSystem 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 ...

Page 30: ...his 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...

Page 31: ...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 poi...

Page 32: ...00 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 r...

Page 33: ...distance between the left edge of the main window of the application and the left edge of the screen in pixel unit longPosTop Required VT_I4 or Long 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 long...

Page 34: ...a family Parameters strFamilyName Optional VT_BSTR or String It specifies the 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 Optional VT_I2 or Integer or enumKindOf Printers default lppxInternalPrinters ...

Page 35: ...alPrinters 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...

Page 36: ...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 Note Only models can be renamed ...

Page 37: ...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 ...

Page 38: ...ring 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 De...

Page 39: ...le Options Language Returns or sets the Language option Access Read Write Type VT_I4 or Long or enumLanguage type The value can be one of the following 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 lppxTraditionalChines...

Page 40: ...eSystem Returns or sets the MeasureSystem option Default lppxMilli meter Access Read Write Type VT_I2 or Integer or enumMeasureSystem type The value can be one of the following 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 set...

Page 41: ...ts the OpenReadOnly 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_I4 or Long Options TrayNotification Enables or disables notification of printing in System Tray Bar Default True Access Read Write Type VT_BOOL or Boolean ...

Page 42: ...he 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_I2 or Integer Dialogs Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Object Properties ...

Page 43: ... 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 The value can be one of the following...

Page 44: ...ect 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_I2 or Integer or enumDialogType type Object Properties ...

Page 45: ...rn 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 ...

Page 46: ... 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_I2 or Integer RecentFiles Maximum Returns or sets the maximum number of items in the specified collection from 0 to 16 Access Read Write Type VT_I2 or Integer RecentFiles Parent Returns the parent object of the specified object Access...

Page 47: ...ATCH 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 ...

Page 48: ...Chapter 2 40 Programmer s Guide RecentFiles Remove VTS_NONE Remove intIndex Deletes object with intIndex index ...

Page 49: ...ead 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 Objec...

Page 50: ...Chapter 2 42 Programmer s Guide RecentFile Open VTS_DISPACTCH or Document Open Opens the document associated with the current filename Object Methods ...

Page 51: ... or Integer 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...

Page 52: ...he 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 The name or index number of a member of the collection The index can b...

Page 53: ...ment paths are accepted boolReadOnly Optional VT_BOOL or Boolean True to open 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_...

Page 54: ...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 V...

Page 55: ...ormat object Document TriggerForm Sets or returns the TriggerForm in printing situation Access Read Write Type VT_I2 or Integer or enumTriggerForm type The value can be one of the following 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 Ret...

Page 56: ...bjects 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 change...

Page 57: ...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_I2 or Integer or enumRotation type The value can be one of the following lppxNoRotation 0 lppx90DegreeRight 1 lppxUpSideDown 2 lppx90DegreeLeft 3 Document WindowState Sets or retrieves the current size of the v...

Page 58: ... job Document GeneratePOF VTS_I2 GeneratePOF strDestinationFileName strModelFile Name Generates a POF file Parameters strDestinationFileName Required VT_BSTR or String Name of the file to print to strModelFileName Optional VT_BSTR or String Name or 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 ...

Page 59: ...py Optional VT_I4 or Long default 1 longLabelNoPrintedFrom Optional VT_I4 or Long 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 Optional VT_I4 or Long Quantity of labels to print Defau...

Page 60: ... 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_NON...

Page 61: ...its per pixel Depending of the generated file 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 Optional VT_I2 or Integer Default 0 Rotation in geometrical degree The values must be between 0 and 360 Percent Optional VT_I2 or Integ...

Page 62: ...efault 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 ...

Page 63: ...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_BO...

Page 64: ... 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 ...

Page 65: ...Query strQueryFileName Opens a CSQ query file Return value returns a boolean that indicates whether the opening fails or not Parameters strQueryFileName Required VT_BSTR or 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...

Page 66: ... 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 ...

Page 67: ...er 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 s name 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 instructi...

Page 68: ...eFontNames 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 ...

Page 69: ...Access Read Only Type VT_DISPATCH Printer XDPI Returns the horizontal resolution of the printer in DPI Access Read Only Type VT_I4 or Long Printer YDPI Returns the vertical resolution of the printer in DPI Access Read Only Type VT_I4 or Long Printer WindowsFontNames Returns the Strings collection that represents all the windows font names Access Read Only Type VT_DISPATCH or Strings collection ...

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: ...zontalGap 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 ...

Page 72: ... 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_I4 or Long 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_I4 or Long Format VerticalGap Retrieves or sets the...

Page 73: ... MeasureSystem unit Access Read Write Type VT_I4 or Long Format MarginLeft Retrieves or sets the left margin of the page in MeasureSystem unit Access Read Write Type VT_I4 or Long Format MarginTop Retrieves or sets the top margin of the page in MeasureSystem unit Access Read Write Type VT_I4 or Long Format StockName Retrieves or sets the name of the format model if any Access Read Write Type VT_BS...

Page 74: ...of the page in MeasureSystem unit Access Read Write Type VT_I4 or Long Format PageWidth Retrieves or sets the width of the page in MeasureSystem unit Access Read Write Type VT_I4 or Long 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 ...

Page 75: ...ureSystem unit Access Read Write Type VT_I4 or Long Format RowCount Retrieves or sets the number of labels per column vertical count Access Read Write Type VT_I4 or Long Format SaveStock VTS_NONE Format SaveStock Saves the current stock Name Type In order to reuse it with others documents Object Methods ...

Page 76: ...he 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_I2 or Integer DocumentProperties Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Object Properties ...

Page 77: ...sion 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 enumBuiltInD...

Page 78: ...perty 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 ...

Page 79: ...2 or Integer or enumProperty type The value can be one of the following 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 ...

Page 80: ...on 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_I2 or Integer DocObjects Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Object Properties ...

Page 81: ..._DISPATCH or Shapes collection DocObjects OLEObjects Returns the OLEObjects collection that represents all the created OLEObject objects in the document Access Read Only Type VT_DISPATCH or 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 Return...

Page 82: ...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 The name or index number of a member of the collection The index can be a numeric ...

Page 83: ...ndex 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 ...

Page 84: ... 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 ...

Page 85: ...ct 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_I4 or Long DocObject Name Returns or sets the name of the DocObject Access Read Write Type VT_BSTR or String DocObject Printable Sets or not whether the obj...

Page 86: ...p 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_I4 or Long DocObject Type Returns the type of the object in enumDocObject type Access Read Only Type VT_I2 or Integer DocObject Width Returns or sets the width of the object in enumMeasureSystem unit Access Read Write Type VT_I4 or L...

Page 87: ...tPosition Required VT_I4 or Long Distance between the right edge of an object and the left edge ofthe document in MeasureSystem unit longBottomPosition Required VT_I4 or Long Distance between the bottom edge of an object and the top edge ofthe document in MeasureSystem unit DocObject Move VTS_NONE Move longLeftPosition longTopPosition Moves an object in its window Parameters longLeftPosition Requi...

Page 88: ... 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 Strin...

Page 89: ...ring 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 specifi...

Page 90: ...ment influences the color reduction process Use this property to print a color image on a noncolor printer Access Read Write Type VT_I2 or Integer 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 Boo...

Page 91: ...lean 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 ...

Page 92: ... 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 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 ...

Page 93: ... 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 Remove...

Page 94: ...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_I4 or Long Object Properties ...

Page 95: ... 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_I4 or Long or enumAlignment type The v...

Page 96: ...t 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...

Page 97: ...RPositionBelow 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_I4 or Long Barcode Ratio Retrieves or sets the ratio of the barcode between 20 and 35 Access Read Write Type VT_I4 or Long Barcode Symbology Retrieves or sets the symbology of barcode Access Read Write Type VT_I4 or...

Page 98: ...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 Lppx...

Page 99: ...atrixJapan 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 Retrieves or sets the value of the barcode 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...

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: ...er Code2D ECC Sets or retrieves the Security attribute of the current 2D code see annexes Access Read Write Type VT_I2 or Integer Code2D ModuleX Sets or retrieves the thickness of the ModuleX attribute of the current 2D code Access Read Write Type VT_I2 or Integer Code2D ModuleY Sets or retrieves the thickness of the ModuleY attribute of the current 2D code Access Read Write Type VT_I2 or Integer ...

Page 102: ... Read Write Type VT_I2 or Integer Code2D SetOption VTS_NONE Code2D SetOption strOptionName varOptionVa lue Sets option of the current 2D code Parameters strOptionName Required VT_BSTR or String Name of the option to set varOptionValue Required VT_VARIANT or Variant Value of the option to set Object Methods ...

Page 103: ...Application object Texts Count Returns the number of items in the specified collection Access Read Only Type VT_I2 or Integer Texts Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Texts Add VTS_DISPATCH or Text Add strTextName Adds a new Text object to the collection Return value Returns a Text object Parameters strTextName Optional VT_BSTR or String The ...

Page 104: ...g 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 Texts 1 Object Texts Item 1 Texts Remove VTS_NONE Remove varIndex Removes a member from the collection Parameters varIndex Required VT_VARIANT or Variant An expression that sp...

Page 105: ...tion InsertCRLF WordWrap InsertString SelText InsertTextObject InsertVariable Paste Text Alignment Sets or retrieves current alignment in enumAlignment type Access Read Write Type VT_I2 or Integer or enumAlignment type Text FitToFrame Sets or retrieves fit to frame option Access Read Write Type VT_BOOL or Boolean Text Font Sets or retrieves text font Access Read Write Type VT_FONT or StdFont objec...

Page 106: ... with the text Access Read Write Type VT_BSTR or String Text VariableObject Retrieves or sets the current Variable object associated with the text Access Read Write Type VT_DISPATCH or Variable object Text WordHyphenation Retrieves or sets the WordHyphenation option Access Read Write Type VT_BOOL or Boolean Text WordWrap Retrieves or sets the WordWrap option Access Read Write Type VT_BOOL or Boole...

Page 107: ...ont Font associated with the Carriage return Text AppendString VTS_NONE AppendString strString fntFont Appends a string at the end of the text Parameters strString Required VT_BSTR or String String to append fntFont Optional VT_FONT or StdFont Font associated with the string Text AppendTextObject VTS_NONE AppendTextObject objectText Appends a Text object at the end of the text Parameters objectTex...

Page 108: ...d with the Variable object Text Copy VTS_NONE Copy Copies the Text object to the clipboard Note About Insert functions Positions starts at 1 A variable object equals 1 position A CarriageReturn field equals 1 position Text InsertCRLF VTS_NONE InsertCRLF longPosition fntFont Inserts a carriage return at the position longPosition Parameters longPosition Optional VT_I4 or Long Position to insert Carr...

Page 109: ...ject objectText longPosition Inserts a Text object at the position longPosition Parameters objectText Required VT_DISPATCH or Text object Text to insert longPosition Optional VT_I4 or Long Position to insert Text object Text InsertVariable VTS_NONE InsertVariable objectVariable longPosition fntFont Inserts a Variable object at the position longPosition Parameters objectVariable Required VT_DISPATC...

Page 110: ...ted text if any Access Read Write Type VT_I4 or Long TextSelection Font Retrieves or sets font of the select text if any Access Read Write Type VT_DISPATCH or StdFont TextSelection ForeColor Retrieves or sets fore color of the selected text if any Access Read Write Type VT_I4 or Long TextSelection IsEmpty Tests if the selected text exists Access Read Write Type VT_BOOL or Boolean Object Properties...

Page 111: ...d into the current selected text TextSelection Select VTS_NONE Select longFirstPosition longLastPosition Selects the text from longFirstPosition to longLastPosition Parameters longFirstPosition Optional VT_I4 or Long Index of the first position of the text to select starts with 1 longLastPosition Optional VT_I4 or Long Index of the last position of the text to select Note If longLastPosition is om...

Page 112: ...ation object that represents the root object of the hierarchy Access Read Only Type VT_DISPATCH or Application object OLEObjects Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH OLEObjects Add VTS_DISPATCH or OLEObject Add strOLEObjectName Adds a new OLEObject object to the collection Return value Returns a OLEObject object Parameters strOLEObjectName Requ...

Page 113: ...te 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 OLEObjects 1 Object OLEObjects Item 1 OLEObjects Remove VTS_NONE Remove varIndex Removes a member from the collection Parameters varIndex Required VT_VARIANT or Variant An express...

Page 114: ...Connects the object to a file see Insert OLE object dialog box Return value Returns the result of the connection Parameters strOLEFileNameToConnect Required VT_BSTR or String The name of the filename to connect to OLEObject LinkFile VTS_BOOL or Boolean LinkFile strOLELinkFileNameToCon nect Connects the object to a file see Insert OLE object dialog box Return value Returns the result of the connect...

Page 115: ...Server 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 String The CLSID with brackets or directly the name of the OLE server ...

Page 116: ...es Count Returns the number of items in the specified collection Access Read Only Type VT_I2 or Integer Shapes Application This property returns the Application object that represents the root object of the hierarchy Access Read Only Type VT_DISPATCH or Application object Shapes Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Object Properties ...

Page 117: ...tom Required VT_I4 or Long Sets the bottom corner of the bounding rectangle of the object in MeasureSystem unit Shapes AddLine VTS_DISPATCH or Shape AddLine 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 l...

Page 118: ...gBottom Required VT_I4 or Long Sets the bottom corner of the bounding rectangle of the object in MeasureSystem unit Shapes AddRectangle VTS_DISPATCH or Shape AddRectangle 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 Measur...

Page 119: ...ong Sets the right corner of the bounding rectangle of the object in MeasureSystem unit longBottom Required VT_I4 or Long Sets the bottom corner of the bounding rectangle of the object in MeasureSystem unit LongCorner Required VT_I4 or Long Sets the radius of the corner distance from bound in MeasureSystem unit Shapes AddPolygon VTS_DISPATCH or Shape AddPolygon varSafeArrayOf Points Adds a new Sha...

Page 120: ...g 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 Shapes 1 Object Shapes Item 1 Shapes Remove VTS_NONE Remove varIndex Removes a member from the collection Parameters varIndex Required VT_VARIANT or Variant An expression that...

Page 121: ...f the bounds of the object Access Read Write Type VT_I4 or Long Shape SetPoints VTS_NONE SetPoints varArrayOfPoints Sets all points describing the current object Parameters varArrayOfPoints Required VT_VARIANT VT_ARRAY or Variant An expression that evaluates to an array of points Note In order to have a closed polygon last point must match first point Object Properties Object Methods ...

Page 122: ...ps Variables Application This property returns the Application object that represents the root object of the hierarchy Access Read Only Type VT_DISPATCH or Application object Variables Count Returns the number of items in the specified collection Access Read Only Type VT_I2 or Integer Variables Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Object Proper...

Page 123: ...DISPATCH or DatabaseVariables collection Variables Dates Returns the Dates collection that represents all the created Date variables in the document Access Read Only Type VT_DISPATCH or Dates collection Variables FormVariables Returns the FormVariables collection that represents all the created Free variables with form attribute in the document Access Read Only Type VT_DISPATCH or FormVariables co...

Page 124: ...okups collection Variables Add VTS_DISPATCH or Variable Add VariableDataSource strVariableName Adds a new Variable object to the current document Return value Returns a Variable object Parameters strVariableDataSource Required VT_I4 or Long The data source type of the variable to add Can be one of the following values enumDatasource type lppxDataSourceCounter 1 lppxDataSourceTableLookup 2 lppxData...

Page 125: ...ote 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 Variables 1 Object Variables Item 1 Variables Remove VTS_NONE Remove varIndex Removes a member from the collection Parameters varIndex Required VT_VARIANT or Variant An expressio...

Page 126: ...the hierarchy Access Read Only Type VT_DISPATCH or Application object Variable DataSource Returns the kind of data source of the variable enumDatasource type Access Read Only Type VT_I2 or Integer or enumDataSource type Variable Name Returns the name of the variable Access Read Write Type VT_BSTR or String Variable Parent Returns the parent object of the specified object Access Read Only Type VT_D...

Page 127: ...Chapter 2 119 Reference Guide Variable Value Returns the current value of the variable Access Read Write Type VT_BSTR or String ...

Page 128: ...ation object that represents the root object of the hierarchy Access Read Only Type VT_DISPATCH or Application object TableLookups Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH TableLookups Add VTS_DISPATCH or TableLookup Add strLinkedTableName Adds a new TableLookup object to the collection Return value Returns a TableLookup object Parameters strLinked...

Page 129: ...e 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 TableLookups 1 Object TableLookups Item 1 TableLookups Remove VTS_NONE Remove varIndex Removes a member from the collection Parameters varIndex Required VT_VARIANT or Variant An ex...

Page 130: ...th PadLength TableName TableLookup CounterUse Activates or not a counter on the object Access Read Write Type VT_BOOL or Boolean TableLookup DatabaseSource Sets or retrieves the data source name of the linked ODBC database Access Read Write Type VT_BSTR or String TableLookup Length Sets or retrieves the length of the output value Access Read Write Type VT_I4 or Long Object Properties ...

Page 131: ...s Access Read Only Type VT_DISPATCH or Strings TableLookup TableName Sets or retrieves the linked table name of the current data source Access Read Write Type VT_BSTR or String TableLookup AddKey VTS_NONE AddKey strSearchFieldName strSearchFieldVa lue Adds a pair SearchFieldName SearchFieldValue in the Search Field List Parameters strSearchFieldName Required VT_BSTR or String The field name strSea...

Page 132: ...hapter 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: ...Application object that represents the root object of the hierarchy Access Read Only Type VT_DISPATCH or Application object Formulas Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Formulas Add VTS_DISPATCH or Formula Add strFormulaName Adds a new Formula object to the collection Return value Returns a Formula object Parameters strFormulaName Optional VT_...

Page 134: ... 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 Formulas 1 Object Formulas Item 1 Formulas Remove VTS_NONE Remove varIndex Removes a member from the collection Parameters varIndex Required VT_VARIANT or Variant An expression...

Page 135: ...unting on the object Access Read Write Type VT_BOOL or Boolean Formula Expression Sets or retrieves the format of the Formula object Access Read Write Type VT_BSTR or String Formula Length Sets or retrieves the length of the output value Access Read Write Type VT_I4 or Long Formula PadLength Sets or retrieves the number of characters to pad up to Access Read Write Type VT_I4 or Long Object Propert...

Page 136: ...ter 2 128 Programmer s Guide 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 Object Methods ...

Page 137: ...s the Application object that represents the root object of the hierarchy Access Read Only Type VT_DISPATCH or Application object Dates Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Dates Add VTS_DISPATCH or Date Add strDateName Adds a new Date object to the collection Return value Returns a Date object Parameters strDateName Optional VT_BSTR or String ...

Page 138: ...g 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 Dates 1 Object Dates Item 1 Dates Remove VTS_NONE Remove varIndex Removes a member from the collection Parameters varIndex Required VT_VARIANT or Variant An expression that sp...

Page 139: ...generated by the printer or not Access Read Write Type VT_BOOL or Boolean Date Format Sets or retrieves the format of the value Access Read Write Type VT_BSTR or String Can contain a prefix code which indicates country code Prefix Code Country UK English default GE German IT Italian FR French SW Swedish SP Spanish CH Chinese DK Danish JP Japanese Object Properties ...

Page 140: ...eek as 0 6 0 Sunday 1 Monday dddd day of week as Sun Sat ddddd day of week as Sunday Saturday j Julian day as 1 366 jj Julian day as 001 366 y year as 0 9 yy year as 00 99 yyyy year as 1900 2040 w week number as 1 53 ww week number as 01 53 h hour as 0 23 hh hour as 00 23 hhh hour as 0 12 hhhh hour as 00 12 am pm am or pm n Minutes as 0 59 nn Minutes as 00 59 c Separator c any non ambiguous charac...

Page 141: ...Application object that represents the root object of the hierarchy Access Read Only Type VT_DISPATCH or Application object Counters Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Counters Add VTS_DISPATCH or Counter Add strCounterName Adds a new Counter object to the collection Return value Returns a Counter object Parameters strCounterName Optional VT_...

Page 142: ... 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 Counters 1 Object Counters Item 1 Counters Remove VTS_NONE Remove varIndex Removes a member from the collection Parameters varIndex Required VT_VARIANT or Variant An expression...

Page 143: ...Separator Increment ISO BaseType CustomSet MaxValue ResetToValue PadCharacter Prefix Suffix TriggerMode TriggerParameter Counter NumberOfDecimals Sets or retrieves the number of digits after the decimal point Access Read Write Type VT_I4 or Long Counter DecimalSeparator Sets or retrieves the decimal separator Access Read Write Type VT_BSTR or String Object Properties ...

Page 144: ...rieves the increment Access Read Write Type VT_VARIANT or Variant Counter ISO Uniquely numbers each copy of a label Access Read Write Type VT_BOOL or Boolean Counter BaseType Sets or retrieves the counting base used for counting Access Read Write Type VT_I2 or Integer or enumBase type The value can be one of the following lppxBaseBinary 2 lppxBaseOctal 8 lppxBaseDecimal 10 lppxBaseHexadecimal 16 l...

Page 145: ...ccess Read Write Type VT_VARIANT or Variant Note Can be the number of labels printed or the name of an other counter By default it is the number of labels printed with a value set to 1 Counter CustomSet Sets or retrieves the characters list of the custom counter ex 0123456789ABCD The first element must be the neutral element Access Read Write Type VT_BSTR or String Counter MaxValue Sets or retriev...

Page 146: ...aracter Sets or retrieves the character used to pad the left of variable value Access Read Write Type VT_BSTR or String Counter Prefix Sets or retrieves the prefix string added to the variable Access Read Write Type VT_BSTR or String Counter Suffix Sets or retrieves the suffix string added to the variable Access Read Write Type VT_BSTR or String ...

Page 147: ...ems 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 Access Read Only Type VT_DISPATCH or Application object FreeVariables Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Object Properties ...

Page 148: ...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 FreeVariables 1 Object Freevariables Item 1 FreeVariables Remove VTS_NO...

Page 149: ...tmask Length PadLength Shared Free CounterUse Activates or not a counter on the object Access Read Write Type VT_BOOL or Boolean Free DisplayInForm Includes or not the current object in the Form grid Access Read Write Type VT_BOOL or Boolean Free FormOrder Specifies the order of objects in the Form grid Access Read Write Type VT_I2 or Integer Object Properties ...

Page 150: ... the Form grid Access Read Write Type VT_BSTR or String Free Length Sets or retrieves the length of the output value Access Read Write Type VT_I4 or Long Free PadLength Sets or retrieves the number of characters to pad up to Access Read Write Type VT_I4 or Long Free Shared Specifies the list of proposed values for the prompt associated in the Form grid Access Read Write Type VT_BOOL or Boolean ...

Page 151: ...ems 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 Access Read Only Type VT_DISPATCH or Application object DatabaseVariables Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Object Properties ...

Page 152: ...ric 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 DatabaseVariables 1 Object DatabaseVariables Item 1 DatabaseVariables Remov...

Page 153: ...ems 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 Access Read Only Type VT_DISPATCH or Application object FormVariables Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Object Properties ...

Page 154: ... 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 FormVariables 1 Object FormVariables Item 1 FormVariables Remove VTS...

Page 155: ...d Only Type VT_DISPATCH or Application object Strings Count Returns the number of items in the specified collection Access Read Only Type VT_I2 or Integer Strings Parent Returns the parent object of the specified object Access Read Only Type VT_DISPATCH Strings Add VTS_NONE Add strStringValue Adds a new string to the collection Parameters strStringValue Required VT_BSTR or String Specifies the str...

Page 156: ... 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 Strings 1 Object Strings Item 1 Strings Remove VTS_NONE Remove longIndex Removes a member from the coll...

Page 157: ...ng Name of the document starting to print Document Change VTS_NONE Change Informs the user of a change in the document User is invited to save or save as the current document Document ProgressPrinting VTS_NONE ProgressPrinting LabelPercent refCancel Informs the user of the printing progress for the current document Parameters LabelPercent VT_I2 or Integer Percent value of the printing of the curre...

Page 158: ...cument PausedPrinting VTS_NONE PausedPrinting Reason refCancel Informs the user of a problem during printing process for the current document Reason VT_I2 or Integer or enumPausedReasonPrinting type Reason for the end of the process The value can be one of the following lppxGenericError 0 lppxNoPaper 2 lppxNoRibbon 3 lppxPortNotAvailable 4 lppxPrinterNotReady 5 lppxCommunicationError 6 lppxHeadLif...

Page 159: ...n ApplicationEvent Quit VTS_NONE Quit Informs users when someone quits the application with Application Quit method or if the user has manually closed the application ApplicationEvent DocumentClosed VTS_NONE DocumentClosed strDocTitle Informs that the document with title strDocTitle has been closed Parameters strDocTitle VT_BSTR or String Title of the document closed Object Methods ...

Page 160: ...ation 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 V T P S Value VT_EMPTY nothing VT_NUL SQL style Null VT_I2 2 byte signed int VT_I4 4 byte signed int VT_R4 4 byte real VT_R8 8 byte real VT_CY currency VT_DATE date VT_BSTR OLE Automation string VT_DISPATCH IDispatch VT_ERROR SCODE 3 ...

Page 161: ...T signed machine int VT_UINT unsigned machine int VT_VOID C style void VT_HRESULT Standard return type VT_PTR pointer type VT_SAFEARRAY use VT_ARRAY in VARIANT VT_CARRAY C style array VT_USERDEFINED user defined type VT_LPSTR null terminated string VT_LPWSTR wide null terminated string VT_FILETIME FILETIME VT_BLOB Length prefixed bytes VT_STREAM Name of the stream follows VT_STORAGE Name of the st...

Page 162: ... 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 use Note VT data type of variable or function parameters VTS data type of the function return value ...

Page 163: ...apter 2 135 Counters Collection Chapter 2 133 Create Object function Chapter 1 4 D Data Type Chapter 1 8 Database Object Chapter 2 54 DatabaseVariables Collection Chapter 2 143 Date Object Chapter 2 131 Dates Collection Chapter 2 129 Dialog Object Chapter 2 36 Dialogs Collection Chapter 2 34 DocObject Object Chapter 2 76 DocObjects Collection Chapter 2 72 Document Chapter 1 2 Chapter 1 4 Document ...

Page 164: ...er 1 3 M Mechanisms Chapter 1 4 Methods Chapter 1 2 N New function Chapter 1 6 O OLEObject Object Chapter 2 106 OLEObjects Collection Chapter 2 104 Options Object Chapter 2 29 P Printer Object Chapter 2 58 PrinterSystem Object Chapter 2 26 Properties Chapter 1 2 Q Quit method Chapter 1 4 Chapter 1 8 R RecentFile Object Chapter 2 41 RecentFiles Collection Chapter 2 38 S Server Activation Chapter 1 ...

Page 165: ...Index Chapitre 4 157 V Variable Object Chapter 2 118 Variables Collection Chapter 2 114 W WithEvents keyword Chapter 1 11 WithEvents variables Chapter 1 11 ...

Search results

Summary of Contents for Discover ActiveX

Reviews:

Related manuals for Discover ActiveX

Brands by name

Popular brands

Teklynx Discover ActiveX, Programmer'S Manual

Search results

Summary of Contents for Discover ActiveX

Reviews:

Related manuals for Discover ActiveX

Brands by name

Popular brands