> For the complete documentation index, see [llms.txt](https://doc.sysdevmobile.com/kalipso5/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.sysdevmobile.com/kalipso5/developing/form/expressions/functions/functions-descriptions/numeric-functions/mask-number.md).

# Mask Number

This Function returns a *\<string>*, composed by the **Value** formatted according to the remaining parameters.

### Parameters

* **Value** *\<numeric*> - Number to format.
* **Sign** *\<numeric*> - Display the sign at left of the **Value**. It can be one of:
  * Minus - Display only if it's a negative Value.
  * Always - Always display the sign.
  * Never - Never display the sign.
* **Add Thousand Separator** *\<boolean*> - Display the **Value** with the thousand separator?
* **Thousand Separator** *\<string*> - Char to represent the thousand separator.
* **Round** *\<boolean> -* Round the value?
* **Decimal Places** *\<numeric*> - Number of decimal places to round if the Round parameter is true.

  Number of decimal places to add zeros to the right if Add Right Zeros parameter is true.
* **Decimal Separator** *\<string*> - Char to represent the decimal separator.
* **Add Right Zeros** *\<boolean> -* Use char "0" to complete the **Value** at right in order to achieve the number of Decimal Places to display.

### Examples

* *Example 1*

MaskNumber("-10000", MINUS, TRUE, ".", FALSE, 0, "", FALSE)\
**Result** = -10.000

* *Example 2*

MaskNumber("-10000", ALWAYS, TRUE, ".", FALSE, 0, "", FALSE)\
**Result** = -10.000

* *Example 3*

MaskNumber("-10000", NEVER, TRUE, ".", FALSE, 0, "", FALSE)\
**Result** = 10.000

* *Example 4*

MaskNumber("10000", ALWAYS, TRUE, ".", FALSE, 0, "", FALSE)\
**Result** = +10.000

* *Example 5*

MaskNumber("10000.5", MINUS, TRUE, ".", TRUE, 1, ",", FALSE)\
**Result** = 10.000,6

* *Example 6*

MaskNumber("10000.55", MINUS, TRUE, ".", TRUE, 3, ",", FALSE)\
**Result** = 10.000,55

* *Example 7*

MaskNumber("10000.55", MINUS, TRUE, ".", TRUE, 3, ",", TRUE)\
**Result** = 10.000,550

* *Example 8*

MaskNumber("10000.55", MINUS, TRUE, ".", FALSE, 1, ",", TRUE)\
**Result** = 10.000,55

{% hint style="info" %}
If **Round** is false, **Add Right Zeros** is true, and the decimal places in the **Value** are more than **Decimal Places** parameter, the decimal part will remain unmodified (see Example 8).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.sysdevmobile.com/kalipso5/developing/form/expressions/functions/functions-descriptions/numeric-functions/mask-number.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.