PadLeft
Inserts a particular character(s) to the left of a value to make the value a particular length. One example is:
•Original token: ABC
•Modifier: Pad Left (0,7)
•Result: 0000ABC
Syntax
PadLeft(textValue, padText, length)
Enabled For
For a description of the business object categories, see Notes on "Enabled For".
| Business Object Category | Yes/No |
|---|---|
| Business Rules: Before-Save Rules | Yes |
| Business Rules: Calculation Rules (After Save, with or without Also Recalculate on Load) | Yes1 |
| Business Rules: Calculation Rules (Before Save or Always, without Also Recalculate On Load) | Yes |
| Business Rules: Calculation Rules (Before Save or Always, with Recalculate On Load) | Yes1 |
| Business Rules: Editing Rules | Yes |
| Business Rules: Initialization Rules | Yes |
| Business Rules: Read Only Rules | Yes |
| Business Rules: Required Rules | Yes |
| Business Rules: Validation Rules | Yes |
| Client Expressions | Yes |
| Object Permissions | No |
| Services | No |
| LDAP | No |
| Mobile | No |
| Quick Actions (except UI Quick Actions) | Yes |
| UI Quick Actions | Yes |
| Reports | Yes |
| Search/Dashboard without field references | No |
| Search/Dashboard with field references | No |
|
1. Not fully supported in calculation rules that have a condition of After Save or the Also Recalculate on Load option selected. It may fail if the rule's field is used in a grid, form, or saved search. |
|
Parameters
| Parameter | Description |
|---|---|
| textValue | Input string to pad |
|
padText |
Text to add at left hand side |
|
length |
Length amount that you want to extend the length of the input string |
Return Value
Returns a string with the length equal to the given length including padText at the left of the string.
Example
$(PadLeft("1234", "$" , 10 ))
Returns this value:
$$$$$$1234