Verastream SDK .Net Reference
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_2 24x80 3270 model display size.  
Public PropertyATM_3270_MODEL_3 32x80 3270 model display size.  
Public PropertyATM_3270_MODEL_4 43x80 3270 model display size.  
Public PropertyATM_3270_MODEL_5 27x132 3270 model display size.  
Public PropertyBgBlack Black background.  
Public PropertyBgBlue Blue background.  
Public PropertyBgCyan Cyan background.  
Public PropertyBgDarkBlue Dark blue background.  
Public PropertyBgDarkCyan Dark cyan background.  
Public PropertyBgDarkGray Dark gray background.  
Public PropertyBgDarkGreen Dark green background.  
Public PropertyBgDarkMagenta Dark magenta background.  
Public PropertyBgDarkRed Dark red background.  
Public PropertyBgDarkYellow Dark yellow background.  
Public PropertyBgGray Gray background.  
Public PropertyBgGreen Green background.  
Public PropertyBgMagenta Magenta background.  
Public PropertyBgRed Red background.  
Public PropertyBgWhite White background.  
Public PropertyBgYellow Yellow background.  
Public PropertyBLINK Blink attribute.  
Public PropertyBOLD Bold attribute.  
Public PropertyBRIGHT Bright attribute.  
Public PropertyDIM Dim attribute.  
Public PropertyDIRECTION_BACKWARD Search in backward direction in presentation space.  
Public PropertyDIRECTION_FORWARD Search in forward direction in presentation space.  
Public PropertyDOUBLEHEIGHT Double height attribute.  
Public PropertyDOUBLEWIDTH Double width attribute.  
Public PropertyFgBlack Black foreground.  
Public PropertyFgBlue Blue foreground.  
Public PropertyFgCyan Cyan foreground.  
Public PropertyFgDarkBlue Dark blue foreground.  
Public PropertyFgDarkCyan Dark cyan foreground.  
Public PropertyFgDarkGray Dark gray foreground.  
Public PropertyFgDarkGreen Dark green foreground.  
Public PropertyFgDarkMagenta Dark magenta foreground.  
Public PropertyFgDarkRed Dark red foreground.  
Public PropertyFgDarkYellow Dark yellow foreground.  
Public PropertyFgGray Gray foreground.  
Public PropertyFgGreen Green foreground.  
Public PropertyFgMagenta Magenta foreground.  
Public PropertyFgRed Red foreground.  
Public PropertyFgWhite White foreground.  
Public PropertyFgYellow Yellow foreground.  
Public PropertyFIELDTYPE_ANY Find any fields in presentation space.  
Public PropertyFIELDTYPE_PROTECTED Find protected fields in presentation space.  
Public PropertyFIELDTYPE_UNPROTECTED Find unprotected fields in presentation space.  
Public PropertyFINDFIELD_CURRENT Find current field in presentation space.  
Public PropertyFINDFIELD_NEXT Find next field in presentation space.  
Public PropertyFINDFIELD_PREVIOUS Find 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_BRACES Use curly braces format when sending keys to presentation space.  
Public PropertyKEYTYPE_HLLAPI Use HLLAPI format when sending keys to presentation space.  
Public PropertyLEFTCOLSEP Column separator attribute.  
Public PropertyNORMAL Normal attribute.  
Public PropertyPUTSTRING_SKIP Skip protected fields encountered.  
Public PropertyPUTSTRING_SPAN Span protected fields encountered.  
Public PropertyPUTSTRING_STOP Stop when protected field encountered.  
Public PropertyREVERSE Reverse attribute.  
Public PropertySCREEN_3270 3270 screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_5250 5250 screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_ALC ALC screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_T27 T27 screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_UNKNOWN Unknown screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_UTS UTS screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREEN_VT VT screen type returned by SessionLoader.getTerminalType.  
Public PropertySCREENATTR_ANY Include text with any screen attribute.  
Public PropertySCREENATTR_HIDDEN Include text with hidden screen attribute.  
Public PropertySCREENATTR_PROTECTED Include text with protected screen screen attribute.  
Public PropertySCREENATTR_UNPROTECTED Include text unprotected screen attribute.  
Public PropertySCREENATTR_VISIBLE Include text with visible screen attribute.  
Public PropertySECURE Secure attribute.  
Public PropertySPECIAL Special attribute.  
Public PropertySTRIKETHROUGH Strikethrough attribute.  
Public PropertyTOP_BOTTOM Top bottom attribute.  
Public PropertyUNDERSCORE Underscore attribute.  
Public PropertyUPPER Upper 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_OFF Don't wrap to top of presentation space when end encountered.  
Public PropertyWRAP_ON Wrap to top of presentation space when end encountered.  
Top
Public Methods
 NameDescription
