This element is used to display a check box on the page.
Attributes
| Name | Description | Value |
|---|---|---|
| id | Unique Identifier. | Any |
| visiblemodes | The modes the button should be visible. | A comma-separated list of the modes (read, new, edit) |
| visibilityconditions | The conditions that should be met in order to display the component. | '[[pagefunction, datatype, datapath ]]' operator(==,!=) 'value' |
| readonly | If is true then the checkbox is in read mode and the user cannot change the value. | true or false |
| datapath | The data path field name. | Needs to correspond to the CRMDO object field |
| datatype | The type of datapath field. | java.lang.Integer, java.lang.String, ... |
| refresh | The parts of the page that should be refreshed when the button is clicked. | page mainmenu main details tab,tabID component,is_on_tab:is_on_menu:tabID:componentID element,is_on_tab:is_on_menu:tabid:componentID:elementID section,sectionID area,areaID |
| truevalue | The value to be assigned on the datapath when the checkbox is checked. | Any |
| falsevalue | The value to be assigned on the datapath when the checkbox is not checked. | Any |
| truelabel | The label of the checked checkbox in read mode. | Any |
| falselabel | The label of the non checked checkbox in read mode. | Any |
| defaultvalue | The default value to be assigned on the datapath. | Any |
| onchange | Defines the function call(s) triggered when the checkbox value changes. | <functions>…</functions> |
Example
Checkbox
<checkbox>
<id>chkApplyRounding</id>
<datapath>applyRounding</datapath>
<truevalue>1</truevalue>
<falsevalue>0</falsevalue>
<truelabel>Yes</truelabel>
<falselabel>No</falselabel>
<refresh>page</refresh>
<onchange>
<functions>
<function>
<type>staticjs</type>
<functionname>voidFunc</functionname>
</function>
</functions>
</onchange>
</checkbox>