Webgate Anywhere 4.1 - TMLScript Referenz

Objekt TMLForm
Beschreibung	Das Objekt "TMLForm" repräsentiert ein WebTML-Formular welches über einen Tag <tml:form> erstellt wurde. Es bietet diverse Funktionalitäten um die Werte im Formular auszulesen, zu modifizieren und in verschiedenen Zielen zu speichern. Die Felder eines WebTML-Formulars bestehen grundsätzlich jeweils aus einer Liste von Einzelwerten. Um die Felder als Liste zu bearbeiten bieten sich die Funktionen fieldList, setField (mit Liste als Wertparameter) und appendToField an. Sollen Formularfelder jedoch nur Einzelwerte erhalten, so können die Felder über die Methoden field, setField und removeField auch so behandelt werden, als würden sie nur aus Einzelwerten bestehen. Alle Methoden dieses Objektes sind case-insensitiv und können in diversen Groß-/Kleinschreibungs-Varianten verwendet werden.
Ermittelbar über	this.tmlform this.tmlformbyid()
Verfügbar in	WebTML-Seiten und normalen WebTML-Aktionen Master-Aktionen
Eigenschaften und Methoden	Name Purpose tmlform.addFile(file, fileName) Fügt eine Datei aus dem Dateisystem des Servers an das Formular an tmlform.addMessage(msg) Fügt den Validierungsmeldungen eine neue Meldung hinzu tmlform.appendToField(name, value) Fügt einen Wert an die Wertliste eines Feldes an. tmlform.attach(document, [alternativeFileName]) Überträgt hochgeladenen Datei-Anhänge an ein Dokument. tmlform.attachImage(document, size) tmlform.attachImage(document, [altFileName,] keepRatio, compression, width, height ) Überträgt eine benutzerdefiniert umformatierte Grafik-Datei in ein Dokument tmlform.attachmentSize(filename) Liefert die Größe einer hochgeladenen Datei am WebTML-Formular in Bytes zurück. tmlform.attachScaledImage(doc, scaler [, targetFileName)) Fügt die Grafikdaten in einem ImageScaler-Objekt einem WGAPI-Dokument als Anhang hinzu tmlform.clearMessages() Entfernt alle Validierungs-Meldungen tmlform.enteredValue(fieldname) Gibt den vom Benutzer eingegebenen, unkonvertierten Text zu einem Eingabefeld aus tmlform.errors Gibt Konvertierungsfehler von Zahlen- und Datumsfeldern zurück tmlform.field(name) Gibt den Inhalt eines Feldes zurück. tmlform.fieldList(name) Gibt den Inhalt eines Feldes als Liste zurück. tmlform.fieldNames Gibt einer Liste der Namen aller Felder zurück welche dieses TMLForm-Objekt enthält. tmlform.fileNames Bietet eine Liste der Namen aller Dateien, welche in das Formular hochgeladen wurden tmlform.formID Beinhaltet die ID des Formulars tmlform.getFile(filename) Liefert ein Java-Objekt vom Typ java.io.File zu einer hochgeladenen Datei tmlform.getFileText(filename) Ermittelt den Textinhalt einer hochgeladenen Datei tmlform.getInvalidFields() Gibt die Namen der Felder zurück, deren Inhalt Validierungsfehler hervorgerufen hat tmlform.getMessage(fieldname) Gibt die Validierungs-Meldung eines speziellen Feldes zurück, dessen Validierung fehlgeschlagen ist tmlform.hasField(name) Prüft ob das Formular ein Feld des angegebenen Namens enthält tmlform.hasMessage(fieldname) Überprüft, ob für das angegebene Feld eine Validierungs-Meldung vorliegt tmlform.hasMessages() Überprüft ob Validierungs-Meldungen vorliegen tmlform.messages Gibt alle Validierungs-Meldungen zurück tmlform.mode() Gibt den Darstellungsmodus des WebTML-Formulars zurück tmlform.parsedValue(fieldname) Gibt den endgültigen, eventuell konvertierten, Wert des Feldes aus tmlform.persistent Zeigt an, ob das WebTML-Formular persistent ist. tmlform.removeField(name) Entfernt ein Feld aus dem WebTML-Formular. tmlform.removeFile(fileName) Entfernt eine Attachment-Datei vom TMLForm-Objekt tmlform.reset() Setzt das Formular zurück und löscht alle Felder und hochgeladenen Dateien. tmlform.setField(name, value) Setzt den Inhalt eines Feldes auf den angegebenen Wert tmlform.source() Gibt den Quellentypen des WebTML-Formulars zurück tmlform.storeInContent([content]) Speichert den Inhalt des Formulars in einem Inhaltsdokument tmlform.storeInPortlet() Speichert den Inhalt des Formulars in der Konfiguration des aktuellen Portlets tmlform.storeInProfile() Speichert den Inhalt des Formulars im aktuellen Benutzerprofil tmlform.submitted Gibt an, ob das WebTML-Formular bereits vom Web-Benutzer übertragen wurde tmlform.validate() Führt alle definierten Validierungen aus tmlform.writeCSV(destination, includeHeaders [, delimiter]) Gibt die Formulardaten in eine kommaseparierte Datei aus