ScreenUPG
ScreenUPG Class Members
Properties  Methods  Events


The following tables list the members exposed by ScreenUPG.

Public Constructors
 NameDescription
Public ConstructorScreenUPG Constructor  
Top
Public Properties
 NameDescription
Public PropertyALC_ERROR_TRAFFIC_CLASSStatus indicating traffic class not supported returned by onStatusReceived.  
Public PropertyALC_HOSTACTIVEStatus indicating ALC host connection is active returned by onStatusReceived.  
Public PropertyALC_HOSTINACTIVEStatus indicating ALC host connection is inactive returned by onStatusReceived.  
Public PropertyALC_HOSTLOSTStatus indicating ALC host connection has broken returned by onStatusReceived.  
Public PropertyALC_STRUCTURED_DATASend this status with SendStatus to the Apollo/Galileo transport to enable binary data mode.  
Public PropertyALC_TERMINAL_DATASend this status with SendStatus to the Apollo/Galileo transport to enable terminal data mode.  
Public PropertyATM_3270_MODEL_224x80 3270 model display size.  
Public PropertyATM_3270_MODEL_332x80 3270 model display size.  
Public PropertyATM_3270_MODEL_443x80 3270 model display size.  
Public PropertyATM_3270_MODEL_527x132 3270 model display size.  
Public PropertyBgBlackBlack background.  
Public PropertyBgBlueBlue background.  
Public PropertyBgCyanCyan background.  
Public PropertyBgDarkBlueDark blue background.  
Public PropertyBgDarkCyanDark cyan background.  
Public PropertyBgDarkGrayDark gray background.  
Public PropertyBgDarkGreenDark green background.  
Public PropertyBgDarkMagentaDark magenta background.  
Public PropertyBgDarkRedDark red background.  
Public PropertyBgDarkYellowDark yellow background.  
Public PropertyBgGrayGray background.  
Public PropertyBgGreenGreen background.  
Public PropertyBgMagentaMagenta background.  
Public PropertyBgRedRed background.  
Public PropertyBgWhiteWhite background.  
Public PropertyBgYellowYellow background.  
Public PropertyBLINKBlink attribute.  
Public PropertyBOLDBold attribute.  
Public PropertyBRIGHTBright attribute.  
Public PropertyDIMDim attribute.  
Public PropertyDIRECTION_BACKWARDSearch in backward direction in presentation space.  
Public PropertyDIRECTION_FORWARDSearch in forward direction in presentation space.  
Public PropertyDOUBLEHEIGHTDouble height attribute.  
Public PropertyDOUBLEWIDTHDouble width attribute.  
Public PropertyFgBlackBlack foreground.  
Public PropertyFgBlueBlue foreground.  
Public PropertyFgCyanCyan foreground.  
Public PropertyFgDarkBlueDark blue foreground.  
Public PropertyFgDarkCyanDark cyan foreground.  
Public PropertyFgDarkGrayDark gray foreground.  
Public PropertyFgDarkGreenDark green foreground.  
Public PropertyFgDarkMagentaDark magenta foreground.  
Public PropertyFgDarkRedDark red foreground.  
Public PropertyFgDarkYellowDark yellow foreground.  
Public PropertyFgGrayGray foreground.  
Public PropertyFgGreenGreen foreground.  
Public PropertyFgMagentaMagenta foreground.  
Public PropertyFgRedRed foreground.  
Public PropertyFgWhiteWhite foreground.  
Public PropertyFgYellowYellow foreground.  
Public PropertyFIELDTYPE_ANYFind any fields in presentation space.  
Public PropertyFIELDTYPE_PROTECTEDFind protected fields in presentation space.  
Public PropertyFIELDTYPE_UNPROTECTEDFind unprotected fields in presentation space.  
Public PropertyFINDFIELD_CURRENTFind current field in presentation space.  
Public PropertyFINDFIELD_NEXTFind next field in presentation space.  
Public PropertyFINDFIELD_PREVIOUSFind previous field in presentation space.  
Public PropertyHOST_STATUSStatus message indicating INT-1 host status has changed returned by onStatusReceived.  
Public PropertyHOST_STATUS_HOSTACTIVESub-status of HOST_STATUS indicating INT-1 host connection is active.  
Public PropertyHOST_STATUS_HOSTINACTIVESub-status of HOST_STATUS indicating INT-1 host connection is inactive.  
Public PropertyHOST_STATUS_HOSTLOSTSub-status of HOST_STATUS indicating INT-1 host connection has broken.  
Public PropertyKEYTYPE_BRACESUse curly braces format when sending keys to presentation space.  
Public PropertyKEYTYPE_HLLAPIUse HLLAPI format when sending keys to presentation space.  
Public PropertyLEFTCOLSEPColumn separator attribute.  
Public PropertyNORMALNormal attribute.  
Public PropertyPUTSTRING_SKIPSkip protected fields encountered.  
Public PropertyPUTSTRING_SPANSpan protected fields encountered.  
Public PropertyPUTSTRING_STOPStop when protected field encountered.  
Public PropertyREVERSEReverse attribute.  
Public PropertySCREEN_32703270 screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_52505250 screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_ALCALC screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_T27T27 screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_UNKNOWNUnknown screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_UTSUTS screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_VTVT screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREENATTR_ANYInclude text with any screen attribute.  
Public PropertySCREENATTR_HIDDENInclude text with hidden screen attribute.  
Public PropertySCREENATTR_PROTECTEDInclude text with protected screen screen attribute.  
Public PropertySCREENATTR_UNPROTECTEDInclude text unprotected screen attribute.  
Public PropertySCREENATTR_VISIBLEInclude text with visible screen attribute.  
Public PropertySECURESecure attribute.  
Public PropertySPECIALSpecial attribute.  
Public PropertySTRIKETHROUGHStrikethrough attribute.  
Public PropertyTOP_BOTTOMTop bottom attribute.  
Public PropertyUNDERSCOREUnderscore attribute.  
Public PropertyUPPERUpper case attribute.  
Public PropertyUTS_DESELECTStatus message received by onStatusReceived indicating the UTS device has been unselected.  
Public PropertyUTS_DEVICESTATUSStatus message sent by SendStatus notifying the host of the status of the local UTS device.  
Public PropertyUTS_DEVICESTATUS_BUSY"Busy" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.  
Public PropertyUTS_DEVICESTATUS_ERROR"Error" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.  
Public PropertyUTS_DEVICESTATUS_NOTREADY"Not ready" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.  
Public PropertyUTS_DEVICESTATUS_OFFLINE"Offline" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.  
Public PropertyUTS_DEVICESTATUS_POC"Power-on Confidence" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.  
Public PropertyUTS_DEVICESTATUS_READY"Ready" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.  
Public PropertyUTS_DEVICESTATUS_THRU"Thru" sub-status of UTS_DEVICESTATUS notifying host of the status of the local UTS device.  
Public PropertyUTS_MSGWAITStatus message received by onStatusReceived indicating the UTS message wait indicator is lit.  
Public PropertyUTS_SELECTStatus message received by onStatusReceived indicating the UTS device has been selected.  
Public PropertyVSDKVersionCurrent version of Verastream SDK for Unisys and Airlines returned by getObjectVersion.  
Public PropertyWRAP_OFFDon't wrap to top of presentation space when end encountered.  
Public PropertyWRAP_ONWrap to top of presentation space when end encountered.  
Top
Public Methods
 NameDescription
