The SUBFILE_ACCESSOR object may be used to access a 5250 subfile from a script.
See Using Subfile Accessor.
Properties
SelectionColumnOffset |
The offset of the selection column when it is in a different row to the matched column. Default is 0 (zero), indicating it is on the same subfile row. |
|---|---|
SelectionKey |
The key to be sent to select an entry in the subfile. The default is KeyEnter. |
KeyPageDown |
The key to be used to page the subfile down. The default is KeyPageDown. |
Scrollable |
Indicates whether the subfile may be scrolled down. The default is true. |
Trace |
Indicates whether detailed trace information should be produced from the subfile when trace mode is on. The default is true. |
SelectionByCursor |
Used when selection is to be done by cursor location. Default is false. Typically SelectionByCursorOffset is also set when using this value. |
SelectionByCursorOffset |
When using SelectionByCursor this value indicates the offset between the matching row in the datagrid control and the actual 5250 screen line number the cursor should be positioned to. |
EndofFileMarker |
Set the EndofFileMarker property to the value used in the subfile/browselist marker when the end of file has been reached. It will be then used to determine the end of the subfile when trying to select an entry. Default is "Bottom". |
UseMarker |
Set the UseMarker property to false when the subfile/browse list does not use markers. |
|
Methods
Dispose() |
Used to dispose of a SUBFILE_ACCESSOR object when you have completed using in a script |
|---|---|
SetSearchColumnNumber(1,2,3,4); |
Defines a search column, by column number, to be used when looking for an entry in the subfile. Arguments are: |
SetSearchColumnName(1,2,3,4) |
Defines a search column, by column name, to be used when looking for an entry in the subfile. Arguments are: |
SelectSubFileEntry() |
Searches the subfile using the column search and selection details provided and selects the required subfile entry. |
TracePage() |
Dumps the current subfile details to the trace (if trace is active). No arguments. |
SetSelectionColumnName(1,2,3) |
Defines the selection column, by column name, to be used when selecting an entry in the subfile. Arguments are: |
SetSelectionColumnNumber(1,2,3) |
Defines the selection column, by column number, to be used when selecting an entry in the subfile. Arguments are: |
|
Use the right mouse when coding scripts to generate base SUBFILE_ACCESSOR code. See Using the Scripting Pop-up Menu .
Show Contents List