Description
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 checkbox is in read mode, cannot change value. | true,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 page parts 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 assign on datapath when checkbox is checked | any |
| falsevalue | the value to be assign on datapath when checkbox is not checked | any |
| truelabel | the label of checked checkbox in read mode | any |
| falselabel | the label of non checked checkbox in read mode | any |
| defaultvalue | the default value to be assign on datapath. | any |
| onchange | Defines the function call(s) triggered checkbox value changed. | <functions>…</functions> |
Examples
CheckBox
Tab
<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>