Rocket wintegrate. Object Model Reference. Version December 2017 WIN-642-OM-RM-01

Transcription

1 Rocket wintegrate Object Model Reference Version December 2017 WIN-642-OM-RM-01

2 Notices Edition Publication date: December 2017 Book number: WIN-642-OM-RM-01 Product version: Version Copyright Rocket Software, Inc. or its affiliates All Rights Reserved. Trademarks Rocket is a registered trademark of Rocket Software, Inc. For a list of Rocket registered trademarks go to: All other products or services mentioned in this document may be covered by the trademarks, service marks, or product names of their respective owners. Examples This information might contain examples of data and reports. The examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. License agreement This software and the associated documentation are proprietary and confidential to Rocket Software, Inc. or its affiliates, are furnished under license, and may be used and copied only in accordance with the terms of such license. Note: This product may contain encryption technology. Many countries prohibit or restrict the use, import, or export of encryption technologies, and current use, import, and export regulations should be followed when exporting this product. 2

3 Corporate information Rocket Software, Inc. develops enterprise infrastructure products in four key areas: storage, networks, and compliance; database servers and tools; business information and analytics; and application development, integration, and modernization. Website: Rocket Global Headquarters 77 4 th Avenue, Suite 100 Waltham, MA USA To contact Rocket Software by telephone for any reason, including obtaining pre-sales information and technical support, use one of the following telephone numbers. Country Toll-free telephone number United States Australia Belgium Canada China France Germany Italy Japan Netherlands New Zealand South Africa United Kingdom Contacting Technical Support The Rocket Community is the primary method of obtaining support. If you have current support and maintenance agreements with Rocket Software, you can access the Rocket Community and report a problem, download an update, or read answers to FAQs. To log in to the Rocket Community or to request a Rocket Community account, go to In addition to using the Rocket Community to obtain support, you can use one of the telephone numbers that are listed above or send an to support@rocketsoftware.com. 3

4 Contents Notices... 2 Corporate information... 3 Chapter 1: wintegrate overview... 9 wintegrate features... 9 Chapter 2: Objects Application AutoBridgeRx...11 AutoBridgeTx...11 AutoData...11 AutoFileTransfer...11 AutoImportTarget AutoWindow Capture DataWatch DisplayArea...14 DockBar HotSpot...15 HotSpots Selection Trigger...20 Triggers Chapter 3: Properties AlwaysOnTop...22 AppName ()...22 AppTitle () Attribute...23 Attributes BackColor (HotSpot)...24 BackColor (HotSpots) Bottom Busy () Caption CaretPosition...26 CaretShape CommandBars...27 ContainerFlags ()...27 Count (Capture) Count (HotSpots) Count (Triggers) DisplayHorizontalScrollBar DisplayOn DisplayStatusBar...29 DisplayUpdate...29 DisplayVerticalScrollBar Enabled...30 FileName...30 ForeColor (HotSpot) ForeColor (HotSpots)...31 FoundCount

5 Contents FullName () Height...32 HotSpots Id (DockBar) Id () Index Information...34 Item (HotSpots)...34 Item (Triggers)...35 Left Length MouseIcon MousePointer MousePosition...36 Name () Pattern Paused RequiredHeight (DockBar) Right...38 Running...39 ScreenArea...39 ScrollArea (DisplayArea) ScrollArea (Window) Selected Selection Setting...41 SettingsDialog StatusBarText...42 Style (HotSpot)...42 Style (HotSpots) Text (Capture) Text (DataWatch) Text (DisplayArea)...44 Text (Selection) Text (Window) TextFormat Top Triggers Type (Selection) Type (Trigger)...47 Variable...47 Version Visible...48 WHeight ()...48 WLeft ()...48 WState () WTop () WWidth () Width...50 Window WindowState Word...51 hwnd () Chapter 4: Methods AboutBox ()

6 Contents Add (HotSpots)...53 Add (Triggers)...54 AppendText AttachDockBar () AttributeFill...55 Box CanExit () CanRestore ()...57 Capture CharacterFill Clear (Capture)...58 Clear (Selection)...58 Continue Copy Copy ()...59 CopySpecial () DataWatch DisplayArea...61 DisplayAttribute DisplayCommand...62 DisplayText Exit () Extension ()...63 GetScript ()...63 Inflate...64 InvokeDialog...64 MoveCaret...65 Open () OpenScript () Paste ()...66 Pause Quit Remove RemoveAll...67 Resize RunScriptCommand RunScriptFile Save () ScrollAll () ScrollLine ()...70 ScrollPage () Select SelectAll SelectWindow...71 Send SetEnd...72 SetStart...73 SetStatusBar () SetupOpen () SetupSave () ShowDialog...74 SnapToSize () Start Stop...75 StoreSetting...76 UpdateSettings