Public MethodaddIScreenListenerExEnables your application to receive various screen event notifications from the Screen object.  
Public MethodaddIStatusListenerEnables your your application to receive status event notifications from the Screen object.  
Public MethodclearCapturedDataClears information from the captured data buffer.  
Public MethodCloseCloses the current host session.  
Public MethodDisposeOverloaded.   
Public MethodEquals (Inherited from object)
Public MethodfieldCountReturns the number of fields of the specified type.  
Public MethodfindFieldSearches the presentation space for the specified field beginning from the row and column position specified.  
Public MethodfindFieldExSearches the presentation space for the specified field beginning from the index (field number) specified.  
Public MethodfindStringSearches 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 MethodfindStringExSearches 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 MethodgetCapturedBytesReturns 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 MethodgetCapturedDataReturns 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 MethodgetCapturedJavaBytesReturns 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 MethodgetColumnsReturns the number of columns in the presentation space.  
Public MethodgetCursorReturns the current cursor position.  
Public MethodgetCursorColumnReturns the column of the current cursor position.  
Public MethodgetCursorRowReturns the row of the current cursor position.  
Public MethodgetDataCaptureReturns the current state of the data capture facility.  
Public MethodgetDescriptionReturns a custom description for the instance of the Screen object if a description was created previously using setDescription.  
Public MethodgetExtPSReturns the specified portion of the presentation space in a string format.  
Public MethodgetgetText_DisplayReturns the current setting of the getText_Display property.  
Public MethodGetHashCode (Inherited from object)
Public MethodgetKeyboardLockedReturns the current state of the keyboard.  
Public MethodgetMaxDataCaptureLengthReturns 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 MethodgetObjectVersionReturns the version number of the specified Screen object.  
Public MethodgetOIAContentsReturns the data displayed in the OIA portion (status line) of the presentation space.  
Public MethodgetOIATextReturns the text of the OIA portion (status line) of the presentation space in a string format.  
Public MethodgetOperatorDisableGets the current Operator Disabled status for MATIP sessions.  
Public MethodgetPeripheralControlGets the current peripheral control state for UTS INT-1 sessions.  
Public MethodgetRowsReturns the number of rows in the presentation space.  
Public MethodgetScreenTypeReturns the current host type.  
Public MethodgetStringReturns the visible text from the specified location.  
Public MethodgetStringExReturns the visible text from the specified location with attributes matching those specified by inAttr.  
Public MethodgetTextReturns the text contents of the presentation space as a string.  
Public MethodGetType (Inherited from object)
Public MethodisConnectedReturns the state of the host/gateway connection.  
Public MethodisKeyboardLockedReturns the current state of the keyboard.  
Public MethodOpenOpens a host session.  
Public MethodOpenExOpens a host session, waiting a specified time for the connection to be established before returning.  
Public MethodputStringCopies a string of text to the specified position in the presentation space and returns the number of characters written.  
Public MethodputStringExCopies a string of text to the specified position in the presentation space and returns the number of characters written.  
Public MethodRawDataTransmitWrites 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 MethodRawDataTransmitBytesOverloaded. 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.

