Class TerminalScreen

TerminalScreen represents a terminal screen. It contains methods that allow an entity or an unrecognized screen to be displayed, for example, as a web page.

Inheritance

object

TerminalScreen

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: WRQ.Verastream.HostIntegrator

Assembly: WRQ.Verastream.HostIntegrator.dll

Syntax

[Serializable]
public class TerminalScreen

Properties

Columns

Get the number of columns of text on the screen.

Declaration

public int Columns { get; }

Property Value

Type	Description
int

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

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.

Declaration

public string CommErrorCode { get; }

Property Value

Type	Description
string	3270 communication error text

ConnectedToHost

Determine if the session is connected to the host system.

Declaration

public bool ConnectedToHost { get; }

Property Value

Type	Description
bool	Flag indicating that this session is connected to the host system.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

CursorColumn

Get the zero-based column number where the cursor is located.

Declaration

public int CursorColumn { get; }

Property Value

Type	Description
int	The (zero-based) column number containing the cursor.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

CursorPosition

Get the zero-based absolute offset to where the cursor is located.

Declaration

public int CursorPosition { get; }

Property Value

Type	Description
int	The (zero-based) cursor offset within the screen.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

CursorRow

Get the zero-based row number where the cursor is located.

Declaration

public int CursorRow { get; }

Property Value

Type	Description
int	The (zero-based) row number containing the cursor.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

DefaultOperationName

Get the name of the default VHI operation.

Declaration

public string DefaultOperationName { get; }

Property Value

Type	Description
string	Default VHI operation, or null if there is none.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

Entity

Create an XML representation of a terminal screen, using VHI entity attributes when presenting input fields.

Declaration

public Screen Entity { get; }

Property Value

Type	Description
Screen	String containing XML representation of a terminal screen, or null if this is not a defined entity.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

EntityName

Return the name of the host application screen.

Declaration

public string EntityName { get; }

Property Value

Type	Description
string	Empty string if host screen not recognized, else the entity name defined in the VHI model file.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

ErrorCode

Return the 5250 error code (1 4-digit hex value), or an empty string if there is no error condition.

Declaration

public string ErrorCode { get; }

Property Value

Type	Description
string	5250 Error Code (4-digit hex value)

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).

Declaration

public bool FieldStructured { get; }

Property Value

Type	Description
bool	true if the screen is structured.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

Fields

Return a list of ScreenField objects that represent terminal fields

Declaration

public IList Fields { get; }

Property Value

Type	Description
IList	List of ScreenField objects containing information for each terminal field on the screen.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

InputInhibit

Return a flag indicating that the Input Inhibit (Also known as keyboard locked) indicator is asserted on the status line.

Declaration

public bool InputInhibit { get; }

Property Value

Type	Description
bool	5250 Input Inhibit (Keyboard disabled) flag

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>"

Declaration

public string KeyboardDisabledReason { get; }

Property Value

Type	Description
string	3270 keyboard disabled reason/status.

MessageWaiting

Return a flag indicating that the Message Wait indicator is asserted on the status line.

Declaration

public bool MessageWaiting { get; }

Property Value

Type	Description
bool	5250 Message Waiting flag

OperationNames

Get a list of operation names for this screen.

Declaration

public IList OperationNames { get; }

Property Value

Type	Description
IList	list of operation names.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

PartitionId

Return the 3270 partition ID (A number from 0 to 255), or an empty string if partitions are not in use.

Declaration

public string PartitionId { get; }

Property Value

Type	Description
string	3270 partition ID

PartitionOwner

Return the 3270 partition owner.

Expected return values are:

• "None"
• "SSCP"
• "LU"
• "Not-Active"

Declaration

public string PartitionOwner { get; }

Property Value

Type	Description
string	3270 partition owner.

ReachableEntities

Get a list of entities reachable from the current entity.

Declaration

public IList ReachableEntities { get; }

Property Value