7 Contents Chapter 5: Events...78 About () Another ()...78 CaptionChanged () Change Click...78 DblClick...79 Exit () Found Full HeightChanged (DockBar)...79 Open () Opened () RequestAlwaysOnTop () RequestEnable ()...81 RequestLockSize ()...81 RequestResize ()...81 RequireDockBar ()...82 Save () SaveAs () ShowStatusBar () Chapter 6: Enumerations wattributetypeenum...84 wboxstyleenum wcaptureformatenum wcaptureoptionsenum wcapturetargetenum wcapturetextformatenum...86 wcaretshapeenum wcursorshapeenum wdisplayupdateenum whotspotstyleenum...88 wmousepositionenum wpositionenum wscrollareaenum...89 wselectionformatenum wselectioninfoenum...90 wselectiontextenum wselectiontypeenum wsendoptionsenum wtextcolorenum...91 wtexteffectenum wtextformatenum wtextlayoutenum wtriggertypeenum...93 wwindowstateenum wwordoptionsenum...94 Chapter 7: Accessing the object model...95 Overview of the main objects in the object model Examples Setting the show state of the application Setting up the Retrieving text from the screen Displaying text on the screen Finding out when part of the screen changes

8 Contents Sending data to the host Retrieving and recording data sent from the host...98 Waiting for a specific piece of data to be received Appendix A: Serial control Appendix B: Windows Sockets control

9 Chapter 1: wintegrate overview wintegrate is a connectivity tool that integrates host-based applications with the desktop. The initial interface is a terminal emulator with data transfer features designed for the multi-valued environments of UniVerse, UniData, D3, and mvbase. You can share data with popular Windows applications, including Microsoft Word and Excel. For developers, a comprehensive programming language enables a range of options for integrating host environments with the desktop. You can add GUI features incrementally or create full GUI applications driven from the host. A suite of host-based subroutines is supplied to control the PC. These subroutines are created for multi-valued environments, but the techniques used can be adapted to any host. Developer tools include the Editor and a Tools menu with useful utilities. You can choose to display the Tools menu in Setup > Preferences. Select the Scripts tab and then use the Menu Bar Script drop-down list. wintegrate features All wintegrate features are supported with Rocket s UniVerse, UniData, D3, and mvbase databases. With wintegrate, you can do the following tasks: Run concurrent sessions Customize a wintegrate session Control any aspect of the application using powerful scripting language Optionally deploy a thin client on Windows or Java Run scripts from supplied host-based subroutines Define terminal emulations Export files from your PC to a host computer Import host computer files to your PC Transfer files from one host computer to another host computer Simplify deployment through optional thin client and browser interfaces 9

10 Chapter 2: Objects This section describes the objects in the object model. Creating a document object or getting a document object from a wintegrate configuration file returns an Application object. The object for a wintegrate session control is the object. This can also be retrieved through the property of the Application object. The following shows the object model hierarchy: Application AutoWindow DisplayArea Application HotSpots HotSpot Selection Triggers Trigger Capture DataWatch This object represents a wintegrate application. Properties The following table describes the properties for the Application object: Property AlwaysOnTop Caption DisplayStatusBar Height Left StatusBarText Top Version Visible Width WindowState R Represents the caption or title text of a wintegrate object Represents the visible state of a wintegrate application window status bar Represents the height of a wintegrate object Represents the horizontal position of a wintegrate object Returns the object associated with a wintegrate application Represents the text associated with a wintegrate application window status bar Represents the vertical position of a wintegrate object Returns the wintegrate version number Represents the visible state of a wintegrate object Represents the width of a wintegrate object Represents the window state of a wintegrate application window, such as maximized or minimized Methods The following table describes the methods for the Application object: Method Quit Resize Quits wintegrate Resizes a wintegrate application window 10

11 AutoBridgeRx AutoBridgeRx This object is for internal use only and is subject to change. Do not use. AutoBridgeTx AutoData This object is for internal use only and is subject to change. Do not use. This object is for internal use only and is subject to change. Do not use. AutoFileTransfer This object is for internal use only and is subject to change. Do not use. AutoImportTarget This object is for internal use only and is subject to change. Do not use. AutoWindow This object represents a wintegrate session window. Only one window object per wintegrate session can exist. Properties The following table describes the properties for the AutoWindow object: Property Attribute Attributes Caption CaretPosition CaretShape DisplayHorizontalScrollBar Returns the text attribute at a specified location within a wintegrate session window Returns the text attribute at a specified location within a wintegrate session window Represents the caption or title text of a wintegrate object Represents the position of the text cursor or caret Represents the shape of the text cursor or caret Represents the visible state of a wintegrate session window horizontal scroll bar 11

