WebDisplayFile class | QSYS API Reference Guide
Estimated reading time: 8 minutes
Provides a program with an interface to the user interactions, supporting read and write operation to the user’s screen.
Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Constructors
| Name | Description |
|---|---|
| WebDisplayFile(String, String, AdgDataSet, Boolean) | Initializes a new instance of a web display file. |
| WebDisplayFile(String, String, DataSet) | Initializes a new instance of a web display file. |
WebDisplayFile(String, String, AdgDataSet, Boolean)
Initializes a new instance of a web display file.
WebDisplayFile(String, String, AdgDataSet, Boolean)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | fileName | Name of the display file. |
| String | pageName | Web page name used to identify the display file. |
| AdgDataSet | dataSet | Dataset used as the data buffer for the records of the display file. |
| Boolean | shared | true to indicate that the display file can be shared with other programs using the same device; otherwise false. |
WebDisplayFile(String, String, DataSet)
Initializes a new instance of a web display file.
WebDisplayFile(String, String, DataSet)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | fileName | Name of the display file. |
| String | pageName | Web page name used to identify the display file. |
| DataSet | dataSet | Dataset used as the data buffer for the records of the display file. |
Properties
| Type | Name | Description |
|---|---|---|
| DataSet | DataSet | Gets the dataset containing the data for the records of the display file. |
| Boolean | DisplayErrorMessages | Gets a value that indicates whether to display error messages. |
| Int16 | FeedbackActiveWindowCursor | Gets or sets the cursor position on the active window. |
| Byte | FeedbackAID | Gets or sets the device’s attention identifier (AID) key pressed. |
| Int16 | FeedbackCursor | Gets or sets the device’s cursor position. |
| String | FeedbackField | Gets or set the name of the field where the cursor was position when the AID key was pressed. |
| Int16 | FeedbackFlags | Gets an indication of the last key pressed: a value of 0 if it was a function key, otherwise a 4. |
| Int16 | FeedbackLowestSubfile | Gets or sets the subfile record number on first record displayed on the screen when the AID key was pressed. |
| Int16 | FeedbackSubfileCursorRRN | Gets or sets the subfile record number where the cursor was position when the AID key was pressed. |
| Int32 | HostResult | Result from HostService. |
| HostService | HostService | Requested service from the (IBM i) Host. |
| String | LastFormatName | Gets or sets the name of the last format name of the display file used to output data. |
| String | PageName | Gets the page name that identifies this display file. |
| String | SvcString | Parameter of HostService. |
Methods
| Signature | Description |
|---|---|
| Attach() | Attaches a new use of the display file. |
| ClearSubfile(String) | Clears the dataset’s table used as the bufer for a subfile. |
| Close() | Closes the display file disposing of its resources. |
| DeactivateFormats(String, String) | Marks a set of record formats as not being available for being displayed on the device. |
| DisplaySubfileRecords(String) | Marks a subfile as being active and available to be displayed at the device. |
| GetCurrentRow(String) | Gets the current, or active, row number for a record format. |
| GetSharedFile(String) | Gets a sharable display file. |
| InitMessageSubfile(String, String, Char[]) | Initialized the records of a subfile with the messages on a program’s message queue. |
| IsActive(String) | Gets a value indicating whether a record format is active or not. |
| Open() | Opens the display file for IO operations, allocating the dataset buffer for the file’s records. |
| Read() | Presents the current data on the device and waits for the user to enter new data. |
| SetActive(String) | Marks a record format as being active. |
| SetCurrentRow(String, Int32) | Sets the current, or acive, row number for a record format. |
| Update() | Checks to see if the job should shutdown. |
| Write() | Checks to see if the job should shutdown. |
AdgDataSet Attach()
Attaches a new use of the display file.
AdgDataSet Attach()
void ClearSubfile(string subfileName)
Clears the dataset’s table used as the bufer for a subfile.
void ClearSubfile(string subfileName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | subfileName | The name of the sufile to clear. |
void Close()
Closes the display file disposing of its resources.
void Close()
void DeactivateFormats(string formatNames, string excludeFormatChildren)
Marks a set of record formats as not being available for being displayed on the device.
void DeactivateFormats(string formatNames, string excludeFormatChildren)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatNames | A comma separated list of the record formats to clear. Use *ALL to deactivate all the records of the display file. |
| String | excludeFormatChildren | The name of the format whose children should not be affected when deactiating *ALL records. |
void DisplaySubfileRecords(string subfileName)
Marks a subfile as being active and available to be displayed at the device.
void DisplaySubfileRecords(string subfileName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | subfileName | The name of the sufile to clear. |
int GetCurrentRow(string formatName)
Gets the current, or active, row number for a record format.
int GetCurrentRow(string formatName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | The name of the record format. |
Returns
| Type | Description |
|---|---|
| Int32 | The current row number. |
WebDisplayFile GetSharedFile(string DclFileName)
Gets a sharable display file.
WebDisplayFile GetSharedFile(string DclFileName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | DclFileName | The name of the display file to get. |
Returns
| Type | Description |
|---|---|
| WebDisplayFile | The sharable display file. Null if one is not found. |
void InitMessageSubfile(string subfileName, string programQ, Char[] optionIndicators)
Initialized the records of a subfile with the messages on a program’s message queue.
void InitMessageSubfile(string subfileName, string programQ, Char[] optionIndicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | subfileName | The name of the subfile file to initialize. |
| String | programQ | The program queue identifier. |
| Char[] | optionIndicators | A set of 100 option indicators to associate with each subfile record. |
bool IsActive(string formatName)
Gets a value indicating whether a record format is active or not.
bool IsActive(string formatName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | The name of the record format. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the record format is active. |
void Open()
Opens the display file for IO operations, allocating the dataset buffer for the file’s records.
void Open()
void Read()
Presents the current data on the device and waits for the user to enter new data.
void Read()
void SetActive(string formatName)
Marks a record format as being active.
void SetActive(string formatName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | The name of the record format. |
void SetCurrentRow(string formatName, int row)
Sets the current, or acive, row number for a record format.
void SetCurrentRow(string formatName, int row)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | The name of the record format. |
| Int32 | row | The new current row number. |
void Update()
Checks to see if the job should shutdown.
void Update()
void Write()
Checks to see if the job should shutdown.
void Write()