SetDisplayFormat
Mon 01 January 2018Syntax
SetDisplayFormat(scrollpath, target_row, [recordname.]fieldname, display_format_name)
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
Usethe SetDisplayFormat function to change the display format of Custom Defined Fields at runtime. For instance, you may want to update a custom numeric display to reveal more decimal points.
Note: This function remains for backward compatibility only. Use the DisplayFormat field property instead.
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. |
| [ recordname . ] fieldname |
The name of the field to change. The field can be on scroll level one, two, or three of the active page. The recordname prefix is required if the call to SetDisplayFormat is not on the record definition recordname . |
| display_format_name |
The name of the custom display format specified in the field definition. |
Returns
Returns a Boolean value indicating whether the function executed successfully. The return value is not optional.