The FormatNumberOnInput Command

Although users can enter numbers with formatting according to their own region, often they enter numbers with no spaces or other punctuation. The FormatNumberOnInput command assists the user with readability of numbers on the interview. It does not affect the assembled document in any way.

 

Command structure:

«FormatNumberOnInput('#,###.##')»
This would apply to all number data elements in the template.

«FormatNumberOnInput(Loan_Amount,'#,###.##')»
This would apply to only the Loan_Amount data element.

 

Example of usage:

«FormatNumberOnInput(Loan_Amount,Deposit_Amount,'#,###.##')»
«FormatNumber(Loan_Amount)»
«FormatNumber(Deposit_Amount)»
«FormatDate(Installment_date,’mmmm d, yyyy’)»

 


When entered without using the FormatNumberOnInput, the numbers can prove to be difficult to read.

 

But when applying the FormatNumberOnInput to this interview there is a more readable outcome:

 

 

Types of formatting strings used in the command:

‘#,###.##’ means show a number if one was captured otherwise leave blank. Do not insert decimals if none have been captured.

‘#,###.00’ means show 0 even if no number was was captured. And insert .00 as decimals if no decimals were captured.

In both those cases a comma is the thousands separator.

 

Notes:

To apply formatting to the number in the document, use FormatNumber.

The FormatNumberOnInput command should appear before the data elements in the template. (See above snippet.)

Specify a FormatNumberOnInput() to apply to all data elements in the template, or use it per data element to specify a different formatting on a particular data element.

This command has not yet been implemented in the web version.

 

Table of Contents