Unhide

Mon 01 January 2018

Syntax

Unhide(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 use SCROLL. scrollname , where scrollname is the same as the scroll level’s primary record name.

Description

Use the Unhide function to make a field visible that was previously hidden with Hide. If the field was hidden by setting its Invisible property in the Page Field Properties dialog box, then Unhide has no effect.

Note: This function remains for backward compatibility only. Use the Visible field property instead.

Generally, you want to put this function on the same scroll level as the field that is being changed in RowInit (which executes on every row) or FieldChange (which executes on the current row). This simplifies the function’s syntax to:

unhide(fieldname)

A typical use of the more complex syntax is when looping through rows on a scroll on a lower level than the 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

The row number of the target row. If this parameter is omitted, the function assumes the row on which the PeopleCode program is executing.

[ recordname . ] fieldname

The name of the field to unhide. The field can be on scroll level one, two, or three of the active page. The recordname prefix is required if the call to Unhide is not on the record definition recordname .

Returns

Optionally returns a Boolean value indicating whether the function executed successfully.