Public MethodaddIScreenListenerEx Enables your application to receive various screen event notifications from the Screen object.  
Public MethodaddIStatusListener Enables your your application to receive status event notifications from the Screen object.  
Public MethodclearCapturedData Clears information from the captured data buffer.  
Public MethodClose Closes the current host session.  
Public MethodDisposeOverloaded.   
Public MethodfieldCount Returns the number of fields of the specified type.  
Public MethodfindField Searches the presentation space for the specified field beginning from the row and column position specified.  
Public MethodfindFieldEx Searches the presentation space for the specified field beginning from the index (field number) specified.  
Public MethodfindString 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 MethodfindStringEx 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 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 MethodgetCapturedData 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 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 MethodgetColumns Returns the number of columns in the presentation space.  
Public MethodgetCursor Returns the current cursor position.  
Public MethodgetCursorColumn Returns the column of the current cursor position.  
Public MethodgetCursorRow Returns the row of the current cursor position.  
Public MethodgetDataCapture Returns 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 MethodgetExtPS Returns the specified portion of the presentation space in a string format.  
Public MethodgetgetText_Display Returns the current setting of the getText_Display property.  
Public MethodgetKeyboardLocked Returns the current state of the keyboard.  
Public MethodgetMaxDataCaptureLength 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 MethodgetObjectVersion Returns the version number of the specified Screen object.  
Public MethodgetOIAContents Returns the data displayed in the OIA portion (status line) of the presentation space.  
Public MethodgetOIAText Returns the text of the OIA portion (status line) of the presentation space in a string format.  
Public MethodgetOperatorDisable Gets the current Operator Disabled status for MATIP sessions.  
Public MethodgetPeripheralControl Gets the current peripheral control state for UTS INT-1 sessions.  
Public MethodgetRows Returns the number of rows in the presentation space.  
Public MethodgetScreenType Returns the current host type.  
Public MethodgetString Returns the visible text from the specified location.  
Public MethodgetStringEx Returns the visible text from the specified location with attributes matching those specified by inAttr.  
Public MethodgetText Returns the text contents of the presentation space as a string.  
Public MethodisConnected Returns the state of the host/gateway connection.  
Public MethodisKeyboardLocked Returns the current state of the keyboard.  
Public MethodOpen Opens a host session.  
Public MethodOpenEx Opens a host session, waiting a specified time for the connection to be established before returning.  
Public MethodputString Copies a string of text to the specified position in the presentation space and returns the number of characters written.  
Public MethodputStringEx Copies 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 MethodremoveIScreenListenerEx Removes the ScreenListener from the Screen object. The Screen object will no longer receive screen/status event notifications.  
Public MethodremoveIStatusListener Removes 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 MethodsetCursor Sets the cursor position in the presentation space.  
Public MethodsetCursorColumn Sets the column of the cursor position.  
Public MethodsetCursorRow Sets the row of the cursor position.  
Public MethodsetDataCapture Turns the data capture facility on or off.  
Public MethodsetDataCaptureEx Turns the data capture facility on or off. In addition, turns on or off the suppression of updates to the presentation space.  
Public MethodsetDescription Creates a custom description for the instance of the Screen object.  
Public MethodsetgetText_Display Turns the getText_Display property on or off.  
Public MethodsetMaxDataCaptureLength 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 MethodsetOperatorDisable Attempts to set Operator Disabled status for MATIP sessions.  
Public MethodsetPeripheralControl Sets the Peripheral Control State for UTS INT-1 sessions. This advanced feature is for applications that want control over print activity.  
Public MethodwaitForCursor Waits for the cursor to appear at the specified position for a specified period of time.  
Public MethodwaitForString Waits for the specified text to appear at the specified position for a specified period of time.  
Public MethodwaitHostQuiet 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
 NameDescription
Protected MethodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.  
Top
Public Events
 NameDescription
Public EventonConnectionLost Occurs when the connection to host is lost.  
Public EventonError Occurs when an error is detected.  
Public EventonLostRemoteWindow Occurs when the connection to the RemoteWindow is unexpectedly broken.  
Public EventonScreenChanged Occurs when host data causes the screen to change.  
Public EventonScreenShapeChanged Occurs when the screen shape (number of rows and/or columns) changes.  
Public EventonStatusReceived Occurs when a status message is generated by the screen object.  
Top
See Also