Module: Editor

Version: 2.2.1 +

User: Developer

Object Type: Output Object

Child of:

- WebPage

- WebPanel



A CheckBox object provides output on a website. A CheckBox is a square box that can be checked or unchecked by clicking the mouse. A caption describing the meaning of the object is shown adjacent to the checkbox. If checked, the CheckBox will pass on the value 'True', if not, it will pass on the value 'False'.

For example, a CheckBox can be used when you want a user to confirm a statement.



A postback is an action taken by an interactive webpage, when the entire page and its contents are sent to the server for processing some (submitted) information and then, the server posts the same page back to the browser. Possible values of the AutoPostBack property are 'True' or 'False'. If the value is 'True', then the Index of the RadioButton will be used directly in the calculation after selecting it. If the value is 'False', then the input will not directly be processed.

DebugLogMode (from version 4.1)

Indicates the level of detail of debug information that is logged during runtime of the website to the trace, a logfile, a database etc. The possible values are:

  • None: no debug information is logged
  • Simple: only basic information is given
  • Extended: in addition to the information in the Simple mode the values of all the properties of the object are shown


Possible values are 'True' or 'False'. If the value is 'False', then the object can not be used within the application.


Possible values are 'True' or 'False'. If the value is 'False', then the object can only be used within the document where it is created. If the value is 'True', then also from other Futurama documents can be referred to this object. This means that changes in the object also affect the document in which is referred to this object. If the value is 'True' and you attempt to move or delete the object, a warning will be given. To limit these warnings to a minimum it is recommended to set IsPublic to 'True' only when necessary.


In the property Tooltip a text can be entered that is shown in the application when a cursor is moved across the RadioButton. In this way information about the usage of the RadioButton can be given to the user.


Here you should select the UserVariable that gets its value by the CheckBox. The UserVariable must have the Type 'Boolean'. If checked, the UserVariable will obtain the value 'True', if unchecked, the value will be 'False'.


Possible values are 'True' or 'False'. If the value is 'True', the object will be rendered and therefore displayed in your application. If the value is 'False', the object will not be rendered.


The name of the object as it is shown in the source of the website. By default the XmlName is equal to the name given in the property (Name) with spaces replaced by underscores, but you are free to change it.


The name of the object.


Here a comment can be entered. For example a short description of the object.


The unique identification number of the object. This number is automatically generated by Futurama on the moment of creation. This number can be used when searching for a certain object in the Find Window.


Here the CssClass can be entered. In the stylesheet you can define the style elements that belong to this class.


Here you can enter the text that will be displayed next to the checkbox, explaining the meaning of it. From Futurama version 18.02 it is also possible to define the texts within a ResourceDocument. See the page Text management and Multi-language.


A CheckBox object is rendered as follows:

Within the label element, the text entered in the Text property is rendered. If you've entered a classname in the CssClass property, this will be added as a class attribute in the span element.

Beware that the rendering of objects depends on the DocType selected for your Futurama Document. The rendering mentioned above is based on the DocType XHTML_1_0. If your using the old DocType HMTL4_Transitional, please consult the Document page for further information.


This example shows the usage of the CheckBox object.


Download the Futurama Document CheckBox Example.


  1. Open the XML-document which is contained in the zip-file in the Futurama Editor (Version 4.2.1 or later).
  2. Here a CheckBox object can be seen within the WebPage and WebPanel construction.
  3. By running this 'application' in your browser, you can see how the CheckBox object is displayed.

Related Topics

- Futurama Objects: The Atlas chapter that describes all Futurama objects. See the Output-section for a description of the type of objects this object belongs to.

- UserVariable


Updated: 2012-08-14