In the case of ALC, you must have two leading placeholder characters and one trailing placeholder character in your buffer (i.e. nn mm "real data" zz).

 
Public MethodremoveIScreenListenerExRemoves the ScreenListener from the Screen object. The Screen object will no longer receive screen/status event notifications.  
Public MethodremoveIStatusListenerRemoves the StatusListener from the Screen object. The Screen object will no longer receive status event notifications.  
Public MethodsendKeysSends 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 MethodSendStatusOverloaded. Sends a status message with option detail to screen.  
Public MethodsetCursorSets the cursor position in the presentation space.  
Public MethodsetCursorColumnSets the column of the cursor position.  
Public MethodsetCursorRowSets the row of the cursor position.  
Public MethodsetDataCaptureTurns the data capture facility on or off.  
Public MethodsetDataCaptureExTurns the data capture facility on or off. In addition, turns on or off the suppression of updates to the presentation space.  
Public MethodsetDescriptionCreates a custom description for the instance of the Screen object.  
Public MethodsetgetText_DisplayTurns the getText_Display property on or off.  
Public MethodsetMaxDataCaptureLengthSets 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 MethodsetOperatorDisableAttempts to set Operator Disabled status for MATIP sessions.  
Public MethodsetPeripheralControlSets the Peripheral Control State for UTS INT-1 sessions. This advanced feature is for applications that want control over print activity.  
Public MethodToString (Inherited from object)
Public MethodwaitForCursorWaits for the cursor to appear at the specified position for a specified period of time.  
Public MethodwaitForStringWaits for the specified text to appear at the specified position for a specified period of time.  
Public MethodwaitHostQuietWaits 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
 NameDescription
Protected MethodFinalize  
Protected MethodMemberwiseClone (Inherited from object)
Top
Public Events
 NameDescription
Public EventonConnectionLostOccurs when the connection to host is lost.  
Public EventonErrorOccurs when an error is detected.  
Public EventonLostRemoteWindowOccurs when the connection to the RemoteWindow is unexpectedly broken.  
Public EventonScreenChangedOccurs when host data causes the screen to change.  
Public EventonScreenShapeChangedOccurs when the screen shape (number of rows and/or columns) changes.  
Public EventonStatusReceivedOccurs when a status message is generated by the screen object.  
Top
See Also

Reference

ScreenUPG Class
ScreenUPG Namespace