12 Chapter 2: Objects Property DisplayOn DisplayUpdate DisplayVerticalScrollBar Enabled MouseIcon MousePointer MousePosition ScreenArea ScrollArea (Window) Text (Window) Word Represents the display state of a Window object Represents the update state of the Window object Represents the visible state of a wintegrate session window vertical scroll bar Represents the active state of a wintegrate object Represents the shape of the custom mouse cursor associated with a wintegrate session window Represents the shape of the mouse cursor associated with a wintegrate session window Represents the position of the mouse cursor when over a wintegrate session window Returns a DisplayArea object that covers the entire display screen of the Window object Returns a DisplayArea object that covers the area of the Window object in which text will scroll Returns the text at a specified location within a wintegrate session window Returns the word or highlighted character of the word at a specified location within the wintegrate session window Methods The following table describes the methods for the AutoWindow object: Method DisplayArea DisplayAttribute DisplayCommand DisplayText MoveCaret Creates a new DisplayArea object that represents a rectangular section of the Window object Sets the terminal emulation text attribute at the current text cursor or caret position in a wintegrate session window Runs the emulation command specified Displays text in a wintegrate session window at the current text cursor or caret position Moves the text caret to the new column and row See Also Window Capture This object represents a Capture object that is associated with a wintegrate session. wintegrate sessions can have many Capture objects. A new Capture object is created using the capture method. When a capture object is created, a buffer size is used. When the amount of data reaches the buffer size, the Full event is generated, and the buffer is cleared (unless the wcaptureoptionsshift option was specified). 12

13 DataWatch Properties The following table describes the properties for the Capture object: Property Count (Capture) FileName Length Paused Running Text (Capture) TextFormat Describes the amount of data currently captured in a wintegrate capture object Represents the name of the file that receives captured data for a wintegrate capture object Describes the amount of data to capture for a wintegrate capture object Represents the paused state of a capture object Represents the running state of a capture object Represents the text in a wintegrate capture object Represents the format that the text in a wintegrate capture object should be returned Methods The following table describes the methods for the Capture object: Method AppendText Clear (Capture) Continue Pause Start Stop Appends text to the data recorded in a Capture object Removes or clears all captured data from a wintegrate Capture object Continues a capture after is has been paused with the Pause method of a wintegrate Capture object Pauses a capture Starts a Capture object recording Stops the recording for a Capture object Events The following table describes the events for the Capture object: Event Full Called when a wintegrate capture object is full of data See Also Capture DataWatch This object represents a DataWatch object that is associated with a wintegrate session, which fires an event whenever the specified text is received from the host. wintegrate sessions can have many DataWatch objects. A new DataWatch object is created using the DataWatch method. Properties The following table describes the properties for the DataWatch object: 13

14 Chapter 2: Objects Property Enabled FoundCount Text (DataWatch) Represents the active state of a wintegrate object Represents the number of times the text in a DataWatch object is found Represents the text to be found in a wintegrate DataWatch object Events The following table describes the events for the DataWatch object: Event Found Called when a wintegrate DataWatch object matches its text against the incoming data from the host See Also DataWatch DisplayArea This object represents a rectangular area of the wintegrate window. Properties The following table describes the properties for the DisplayArea object: Property Bottom Height Left Right ScrollArea (DisplayArea) Text (DisplayArea) Top Width Represents the bottom vertical position of a wintegrate object Represents the height of a wintegrate object Represents the horizontal position of a wintegrate object Represents the horizontal position of the right edge of a wintegrate object Represents the scroll area type of a display area object Returns all the text within a display area object Represents the vertical position of a wintegrate object Represents the width of a wintegrate object Methods The following table describes the methods for the DisplayArea object: Method AttributeFill Box CharacterFill Inflate Fills the area of the Window represented by a DisplayArea object with the specified attribute Draws a box in the rectangle area defined by a DisplayArea object Fills the area of a DisplayArea object with the specified character Increases the size of a DisplayArea object by adding an amount to its sides 14

15 DockBar See Also DockBar DisplayArea, ScrollArea (Window) This object is used with the session control in a third-party container, for example, a web page. By linking the docking bar control to the session with the session control s AttachDockBar method, the docking bar is populated with the menus and toolbars that are defined by the session or with script commands. The DockBar object is the interface for the wintegrate DockBar control. Properties The following table describes the properties for the DockBar object: Property Id (DockBar) RequiredHeight (DockBar) Provides the identifier required for the AttachDockBar method on the session object Returns the minimum height required for the docking bar to show all the toolbars currently on it Events The following table describes the events for the DockBar object: Event HeightChanged (DockBar) Occurs when a toolbar is added or removed from a docking bar Version Supported See Also HotSpot AttachDockBar () This object represents a HotSpot object in a wintegrate session. wintegrate sessions can have many HotSpot objects that are maintained by a HotSpots collection object. Properties The following table describes the properties for the HotSpot object: Property BackColor (HotSpot) ForeColor (HotSpot) R Represents the foreground color of a wintegrate HotSpot 15

