HideRow
Mon 01 January 2018Syntax
HideRow(scrollpath) [, target_row])
Where scrollpath is:
[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]] RECORD.target_recname
To prevent ambiguous references, you can also use SCROLL. scrollname , where scrollname is the same as the scroll levelâs primary record name.
Description
Use the HideRow function to hide a row occurrence programmatically.
Note: This function remains for backward compatibility only. Use the Visible row class property instead.
It hides the specified row and any associated rows at lower scroll levels.
Hiding a row just makes the row invisible, it does not affect database processing such as inserting new rows, updating changed values, or deleting rows.
When you hide a row, it becomes the last row in the scroll or grid, and the other rows are renumbered accordingly. If you later use UnHideRow to make the row visible again, it is not moved back to its original position, but remains in its new position. When HideRow is used in a loop, you have to process rows from the highest number to the lowest to achieve the correct results.
Note: HideRow cannot be executed from the same scroll level as the row that is being hidden, or from a lower scroll level. Place the PeopleCode in a higher scroll level record.
Parameters
|
Field or Control |
Definition |
|---|---|
| scrollpath |
A construction that specifies a scroll level in the component buffer. |
| target_row |
An integer specifying which row in the scroll to hide. If this parameter is omitted, the row on which the PeopleCode program is executing is assumed. |
Returns
Boolean (optional). HideRow returns a Boolean value indicating whether the function executed successfully.