3d63d6c8fb7dffea8844d2d4cb787309fddd5e4c
[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-breakonerror:
35
36 breakOnError
37 ============
38
39 :aspect:`Property:`
40     breakOnError
41
42 :aspect:`Data type:`
43     boolean
44
45 :aspect:`Description:`
46     If breakOnError = 1 and the rule does not validate, all remaining rules
47     will not be processed.
48
49 :aspect:`Default:`
50     0
51
52
53 .. _reference-validation-attributes-element:
54
55 element
56 =======
57
58 :aspect:`Property:`
59     element
60
61 :aspect:`Data type:`
62     string
63
64 :aspect:`Description:`
65     Name of the object. Normally the "filtered" name can be found in the
66     HTML output between the square brackets like tx\_form[name] where "name"
67     is the name of the object.
68
69
70 .. _reference-validation-attributes-error:
71
72 error
73 =====
74
75 :aspect:`Property:`
76     error
77
78 :aspect:`Data type:`
79     string/ cObject
80
81 :aspect:`Description:`
82     Overriding the default text of the error message, describing the error.
83
84     When no cObject type is set, the message is a simple string. The value
85     can directly be assigned to the message property. If one needs the
86     functionality of cObjects, just define the message appropriately. Any
87     cObject is allowed.
88
89     For more information about cObjects, take a look in the document TSREF.
90
91     **Example:**
92
93     .. code-block:: typoscript
94
95       error = TEXT
96       error {
97         data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:alphabeticError
98       }
99
100     **Example:**
101
102     .. code-block:: typoscript
103
104       error = The value contains not only alphabetic characters
105
106 :aspect:`Default:`
107     Depends on the rule. Check over there.
108
109
110 .. _reference-validation-attributes-message:
111
112 message
113 =======
114
115 :aspect:`Property:`
116     message
117
118 :aspect:`Data type:`
119     string/ cObject
120
121 :aspect:`Description:`
122     Overriding the default text of the message, describing the rule.
123
124     When no cObject type is set, the message is a simple string. The value
125     can directly be assigned to the message property. If one needs the
126     functionality of cObjects, just define the message appropriately. Any
127     cObject is allowed.
128
129     For more information about cObjects, take a look in the document TSREF.
130
131     **Example:**
132
133     .. code-block:: typoscript
134
135       message = TEXT
136       message {
137         data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:betweenMessage
138       }
139
140     **Example:**
141
142     .. code-block:: typoscript
143
144       message =  The value must be between %minimum and %maximum
145
146 :aspect:`Default:`
147     Depends on the rule. Check over there.
148
149
150 .. _reference-validation-attributes-showmessage:
151
152 showMessage
153 ===========
154
155 :aspect:`Property:`
156     showMessage
157
158 :aspect:`Data type:`
159     boolean
160
161 :aspect:`Description:`
162     If showMessage = 0, a message describing the rule will not be added to
163     the label of the object.
164
165 :aspect:`Default:`
166     1
167