Provides programmatic access to host screens. Supports the following host types: ALC, IBM 3270, IBM 5250, T27, UTS and VT.


The following tables list the members exposed by ScreenUPG.

Public Constructors

  Name Description
Public method ScreenUPG Initializes a new instance of the ScreenUPG class.
Top

Public Properties

  Name Description
Public property ALC_ERROR_TRAFFIC_CLASS Status indicating traffic class not supported returned by onStatusReceived.
Public property ALC_HOSTACTIVE Status indicating ALC host connection is active returned by onStatusReceived.
Public property ALC_HOSTINACTIVE Status indicating ALC host connection is inactive returned by onStatusReceived.
Public property ALC_HOSTLOST Status indicating ALC host connection has broken returned by onStatusReceived.
Public property ALC_STRUCTURED_DATA Send this status with SendStatus to the Apollo/Galileo transport to enable binary data mode.
Public property ALC_TERMINAL_DATA Send this status with SendStatus to the Apollo/Galileo transport to enable terminal data mode.
Public property ATM_3270_MODEL_2 24x80 3270 model display size.
Public property ATM_3270_MODEL_3 32x80 3270 model display size.
Public property ATM_3270_MODEL_4 43x80 3270 model display size.
Public property ATM_3270_MODEL_5 27x132 3270 model display size.
Public property BgBlack Black background.
Public property BgBlue Blue background.
Public property BgCyan Cyan background.
Public property BgDarkBlue Dark blue background.
Public property BgDarkCyan Dark cyan background.
Public property BgDarkGray Dark gray background.
Public property BgDarkGreen Dark green background.
Public property BgDarkMagenta Dark magenta background.
Public property BgDarkRed Dark red background.
Public property BgDarkYellow Dark yellow background.
Public property BgGray Gray background.
Public property BgGreen Green background.
Public property BgMagenta Magenta background.
Public property BgRed Red background.
Public property BgWhite White background.
Public property BgYellow Yellow background.
Public property BLINK Blink attribute.
Public property BOLD Bold attribute.
Public property BRIGHT Bright attribute.
Public property DIM Dim attribute.
Public property DIRECTION_BACKWARD Search in backward direction in presentation space.
Public property DIRECTION_FORWARD Search in forward direction in presentation space.
Public property DOUBLEHEIGHT Double height attribute.
Public property DOUBLEWIDTH Double width attribute.
Public property FgBlack Black foreground.
Public property FgBlue Blue foreground.
Public property FgCyan Cyan foreground.
Public property FgDarkBlue Dark blue foreground.
Public property FgDarkCyan Dark cyan foreground.
Public property FgDarkGray Dark gray foreground.
Public property FgDarkGreen Dark green foreground.
Public property FgDarkMagenta Dark magenta foreground.
Public property FgDarkRed Dark red foreground.
Public property FgDarkYellow Dark yellow foreground.
Public property FgGray Gray foreground.
Public property FgGreen Green foreground.
Public property FgMagenta Magenta foreground.
Public property FgRed Red foreground.
Public property FgWhite White foreground.
Public property FgYellow Yellow foreground.
Public property FIELDTYPE_ANY Find any fields in presentation space.
Public property FIELDTYPE_PROTECTED Find protected fields in presentation space.
Public property FIELDTYPE_UNPROTECTED Find unprotected fields in presentation space.
Public property FINDFIELD_CURRENT Find current field in presentation space.
Public property FINDFIELD_NEXT Find next field in presentation space.
Public property FINDFIELD_PREVIOUS Find previous field in presentation space.
Public property HOST_STATUS Status message indicating INT-1 host status has changed returned by onStatusReceived.
Public property HOST_STATUS_HOSTACTIVE Sub-status of HOST_STATUS indicating INT-1 host connection is active.
Public property HOST_STATUS_HOSTINACTIVE Sub-status of HOST_STATUS indicating INT-1 host connection is inactive.
Public property HOST_STATUS_HOSTLOST Sub-status of HOST_STATUS indicating INT-1 host connection has broken.
Public property KEYTYPE_BRACES Use curly braces format when sending keys to presentation space.
Public property KEYTYPE_HLLAPI Use HLLAPI format when sending keys to presentation space.
Public property LEFTCOLSEP Column separator attribute.
Public property NORMAL Normal attribute.
Public property PUTSTRING_SKIP Skip protected fields encountered.
Public property PUTSTRING_SPAN Span protected fields encountered.
Public property PUTSTRING_STOP Stop when protected field encountered.
Public property REVERSE Reverse attribute.
Public property SCREEN_3270 3270 screen type returned by SessionLoader.getTerminalType.
Public property SCREEN_5250 5250 screen type returned by SessionLoader.getTerminalType.
Public property SCREEN_ALC ALC screen type returned by SessionLoader.getTerminalType.
Public property SCREEN_T27 T27 screen type returned by SessionLoader.getTerminalType.
Public property SCREEN_UNKNOWN Unknown screen type returned by SessionLoader.getTerminalType.
Public property SCREEN_UTS UTS screen type returned by SessionLoader.getTerminalType.
Public property SCREEN_VT VT screen type returned by SessionLoader.getTerminalType.
Public property SCREENATTR_ANY Include text with any screen attribute.
Public property SCREENATTR_HIDDEN Include text with hidden screen attribute.
Public property SCREENATTR_PROTECTED Include text with protected screen screen attribute.
Public property SCREENATTR_UNPROTECTED Include text unprotected screen attribute.
Public property SCREENATTR_VISIBLE Include text with visible screen attribute.
Public property SECURE Secure attribute.
Public property SPECIAL Special attribute.
Public property STRIKETHROUGH Strikethrough attribute.
Public property TOP_BOTTOM Top bottom attribute.
Public property UNDERSCORE Underscore attribute.
Public property UPPER Upper case attribute.
Public property UTS_DESELECT Status message received by onStatusReceived indicating the UTS device has been unselected.
Public property UTS_DEVICESTATUS Status message sent by SendStatus notifying the host of the status of the local UTS device.
Public property UTS_DEVICESTATUS_BUSY "Busy" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.
Public property UTS_DEVICESTATUS_ERROR "Error" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.
Public property UTS_DEVICESTATUS_NOTREADY "Not ready" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.
Public property UTS_DEVICESTATUS_OFFLINE "Offline" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.
Public property UTS_DEVICESTATUS_POC "Power-on Confidence" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.
Public property UTS_DEVICESTATUS_READY "Ready" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.
Public property UTS_DEVICESTATUS_THRU "Thru" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.
Public property UTS_MSGWAIT Status message received by onStatusReceived indicating the UTS message wait indicator is lit.
Public property UTS_SELECT Status message received by onStatusReceived indicating the UTS device has been selected.
Public property VSDKVersion Current version of Verastream SDK for Unisys and Airlines returned by getObjectVersion.
Public property WRAP_OFF Don't wrap to top of presentation space when end encountered.
Public property WRAP_ON Wrap to top of presentation space when end encountered.
Top