16 Chapter 2: Objects Property Index Style (HotSpot) Left Top Width Height Represents the index of a wintegrate object within a collection Represents the style of a wintegrate HotSpot object Represents the horizontal position of a wintegrate object Represents the vertical position of a wintegrate object Represents the width of a wintegrate object Represents the height of a wintegrate object Events The following table describes the events for the HotSpot object: Event Click DblClick Called when a wintegrate object is clicked Called when a wintegrate object is double-clicked See Also HotSpots HotSpots, Add (HotSpots), Item (HotSpots) This object represents a collection of HotSpot objects in a wintegrate session window. Only one HotSpots object is allowed in a wintegrate session, and one is always associated with a session. There is no need to create the object. Properties The following table describes the properties for the HotSpots object: Property BackColor (HotSpots) Count (HotSpots) Enabled ForeColor (HotSpots) Item (HotSpots) Style (HotSpots) R Represents the number of items in a collection of HotSpot objects Represents the active state of a wintegrate object Represents the foreground color of a HotSpots collection object Represents a HotSpot item in a HotSpots collection Represents the style of a HotSpots collection object Methods The following table describes the methods for the HotSpots object: Method Add (HotSpots) Remove RemoveAll Adds a new hot spot to a wintegrate session Removes a specific object from a collection of wintegrate objects Removes all objects from a collection of wintegrate objects 16

17 Selection See Also Selection HotSpots, HotSpot This object represents a selected or highlighted area of a wintegrate session window. Only one Selection object is allowed in a wintegrate session, and one is always associated with a session. There is no need to create the object. Properties The following table describes the properties for the Selection object: Property Information Selected Text (Selection) Type (Selection) Returns information about a Selection Specifies whether an area has been highlighted by a selection or not Represents the text highlighted by a selection Describes the type of a selection Methods The following table describes the methods for the Selection object: Method Clear (Selection) Copy Select SelectAll SelectWindow SetStart SetEnd Clears or removes the highlighted area of a Selection object Copies the text associated with a Selection object to the clipboard Selects an area of a wintegrate session window Selects all of the data in the current screen and backpage memory of the current session Selects all of the visible data in a wintegrate session window Sets the start position Sets the end position This object represents a wintegrate session. Only one object is allowed in a wintegrate application, and one is always associated with an application. There is no need to create the object. The events from the object are used as a session control inside a container application. They are mainly requests from the session control for services that must be controlled or implemented by the container. Properties The following table describes the properties for the object: Property AppName () The name of the executable containing the session control 17

18 Chapter 2: Objects Property AppTitle () Busy () CommandBars ContainerFlags () FullName () HotSpots Id () Name () Selection Setting SettingsDialog Triggers Variable WHeight () WLeft () WState () WTop () WWidth () Window Version hwnd () The title of the application Returns non-zero if the session is busy Reserved Controls how the session control deals with the File and Exit handling when used in another application Full name of the file that opened this session Returns the HotSpots object associated with a wintegrate session The numeric ID for the session Represents the internal name of a wintegrate session Returns the selection object associated with a wintegrate session Allows the setting of variables that are saved in a wintegrate session or the variable associated with a dialog to be set or interrogated Represents the name of the wintegrate dialog to use with the Setting property or StoreSetting method Returns the triggers object associated with a wintegrate session Represents the global script variable The session s internal height The session s internal left position The session s internal show state The session s internal top position The session s internal width Returns the window object associated with a wintegrate session Returns the wintegrate version number The Windows window handle of the session Methods The following table describes the methods for the object: Method AboutBox () AttachDockBar () CanExit () CanRestore () Capture Copy () CopySpecial () DataWatch Exit () Extension () GetScript () Shows the session control About box Used in an external container application, for example, to attach a docking bar control to a session Internal method to check if the session can exit Checks if it is OK to restore the session from minimized Creates a new Capture object to record data from the wintegrate session Copies the current selection to the clipboard Copies the current Selection object to the clipboard using the format defined in the Edit > Copy Special to menu option Creates a new DataWatch object that fires an event when the specified text is received from the host Asks the session to exit An internal method to return an extension Creates and returns a string that contains the session configuration script 18

19 Method InvokeDialog Open () OpenScript () Paste () RunScriptCommand RunScriptFile Save () ScrollAll () ScrollLine () ScrollPage () Send SetStatusBar () SetupOpen () SetupSave () ShowDialog SnapToSize () StoreSetting UpdateSettings Invokes the functionality behind a dialog box Opens a script file Runs a session configuration script file on the current session, using the received script text Pastes data from clipboard to the session window Runs a wintegrate script command Runs a wintegrate script file Saves session parameters as a script Scrolls the display to the top or the bottom of the backpage memory Scrolls the display back or forward one line Scrolls the display up or down one page Sends data to a remote host as if the user had typed the data in a wintegrate session The internal method to setup the status bar Shows the open dialog box Shows the save as dialog box Displays a dialog box Internal method to implement snap to size Allows the value session setting variable to be stored for update by a following UpdateSettings command Updates all of the session settings that have been stored by the StoreSetting method at once Events The following table describes the events for the object: Event About () Another () CaptionChanged () Exit () Open () Opened () RequestAlwaysOnTop () RequestEnable () RequestLockSize () RequestResize () RequireDockBar () Requests that the container of a session control shows its About dialog box Fired when the user selects the File > Another menu option or runs it through a script Fired whenever the session title changes Sent when the Exit or Exit all menu options are selected or are ran through the script language Sent by the session control when the File > Open menu option is selected or is ran through a script Obsolete and no longer generated by the session control Fired when the session control is set to be always-on-top through the menus or script language Fired through the session control when a script command wants the entire container application to be enabled or disabled Requests that the container does not allow the user to change its size Sent from the session control to request that it is moved, resized, or changed its state Internal event requesting a docking bar 19

