Actions

J1.5

Difference between revisions of "Text parameter type"

From Joomla! Documentation

m (Fixed category mess)
(This is a parameter, not a form field.)
Line 1: Line 1:
 
[[Image:Params.text.jpg|right]]
 
[[Image:Params.text.jpg|right]]
 +
 +
{{Ambox|type=notice|text=[[Parameter|Parameters]] have been superseded by [[Form field|form fields]] in Joomla! 1.6. You may want to use the corresponding [[Text form field type]].}}
 +
 
The '''text''' parameter type provides a text box for data entry.  If the parameter has a value saved, this value is displayed when the page is first loaded.  If not, the default value (if any) is selected.  
 
The '''text''' parameter type provides a text box for data entry.  If the parameter has a value saved, this value is displayed when the page is first loaded.  If not, the default value (if any) is selected.  
  
Line 15: Line 18:
 
=== See also ===
 
=== See also ===
 
* [[Textarea parameter type]]
 
* [[Textarea parameter type]]
* [[Standard form field types|Table of all standard form field types]]
+
* [[Standard parameter types|List of standard parameter types]]
[[Category:Standard form field types]]</noinclude>
+
[[Category:Standard parameter types]]</noinclude>

Revision as of 08:37, 21 May 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.
Params.text.jpg

The text parameter type provides a text box for data entry. If the parameter 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 parameter.
  • 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.
  • 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'.

Example XML parameter definition:

<param name="mytextvalue" type="text" default="Some text" label="Enter some text" description="" size="10" />

See also