Public Methods

  Name Description
Public method addIScreenListenerEx Enables your application to receive various screen event notifications from the Screen object.
Public method addIStatusListener Enables your your application to receive status event notifications from the Screen object.
Public method clearCapturedData Clears information from the captured data buffer.
Public method Close Closes the current host session.
Public method Equals Determines whether the specified Object is equal to the current Object. (inherited from Object)
Public method fieldCount Returns the number of fields of the specified type.
Public method findField Searches the presentation space for the specified field beginning from the row and column position specified.
Public method findFieldEx Searches the presentation space for the specified field beginning from the index (field number) specified.
Public method findString Searches the presentation space for the specified text string starting from the specified start position. If found, it returns true and the start position of the string.
Public method findStringEx Searches the presentation space for the specified text string from the specified start position to the specified end position. If found, it returns true and the start position of the string.
Public method getCapturedBytes Returns the currently captured data as a byte array. The data capture facility allows you to save all information being sent by the host communications layer to the presentation space for later retrieval as a byte array or a String.

Depending on the type of terminal and type of host connection, this data may be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.

Public method getCapturedData Returns the currently captured data as a string. The data capture facility allows you to save all information being sent by the host communications layer to the presentation space for later retrieval as a byte array or a String. Depending on the type of terminal and type of host connection, this data may be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.
Public method getCapturedJavaBytes Returns the currently captured data as a signed byte array. The data capture facility allows you to save all information being sent by the host communications layer to the presentation space for later retrieval as a byte array or a String.

Depending on the type of terminal and type of host connection, this data may be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.

