IDisplayFile interface | QSYS API Reference Guide
Estimated reading time: 4 minutes
Exposes DisplayFile properties and methods
Namespace: ASNA.QSys.Expo.Model Assembly: ASNA.QSys.Expo.Model.dll
Extends: doesn’t extend any other interfaces.
Remarks
Encapsulates the portion if the class that implements this interface with properties and methods that are common between the Application logic and the Interactive Website.
The interface is used by ASNA.QSys.Runtime’s Workstation file concept maintaining the two assemblies (ASNA.QSys.Expo and ASNA.QSys.Runtime) Loosely coupled.
Properties
| Type | Name | Description |
|---|---|---|
| DataSet | DataSet | Gets the DisplayFile DataSet |
| Boolean | DisplayErrorMessages | Gets a boolean value that indicates if the Error Messages should be displayed |
| Int16 | FeedbackActiveWindowCursor | If a Window Record is active, this property gets or sets a value that indicates Cursor (row, column) corresponding to the last location last user input (Hi byte is the row, Lo-byte is the column) |
| Byte | FeedbackAID | Gets a value that indicates the AID code sent in last user request |
| Int16 | FeedbackCursor | Gets a value that indicates Cursor (row, column) corresponding to the last location last user input (Hi byte is the row, Lo-byte is the column) |
| String | FeedbackField | Gets a value that indicates the name of the last Field where the Cursor was positioned, corresponding to the last location last user input |
| Int16 | FeedbackFlags | Gets a value that indicates Miscellaneous feedback flags. Bit 1: Cancel-read indicator. Bit 2: Data-returned indicator. Bit 3: Command key indicator. Bits 4-16: Reserved. |
| Int16 | FeedbackLowestSubfile | Gets a value that indicates the indicates the lowest subfile relative record number currently displayed in the uppermost subfile display area if the last write operation was done to the subfile control record with ‘Subfile Display’ specified. Updated for roll up and roll down operations. Reset to 0 on a write operation to another record. Not set for message subfiles |
| Int16 | FeedbackSubfileCursorRRN | Gets or sets a value that indicates Relative Record Number of a subfile record. For input operations, updated only if data is returned to the program. If multiple subfiles are on the display, this offset will contain the relative record number for the last subfile updated. |
| Int32 | InstanceId | Gets a value that indicates the Unique Page instance ID |
| String | LastFormatNameWritten | Gets a value that indicates the name of the last Record Format written |
| String | PageName | Gets a value that indicates the Name of the Page (URL) |
Methods
| Signature | Description |
|---|---|
| AddCallHostSpecs(CallHostSpecs) | Will throw NonImplemented exception |
| GetTopRecordOnInput(String) | Gets the Subfile Top Relative Record Number in the last input operation |
| SetOneTimeDefaultValue(String) | Marks a field as one that has had a Default value (internal use) |
| SetTopRecordOnInput(String, Int32) | Sets the Subfile Top Relative Record Number for the last input operation |
int AddCallHostSpecs(CallHostSpecs buildOptionsSpecs)
Will throw NonImplemented exception
int AddCallHostSpecs(CallHostSpecs buildOptionsSpecs)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| CallHostSpecs | buildOptionsSpecs | CallHostSpecs instance |
Returns
| Type | Description |
|---|---|
| Int32 | throws exception |
int GetTopRecordOnInput(string format)
Gets the Subfile Top Relative Record Number in the last input operation
int GetTopRecordOnInput(string format)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | format | subfile record name |
Returns
| Type | Description |
|---|---|
| Int32 | the relative record number at the top |
bool SetOneTimeDefaultValue(string fieldID)
Marks a field as one that has had a Default value (internal use)
bool SetOneTimeDefaultValue(string fieldID)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | fieldID | field name |
Returns
| Type | Description |
|---|---|
| Boolean | true the field was not marked as having a Default value |
void SetTopRecordOnInput(string formatName, int rrn)
Sets the Subfile Top Relative Record Number for the last input operation
void SetTopRecordOnInput(string formatName, int rrn)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | subfile record name |
| Int32 | rrn | relative record number |