J1.5:Usergroup parameter type
From Joomla! Documentation
(Difference between revisions)
m (Found another one. :-)) |
m (Added more categorisations because this page is generic.) |
||
| Line 1: | Line 1: | ||
[[Image:Params.usergroups.png|right]] | [[Image:Params.usergroups.png|right]] | ||
| − | The usergroup parameter type provides a drop down list of user groups. 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 '''usergroup''' parameter type provides a drop down list of user groups. 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 ''usergroup''. | * '''type''' (mandatory) must be ''usergroup''. | ||
| Line 16: | Line 16: | ||
=== See also === | === See also === | ||
* [[Standard parameter types|Full list of standard parameter types]] | * [[Standard parameter types|Full list of standard parameter types]] | ||
| − | + | [[Category:Components]][[Category:Modules]][[Category:Plugins]][[Category:Templates]][[Category:Development]]</noinclude> | |
| − | [[Category:Templates]] | + | |
Revision as of 17:43, 21 August 2008
The usergroup parameter type provides a drop down list of user groups. 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 usergroup.
- name (mandatory) is the unique name of the parameter.
- label (mandatory) (translatable) is the descriptive title of the field.
- default (optional) is the default user group. This is the user group ID number.
- size (optional) is the number of rows of the list to display. If there are more items in the list than the size specified then scroll-bars will appear. If omitted, the list will be shown as a drop-down list.
- multiple (optional) is a Boolean argument. If true then multiple items may be selected from the drop-down list. If omitted, or false then only one item may be selected. [[[ Note: This option does not currently work. ]]]
- 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 'inputbox'.
Example XML parameter definition:
<param name="myusergroups" type="usergroup" default="" label="Select a user group" description="" />
