Format functionOfficial Content

This function is used to create a character expressions with parameter markers. The string expression has zero o more parameter markers like %1.  If a '%' sign must be included in character-expression, it must be preceded by the '\' (backslash) sign. For example: "This is not a parameter marker: \%1".

Syntax

Format(format-string [ , character-expression1 [ ,… ] ] )

Type Returned:
Character

Where:
format-string
   Must be a character expression. This is the expression that has zero or more parameter markers (from 1 to 9) like %1, %2, etc. format-string may be an expression with a translation available; therefore, the translation to the language being used when formatting will be selected.

character-expressionn
   Must be a character expression. These are character expressions that will replace the parameter markers.

Examples

In the example, parameter markers are %1 and %2. They state where, in the resulting string, the values of "Alex" and "13" must be embeded.

Format("%1 is %2 years old.", "Alex", "26")

The result must be "Alex is 26 years old".

In this example, the markers are substituted with attributes and the result is moved to a variable which can be used later:

&Variable=format("Customer %1 was born in %2", CustomerName, CountryName);

Scope

Objects Procedure object, Transaction object, Web Panel objectWork With for Smart Devices objectPanel for Smart Devices object

 




Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.