Formats a value into a string.
String := FORMAT(Value[, Length][, FormatStr/FormatNumber]) |
Parameters
- Value
-
Type: Any
This is a C/AL variable (expression) of any simple data type, such as option, integer, biginteger, decimal, char, text, code, date, time, datetime, Boolean, binary, or GUID.
If, when the system formats Value, the result is a value larger than the maximum length MAXSTRLEN Function (Code, Text) of String, a run-time error occurs.
- Length
-
Type: Integer
This optional parameter specifies the length of String. The following rules apply:
-
If Length = 0 then the entire value is returned (default).
-
If Length > 0 then the returned string will be exactly Length characters.
If Value is less than Length characters, then either leading or trailing spaces are inserted, depending on the format that you select.
If Value exceeds Length characters, then String is truncated to Length characters.
-
If Length < 0 then the returned string will not have leading or trailing spaces.
If Value is less than Length characters, the length of String will equal the length of Value.
If Value exceeds Length characters, then String is truncated to Length characters.
-
- FormatStr
-
Type: String
A literal string that defines a format as in the Format Property.
- FormatNumber
-
Type: Integer
This optional parameter specifies the format that you want to use. The basic options are the following:
-
<Sign><Integer Thousand><Decimals> is Format 0
-
<Sign><Integer><Decimals> is Format 1
-
<Sign><Integer><Decimals><1000Character,.> is Format 2
-
<Integer Thousand><Decimals><Sign,1> is Format 3
-
<Integer><Decimals><Sign,1> is Format 4
NoteYou cannot use both FormatNumber and FormatStr at the same time.
-
