Module: Editor

Version: 2.2.1 +

User: Developer

Object Type: Output Object

Child of:

- WebPage

- WebPanel



A TextBox object provides output on a website. It displays an input-field in your website.



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 input of the TextBox will be used directly in the calculation after you've submitted and left the input-field (by clicking outside of 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.

PostbackOnEnter (from version 4.2.1)

Possible values are 'True' or 'False'. If the value is 'True', then a user can submit the value entered in the TextBox by pressing the Enter-button. This property only applies when the AutoPostBack property is set on 'False'.

If you want a specific action to happen when pressing the Enter-button, you can use the Action object. The Action object has to be placed inside the TextBox object and has to be named 'OnKeyEnter'. Inside the action object 'OnKeyEnter' you can place references to actions that you want to perform when pressing the Enter-button.


Possible values are ‘True’ or ‘False. If the value is ‘True’, the Default value of the UserVariable (that is referred to in the UserVariable property) will be displayed. If the value is ‘False’, no initial value will be displayed.


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


Here you should select the UserVariable that gets its value by the TextBox. When a user of your application enters a value in the TextBox, the UserVariable linked to the TextBox will hold the value entered. This UserVariable can then be used in the calculations, actions, etc. in your application.


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.


This property indicates the number of characters that are allowed in the TextBox.


This property indicates the number of lines that are allowed in the TextBox.


Possible values are ‘True’ or ‘False’. If the value is ‘True’, then all characters entered in the TextBox are represented as bullets. This property is often used for password-fields, where you don’t want any spectators to see what’s entered in the field.


Here you can enter a text that’s displayed by default in the TextBox. This property will be overruled when you set the property ShowInitialValue on True. You can use this property for example when you want to explain what users should enter in the field. 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 TextBox object has the following basic rendering:

Some of the properties above will result in additional coded elements.
If you've entered a classname in the CssClass property, this will be added as a class attribute in the input element.


This example shows the usage of the TextBox object.


Download the Futurama Document TextBox 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 TextBox object can be seen within the WebPage and WebPanel construction.
  3. By running this 'application' in your browser, you can see how the textbox 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

Relevant Tutorials

- Adding interactivity to your website: This tutorial shows how you how to use the TextBox to add interactivity to your website.

Updated: 2014-10-9