[TASK] EXT:form - Update documentation
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Configuration / Rules / ValidationAttributes / Index.rst
1 .. include:: ../../../Includes.txt
2
3
4 .. _reference-validation-attributes:
5
6 =====================
7 Validation Attributes
8 =====================
9
10 .. contents::
11     :local:
12     :depth: 1
13
14
15 .. _reference-validation-attributes-allowwhitespace:
16
17 allowWhiteSpace
18 ===============
19
20 :aspect:`Property:`
21     allowWhiteSpace
22
23 :aspect:`Data type:`
24     boolean
25
26 :aspect:`Description:`
27     If allowWhiteSpace = 1, whitespace is allowed in front of, after or
28     between the characters.
29
30 :aspect:`Default:`
31     0
32
33
34 .. _reference-validation-attributes-element:
35
36 element
37 =======
38
39 :aspect:`Property:`
40     element
41
42 :aspect:`Data type:`
43     string
44
45 :aspect:`Description:`
46     Name of the object. Normally the "filtered" name can be found in the
47     HTML output between the square brackets like tx\_form[name] where "name"
48     is the name of the object.
49
50
51 .. _reference-validation-attributes-error:
52
53 error
54 =====
55
56 :aspect:`Property:`
57     error
58
59 :aspect:`Data type:`
60     string/ cObject
61
62 :aspect:`Description:`
63     Overriding the default text of the error message, describing the error.
64
65     When no cObject type is set, the message is a simple string. The value
66     can directly be assigned to the message property. If one needs the
67     functionality of cObjects, just define the message appropriately. Any
68     cObject is allowed.
69
70     For more information about cObjects, take a look in the document TSREF.
71
72     **Example:**
73
74     .. code-block:: typoscript
75
76       error = TEXT
77       error {
78         data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:alphabeticError
79       }
80
81     **Example:**
82
83     .. code-block:: typoscript
84
85       error = The value contains not only alphabetic characters
86
87 :aspect:`Default:`
88     Depends on the rule. Check over there.
89
90
91 .. _reference-validation-attributes-message:
92
93 message
94 =======
95
96 :aspect:`Property:`
97     message
98
99 :aspect:`Data type:`
100     string/ cObject
101
102 :aspect:`Description:`
103     Overriding the default text of the message, describing the rule.
104
105     When no cObject type is set, the message is a simple string. The value
106     can directly be assigned to the message property. If one needs the
107     functionality of cObjects, just define the message appropriately. Any
108     cObject is allowed.
109
110     For more information about cObjects, take a look in the document TSREF.
111
112     **Example:**
113
114     .. code-block:: typoscript
115
116       message = TEXT
117       message {
118         data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:betweenMessage
119       }
120
121     **Example:**
122
123     .. code-block:: typoscript
124
125       message =  The value must be between %minimum and %maximum
126
127 :aspect:`Default:`
128     Depends on the rule. Check over there.
129
130
131 .. _reference-validation-attributes-showmessage:
132
133 showMessage
134 ===========
135
136 :aspect:`Property:`
137     showMessage
138
139 :aspect:`Data type:`
140     boolean
141
142 :aspect:`Description:`
143     If showMessage = 0, a message describing the rule will not be added to
144     the label of the object.
145
146 :aspect:`Default:`
147     1
148