Class ScreenField

ScreenField provides information about a field on the terminal screen.

Inheritance

object

ScreenField

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 ScreenField

Remarks

This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.

Properties

Column

Gets the 0-based column of the start of this field.

Declaration

public virtual int Column { 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.

HasCursor

Determine if the terminal cursor is within this field.

Declaration

public virtual bool HasCursor { get; }

Property Value

Type	Description
bool	true if the terminal cursor is within this field.

Remarks

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

Length

Gets the length of this field.

Declaration

public virtual int Length { 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.

Offset

Gets the 0-based offset of the start of this field.

Declaration

public virtual int Offset { 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.

Row

Gets the 0-based row of the start of this field.

Declaration

public virtual int Row { 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.

Text

The screen text for this field.

Declaration

public virtual string Text { get; }

Property Value

Type	Description
string	The text for the entire field. Note that when isWrapAround() is true the first getWrapLength() characters of the text should appear at the position Offset, (or at Row, Column). The next (getLength() - getWrapLength()) characters should appear at the top left of the terminal screen.

Remarks

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

UniformAttributes

Return true if the character attributes (color, highlighting, etc) are the same for each character within this field.

Declaration

public virtual bool UniformAttributes { get; }

Property Value

Type	Description
bool	Flag indicating that the attributes within this field are uniform.

Remarks

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

WrapAround

Return true if this field wraps around on the screen.

Declaration

public virtual bool WrapAround { get; }

Property Value

Type	Description
bool	Flag indicating that this field wraps the screen.

Remarks

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

WrapLength

Return number of characters which occur before the field wrap.

Declaration

public virtual int WrapLength { get; }

Property Value

Type	Description
int

Remarks

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

Methods

CharAt(int)

The character at a zero-based offset within the field.

Declaration

public virtual string CharAt(int i)

Parameters

Type	Name	Description
int	i	zero-based offset within this field.

Returns

Type	Description
string	The character at the specified offset within the field.

Remarks

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

Exceptions

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

GetColor()

Return true if the first character of the field is for input.

Declaration

public virtual Color GetColor()

Returns

Type	Description
Color	The color of the field.

Remarks

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

GetColor(int)

Return the color of a character within the field.

Declaration

public virtual Color GetColor(int i)

Parameters

Type	Name	Description
int	i	zero-based offset within the terminal field.

Returns

Type	Description
Color

Remarks

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

IsBlink()

Return true if the first character of the field is blinking text.

Declaration

public virtual bool IsBlink()

Returns

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

Remarks

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

IsBlink(int)

Return true if the ith character of the field is blinking text.

Declaration

public virtual bool IsBlink(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

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

Remarks

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

Exceptions

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

IsColumnSeparated()

Return true if the first character of the field is column separated (5250).

Declaration

public virtual bool IsColumnSeparated()

Returns

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

Remarks

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

IsColumnSeparated(int)

Return true if the ith character of the field is column separated (5250).

Declaration

public virtual bool IsColumnSeparated(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

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

Remarks

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

Exceptions

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

IsHighIntensity()

Return true if the first character of the field is high intensity.

Declaration

public virtual bool IsHighIntensity()

Returns

Type	Description
bool	Flag indicating that this is a high-intensity field.

Remarks

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

IsHighIntensity(int)

Return true if the ith character of the field is high intensity. Note: VHI emulation (3270 and 5250) never set this bit.

Declaration

public virtual bool IsHighIntensity(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

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

Remarks

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

Exceptions

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

IsInput()

Return true if the first character of the field is for input.

Declaration

public virtual bool IsInput()

Returns

Type	Description
bool	Flag indicating this is an input field.

Remarks

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

IsInput(int)

Return true if the ith (zero-based) character of the field is for input.

Declaration

public virtual bool IsInput(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

Type	Description
bool	Flag indicating this is the character of an input field.

Remarks

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

Exceptions

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

IsNumeric()

Return true if the first character of the field has numeric attribute.

Declaration

public virtual bool IsNumeric()

Returns

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

Remarks

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

IsNumeric(int)

Return true if the ith character of the field has numeric attribute.

Declaration

public virtual bool IsNumeric(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

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

Remarks

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

Exceptions

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

IsPenDetect()

Return true if the first field character is lightpen detectable.

Declaration

public virtual bool IsPenDetect()

Returns

Type	Description
bool	Flag indicating that this is a pen-detectable field.

Remarks

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

IsPenDetect(int)

Return true if the ith field character is lightpen detectable.

Declaration

public virtual bool IsPenDetect(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

Type	Description
bool	Flag indicating that this is a character in a pen-detectable field.

Remarks

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

Exceptions

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

IsReverseVideo()

Return true if the first field character is reverse-video.

Declaration

public virtual bool IsReverseVideo()

Returns

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

Remarks

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

IsReverseVideo(int)

Return true if the ith field character is reverse-video.

Declaration

public virtual bool IsReverseVideo(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

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

Remarks

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

Exceptions

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

IsUnderscore()

Return true if the first field character is underlined.

Declaration

public virtual bool IsUnderscore()

Returns

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

Remarks

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

IsUnderscore(int)

Return true if the ith field character is underlined.

Declaration

public virtual bool IsUnderscore(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

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

Remarks

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

Exceptions

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

IsVisible()

Return true if the first character of the field is visible.

Declaration

public virtual bool IsVisible()

Returns

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

Remarks

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

IsVisible(int)

Return true if the ith character of the field is visible.

Declaration

public virtual bool IsVisible(int i)

Parameters

Type	Name	Description
int	i	Zero-based character offset within the field.

Returns

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

Remarks

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

Exceptions

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