Class Screen
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.
Inherited Members
Namespace: WRQ.Verastream.HostIntegrator
Assembly: WRQ.Verastream.HostIntegrator.dll
Syntax
[Serializable]
public class Screen
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.
Constructors
Screen(string, IDictionary, bool, bool, bool, string, string, IList, IDictionary, IDictionary, string, string)
Constructor for internal use only. Creates Hashtable containers for the IDictionary parameters because legacy Web Builder casts IDictionary properties to Hashtable. This behavior is fixed in VHI 7.0 but we need to do this to support existing applications.
Declaration
public Screen(string xmlText, IDictionary fields, bool messageWaiting, bool keyboardLocked, bool connectedToHost, string errorCode, string errorMessage, IList operationNames, IDictionary readableAttributes, IDictionary writeableAttributes, string defaultOperationName, string entityName)
Parameters
Type | Name | Description |
---|---|---|
string | xmlText | xmlText |
IDictionary | fields | fields |
bool | messageWaiting | messageWaiting |
bool | keyboardLocked | keyboardLocked |
bool | connectedToHost | connectedToHost |
string | errorCode | errorCode |
string | errorMessage | errorMessage |
IList | operationNames | operationNames |
IDictionary | readableAttributes | readableAttributes |
IDictionary | writeableAttributes | writeableAttributes |
string | defaultOperationName | defaultOperationName |
string | entityName | entityName |
Properties
ConnectedToHost
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
Declaration
public virtual bool ConnectedToHost { get; }
Property Value
Type | Description |
---|---|
bool | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
Remarks
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
Exceptions
Type | Condition |
---|---|
HostIntegratorConnectorException | Thrown when client is not connected. |
DefaultOperationName
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
Declaration
public virtual string DefaultOperationName { get; }
Property Value
Type | Description |
---|---|
string | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
Remarks
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
EntityName
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
Declaration
public virtual string EntityName { get; }
Property Value
Type | Description |
---|---|
string | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
ErrorCode
Gets the AS/400 error code, or empty string if there is no error.
Declaration
public virtual string ErrorCode { get; }
Property Value
Type | Description |
---|---|
string | AS/400 error code, or empty string if there is no error. |
Remarks
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
ErrorMessage
Gets the terminal error message, or empty string if there is no error.
Declaration
public virtual string ErrorMessage { get; }
Property Value
Type | Description |
---|---|
string | Error message, or empty string if there is no error. |
Remarks
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
InputFields
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
Declaration
public virtual IDictionary InputFields { get; }
Property Value
Type | Description |
---|---|
IDictionary | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
KeyboardLocked
Determines whether or not the keyboard is locked.
Declaration
public virtual bool KeyboardLocked { get; }
Property Value
Type | Description |
---|---|
bool | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
MessageWaiting
Determine whether or not the AS/400 message waiting indicator is asserted.
Declaration
public virtual bool MessageWaiting { get; }
Property Value
Type | Description |
---|---|
bool | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
OperationNames
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
Declaration
public virtual IList OperationNames { get; }
Property Value
Type | Description |
---|---|
IList | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
Remarks
This property supports the Verastream .NET API framework and is not intended to be used directly in your code.
ReadableAttributes
Gets a Map of readable VHI attributes names/values.
Declaration
public virtual IDictionary ReadableAttributes { get; }
Property Value
Type | Description |
---|---|
IDictionary | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
WriteableAttributes
Gets a Map of writeable VHI attributes names/values.
Declaration
public virtual IDictionary WriteableAttributes { get; }
Property Value
Type | Description |
---|---|
IDictionary | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |
XMLText
Creates an xml document that specifies the text, colors, fields, and field attributes of a terminal screen. If the screen is a recognized entity, the xml document also contains information about writeable attributes that exist on the entity.
Declaration
public virtual string XMLText { get; }
Property Value
Type | Description |
---|---|
string | This property supports the Verastream .NET API framework and is not intended to be used directly in your code. |