Type	Description
IList	list of reachable entities.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

ReadableAttributes

Get a map of readable attributes and their values.

Declaration

public IDictionary ReadableAttributes { get; }

Property Value

Type	Description
IDictionary	Map of readable VHI attributes and their values.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

Rows

Get the number of rows of text on the screen, excluding the OIA and divider line.

Declaration

public int Rows { get; }

Property Value

Type	Description
int	Number of rows on this screen.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

Screen

Create an XML representation of a terminal screen.

Declaration

public Screen Screen { get; }

Property Value

Type	Description
Screen	String containing XML representation of a terminal screen.

SystemAvailable

Return a flag indicating that the AS/400 system available indicator is asserted on the status line.

Declaration

public bool SystemAvailable { get; }

Property Value

Type	Description
bool	5250 System Available flag

WriteableAttributes

Get a map of writeable attributes and their values.

Declaration

public IDictionary WriteableAttributes { get; }

Property Value

Type	Description
IDictionary	Map of writeable VHI attributes and their values.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

Methods

GetColor(int)

Returns the color of the character at the specified offset.

Declaration

public Color GetColor(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
Color	Color of this character cell.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

GetText()

Get the text for the entire screen.

Declaration

public string GetText()

Returns

Type	Description
string	text for the entire terminal screen.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

GetText(int)

This method is deprecated and will be removed in a future releaase. Please replace with GetText() to get the same result.

Declaration

[Obsolete("Please use GetText() instead.", false)]
public string GetText(int offset)

Parameters

Type	Name	Description
int	offset	offset

Returns

Type	Description
string	text

GetText(int, int)

Get length characters of text from the terminal screen starting at offset.

Declaration

public string GetText(int offset, int length)

Parameters

Type	Name	Description
int	offset	0-based offset starting character
int	length	number of characters to return

Returns

Type	Description
string	Requested characters from the display.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

GetTextRow(int)

Get a row of text for this screen.

Declaration

public string GetTextRow(int row)

Parameters

Type	Name	Description
int	row	0-based row for which text is to be obtained.

Returns

Type	Description
string	Row of text, or empty string if row value is out of range.

Remarks

This property supports the Verastream .NET API framework and is not intended to be used directly in your code.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsBlink(int)

Determines if the character at the specified offset is blinking.

Declaration

public bool IsBlink(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is a blinking character.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsColumnSeparated(int)

Determines if the character at the specified offset is column separated.

Declaration

public bool IsColumnSeparated(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is a column separated character.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsFieldEnd(int)

Determines if the character at the specified offset is the end of a terminal field.

Declaration

public bool IsFieldEnd(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is the end of a terminal field.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsFieldStart(int)

Determines if the character at the specified offset is the start of a terminal field.

Declaration

public bool IsFieldStart(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is the start of a terminal field.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsHighIntensity(int)

Determines if the character at the specified offset is high intensity.

Declaration

public bool IsHighIntensity(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is an intense display character.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsInput(int)

Determines if the character at the specified offset is an input field.

Declaration

public bool IsInput(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is an input field.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsNumeric(int)

Determines if the character at the specified offset is numeric.

Declaration

public bool IsNumeric(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is a character within a numeric field.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsPenDetect(int)

Determines if the character at the specified offset is pen detect.

Declaration

public bool IsPenDetect(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is a character within a lightpen field.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsReverseVideo(int)

Determines if the character at the specified offset is reverse video.

Declaration

public bool IsReverseVideo(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is a reverse-video character.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsUnderscore(int)

Determines if the character at the specified offset is underscore.

Declaration

public bool IsUnderscore(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is an underlined character.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.

IsVisible(int)

Determines if the character at the specified offset is visible.

Declaration

public bool IsVisible(int offset)

Parameters

Type	Name	Description
int	offset	0-based offset of character for which data is to be obtained.

Returns

Type	Description
bool	Flag indicating that this is a visible character.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when an index argument value is out of range.