Functions (all)

LeftText

Function Name:

LeftText

Description:

Returns a text string with a specified number of characters, extracted from the leftmost end of a given text string.  The whole string will be returned if less than the specified length.  See also the RightText and MidText functions.

Minimum FH Version:

7.0

No. of Parameters:

2

Return Type:

Text

Parameter 1:

Text.

Parameter 2:

A number.  The number of characters to return in the text string.

Parameter 3 (Minimum FH Version: 7.0.4):

Optional. A string. This parameter is intended to hold a comma-separated list of flag values, that indicate further optional requirements.  Currently only one flag value is supported: "ELLIPSIS" - meaning that the string should be terminated with 3 dots if has been truncated.   If this option is taken, the returned may be slightly shorter than the value specified in parameter 2 if the string can be conveniently truncated on a word boundary, without having to be shortened excessively.

Examples:

=LeftText(%INDI%, 12)

=LeftText(%INDI.BIRT.NOTE2%, 250, "ELLIPSIS")