Hide
Mon 01 January 2018Syntax
Hide(scrollpath, target_row, [recordname.]fieldname)
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 Hide function to make a page field invisible.
Note: This function remains for backward compatibility only. Use the Visible field class property instead.
You can display the field again using Unhide, but Unhide has no effect on a field that has been made display-only in the page definition.
Gray, Hide, Ungray, and Unhide usually appear in RowInit programs that set up the initial display of data, and in FieldChange programs that change field display based on changes the user makes to a field. Generally, you put the functions on the same scroll level as the field that is being changed. This reduces the complexity of the functionâs syntax to:
Hide(fieldname)The more complex syntax can be used to loop through a scroll on a lower level than the PeopleCode program.
Note: This function shouldn't be used in any event prior to RowInit.
Parameters
|
Field or Control |
Definition |
|---|---|
| scrollpath |
A construction that specifies a scroll level in the component buffer. |
| target_row |
An integer specifying the row on the target scroll level where the referenced buffer field is located. |
| [ recordname . ] fieldname |
The name of the field to hide. The field can be on scroll level one, two, or three of the active page. The recordname prefix is required if the call to Hide is not on the record definition recordname |
Returns
Boolean (optional). Hide returns a Boolean value indicating whether it executed successfully.