Text form field type

2011-10-30T12:05:24Z

BEuwe:

[[Image:Params.text.jpg|right]]

{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Text parameter type]].}}

The '''text''' form field type provides a text box for data entry. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be ''text''.
* '''name''' (mandatory) is the unique name of the field.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''size''' (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.
* '''maxlength''' (optional) limits the number of characters that may be entered.
* '''default''' (optional) (translatable) is the default value.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.
* '''readonly''' (optional)
* '''disabled''' (optional)
* '''filter''' (optional) allow the system to save certain html tags or raw data.

Example XML field definition:
<source lang="xml"><field name="mytextvalue" type="text" default="Some text" label="Enter some text" description="" size="10" /></source>

Use the integer filter to ensure that letters types get stripped when the form is processed.
<source lang="xml"><field name="myintvalue" type="text" default="8" label="Enter some text" description="Enter some description" filter="integer" /></source>

Use the raw filter to ensure that html code is preserved when the form is processed.
<source lang="xml"><field name="myhtmlvalue" type="text" default="" label="Enter some text" description="Enter some description" filter="raw" /></source>
<noinclude>
=== See also ===
* [[Textarea form field type]]
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Text form field type

2011-10-30T12:02:50Z

BEuwe: Added filter as optional parameter, added two examples.

[[Image:Params.text.jpg|right]]

{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Text parameter type]].}}

The '''text''' form field type provides a text box for data entry. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be ''text''.
* '''name''' (mandatory) is the unique name of the field.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''size''' (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.
* '''maxlength''' (optional) limits the number of characters that may be entered.
* '''default''' (optional) (translatable) is the default value.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.
* '''readonly''' (optional)
* '''disabled''' (optional)
* '''filter''' (optional) allow the system to save certain html tags or raw data.

Example XML field definition:
<source lang="xml"><field name="mytextvalue" type="text" default="Some text" label="Enter some text" description="" size="10" /></source>

Use the integer filter to ensure that letters types get stripped when the form is processed.
<source lang="xml"><field name="myintvalue" type="text" default="8" label="Enter some text" description="Enter some description" filter="integer" /></source>

Use the raw filter to ensure that html code is preserved when the form is processed.
<source lang="xml"><field name="myintvalue" type="text" default="" label="Enter some text" description="Enter some description" filter="raw" /></source>
<noinclude>
=== See also ===
* [[Textarea form field type]]
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Joomla! Documentation - User contributions [en]

Text form field type

Text form field type