Functions (by category)

Text Functions

 

Function Short Description
CombineText 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 CombineText_AB, ExistsText, NotExistsText and ForceText.

CombineText_AB This function is typically used in diagram text schemes. It allows you to combine two items of text by adding a prefix and/or suffix, and optionally a separator for the two items, and alternative text to use if both items of text are blank.

See also CombineText, ExistsText, NotExistsText and ForceText.

ContainsText Used for search for text in records, and other data items.
ExistsText This function is typically used in diagram text schemes. It allows you to specify a data reference, and text to be output if, and only, if data is found for the specified data reference.
FactText Returns formatted text describing the fact (event or attribute).
FindText Returns the position of a specified search string within another string. Returns 0 if the search string is not found.
ForceText This function is typically used in diagram text schemes. It simply outputs the text specified. It is useful because an ordinary label is only output if the data reference following it matches some data. If you want the label to be output regardless, use ForceText.

See also CombineText, ExistsText and NotExistsText.

FormatFloat This function is used for formatting a floating point number as text.
GetDisplayText Provides a standard way of displaying information about any data item.
GetLabelledText Only for use with long text fields that can include multiple paragraphs (notes, address fields, etc). Returns all text within a given paragraph, following a specified label.
GetParagraph Only for use with long text fields that can include multiple paragraphs (notes, address fields, etc). Returns a numbered paragraph from the text field.
LeftText Returns a text string with a specified number of characters, extracted from the leftmost end of a given text string. See also RightText and MidText.
MidText Returns a text string with a specified number of characters, extracted from a given starting position within a given text string. See also LeftText and RightText.
NotExistsText This function is typically used in diagram text schemes. It allows you to specify a data reference, and text to be output if, and only, if data is not found for the specified data reference

See also ExistsText, CombineText and ForceText.

Parentage Returns a description of a given person in relation to their parents, if known (e.g. "son of John Smith and Jane Doe").
RightText Returns a text string with a specified number of characters, extracted from the rightmost end of a given text string. See also LeftText and MidText.
Section This function is for use with text fields that are separated into multiple sections, using any series of one or more characters as separator characters to define the 'boundaries' of each section. It allows a specific section to be retrieved.
Sex

Used for outputting gender-specific text.

Text

Used for assembling complex text strings. See also See Type-Specifier functions.

TextIf Takes a boolean expression (True or False) and 2 text strings. If the boolean expression evaluates as True, the first text expression is returned; otherwise the second text expression is returned.
TextLen Returns the length of a given text string.
TextPart Although designed primarily to help with the presentation of place information in reports and elsewhere, this function can however be used with any text fields. It returns one or more parts of any comma-separated text.
ToLower Converts a string expression to lower case.
ToUpper Converts a string expression to upper case.