Number
- Last UpdatedJun 25, 2024
- 2 minute read
Use scripts to set and get values for the properties of the Number control.
Basic
|
Property |
Scripting Supported |
Example |
|---|---|---|
|
Name |
Yes Writable Readable |
To set the property control.findById("ID").tagName = "Value for Name"; To get the value of the property control.findById("ID").tagName; |
|
XML Node |
Yes Readable |
To get the value of the property control.findById("ID").xmlNodeBoundTo; |
|
Description |
Yes Writable Readable |
To set the property control.findById("ID").description = "Value for Description"; To get the value of the property control.findById("ID").description; |
|
Tooltip |
No |
Not Applicable |
|
Default Value |
Yes Readable |
To get the value of the property control.findById("ID").defaultValue; |
Appearance
|
Property |
Scripting Supported |
Script |
|---|---|---|
|
Enable |
Yes Writable Readable |
To set the property control.findById("ID").enable = true; To get the value of the property control.findById("ID").enable; |
|
Visible |
Yes Writable Readable |
To set the property control.findById("ID").visible = true; To get the value of the property control.findById("ID").visible; |
|
Read-Only |
Yes Writable Readable |
To set the property control.findById("ID").readOnly = true; To get the value of the property control.findById("ID").readOnly; |
|
Label Position |
No |
Not Applicable |
|
Label-Control Area |
No |
Not Applicable |
|
Watermark |
No |
Not Applicable |
|
Width |
No |
Not Applicable |
|
Retain Space |
No |
Not Applicable |
|
Custom Style Sheet Identifier |
No |
Not Applicable |
Validation
|
Property |
Scripting Supported |
Example |
|---|---|---|
|
Mandatory |
Yes Writable Readable |
To set the property control.findById("ID").isMandatory = true; To get the value of the property control.findById("ID").isMandatory; |
|
Auto-update Value |
No |
Not Applicable |
|
Minimum Value |
Yes Writable Readable |
To set the property control.findById("ID").min = 100; To get the value of the property control.findById("ID").min; |
|
Maximum Value |
Yes Writable Readable |
To set the property control.findById("ID").max = 100; To get the value of the property control.findById("ID").max; |
Advanced
|
Property |
Scripting Supported |
Example |
|---|---|---|
|
On Data Change |
Yes |
For more information, see scripting guidelines for On Data Change property. |
|
ID |
No |
Not Applicable |
|
Number Format |
No |
Not Applicable |
|
Decimal Places |
No |
Not Applicable |
|
Decimal Separator |
No |
Not Applicable |
|
Group Sizes |
No |
Not Applicable |
|
Group Separator |
No |
Not Applicable |
|
Show Group Separator |
No |
Not Applicable |
|
Negative Pattern |
No |
Not Applicable |
|
Include in Summary |
No |
Not Applicable |
Scripts
|
Property |
Scripting Supported |
Example |
|---|---|---|
|
Name |
Yes |
return "Value for Name"; |
|
Description |
Yes |
return "Value for Description"; |
|
Enable |
Yes |
return true; For more information, see scripting guidelines for Enable property. |
|
Visible |
Yes |
return true; For more information, see scripting guidelines for Visible property. |
|
Read-Only |
Yes |
return false; For more information, see scripting guidelines for Read-Only property. |
|
Mandatory |
Yes |
return true; For more information, see scripting guidelines for Mandatory property. |
|
Default Value |
Yes |
return 100; Note: The Value script takes precedence over the Default Value script. |
|
Value |
Yes |
return 100; |
|
Validate |
Yes |
return new ValidationOptions(false, "Error Message"); OR return new ValidationOptions(true, ""); For more information, see scripting guidelines for Validate property. |
Note:
- Display value is readable.
- You can retrieve the display value via script as follows:
return control.findById("ID").displayValue;
- Use parseInt/parseFloat while performing arithmetic operations on the Number control's
value, as the Number control's value is of string type.
- Ensure the Equality Operator (==) is used instead of the Identity Operator (===) when type conversion is not required.
- For more information, see Best Practices for using scripts.