FormatNumber - Built-in Formatting Function¶

Purpose¶

Formats a number using the Windows locale settings or supplied mask.

Syntax¶

FormatNumber(exp,type[,mask])

Arguments¶

Argument	Required	Description
`exp`	Yes	The number to be formatted
`type`	Yes	The format type from one of the predefined number formats
`mask`	No	A string with the number mask to use

Example¶

// format the number using the Windows locale settings
Return FormatNumber({Order.OrderNumber},drWindowsNumber)

// format a number and a date using a combination of Windows locale settings and a mask
Return "Please pay in advance 10% of" *
    FormatNumber({PurchaseOrderHeader.TaxAmt},drWindowsNumber) *
    "(=" +
    FormatNumber({PurchaseOrderHeader.TaxAmt}*0.1,drWindowsNumber) -
    ") before" *
    FormatDate(DateAdd("D",15,{PurchaseOrderHeader.OrderDate}),drCustomDateMask,"yyyy-MM-d")

Notes¶

When exp cannot be converted to a time, a runtime error is generated.
When type cannot be converted to an integer, a runtime error is generated.
When mask cannot be converted to a string, a runtime error is generated.