Function PropertyPrice2Output
Returns the property price and optionally status and tenure as a string for display.
PropertyPrice2Output([VALUE],[SOURCE],[DATASOURCE],[ADDSTATUS],[ADDSTENURE])Parameters
| # | Type | Passing | Default | Name | Description/Comments |
|---|---|---|---|---|---|
| 1 | decimal | required | n/a | VALUE | The value to format (usually PRICEASK). Note also this value may be ignored and PRICEORIG or PRICEOFFER may be used depending on the status value from the property |
| 2 | integer | optional | 0 | SOURCE | Source of data for pricing/status: 0 = From the table alias 1 = From the form object passed in the next parameter |
| 3 | string or object | optional | alias() | DATASOURCE | The data source either: When SOURCE = 0 is an alias like "PROPERTY" or alias() When SOURCE = 1 is a form object like Thisform |
| 4 | boolean | optional | .F. | ADDSTATUS | Add the property status to the price string, .T. = Display "For Sale @" and "To Rent @" etc |
| 5 | boolean | optional | .F. | ADDSTENURE | Add the property tenure to the end of the price string |
Returns
The formatted value as a string
Examples
To output a string like "For Sale @ £1,000,000 Freehold"
PropertyPrice2Output(PRICEASK,0,"PROPERTY",.T.,.T.)To output a string like "£1,000 pm"
PropertyPrice2Output(PRICEASK,0,"PROPERTY",.F.,.F.)
