Function PropertyPropTypePriceDisplay
Returns the property price and optionally status, type and bedrooms as a string for display.
The price that will be displayed depends on the status of the property.
PropertyPropTypePriceDisplay([VALUE],[SOURCE],[DATASOURCE],[ADDSTATUS],[LINEBREAK])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 | required | n/a | SOURCE | Source of data for pricing/status: 0 = From the table alias 1 = From the form object passed in the next parameter 2 = From a a table in the grid - the next parametrer is the Property Code |
| 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 When SOURCE = 2 is a the property code value |
| 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. | LINEBREAK | Add a line break between price, type and bedrooms |
Returns
The formatted value as a string
Examples
To output a string like "For Sale @ £1,000,000 Detached 3 Bedroom"
PropertyPropTypePriceDisplay(PRICEASK,0,"PROPERTY",.T.,.F.)To output a string like "SSTC @ £1,000,000 Detached 3 Bedroom" if the proeprty is SSTC
PropertyPropTypePriceDisplay(PRICEASK,0,"PROPERTY",.T.,.F.)To output a string like
"For Sale @ £1,000,000
Detached
3 Bedroom"
PropertyPropTypePriceDisplay(PRICEASK,0,"PROPERTY",.T.,.T.)To output a string like "For Sale @ £1,000,000"
PropertyPropTypePriceDisplay(PRICEASK,0,"PROPERTY",.F.,.F.)
