ScreenUPG Class Methods

For a list of all members of this type, see ScreenUPG members.

Public Methods

	Name	Description
	addIScreenListenerEx	Enables your application to receive various screen event notifications from the Screen object.
	addIStatusListener	Enables your your application to receive status event notifications from the Screen object.
	clearCapturedData	Clears information from the captured data buffer.
	Close	Closes the current host session.
	Dispose	Overloaded.
	Equals	(Inherited from object)
	fieldCount	Returns the number of fields of the specified type.
	findField	Searches the presentation space for the specified field beginning from the row and column position specified.
	findFieldEx	Searches the presentation space for the specified field beginning from the index (field number) specified.
	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.
	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.
	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.
	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.
	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.
	getColumns	Returns the number of columns in the presentation space.
	getCursor	Returns the current cursor position.
	getCursorColumn	Returns the column of the current cursor position.
	getCursorRow	Returns the row of the current cursor position.
	getDataCapture	Returns the current state of the data capture facility.
	getDescription	Returns a custom description for the instance of the Screen object if a description was created previously using setDescription.
	getExtPS	Returns the specified portion of the presentation space in a string format.
	getgetText_Display	Returns the current setting of the getText_Display property.
	GetHashCode	(Inherited from object)
	getKeyboardLocked	Returns the current state of the keyboard.
	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.
	getObjectVersion	Returns the version number of the specified Screen object.
	getOIAContents	Returns the data displayed in the OIA portion (status line) of the presentation space.
	getOIAText	Returns the text of the OIA portion (status line) of the presentation space in a string format.
	getOperatorDisable	Gets the current Operator Disabled status for MATIP sessions.
	getPeripheralControl	Gets the current peripheral control state for UTS INT-1 sessions.
	getRows	Returns the number of rows in the presentation space.
	getScreenType	Returns the current host type.
	getString	Returns the visible text from the specified location.
	getStringEx	Returns the visible text from the specified location with attributes matching those specified by inAttr.
	getText	Returns the text contents of the presentation space as a string.
	GetType	(Inherited from object)
	isConnected	Returns the state of the host/gateway connection.
	isKeyboardLocked	Returns the current state of the keyboard.
	Open	Opens a host session.
	OpenEx	Opens a host session, waiting a specified time for the connection to be established before returning.
	putString	Copies a string of text to the specified position in the presentation space and returns the number of characters written.
	putStringEx	Copies a string of text to the specified position in the presentation space and returns the number of characters written.
	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.
	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. 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).
	removeIScreenListenerEx	Removes the ScreenListener from the Screen object. The Screen object will no longer receive screen/status event notifications.
	removeIStatusListener	Removes the StatusListener from the Screen object. The Screen object will no longer receive status event notifications.
	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.
	SendStatus	Overloaded. Sends a status message with option detail to screen.
	setCursor	Sets the cursor position in the presentation space.
	setCursorColumn	Sets the column of the cursor position.
	setCursorRow	Sets the row of the cursor position.
	setDataCapture	Turns the data capture facility on or off.
	setDataCaptureEx	Turns the data capture facility on or off. In addition, turns on or off the suppression of updates to the presentation space.
	setDescription	Creates a custom description for the instance of the Screen object.
	setgetText_Display	Turns the getText_Display property on or off.
	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.
	setOperatorDisable	Attempts to set Operator Disabled status for MATIP sessions.
	setPeripheralControl	Sets the Peripheral Control State for UTS INT-1 sessions. This advanced feature is for applications that want control over print activity.
	ToString	(Inherited from object)
	waitForCursor	Waits for the cursor to appear at the specified position for a specified period of time.
	waitForString	Waits for the specified text to appear at the specified position for a specified period of time.
	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
	Finalize
	MemberwiseClone	(Inherited from object)

Top

Reference

ScreenUPG Class
ScreenUPG Namespace