[Spezial] Standard-Kontaktformular 2
Referenz des JSON-Konfigurationsobjekts
Hinweise
- * kennzeichnet Pflichtattribute
- Unterstreichung kennzeichnet Default-Werte
- in den fieldset-Attributen "textBefore" und "textAfter" kann man auch HTML-Code verwenden. Es dürfen aber nur einfache Anführungszeichen verwendet werden (')
- der JSON-Code muss UTF-8 kodiert sein
Attribute des Formular-Objekts
| Attribut | Beschreibung | Typ | Default-Wert | Pflicht-Attribut |
|---|
| name |
Name des Formulars (name-Attribut des form-Tags) |
String |
|
|
| cssId |
ID des Formulars (id-Attribut des form-Tags) |
String |
|
|
| showToc |
zeige Gliederung als Anker-Link-Liste, geeignet für lange Formulare |
Boolean |
false |
|
| enableSendCopy |
Aktiviere Checkbox "Sende Email an mich" |
|
false |
|
| hideFieldsetLabels |
Blende Label der Fieldsets aus |
|
false |
|
| hideToplinks |
Blende Nach-oben-Links in allen Fieldsets aus |
|
false |
|
| labelToc |
Label für die Gliederung |
|
Gliederung |
|
| labelSubmit |
Label für "Senden"-Button |
|
|
|
| labelSendCopy |
Label für "Sende Kopie"-Checkbox |
|
|
|
| fieldsets |
|
Object |
|
ja |
nach oben
Attribute des Fieldset-Objekts
| Attribut | Beschreibung | Typ | Default-Wert | Pflicht-Attribut |
|---|
| name |
Name der Feldgruppe |
String |
|
ja |
| label |
Titel der Feldgruppe |
String |
|
|
| layout |
Layout |
String |
table |
ja |
| textBefore |
Textblock zu Beginn der Feldgruppe |
String |
|
|
| textAfter |
Textblock am Ende der Feldgruppe |
String |
|
|
| hideToplink |
Blende Nach-Oben-Link dieses Fieldsets aus |
Boolean |
false |
|
| fields |
Felder |
Object-Array |
|
|
nach oben
Attribute des Field-Objekts
| Attribut | Beschreibung | Typ | Optionen | Default-Wert | Pflicht-Attribut |
|---|
| name |
Name des Feldes
(Wichtig: Feldnamen dürfen formularweit nicht Prefix eines anderen Feldnamen sein! Beispiel: die Namen "Feld" und "Feld1" führen zu einem Fehler, "Feld1" und "Feld2" können verwendet werden) |
String |
|
|
ja |
| label |
Beschriftung des Feldes |
String |
|
|
ja |
| type |
Feld-Typ |
String |
text,
textarea,
radio,
checkbox,
select,
file |
text |
ja |
| labelShort |
Kurzbeschriftung des Feldes. Wird alternativ zu "label" in der Email verwendet, sofern das Attribut gesetzt ist |
String |
|
|
|
| hideLabel |
Feld-Label nicht anzeigen |
Boolean |
true, false |
false |
|
| description |
Kurzbeschreibung. Wird über dem Feld ausgegeben |
String |
|
|
|
| formatHint |
Kurzer Hinweis zum Ausfüllen, z.B. Angabe zur Formatierung. Wird in grau unter dem Feld ausgegeben |
String |
|
|
|
| dataType |
Datenformat. Bleibt das Attribut leer, wird nichts geprüft |
String |
email, url, number, euroDate |
|
|
| fileLabels |
Labels für Datei-Upload-Felder ( type: "file" ). Die Anzahl der Array-Elemente bestimmt dei Anzahl der File-Upload-Felder |
String-Array |
|
|
|
| emailAttr |
Übergibt den Wert des Feldes an das entsprechende E-Mail-Attribut. Ist fromAddress nicht gesetzt, wird eine anonyme Mail von noreply.internet@verwaltung.uni-muenchen.de verschickt. Alle anderen Felder sind optional. Wenn fullName gesetzt ist, sind firstName und lastName deaktiviert. subject2 und subject3 werden jeweils mit "-" an subject angehängt |
String |
subject,
subject2,
subject3,
message,
fromAddress,
lastName,
firstName,
fullName |
|
|
| confirmEmailAttr |
Übergibt den Wert des Feldes an das Betreff-Attribut der Bestätigungs-Email |
String |
subject |
|
|
| cssClass |
Benutzerdefinierte CSS-Klasse für das Feld |
|
|
|
|
| size |
Anzahl der Zeilen bei type:"select" / Höhe in Pixeln bei type:"textarea" |
Integer |
|
1 |
optional |
| multiple |
|
|
true,
false |
false |
optional, nur in Kombination mit type:"select" |
| defaultValue |
Vorbelegter Wert |
String |
|
|
optional |
| options |
Liste der Optionen (nur bei radio, checkbox, select) |
Object<option> -Array |
|
|
optional |
| optGroups |
Liste von optGropus (nur bei radio, checkbox, select) |
Objekt<optGroup> -Array |
|
|
optional |
| minSelect |
Mindestanzahl der zu selektierenden Optionen (nur bei radio, checkbox, select) |
Integer |
|
|
optional |
| maxSelect |
Maximalzahl der zu selektierenden Optionen (nur bei radio, checkbox, select) |
Integer |
|
|
optional |
| blankOptionLabel |
Label für leere Option (nur bei select) |
String |
|
--- bitte wählen --- |
|
| noBlankOption |
Keinen Text für die leere Option anzeigen (geeignet für Mehrfachauswahlfelder) |
Boolean |
true,
false |
false |
optional |
| required |
Pflichtfeld |
Boolean |
true,
false |
false |
optional |
| requireAll |
Es müssen alle Optionen gewählt werden (geeignet für Bestätigung von Hinweisen) |
Boolean |
true,
false |
false |
optional |
| separated |
Abstand zum vorherigen Feld |
Boolean |
true,
false |
false |
optional |
| disabled |
Feld nur ausgegraut darstellen ohne Möglichkeit der Eingabe (z.B. für Übernahme der Benutzerkennung) |
Boolean |
true,
false |
false |
optional |
| xmlFieldPrefix |
Benutzerdefinierte XML-Tags eines Feldes (i.d.R. öffnende Tags) |
String |
|
|
|
| xmlFieldSuffix |
Benutzerdefinierte XML-Tags eines Feldes (i.d.R. schließende Tags) |
String |
|
|
|
| xmlOptionPrefix |
Benutzerdefinierte XML-Tags für Optionen eines Feldes (nur nötig bei Mehrfachauswahl) |
String |
|
|
|
| xmlOptionSuffix |
Benutzerdefinierte XML-Tags für Optionen eines Feldes (nur nötig bei Mehrfachauswahl) |
String |
|
|
|
nach oben
Attribute des Option-Objekts
| Attribut | Beschreibung | Typ | Optionen | Default-Wert | Pflicht-Attribut |
|---|
| value |
Der Wert |
|
|
|
|
| label |
Der darzustellende Text, sofern er vom Wert abweicht |
String |
|
|
optional |
| description |
Beschreibung |
String |
|
|
optional |
| isDefault |
Legt fest, ob eine Option beim Laden des Formulars selektiert ist |
Boolean |
true,
false |
false |
optional |
| newColumn |
Erzeugt einen Spaltenumbruch |
Boolean |
true,
false |
false |
optional |
| inputField |
Einzeiliges Texteingabefeld |
Object<inputField> |
|
|
optional |
nach oben
{
fieldsets : [
{
name* : ""
label* : ""
layout : ""
textBefore : ""
textAfter : ""
hideToplink: false
fields* : [
{
name* : ""
label* : ""
type* : "text"
labelShort : ""
hideLabel : false
fileLabels : ["Label1", "Label2", ...]
description : ""
formatHint : ""
dataType : ""
emailAttr : ""
confirmEmailAttr : ""
cssClass : ""
size : 1
multiple : false
xmlFieldPrefix : ""
xmlFieldSuffix : ""
xmlOptionPrefix : ""
xmlOptionSuffix : ""
defaultValue : ""
options : [
{
value : ""
label : ""
description : ""
isDefault : false
newColumn : false
inputField :
{
name : ""
label : ""
labelShort : ""
cssClass : ""
required : true
}
}
]
optGroups : [
{
label :
float : true*|false (float: left)
options : [ (nur bei radio, checkbox, select)
{
value : ""
label : ""
description : ""
isDefault : false
clear : false
}
]
optGroups : [ (nur bei radio, checkbox, select)
{
label :
float : true
options : [
{
value : ""
label : ""
description : ""
isDefault : false
clear : false
}
]
}
]
}
]
minSelect :
maxSelect :
blankOptionLabel : "--- bitte wählen ---"
noBlankOption : false
required : false
requireAll : false
separated : false
disabled : false
getCampusLogin : false
},
{
},
...
]
},
...
]
}
