Scope

Objects: Procedures, Transactions, Web Panels, Work Panels
Languages: .NET, Java, Ruby, Visual FoxPro

Purpose

Returns a string that results from applying an attribute/variable picture to its value.

Syntax

att | &var.ToFormattedString()

Type Returned
Character

Description

This function receives an attribute or variable as parameter and it returns a string that results from applying the attribute/variable picture to its value.

The function may be applied to attributes/variables of Numeric, Date, DateTime, Char and VarChar type. In the case of attributes/variables Date and DateTime type, the date and hour format returned will depend also on the "Date Format" and "Time Format" property (both of them depend on the language established on the KB).

Example

If we have a variable &Total(10, 2) with Picture "Z,ZZZ,ZZ9.99" and the value is 4395.35, the &Total.ToFormattedString() function will return the " 4,395.35" string.

See Also

ToFormattedString Function