Formulator Field - MultiCheckBoxField

Widget properties

Title (title)

The title of this field. This is the title of the field that will appear in the form when it is displayed. Required.

Description (description)

Description of this field. The description property can be used to add a short description of what a field does; such as this one.

Default (default)

The initial selections of the widget. This is a list of zero or more values. If you override this property from Python your code should return a Python list.

CSS class (css_class)

The CSS class of the field. This can be used to style your formulator fields using cascading style sheets. Not required.

Alternate name (alternate_name)

An alternative name for this field. This name will show up in the result dictionary when doing validation, and in the REQUEST if validation goes to request. This can be used to support names that cannot be used as Zope ids.

Hidden (hidden)

This field will be on the form, but as a hidden field. The contents of the hidden field will be the default value. Hidden fields are not visible but will be validated.

Items (items)

Items in the field. Each row should contain an item. Use the | (pipe) character to separate what is shown to the user from the submitted value. If no | is supplied, the shown value for the item will be identical to the submitted value. Internally the items property returns a list. If a list item is a single value, that will be used for both the display and the submitted value. A list item can also be a tuple consisting of two elements. The first element of the tuple should be a string that is name of the item that should be displayed. The second element of the tuple should be the value that will be submitted. If you want to override this property you will therefore have to return such a list.

Orientation (orientation)

Orientation of the check boxes. The check boxes will be drawn either vertically or horizontally.

View separator (view_separator)

When called with render_view, this separator will be used to render individual items.

Validator properties

External Validator (external_validator)

When a method name is supplied, this method will be called each time this field is being validated. All other validation code is called first, however. The value (result of previous validation) and the REQUEST object will be passed as arguments to this method. Your method should return true if the validation succeeded. Anything else will cause 'external_validator_failed' to be raised.

Required (required)

Checked if the field is required; the user has to fill in some data.

Unicode (unicode)

Checked if the field delivers a unicode string instead of an 8-bit string.

More help

Field edit screen help