Mvangeest: Created page for form field type

2011-05-20T17:41:00Z

Created page for form field type

New page

[[Image:Params.filelist.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 [[Filelist parameter type]].}}

The '''filelist''' form field type provides a drop down list of files from a specified directory. If the field has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

By default, the first item on the list is '- Do not use -' (which is translatable) and is given the value '-1' and this is followed by '- Use default -' (also translatable) given the value '0'.

* '''type''' (mandatory) must be ''filelist''.
* '''name''' (mandatory) is the unique name of the field.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''directory''' (optional) is the filesystem path to the directory containing the files to be listed. f omitted the directory given by JPATH_ROOT is assumed.
* '''default''' (optional) is the default file name.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''filter''' (optional) is a regular expression string which is used to filter the list of files selected for inclusion in the drop-down list. If omitted, all files in the directory are included. The filter argument expression is applied before the exclude argument expression. For information on constructing regular expressions see [[Regular expressions in parameter arguments]].
* '''exclude''' (optional) is a regular expression string which is used to exclude files from the list. The exclude argument expression is applied after the filter argument expression. For information on constructing regular expressions see [[Regular expressions in parameter arguments]].
* '''stripext''' (optional) is a Boolean argument. If true then file name extensions will be stripped from the file names listed. Also note that the file name will be saved without the extension too.
* '''hide_none''' (optional) is a Boolean argument. If true, the '- Do not use -' item is omitted from the drop-down list.
* '''hide_default''' (optional) is a Boolean argument. If true, the '- Use default -' item is omitted from the drop-down list.

Example XML field definition:
<source lang="xml"><field name="myfile" type="filelist" default="" label="Select a file" description="" directory="administrator" filter="" exclude="" stripext="" /></source>
<noinclude>
=== See also ===
* [[Folderlist form field type]]
* [[Imagelist form field type]]
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Filelist form field type - Revision history

Mvangeest: Created page for form field type