Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This element is used to display a check box on the page.

...

NameDescriptionValue
id

Unique Identifier

any
visiblemodesThe modes the button should be visible.A comma-separated list of the modes read / new / edit
visibilityconditionsThe conditions that should be met in order to display the component.'[[pagefunction, datatype, datapath ]]' operator(==,!=) 'value'
readonlyIf is true then checkbox is in read mode, cannot change value.true,false
datapathThe data path field nameNeeds to correspond to the CRMDO object field.
datatypeThe type of datapath fieldjava.lang.Integer, java.lang.String,...
refreshThe 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

truevaluethe value to be assign on datapath when checkbox is checkedany
falsevaluethe value to be assign on datapath when checkbox is not checkedany
truelabelthe label of checked checkbox in read modeany
falselabelthe label of non checked checkbox in read modeany
defaultvaluethe default value to be assign on datapath.any
onchangeDefines the function call(s) triggered checkbox value changed.<functions>…</functions>

 

                      

Examples

CheckBox

...

Example

html/Tab
Expand
titleCheckbox

Image Added

Code Block
themeEclipse
language
xml
title
Checkbox
linenumberstrue
<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>           

 

...