Fixed Point Intrinsic Functions - AsDisplayString Method
Convert the variable to a formatted string
Member of Fixed Point Intrinsic Functions (PRIM_LIBI.IFixedPointIntrinsics)
Parameters
| Name | Type | Data Type | Description |
|---|---|---|---|
| Result | *Result (Optional) | String | Resulting string |
| Format | *Input (Optional) | Enumeration | Format of the number |
| Mask | *Input (Optional) | String | Edit mask to apply to the variable |
Details
AsDisplayString returns the supplied number formatted using one of the available supplied formats.
Allowed Formats
| Enum Value | Description | Example |
|---|---|---|
| BareString_L | Trailing sign, zero supression | e.g. 1234567.89- and 0 |
| BareString_M | Trailing sign, zero supression, blank when 0 | e.g. 1234567.89- |
| BareString_P | Leading sign, zero supression | e.g. -1234567.89 and 0 |
| BareString_Q | Leading sign, zero supression, blank when 0 | e.g. -1234567.89 |
| EditCode_1 | Separators, unsigned, leading zero supression | e.g. 1,234,567.89000 and .00000 |
| EditCode_2 | Separators, unsigned, leading zero supression, blank when 0 | e.g. 1,234,567.89000 |
| EditCode_3 | Unsigned, leading zero supression | e.g. 1234567.89000 and .00000 |
| EditCode_4 | Unsigned, leading zero supression, blank when 0 | e.g. 1234567.89000 |
| EditCode_A | Separators, leading zero supression, trailing CR | e.g. 1,234,567.89000 CR and .00000 |
| EditCode_B | Separators, trailing CR, leading zero supression, blank when 0 | e.g. 1,234,567.89000 CR |
| EditCode_C | Trailing CR, leading zero supression | e.g. 1234567.89000 CR and .00000 |
| EditCode_D | Trailing CR, leading zero supression, blank when 0 | e.g. 1234567.89000 CR |
| EditCode_J | Separators, leading zero supression, trailing sign | e.g. 1,234,567.89000- and .00000 |
| EditCode_K | Separators, trailing sign, leading zero supression, blank when 0 | e.g. 1,234,567.89000- |
| EditCode_L | Trailing sign, leading zero supression | e.g. "1234567.89000- and .00000 |
| EditCode_M | Trailing sign, leading zero supression, blank when zero | e.g. "1234567.89000- |
| EditCode_N | Separators, leading zero supression, leading sign | e.g. -1,234,567.89000 and .00000 |
| EditCode_None | Leading sign, zero supression | e.g. -1234567.89 and 0 |
| EditCode_O | Separators, leading sign, leading zero supression, blank when zero | e.g. -1,234,567.89000 |
| EditCode_P | Leading sign, leading zero supression | e.g. -1234567.89000 and .00000 |
| EditCode_Q | Leading sign, leading zero supression, blank when zero | e.g. -1234567.89000 and .00000 |
| EditCode_W | 8 digit numeric date nnnn/nn/nn | e.g. 2014/12/31 and 0/00/00 |
| EditCode_X | Leading sign, no zero supression, no decimal | e.g. -000123456789000 and 000000000000000 |
| EditCode_Y | 6 or 8 digit numeric date nn/nn/nn or nn/nn/nnnn | e.g. 31/12/14 or 31/12/2014 and 0/00/00 or 0/00/0000 |
| EditCode_Z | Leading sign, zero supression, blank when 0 | e.g. -1234567.89 |
| EditWord | Edit mask as defined in the Mask parameter | |
| NumString_L | Trailing sign, no zero supression | e.g. 0001234567.89000- and 0000000000.00000 |
| NumString_M | Trailing sign, no zero supression, blank when 0 | e.g. 0001234567.89000- |
| NumString_P | Leading sign, no zero supression | e.g. -0001234567.89000 and 0000000000.00000 |
| NumString_Q | Leading sign, no zero supression, blank when 0 | e.g. 0001234567.89000- |
Example
In this example, the number 1234567.89 would return the value "1,234,567.89"
#Result := #Number.AsDisplayString( EditCode_J )
See also
LANSA Version 15, April 2020