CheckBox

The value type CheckBox is used to create a checkbox.

Syntax

<Parameter>

<Name>CheckBoxValue</Name>

<Text>CheckBox</Text>

<Value>False</Value>

<ValueType>CheckBox</ValueType>

</Parameter>

The <Value> tag can set to False, True, 0 or 1. Internally in the PythonPart script the value is 0 or 1.

Optional tags

If the PythonPart should be localized, the following tag must be added

<TextId>1001</TextId>

Sometimes it’s useful to disable or hide the checkbox depending on the value of another parameter. This is achieved by adding additional tags to the parameter or by defining functions in the py-file. See Enable and visible options

The persistent state of the parameter can be changed by adding

<Persistent>…</Persistent>

Example

The implementation of the CheckBox value type is described in the example AllControls, which is located in

…\etc\Examples\PythonParts\PaletteExamples\AllControls.pyp

…\etc\PythonPartsExampleScripts\PaletteExamples\AllControls.py