20 Chapter 2: Objects Event Save () SaveAs () ShowStatusBar () Runs when the File > Save menu option or script command is run to request that the container of the session control saves its configuration Runs when the File > Save As menu option is selected or run from a script to request the container of the session control to save the configuration with the specified file name Requests that a status bar is shown Version ContainerFlags property added See Also Trigger This object represents a Trigger object in a wintegrate session. A trigger causes a notification event when received data changes. Many Trigger objects can exist in a wintegrate session. They are maintained by a Trigger s collection object. Properties The following table describes the properties for the Trigger object: Property Height Left Pattern Top Type (Trigger) Width Represents the height of a wintegrate object Represents the horizontal position of a wintegrate object Represents the pattern or text monitored by a wintegrate trigger object Represents the vertical position of a wintegrate object Describes the type of a wintegrate trigger object Represents the width of a wintegrate object Events The following table describes the events for the Trigger object: Event Change Called when the data associated with a wintegrate trigger changes See Also Triggers Triggers, Add (Triggers), Item (Triggers) This object represents a collection of Trigger objects in a wintegrate session. A trigger causes a notification event when received data changes. 20

21 Triggers Only one Triggers object can exist for a wintegrate session. Properties The following table describes the properties for the Triggers object: Property Count (Triggers) Item (Triggers) Represents the number of items in a collection of Trigger objects Represents a trigger item in a Triggers collection Methods The following table describes the methods for the Triggers object: Method Add (Triggers) Adds a new Trigger object to a wintegrate session 21

22 Chapter 3: Properties This section contains a list of the properties in the object model. AlwaysOnTop This property represents the always-on-top state of a wintegrate application window. When the wintegrate application window is always-on-top, all other windows appear behind it. AlwaysOnTop Read/Write Boolean. The always-on-top state of the session window. Application AppName () This property is the name of the executable containing the session control. This property should only be set by applications that contain the session control. It is not required that this property is set. AppName Read/Write String. Name of the executable for the application. AppTitle () This property is the title of the application. This property should only be set by applications that contain the session control. It is used in the script language or in message boxes where the application name is displayed. AppTitle 22

23 Attribute Read/Write String. The title of the application. Attribute This property returns the text attribute at a specified location within a wintegrate session window. If any of the Left, Top, and Page arguments are omitted, their values are those of the current text cursor or caret position. If all of them are omitted, the current attribute is returned. In other words, the attribute that is applied to the next text character is displayed. Rows and columns start at 0. The top left of a wintegrate session window is row 0, column 0. The current page is 0, the previous page is 1, the page before that is 2, and so on. Attribute Type, [Left], [Top], [Page] The following table describes the parameters of the Attribute property: Parameter Type Type wattributetypeenum The attribute type Left Variant or Long The column number of the attribute (default: 0) Top Variant or Long The row number of the attribute (default: 0) Page Variant or Long The page number of the attribute (default: the first page) Read-only Long. The required text attribute. AutoWindow Attributes This property returns the text attribute at a specified location within a wintegrate session window. Rows and columns start at 0. The top left of a wintegrate session window is row 0, column 0. The current page is 0, the previous page is 1, the page before that is 2, and so on. Attributes Type, [Left], [Top], [Right], [Bottom], [Layout], [StartPage], [EndPage] 23

24 Chapter 3: Properties The following table describes the parameters of the Attributes property: Parameter Type Type wattributetypeenum The attribute type Left Variant or Long The column number of the top left of the associated text (default: 0) Top Variant or Long The row number of the top left of the associated text (default: 0) Right Variant or Long The column number of the bottom right of the associated text (default: the right of the session window) Bottom Variant or Long The row number of the bottom right of the associated text (default: the bottom of the session window) Layout Variant or wtextlayoutenum The layout of the associated text (default: wtextlayoutlines) StartPage Variant or Long The page number of the top left of the associated text (default: the first page) EndPage Variant or Long The page number of the bottom right of the associated text (default: 0) Read-only Long Array. The required text attributes. AutoWindow BackColor (HotSpot) This property represents the background color of a wintegrate HotSpot object. The color cannot be applied to an object if its style does not allow it. See Style (HotSpot), on page 42. BackColor Read/Write wtextcolorenum. A value representing a color. HotSpot BackColor (HotSpots) This property represents the default background color of a HotSpots collection object. It applies to all HotSpot objects in the HotSpots collection that do not have an individual style. 24

