Difference between revisions of "Form Element description"
From OpenKM Documentation
(Created page with '== Input == This kind of element has these required parameters: * '''label''': The text label which describes the form element. * '''name''': An unique text used to identify the …') |
m |
||
| Line 1: | Line 1: | ||
== Input == | == Input == | ||
| − | This | + | Used to enter free form text: |
| − | * '''label''': The text | + | |
| − | * '''name''': | + | * '''label''': The text which describes the component. '''Required'''. |
| − | * ''' | + | * '''name''': This value is used to access the value typed by the user. '''Required'''. |
| + | * '''type''': This value constrain value type. Allowed types: text, date, link or folder. | ||
| + | * '''value''': Here you can specify a default value for this component. | ||
| + | * '''width''': The width of the component. Defaults to browser default HTML input width. | ||
| + | * '''height''': The height of the component. Defaults to browser default HTML input height. | ||
| + | |||
| + | == TextArea == | ||
| + | Similar to Input but for bigger text: | ||
| + | |||
| + | * '''label''': The text which describes the component. '''Required'''. | ||
| + | * '''name''': This value is used to access the value typed by the user. '''Required'''. | ||
| + | * '''value''': Here you can specify a default value for this component. | ||
| + | * '''width''': The width of the component. Defaults to 300px. | ||
| + | * '''height''': The height of the component. Defaults to 100px. | ||
| + | |||
| + | == Select == | ||
| + | In this case, the value can be selected from a list of predefined one. Every select component can contain an arbitrary number of options bigger than one. | ||
| + | |||
| + | * '''label''': The text which describes the component. '''Required'''. | ||
| + | * '''name''': This value is used to access the value selected by the user. '''Required'''. | ||
| + | * '''type''': Actually can be only "simple". Simple means that only one option can be selected at a time. Defaults to "simple". | ||
| + | * '''width''': The width of the component. Defaults to browser default HTML select width. | ||
| + | * '''height''': The height of the component. Defaults to browser default HTML select height. | ||
| + | |||
| + | === Option === | ||
| + | * '''label''': The text which describes the component. '''Required'''. | ||
| + | * '''value''': This is the value of the option to be selected. '''Required'''. | ||
| + | * '''selected''': Can be "true" or "false". Indicates if the option is selected by default or not. Defaults to "false". | ||
Revision as of 09:11, 19 July 2011
Contents
Input
Used to enter free form text:
- label: The text which describes the component. Required.
- name: This value is used to access the value typed by the user. Required.
- type: This value constrain value type. Allowed types: text, date, link or folder.
- value: Here you can specify a default value for this component.
- width: The width of the component. Defaults to browser default HTML input width.
- height: The height of the component. Defaults to browser default HTML input height.
TextArea
Similar to Input but for bigger text:
- label: The text which describes the component. Required.
- name: This value is used to access the value typed by the user. Required.
- value: Here you can specify a default value for this component.
- width: The width of the component. Defaults to 300px.
- height: The height of the component. Defaults to 100px.
Select
In this case, the value can be selected from a list of predefined one. Every select component can contain an arbitrary number of options bigger than one.
- label: The text which describes the component. Required.
- name: This value is used to access the value selected by the user. Required.
- type: Actually can be only "simple". Simple means that only one option can be selected at a time. Defaults to "simple".
- width: The width of the component. Defaults to browser default HTML select width.
- height: The height of the component. Defaults to browser default HTML select height.
Option
- label: The text which describes the component. Required.
- value: This is the value of the option to be selected. Required.
- selected: Can be "true" or "false". Indicates if the option is selected by default or not. Defaults to "false".
