GetStoredFormat
Mon 01 January 2018Syntax
GetStoredFormat(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 GetStoredFormat function to return the name of a fieldâs custom stored format.
Note: This function remains for backward compatibility only. Use the StoredFormat field class property instead.
To return the format for a field on level zero of the page, pass 1 in target_row .
Parameters
|
Field or Control |
Definition |
|---|---|
| scrollpath |
A construction that specifies a scroll level in the component buffer. |
| target_row |
An integer specifying the row of the target field. If you are testing a field on level zero, pass 1 in this parameter. |
| [ recordname . ] fieldname |
The name of the field from which to get the stored format name. The field can be on any level of the active page. The recordname prefix is required if the call to GetStoredFormat is not on the record definition recordname . |
Returns
Returns a String equal to the name of the stored custom format for the field.