25 Bottom Bottom The color is only applied to the hot spot when the style allows it. See Style (HotSpots), on page 43. BackColor Read/Write wtextcolorenum. A value representing a color. HotSpots This property represents the bottom vertical position of a wintegrate object. Bottom Read/Write Long. The vertical position of the object in pixels. DisplayArea Busy () Caption This property returns non-zero if the session is busy. Currently, this property checks if a file transfer is in progress. Busy Read-only Boolean. True if the session object is busy. This property represents the caption or title text of a wintegrate object. 25

26 Chapter 3: Properties When this property is set, the special characters from the Setup > Preference dialog box for the title can be used to represent the current port name, number, and more. When this property is retrieved, the caption includes the current value of these parameters. Caption Read/Write String. The caption text. Application, AutoWindow CaretPosition This property represents the position of the text cursor or caret. CaretPosition Plane The following table describes the parameters of the CaretPosition property: Parameter Type Plane wpositionenum The plane of the caret position Read/Write Long. The caret position. AutoWindow CaretShape This property represents the shape of the text cursor or caret. CaretShape Read/Write wcaretshapeenum. The caret shape. 26

27 CommandBars AutoWindow CommandBars This property is reserved for future use. It currently returns a null object. CommandBars ContainerFlags () This property controls how the session control deals with the File and Exit handling when used in another application. By default, these menu options send an event to the container so that it can process these menu options itself. These flags allow the session control to process these options. ContainerFlags Read/Write Long. Sets the File menu options that are handled by the session control. The value is either 0 to let the container handle the menu options, or a combination of one or more of the following: 1 - File Open 2 - File Another 4 - File Save As 8 - File Save 16 - File Exit/Exit All Version 5.2 Original version Count (Capture) This property describes the amount of data currently captured in a wintegrate capture object. 27

28 Chapter 3: Properties Count Read-only Long. The amount of data captured. Capture Count (HotSpots) This property represents the number of items in a collection of HotSpot objects. Count Read-only Short. The number of items in the collection. HotSpots Count (Triggers) This property represents the number of items in a collection of Trigger objects. Count Read-only Long. The number of items in the collection. Triggers DisplayHorizontalScrollBar This property represents the visible state of a wintegrate session window horizontal scroll bar. DisplayHorizontalScrollBar 28

29 DisplayOn Read/Write Boolean. The session window horizontal scroll bar display state. AutoWindow DisplayOn This property represents the display state of a Window object. When the display is turned off, the contents of the window are hidden. DisplayOn Read/Write Boolean. The display state. AutoWindow DisplayStatusBar This property represents the visible state of a wintegrate application window status bar. DisplayStatusBar Read/Write Boolean. The session window status bar display state. Application DisplayUpdate This property represents the update state of the Window object. This allows the update of the display to be temporarily stopped to decrease screen flashing. The DisplayUpdate property should only be turned off for short periods of time. DisplayUpdate 29

30 Chapter 3: Properties Read/Write wdisplayupdateenum. The update state. AutoWindow DisplayVerticalScrollBar This property represents the visible state of a wintegrate session window vertical scroll bar. DisplayVerticalScrollBar Read/Write Boolean. The session window vertical scroll bar display state. Enabled AutoWindow This property represents the active state of a wintegrate object. For a window object, the state is active when output appears in the window and inactive when no output appears. Enabled Read/Write Boolean. The active state. FileName AutoWindow, DataWatch, HotSpots This property represents the name of the file that receives captured data for a wintegrate capture object. The capture target must be set to wcapturetargetfile for capturing data to a file. FileName 30

31 ForeColor (HotSpot) Read-only String. The capture data file name. Capture ForeColor (HotSpot) This property represents the foreground color of a wintegrate HotSpot. The color cannot be applied to an object if its style does not allow it. See Style (HotSpot), on page 42. ForeColor Read/Write wtextcolorenum. A value representing a color. HotSpot ForeColor (HotSpots) This property represents the foreground color of a HotSpots collection object. It applies to all HotSpot objects in the HotSpots collection that use the default style. The color cannot be applied to an object if its style does not allow it. See Style (HotSpots), on page 43. ForeColor Read/Write wtextcolorenum. A value representing a color. HotSpots FoundCount This property represents the number of times the text in a DataWatch object is found. The count is automatically reset to zero if a disabled DataWatch object is then enabled. 31

32 Chapter 3: Properties FoundCount Read/Write Long. The number of times the text from the DataWatch object is found. DataWatch FullName () Height HotSpots This property is the full name of the file that opened this session. Setting this property only changes the name internally. FullName Read/Write String. Full name of the file that opened this session. This property represents the height of a wintegrate object. Height Read/Write Long. The height of the object in pixels. Application, DisplayArea, HotSpot, Trigger This property returns the HotSpots object associated with a wintegrate session. HotSpots 32

