Check Box
- Last UpdatedJun 25, 2024
- 2 minute read
Use scripts to set and get values for the properties of the Check Box control.
Basic
|
Property |
Scripting Supported |
Example |
|---|---|---|
|
Name |
Yes Writable Readable |
To set the property
control.findById("ID").tagName =
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").xmlNodeBound
|
|
Description |
Yes Writable Readable |
To set the property
control.findById("ID").description
To get the value of the property
control.findById("ID").description;
|
|
Tooltip |
No |
Not Applicable |
|
Options |
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
To get the value of the property
control.findById("ID").visible;
|
|
Label Position |
No |
Not Applicable |
|
Label-Control Area |
No |
Not Applicable |
|
Width |
No |
Not Applicable |
|
Height |
No |
Not Applicable |
|
Retain Space |
No |
Not Applicable |
|
Options Per Row |
No |
Not Applicable |
|
Options Direction |
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
To get the value of the property
control.findById("ID").isMandatory;
|
Advanced
|
Property |
Scripting Supported |
Example |
|---|---|---|
|
On Data Change |
Yes |
For more information, see scripting guidelines for On Data Change property. |
|
ID |
No |
Not Applicable |
|
Text Parameter |
Yes Writable Readable |
To set the property
control.findById("ID").optionText
To get the value of the property
control.findById("ID").optionText;
|
|
Value Parameter |
Yes Writable Readable |
To set the property
control.findById("ID").optionValue
To get the value of the property
control.findById("ID").optionValue;
|
|
Forms 2011 Compatible |
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.
|
|
Mandatory |
Yes |
return true;
For more information, see scripting guidelines for Mandatory property.
|
|
Default Value |
Yes |
return "ValueOne";
OR
return "ValueOne;#ValueTwo;#ValueThree";
Note:
|
|
Value |
Yes |
return "ValueOne";
OR
return "ValueOne;#ValueTwo;#ValueThree";
|
|
Validate |
Yes |
return new ValidationOptions(false, "Error Message");
OR
return new ValidationOptions(true, "");
For more information, see scripting guidelines for Validate property.
|
|
Options |
Yes |
return "[{\"OValue\":\"1\",\"OText\":\"ValueOne\" },{\"OValue\":\"2\",\"OText\":\"ValueTwo\"},{\"OValue\":\"3\",\"OText\":\"ValueThree\"}]";
Here OText is the Text Parameter and OValue is the Value Parameter. For more information, see scripting guidelines for Options property. Note:
|
Note:
- Display value is readable.
- You can retrieve the display value via script as follows:
return control.findById("ID").displayValue;