Public method getColumns Returns the number of columns in the presentation space.
Public method getCursor Returns the current cursor position.
Public method getCursorColumn Returns the column of the current cursor position.
Public method getCursorRow Returns the row of the current cursor position.
Public method getDataCapture Returns the current state of the data capture facility.
Public method getDescription Returns a custom description for the instance of the Screen object if a description was created previously using setDescription.
Public method getExtPS Returns the specified portion of the presentation space in a string format.
Public method getgetText_Display Returns the current setting of the getText_Display property.
Public method GetHashCode Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (inherited from Object)
Public method getKeyboardLocked Returns the current state of the keyboard.
Public method getMaxDataCaptureLength Returns the current maximum buffer size for data captured using the data capture facility. The data capture facility allows you to save all information being sent to the presentation space by the host for later retrieval as a byte array or a string.
Public method getObjectVersion Returns the version number of the specified Screen object.
Public method getOIAContents Returns the data displayed in the OIA portion (status line) of the presentation space.
Public method getOIAText Returns the text of the OIA portion (status line) of the presentation space in a string format.
Public method getOperatorDisable Gets the current Operator Disabled status for MATIP sessions.
Public method getPeripheralControl Gets the current peripheral control state for UTS INT-1 sessions.
Public method getRows Returns the number of rows in the presentation space.
Public method getScreenType Returns the current host type.
Public method getString Returns the visible text from the specified location.
Public method getStringEx Returns the visible text from the specified location with attributes matching those specified by inAttr.
Public method getText Returns the text contents of the presentation space as a string.
Public method GetType Gets the Type of the current instance. (inherited from Object)
Public method isConnected Returns the state of the host/gateway connection.
Public method isKeyboardLocked Returns the current state of the keyboard.
Public method Open Opens a host session.
Public method OpenEx Opens a host session, waiting a specified time for the connection to be established before returning.
Public method putString Copies a string of text to the specified position in the presentation space and returns the number of characters written.
Public method putStringEx Copies a string of text to the specified position in the presentation space and returns the number of characters written.
Public method RawDataTransmit Writes a string of characters directly to the host communications layer, without going through the presentation space. The Unicode characters are converted to bytes with the default encoding for the platform.

Depending on the type of terminal and type of host connection, this data may have to be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.

Public method RawDataTransmitBytes Overloaded. Writes an array of bytes directly to the host communications layer, without going through the presentation space.

Depending on the type of terminal and type of host connection, this data may have to be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.

Public method removeIScreenListenerEx Removes the ScreenListener from the Screen object. The Screen object will no longer receive screen/status event notifications.
Public method removeIStatusListener Removes the StatusListener from the Screen object. The Screen object will no longer receive status event notifications.
Public method sendKeys Sends characters and special keys to the session. They are treated the same as if they were typed at the keyboard. Special keystrokes can be specified in HLLAPI format, which has a special code for each keystroke, such as "@E" for the host Transmit key, or Braces format, where the key name is surrounded by braces, such as "{Transmit}". See Key Codes for a complete list of codes for each host type. You can also use sendKeys to send text character strings to the session. Text is sent to the host or written to the presentation space at the current cursor location. For example, to send the text "logoff" followed by the Transmit key, inText would be "logoff@T". If you are sending a lot of text to the presentation space, however, it may be more efficient to use putString or putStringEx instead. If an invalid key sequence is detected, no characters or keys are sent. It is recommended that you follow every sendKey call with a call to one of the wait methods (for example, WaitForString , WaitHostQuiet, or WaitForCursor). This helps to ensure that the host has completed processing before your application moves on to the next step.
Public method SendStatus Overloaded. Sends a status message with option detail to screen.
Public method setCursor Sets the cursor position in the presentation space.
Public method setCursorColumn Sets the column of the cursor position.
Public method setCursorRow Sets the row of the cursor position.
Public method setDataCapture Turns the data capture facility on or off.
Public method setDataCaptureEx Turns the data capture facility on or off. In addition, turns on or off the suppression of updates to the presentation space.
Public method setDescription Creates a custom description for the instance of the Screen object.
Public method setgetText_Display Turns the getText_Display property on or off.
Public method setMaxDataCaptureLength Sets the maximum buffer size for data captured using the data capture facility. The data capture facility allows you to save all information being sent to the presentation space by the host for later retrieval as a byte array or a string.
Public method setOperatorDisable Attempts to set Operator Disabled status for MATIP sessions.
Public method setPeripheralControl Sets the Peripheral Control State for UTS INT-1 sessions. This advanced feature is for applications that want control over print activity.
Public method ToString Returns a String that represents the current Object. (inherited from Object)
Public method waitForCursor Waits for the cursor to appear at the specified position for a specified period of time.
Public method waitForString Waits for the specified text to appear at the specified position for a specified period of time.
Public method waitHostQuiet Waits for the host session to be idle for a specified period of time (in milliseconds). A session is considered to be "quiet" when there has been no activity in the host session for the specified amount of time. This is a synchronous call and does not return until the wait condition is satisfied. Otherwise, it times out after wtTime (specified in milliseconds).
Top

Protected Methods

  Name Description
Family method Finalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object)
Family method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object)
Top

Public Events

  Name Description
Public event onConnectionLost Occurs when the connection to host is lost.
Public event onError Occurs when an error is detected.
Public event onLostRemoteWindow Occurs when the connection to the RemoteWindow is unexpectedly broken.
Public event onScreenChanged Occurs when host data causes the screen to change.
Public event onScreenShapeChanged Occurs when the screen shape (number of rows and/or columns) changes.
Public event onStatusReceived Occurs when a status message is generated by the screen object.
Top

See Also

Syntax based on .NET Framework version 2.0.
Documentation version 1.0.0.0.