33 Id (DockBar) Read-only HotSpots. The HotSpots object. Id (DockBar) This property provides the identifier required for the AttachDockBar method on the session object. Id DockBar Version First supported Id () Index This property is the numeric ID for the session. Each session is assigned a unique ID. Id Read-only Long. The ID for the session. This property represents the index of a wintegrate object within a collection. The index can change during the lifetime of the object as other objects are added to or removed from the collection. Index 33

34 Chapter 3: Properties Read-only Long. The index of the object. Capture, HotSpot Information This property returns information about a Selection. The information depends on the specified argument. Information Type The following table describes the parameters of the Information property: Parameter Type Type wselectioninfoenum The type of information that is required Read-only Variant. The required information. The actual value type depends on the Type argument. Selection Item (HotSpots) This property represents a HotSpot item in a HotSpots collection. This is the default property of the HotSpots collection. Item Index The following table describes the parameters of the Item property: Parameter Type Index Variant or Long The index of the item required Read-only HotSpot. The required collection item. 34

35 Item (Triggers) HotSpots Item (Triggers) Left This property represents a trigger item in a Triggers collection. This is the default property for the Triggers collection. Item Index The following table describes the parameters of the Item property: Parameter Type Index Variant or Long The index of the item required Read-only Trigger. The required collection item. Triggers This property represents the horizontal position of a wintegrate object. Left Length Read/Write Long. The horizontal position of the object in pixels. Application, DisplayArea, HotSpot, Trigger This property describes the amount of data to capture for a wintegrate capture object. When the amount of data received reaches the length, a Full event is generated. 35

36 Chapter 3: Properties Length Read-only Long. The capture data length. Capture MouseIcon This property represents the shape of the custom mouse cursor associated with a wintegrate session window. Custom cursors can be defined and stored in a file that should be called wcursor.dll and placed in the wintegrate folder. All the custom cursors should be given names; these names are used to set the mouse cursor shape. To set the mouse cursor to a custom cursor shape, set the MouseIcon property to the required cursor then set the MousePointer property to the custom cursor value. MouseIcon Read/Write String. The name of the custom mouse cursor shape. AutoWindow MousePointer This property represents the shape of the mouse cursor associated with a wintegrate session window. It can be used to set the mouse cursor to one of the standard Windows shapes or, with the MouseIcon property, a custom shape. MousePointer Read/Write wcursorshapeenum. The mouse cursor shape. AutoWindow MousePosition This property represents the position of the mouse cursor when over a wintegrate session window. 36

37 Name () MousePosition Parameter The following table describes the parameters of the MousePosition property: Parameter Type Parameter wmousepositionenum The mouse position information required Read-only Long. The required information. AutoWindow Name () This property represents the internal name of a wintegrate session. wintegrate ensures that each session has a unique name. Although the property can be changed, doing so is not recommended. Name Read/Write String. wintegrate session internal name. Pattern This property represents the pattern or text monitored by a wintegrate trigger object. For trigger types that do not include a pattern or text, an empty string is returned. Pattern Read-only String. The monitored text. Trigger 37

38 Chapter 3: Properties Paused This property represents the paused state of a capture object. Paused Read-only Boolean. The paused state of the capture. Capture RequiredHeight (DockBar) Right This property returns the minimum height required for the docking bar to show all the toolbars currently on it. It is usually used on the receipt of a HeightChanged event from the docking bar to find out the best height to resize the docking bar to. RequiredHeight DockBar Version Added This property represents the horizontal position of the right edge of a wintegrate object. Right Read/Write Long. The horizontal position of the object in pixels. DisplayArea 38

39 Running Running This property represents the running state of a capture object. Running Read-only Boolean. The running state of the capture. Capture ScreenArea This property returns a DisplayArea object that covers the entire display screen of the Window object. ScreenArea Read-only DisplayArea. The DisplayArea object that covers the screen area. AutoWindow Examples The following example puts a border around the edge of the screen region..window.screenarea.box wboxstylesingleborder ScrollArea (DisplayArea) This property represents the scroll area type of a display area object. Only one scroll area can exist, so setting a new scroll area cancels an existing one. The scroll area is linked to the area of the screen, so moving or resizing the DisplayArea object can change this property. ScrollArea Read/Write wscrollareaenum. The type of the scroll area. 39

40 Chapter 3: Properties DisplayArea ScrollArea (Window) This property returns a DisplayArea object that covers the area of the Window object in which text will scroll. ScrollArea Read-only DisplayArea. The DisplayArea object that covers the scroll area AutoWindow Examples The following example clears the current scroll region..window.scrollarea.scrollarea = wscrollareano Selected Selection This property specifies whether an area has been highlighted by a selection or not. Selected Read-only Boolean. The selected state. Selection This property returns the selection object associated with a wintegrate session. Selection 40

