SelectRowByKey() method
- Last UpdatedNov 26, 2024
- 1 minute read
Use the SelectRowByKey() method to select the row in the grid containing the file path. If the file is not found and the selectFirstRowAsDefault parameter is set, the first row in the grid is selected. Otherwise, the current row selection remains unchanged.
Syntax
result = SelectRowByKey(fileSource, filePath, selectFirstRowAsDefault);
Parameters
fileSource
An enumeration type { ItemFile=0, WorkOrderFile=1, FolderFile=2, FolderEntity=3, RunEntity=4} that is a file source to determine whether the file is an Item file, a Work Order file, a Folder file (specifies a file for the Entity for which the folder was built) or a Run Entity (specifies a file for the current Entity on which the job is running).
filePath
A file path that is the path of the selected file.
selectFirstRowAsDefault
A Boolean value that is set to True to select the first row if the specified path is not found.
Return Value
result
A Boolean value that is True if the row containing the file path is found; otherwise, it returns False.