BlueZone Object methods

Sets and gets the auto-connect value found in Session → Configure in the BlueZone session.

Sets or gets the BlueZone session's Auto-Size font option (VT/6530 only).

Disconnects from the host system and closes the BlueZone Display session window.

Establishes a link between the BlueZone Host Automation object and the BlueZone Display session. Connect must be called before any other BlueZone Host Automation object methods that access data in the host screen.

Retrieves the session's host connection status.

Forces a specific BlueZone session to connect to a host.

Executes the Edit → Copy to Clipboard menu command in the BlueZone session.

Copies the selected text to the clipboard.

A property to get or set the cursor's column position. This property is 0-Base for VT/6530 sessions and 1-Base for all other session types.

A property to get or set the cursor's row position. This property is 0-Base for VT/6530 sessions and 1-Base for all other session types.

Returns the path of the BlueZone installation folder.

Closes a BlueZone session. This method is used to close a session started by NewSession.

The Disconnect method is used in conjunction with the Connect method, to halt communication between the Host Automation Object and the currently connected BlueZone session.

Forces a specific BlueZone session to disconnect from a host.

Executes the File → Exit function.

Selects all the text between the current edit selection start position and the row, column parameters.

Sets the end position of an edit selection.

Retrieves a handle to the Field automation object.

Looks for a specific string on the screen.

Controls window and keyboard focus.

Sets or gets the BlueZone session's fontname (VT/6530 only).

Sets or gets the BlueZone session’s font size (VT/6530 only).

Sets or gets the BlueZone session’s font style (VT/6530 only).

Returns the column position of the beginning of the string found by the FindText method.

Returns the row position of the beginning of the string found by the FindText method.

Returns the full filename of the BlueZone object.

Copies the contents of the clipboard to a string variable.

Retrieves the host screen cursor position.

The GetFieldColor method is used in conjunction with the Connect method to retrieve the color of a specified field.

Invokes the common Folder dialog.

Invokes the common Open file dialog.

Invokes the common Save As file dialog.

Returns the session identifier (1,2,3,etc.) of the currently connected session. This method can only be used after a successful Connect() and can be used in subsequent calls that require a session identifier parameter.

Returns the HLLAPI Short Name (''A'',''B'',''C'',etc.) of the currently connected BlueZone session. This method can only be used after a successful Connect() and can be used in subsequent calls that require a session name parameter.

This property is used to get or set the BlueZone session’s connection address.

Controls what happens when a log file already exists (append, overwrite, cancel). Set this property before calling PrinterLogging and PrintToFile. It will overwrite the existing log file by default if this property is not used (VT/6530 only.)

Prompts for user input.

Returns an Area object that contains the row, column and character selected. Only left mouse clicks are captured that move the cursor or select a Hot Spot.

Used to lock or unlock the BlueZone session's keyboard.

Executes one menu command.

Moves the cursor to the specified location.

Displays a message to the user.

Launches a new BlueZone session.

Starts a BlueZone Display session.

Opens a config file.

This property is used to set the BlueZone session’s SSH password (VT/6530 only).

Prompts the user for a password with a customizable password dialog.

Executes the Edit → Paste function.

Returns the path of the BlueZone object.

Suspends script execution based on the value as noted below.

Executes the File → Print Screen function.

A property to get or set the cursor position.

Reads text from the host screen into a variable.

Performs a case-sensitive search for an occurrence of text in the host screen.

Writes text to an unprotected area of the host screen.

Reads text from the house screen into a variable.

Returns the host field attribute value associated with the specified screen position.

Closes all running BlueZone sessions.

Retrieves data from the host screen.

Initiates an IND$FILE file transfer download from the Mainframe host system.

Executes a program.

Causes the session to load an external VBA project file, run the specified macro procedure, and then close the VBA project.

Runs a VBA macro.

Runs BlueZone Script Host in quiet-mode to play a script.

Returns the session's default script folder.

Searches the host screen for some specified text.

Initiates an IND$FILE file transfer upload to the mainframe host system.

Sends a sequence of keys to the display session.

Associates an instance of the BZHAO with a browser window that has a BlueZone display session embedded. When using the Sx Object Tag parameter with embedded sessions, the SetBrowserWnd() method must be used after each CreateObject() call when running multiple browser instances and specifying ''!'' with Connect() and zero(0) with ConnectToHost(), addConnectionCallback(), etc. in the web page scripts.

Sets the text contents of the clipboard from a string.

Sets the host screen cursor position.

Changes the base value for a row and column values for some methods and properties.

Allows the setting of the host TCP port. You must also set the BlueZone session type and session ID.

Sets host information to any BlueZone session with a URL string.

Sets the start position of an edit selection.

Adjusts the size and position of the BlueZone window.

Starts a BlueZone COM trace. This command must be used in conjunction with StopTrace.

Returns the status of the host session.

Stops a BlueZone COM trace. Used in conjunction with StartTrace.

Returns a string representation of the specified value.

Used before calling NewSession to set or override connection parameters.

Used to auto-type the password.

Auto-types the user name.

Returns a number representation of the specified string.

Returns the version string of the BlueZone object.

Launches the BlueZone Session Manager application.

Suspends script execution for the time specified.

Suspends script execution until the host screen is ready for keyboard input and the cursor is at the specified location.

Waits for the user to press keys while the focus is in the session window.

Used after sending an AID key to wait for the host keyboard to unlock. (Not suggested for VT hosts as the hosts do not lock keyboards.)

Waits for the specified string to be found in the host data stream (VT/6530 only).

Suspends script execution until the desired text is found in the host screen.

Suspends script execution until the host screen is ready for keyboard input. (Not recommended for VT sessions.)

Retrieves a handle to the Window automation object.

Returns the window handle of the connected session.

A property to get or set the session's window state.

Pastes specified text in the host screen.