41 Read-only Selection. The selection object. This property returns the object associated with a wintegrate application. Setting Read-only. The session object Application This property allows the setting of variables that are saved in a wintegrate session or the variable associated with a dialog to be set or interrogated. The SettingsDialog property can be used to specify the dialog to use. To see the available dialog menu option names, see the information about script menu options in the Client Scripting Reference. Setting Name The following table describes the parameters of the Setting property: Parameter Type Name String The name of the setting to use Read/Write String. The value of the setting. 41

42 Chapter 3: Properties Examples The following example sets the emulation to VT100. wapp..setting("emulation") = "vt100" SettingsDialog This property represents the name of the wintegrate dialog to use with the Setting property or StoreSetting method. For global session variables, this value does not need to be set. To see the available dialog menu option names, see the information about script menu options in the Client Scripting Reference. SettingsDialog Read/Write String. wintegrate dialog name. StatusBarText This property represents the text associated with a wintegrate application window status bar. StatusBarText Read/Write String. The session window status bar text. Application Style (HotSpot) This property represents the style of a wintegrate HotSpot object. Style 42

43 Style (HotSpots) Read/Write whotspotstyleenum. A value representing a HotSpot style. HotSpot Style (HotSpots) This property represents the style of a HotSpots collection object. It applies to all HotSpot objects in the HotSpots collection. Style Read/Write whotspotstyleenum. A value representing a HotSpot style. HotSpots Text (Capture) This property represents the text in a wintegrate capture object. The format that the text is returned in can be specified using the TextFormat property. The default format strips out character zero from the returned text. Text Read-only String. The captured text. Capture Text (DataWatch) This property represents the text to be found in a wintegrate DataWatch object. Text 43

44 Chapter 3: Properties Read-only String. The text that is watched for. DataWatch Text (DisplayArea) This property returns all the text within a display area object. Text [Format] The following table describes the parameters of the Text property: Parameter Type Format wtextformatenum The format of the required text (default: wtextformatnone) Read-only String. The required text. DisplayArea Text (Selection) This property represents the text highlighted by a selection. Text Format The following table describes the parameters of the Text property: Parameter Type Format wselectiontextenum The required format Read-only String. The selected text. 44

45 Text (Window) Selection Text (Window) This property returns the text at a specified location within a wintegrate session window. This is the default property for the Window object. Rows and columns start at 0. The top left of a wintegrate session window is row 0, column 0. The current page is 0, the previous page is 1, the page before that is 2, and so on. Text [Left], [Top], [Right], [Bottom], [Layout], [Format], [StartPage], [EndPage] The following table describes the parameters of the Text property: Parameter Type Left Variant or Long The column number of the top left of the required text (default: 0) Top Variant or Long The row number of the top left of the required text (default: 0) Right Variant or Long The column number of the bottom right of the required text (default: the right of the session window) Bottom Variant or Long The row number of the bottom right of the required text (default: the bottom of the session window) Layout Format Variant or wtextlayoutenum Variant or wtextformatenum The layout of text required (default: wtextlayoutlines) The format of the required text (default: wtextformatnone) StartPage Variant or Long The page number of the top left of the required text (default: the first page) EndPage Variant or Long The page number of the bottom right of the required text (default: 0) Read-only Variant. The required text. AutoWindow TextFormat This property represents the format that the text in a wintegrate capture object should be returned. The default value is wcapturetextformatstripzeroes. 45

46 Chapter 3: Properties Top Triggers TextFormat Read/Write wcapturetextformatenum. The format to return the captured text. Capture This property represents the vertical position of a wintegrate object. Top Read/Write Long. The vertical position of the object in pixels. Application, DisplayArea, HotSpot, Trigger This property returns the triggers object associated with a wintegrate session. Triggers Read-only Triggers. The triggers object. Type (Selection) This property describes the type of a selection. Type 46

47 Type (Trigger) Read/Write wselectiontypeenum. The selection type. Selection Type (Trigger) This property describes the type of a wintegrate trigger object. Type Read-only wtriggertypeenum. The trigger type. Trigger Variable This property represents the global script variable. This allows you to set and get variables that can be used by scripting. Variable Name The following table describes the parameters of the Variable property: Parameter Type Name String The name of the global script variable Read/Write String. The value of the global script variable. Version This property returns the wintegrate version number. 47

48 Chapter 3: Properties Visible Version Read-only String. The version number. Application, This property represents the visible state of a wintegrate object. Visible Read/Write Boolean. The visible state. Application WHeight () This property is the session s internal height. This property is for internal use only and is subject to change. Do not use. WHeight Read/Write Long. s height. This object represents a wintegrate session. WLeft () This property is the session s internal left position. This property is for internal use only and is subject to change. 48

49 WState () Do not use. WLeft Read/Write Long. Left position. WState () This property is the session s internal show state. This property is for internal use only and is subject to change. Do not use. WState Read/Write Short. The internal state. WTop () This property is the session s internal top position. This property is for internal use only and is subject to change. Do not use. WTop Read/Write Long. Top position. 49