| Function Name: | CombineText |
| Description: | This function is typically used in diagram text
schemes. It allows you to combine text by
adding a prefix and/or suffix to the text returned
by a given data reference; or to optionally supply
alternative text to use if no text is returned.
See also ExistsText, NotExistsText and ForceText. |
| Minimum FH Version: | 3 |
| No. of Parameters: | 4 |
| Return Type: | Text |
| Parameter 1: | Prefix text. Will be added at the front of the result text if, and only if, parameter 2 text is not empty. |
| Parameter 2: | The main text ‘string’. Is usually the text associated with a data reference. This text string, if not empty, will be returned by the function, preceded by the parameter 1 text, and followed by parameter 3 text. |
| Parameter 3: | Suffix text. Will be added at the end of the result text if, and only if, parameter 2 text is not empty. |
| Parameter 4: | The text to output if parameter 2 is empty. |
| Examples: | =CombineText(“in the year ”,
%INDI.DEAT.DATE:YEAR%, “ A.D.”, “<year not
known>”)
If the data reference in parameter 2 returned 1971, this would output the text in the year 1971 A.D. If the data reference in parameter 2 returned nothing, the function would output <year not known> |
| The CHM file was converted to HTML by chm2web software. |