An NDoc Documented Class Library

TerminalScreen Properties

The properties of the TerminalScreen class are listed below. For a complete list of TerminalScreen class members, see the TerminalScreen Members topic.

Public Instance Properties

Columns Get the number of columns of text on the screen.
CommErrorCode Return communication error code (a 4-digit hex string), or an empty string if there is no communication error. Note: Chances of seeing one of these ranges from rare to never.
ConnectedToHost Determine if the session is connected to the host system.
CursorColumn Get the zero-based column number where the cursor is located.
CursorPosition Get the zero-based absolute offset to where the cursor is located.
CursorRow Get the zero-based row number where the cursor is located.
DefaultOperationName Get the name of the default VHI operation.
Entity Create an XML representation of a terminal screen, using VHI entity attributes when presenting input fields.
EntityName Return the name of the host application screen.
ErrorCode Return the 5250 error code (1 4-digit hex value), or an empty string if there is no error condition.
Fields Return a list of ScreenField objects that represent terminal fields
FieldStructured Returns whether or not this screen has any fields. If there are no fields you can either use the access methods of this class to get the screen contents or you can use the (single) ScreenField object returned by getField(0).
InputInhibit Return a flag indicating that the Input Inhibit (Also known as keyboard locked) indicator is asserted on the status line.
KeyboardDisabledReason Get the 3270 keyboard disablement message. Expected return values are:
  • "" (Empty string) -- Keyboard is unlocked
  • "System"
  • "Wait"
  • "Partition-Wait"
  • "Protected"
  • "Numeric"
  • "Field-Full"
  • "Not-Impl"
  • "Req-Fail"
  • "COMM<hex value>"
  • "SM-Minus"
  • "Machine-Check <hex value>"
  • "Prog <numeric value>"
MessageWaiting Return a flag indicating that the Message Wait indicator is asserted on the status line.
OperationNames Get a list of operation names for this screen.
PartitionId Return the 3270 partition ID (A number from 0 to 255), or an empty string if partitions are not in use.
PartitionOwner Return the 3270 partition owner. Expected return values are:
  • "None"
  • "SSCP"
  • "LU"
  • "Not-Active"
ReachableEntities Get a list of entities reachable from the current entity.
ReadableAttributes Get a map of readable attributes and their values.
Rows Get the number of rows of text on the screen, excluding the OIA and divider line.
Screen Create an XML representation of a terminal screen.
SystemAvailable Return a flag indicating that the AS/400 system available indicator is asserted on the status line.
WriteableAttributes Get a map of writeable attributes and their values.

See Also

TerminalScreen Class | WRQ.Verastream.HostIntegrator Namespace