XML-Format - Waimea Software
Transcrição
XML-Format - Waimea Software
XML-Format für [e] forms & more Formulare Version 6.0.0 09.06.2012 [e] forms & more XML-Format für Formulare Seite 2 1. Allgemeines ................................................................................. 4 2. Grundsätzliche Struktur der XML-Datei ........................................ 5 2.1. Optische Aufbereitung ..................................................................................5 2.2. Code ..............................................................................................................5 2.3. Daten und deren Syntax................................................................................5 2.4. Voreinstellungen (Defaults) ..........................................................................7 2.5. Root Tag ........................................................................................................7 3. Tag <WAIMEA-FORM> ................................................................. 9 3.1. <PROPERTIES> ...............................................................................................9 3.2. <PRINT> .......................................................................................................12 3.3. <HTML-EXPORT> .........................................................................................13 3.4. <PDF-EXPORT> ............................................................................................16 3.5. <MACROS> ..................................................................................................17 3.6. <TEMPLATES>..............................................................................................18 3.7. <PAGES> ......................................................................................................18 4. Tag <PAGE> ................................................................................ 19 4.1. Attribute in <PAGE> ....................................................................................19 4.2. Unter-Tags in <PAGE> .................................................................................20 4.3. Tag <OBJECTS> ............................................................................................21 5. Tags zur Definition von Objekten ............................................... 22 5.1. Allgemeine Attribute ...................................................................................23 5.2. Allgemeine Unter-Tags ................................................................................25 5.3. Unter-Tag <FONT> ......................................................................................26 5.4. Unter-Tag <SEPARATION> ...........................................................................27 5.5. Unter-Tag <MACROS> .................................................................................28 5.6. Unter-Tag <JAVASCRIPT-HTML> .................................................................29 5.7. Unter-Tag <JAVASCRIPT-PDF>.....................................................................29 5.8. Spezifische Attribute und Tags für <BUTTON> ...........................................29 5.9. Spezifische Attribute und Tags für <CHECKBOX> .......................................30 5.10. Spezifische Attribute und Tags für <COMBO> ..........................................31 5.11. Spezifische Attribute und Tags für <EDIT> ................................................32 5.12. Spezifische Attribute und Tags für <ODBCACC> .......................................34 5.13. Spezifische Attribute und Tags für <PICTURE> .........................................34 5.14. Spezifische Attribute und Tags für <RECT> ...............................................36 5.15. Spezifische Attribute und Tags für <TABLE> .............................................37 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 3 6. Formatanweisungen .................................................................. 38 6.1. Datumsformat .............................................................................................38 6.2. Uhrzeitformat ..............................................................................................39 6.3. Ganzzahlformat ...........................................................................................41 6.4. Gleitkommazahlformat ...............................................................................42 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 4 1. Allgemeines Ab der Version 4.1.0.0 des Softwarepaketes [e] forms & more ist es möglich, Formularvorlagen in XML-Dateien abzuspeichern. Das XML-Format wird als vollwertiges Medium neben den proprietären Dateien im FVL-Format unterstützt. Formularvorlagen können sowohl in eine XML-Datei exportiert als auch aus einer solchen wieder eingelesen werden. Dadurch ist es ab dieser Version möglich, die erstellten Formularvorlagen auf transparente Weise mit einem beliebigen Zeileneditor zu bearbeiten. Dies kann insbesondere für Stapelvorgänge von Nutzen sein. Ferner ist es hierdurch möglich geworden, Vorlagen maschinell, d.h. durch andere Programme, zu erzeugen. Vorlagen müssen also nicht mehr nur zwangsweise mit dem Editor erstellt werden. Diese Dokumentation erläutert die Semantik der XML-Dateien, in denen Formulare gespeichert sind. Die XML-Syntax ist international genormt und ist daher nicht Bestandteil dieser Dokumentation. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 5 2. Grundsätzliche Struktur der XML-Datei Dieses Kapitel enthält eine Beschreibung der grundsätzlichen Struktur der XMLDateien, die von [e] forms & more erzeugt bzw. gelesen werden. 2.1. Optische Aufbereitung XML-Dateien, die von [e] forms & more erzeugt werden, werden automatisch je nach Verschachtelungstiefe der Tags mittels Tabulatoren eingerückt. Die Tabulatoren verhalten sich bei der Interpretation der XML-Datei neutral, erhöhen jedoch die Lesbarkeit deutlich. 2.2. Code Als Zeichencode wird UTF-8 verwendet. Die Wahl dieses Codes erlaubt das codieren beliebiger Zeichen, stellt aber alle internationalen Buchstaben und Ziffern eins zu eins dar, so dass zumindest die nicht landesspezifischen Buchstaben direkt lesbar sind. 2.3. Daten und deren Syntax Definitionsgemäß werden alle Daten innerhalb einer XML-Datei als String formuliert. Dies gilt sowohl für die Werte der benannten Attribute von Tags, als auch für die Daten, die innerhalb eines Tags abgelegt sind: • • • <TAG Attribut=“Daten“/> <TAG> Daten </TAG> • Je nach Art der Daten erfolgt die Formulierung des Strings in einer bestimmten Syntax. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 6 Die folgende Tabelle erläutert alle Arten von Daten, die in einer Formular-XMLDatei auftreten können: Datentyp Text Syntax Beispiele Beliebige Zeichenfolge gemäß den syntaktischen Bedingungen in XML-Dateien. Hans Thomas Nicht erlaubte Zeichen (z.B. < oder >) werden durch sogenannte Entities dargestellt. "hallo" (statt “hallo”) Ganzzahl Folge von Ziffern Keine führende Nullen Falls negativ, mit Vorzeichen 0 -123 53 Gleitkommazahl Folge von Ziffern, ggf. ein Dezimalpunkt Keine führende Nullen Falls negativ, mit Vorzeichen 23.7 -100.3 93 Farbe Drei aufeinanderfolgende ganze Zahlen, durch Kommata getrennt, die Rot,Grün,Blau bezeichnen 0,0,0 (schwarz) 255,255,0 (gelb) 255,0,0 (rot) Rechteck Vier aufeinanderfolgende ganze Zahlen, durch Kommata getrennt, die die Kanten des Rechtecks definieren: links,oben,rechts,unten 100,100,200,200 HexadezimalZahl Die ersten beiden Zeichen sind 0x. Dann folgen bis zu acht hexadezimale Ziffern (0123456789ABCDEF). 0x3 0xA0003 Ausrichtung horizontal Einer der folgenden Strings: left, center oder right left center Ausrichtung vertikal Einer der folgenden Strings: top, center oder bottom Top center Orientierung Seite Einer der folgenden Strings: portrait oder landscape portrait landscape Datentyp Einer der folgenden Strings: Int, float, date, time, text Int text Makro Vollständiger Makrotext, codiert als UTF-8-String. Nicht erlaubte Zeichen als Entity. Befehl1()
 ;Befehl2(); Insbesondere werden die Zeilenwechsel im Makro codiert als: 
 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Datentyp Bild XML-Format für Formulare Syntax Seite 7 Beispiele Das gesamte Bild als Zeichenfolge codiert im BASE64-Code 2.4. Voreinstellungen (Defaults) Für jeden XML-Wert eines Formulars existiert eine Voreinstellung (Default). Diese wird genau dann verwendet, wenn der entsprechende Wert in der XML-Datei nicht explizit angegeben ist. Die Defaults aller Werte sind fest definiert und ändern sich auch nicht mehr. Dadurch erübrigt es sich, Werte in die XML-Datei einzutragen, die der Voreinstellung entsprechen. Da dies die Mehrzahl aller Fälle ist, konnte auf diese Weise das Volumen der XMLDateien klein gehalten werden. XML-Dateien sind in der Regel nicht wesentlich größer als die proprietären FVL-Dateien. In dieser Dokumentation wird für alle möglichen Werte immer auch die entsprechende Voreinstellung ausgewiesen. 2.5. Root Tag Jede XML-Datei verfügt definitionsgemäß über genau einen Root Tag. Der Root Tag einer XML-Datei, die ein Formular beinhaltet muss immer WAIMEA-FORM heißen. Der Name dieses Tags wird beim Einlesen einer XML-Datei geprüft. Sollte der Tag nicht WAIMEA-FORM heißen, wird die XML-Datei als Formular abgelehnt. Wenn die XML-Datei von [e] forms & more erzeugt wird, wird der Root Tag standardmäßig mit zwei Attributen ausgestattet: <WAIMEA-FORM Creator=“eforms and more“ Version=”4.1.0.0”> Diese Attribute sind rein informativ. Sie geben Aufschluss darüber, welche Anwendung die Datei erzeugt hat und welche Versionsnummer diese Anwendung hat. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 8 Die beiden Angaben sind optional. Es wird aber empfohlen, diese Angaben grundsätzlich bereitzustellen. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 9 3. Tag <WAIMEA-FORM> Der Tag <WAIMEA-FORM> enthält niemals selbst Daten. Er enthält lediglich eine definierte Anzahl von eingeschachtelten Tags, sogenannte Unter-Tags. Prinzipiell sind alle Tags optional, da es für alle Werte Defaults gibt. In der Regel sind aber alle Tags vorhanden. Lediglich Tags, die keine Daten enthalten würden, werden weggelassen. So wird z.B. der Tag <MACROS> nicht erzeugt, wenn keine Makros vorhanden sind. Der Tag <WAIMEA-FORM> kann folgende Unter-Tags jeweils genau einmal enthalten: <PROPERTIES> <PRINT> <HTML-EXPORT> <PDF-EXPORT> <MACROS> <TEMPLATES> <PAGES> 3.1. <PROPERTIES> Der Tag <PROPERTIES> enthält grundsätzliche Einstellungen des Formulars. Alle Properties werden als eigenständige Unter-Tags in dem Tag <PROPERTIES> formuliert. Die folgende Tabelle definiert alle möglichen Property-Unter-Tags: © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag ActiveInputDisplay XML-Format für Formulare Seite 10 Bedeutung Default Modus, der angibt, ob ds augenblicklich aktiveEingabefeld farblich hervorgehoben werden soll (siehe ColorActiveInput): 0 0 = aktives Objekt nicht hervorheben 1 = aktives Objekt hervorheben AutoZoomMode Modus, der angibt, ob das Formular automatisch auf die jeweilige Fenstergröße gezoomt werden soll: 0 0 = nicht zoomen 1 = zoomen auf Fensterbreite 2 = zoomen auf Fensterhöhe ColorActiveInput Sonderfarbe, die als Hintergrund für Eingabeobjekte verwendet wird, für die ein Kommentartext bereitsteht: 0,0,0 0,0,0 : keine Sonderfarbe R,G,B : Sonderfarbe ColorCommentAvail Sonderfarbe, die als Hintergrund für Eingabeobjekte verwendet wird, für die ein Kommentartext bereitsteht: 0,0,0 0,0,0 : keine Sonderfarbe R,G,B : Sonderfarbe ColorMode 0 = Normaldarstellung 1 = Schwarz/Weiß-Darstellung 0 ColorPageShadow Farbe, mit der der Schatten der Seite dargestellt wird 64,64,64 ColorWindowBgr Farbe, in der der Fensterhintergrund dargestellt wird 192,192,192 DispDistBottom Oberer Rand bei der Anzeige des Formulars im Fenster in Pixeln 20 DispDistHori Linker und rechter Rand bei der Anzeige des Formulars im Fenster in Pixeln 20 DispDistInterpage Abstand zweier Seiten bei der Anzeige in Pixeln 20 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 11 Bedeutung Default DispDistTop Unterer Rand bei der Anzeige des Formulars im Fenster in Pixeln 20 EditPassword Passwort, das für die Bearbeitung des Formulars erforderlich ist <leer> Expiration Verfallsdatum des Formulars in Tagen ab dem 1.1.1600. 0 Nach dem verfall kann ein Formular nicht mehr gedruckt werden. 0 = Keine Verfall Grid Abstand des Rasters in dem alle Objekte einrasten in Mikrometern 500 ModalDialogFlags Bitliste, die Eigenschaften des Formulars für den Betrieb als modaler Dialog festlegt: 0 1 : Fenster maximieren ModalDialogHeight Fensterhöhe beim Betrieb des Formulars als modaler Dialog in Pixeln 500 ModalDialogWidth Fensterbreite beim Betrieb des Formulars als modaler Dialog in Pixeln 800 NextGroupId Nächste in diesem Formular zu vergebende Gruppen-ID (interner Wert) 1 NoSaveQuestion Indikator, ob die Frage Speichern beim Schließen eines geänderten Formulars unterdrückt werden soll: 0 1 = unterdrücken 0 = nicht unterdrücken ObjectNamesPool Liste von Namen (getrennt durch |), die in den Comboboxen zur Auswahl von Objektnamen als Liste präsentiert wird <leer> PageKeyMode Indikator, wie sich die Tasten Bild oben und Bild unten verhalten: 1 1 = Blättern des Formulars 2 = Blättern in der Dantenbank © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 12 Bedeutung Default RasterColor Farbe, in der die Gitternetzlinien zur Orientierung im Editor angezeigt werden 192,192,192 RasterDistance Abstand der Gitternetzlinien, die im Editor eingeblendet werden können in Mikrometern. 0 0 = kein Gitternetz RasterZOrder Indikator, ob das Gitternetz unter oder über den Objekten angezeigt wird: 2 1 = über allen Objekten 2 = unter allen Objekten ReadOnlyMode Indikator ob das Formular im ReadOnlyModus betrieben wird: 0 0 = normaler Betrieb 1 = Read Only (keine Veränderung) XmlSchema Name der XML-Schema-Datei, die die Vorlagen für den Assistenten zum Anlegen neuer Objekte enthält. <leer> 3.2. <PRINT> Der Tag <PRINT> enthält alle Druckeinstellungen eines Formulars. Alle Werte werden als eigenständige Unter-Tags innerhalb des Tag <PRINT> formuliert. Die folgende Tabelle definiert alle möglichen Tags: Tag Bedeutung Default BlackWhite 0 = normale Druckausgabe 1 = Druckausgabe in Schwarz/Weiß 0 Copies Anzahl Kopien beim Drucken 1 CopyList Deskriptor für eine Ausfertigungsliste <leer> CopyListMode 0 = nur eine Ausfertigung drucken 1 = alle Ausfertigungen drucken 0 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag Duplex XML-Format für Formulare Seite 13 Bedeutung Default Definiert den Duplexbetrieb: 1 1 = kein Duplex (Simplex) 2 = vertikaler Duplexbetrieb FromPage Vorgabe der ersten zu druckenden Seite 1 NoBgrPicture 0 = Hintergrundbild drucken 1 = Hintergrundbild nicht drucken 0 OnlyContent 0 = Formula vollständig drucken 1 = nur die Eingaben drucken 0 PageMode 0 = Alle Seiten drucken 1 = Seitenbereich drucken 2 = aktuelle Seite drucken 0 PrinterMode 0 = Standarddrucker verwenden 1 = Ausgabe auf expliziten Drucker 0 PrinterName Name des Druckers <leer> SerialMode 0 = kein Serienformular drucken 1 = Serienformular drucken 0 ToPage Vorgabe des Wertes bis Seite 1 Zoom Druckvergrößerung oder Druckverkleinerung in Prozent 100 3.3. <HTML-EXPORT> Der Tag <HTML-EXPORT> enthält alle Einstellungen eines Formulars, die für den Export nach HTML von Bedeutung sind. Alle Werte werden als eigenständige Tags unter dem Tag <HTML-EXPORT> formuliert. Die folgende Tabelle definiert alle möglichen Tags: © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 14 Bedeutung Default Author Autor, der in die HTML Seite übertragen wird <leer> BgrColor Hintergrundfarbe TML Seite 128,196,196 DateFormat Datums-Formatdescriptor wenn Uhrzeiten in einem einheitlichen Übertragungsformat versendet werden (Kapitel Formatdescriptoren) %Y2-%M2-%D2 Flags Bitliste mit Eigenschaften 0x2439 FloatFormat Gleitkomma-Formatdescriptor wenn Gleitkommazahlen in einem einheitlichen Übertragungsformat versendet werden (Kapitel Formatdescriptoren) %D.%F02 GlobalJavaRoutines Globale Java-Routinen, die immer mitexportiert werden sollen. <leer> IntFormat Ganzzahl-Formatdescriptor wenn ganze Zahlen in einem einheitlichen Übertragungsformat versendet werden (Kapitel Formatdescriptoren) %T JavaName Expliziter Name für exportierte Javascripts <leer> JavaNameMode Benennung von Javascript-Dateien 1 1 = wie HTML-Datei 2 = Expliziter Name JavaPath Verzeichnis zur Ablage von JavascriptDateien <leer> JavaPathMode Export von Javascripts in: 1 1 = Verzeichnis der HTML-Datei 2 = Explizites Verzeichnis Keywords Stichworliste, die in di HTML Datei übertragen wird <leer> LeftFrame Linker Rand in Mikrometern 5000 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag PictureFormat XML-Format für Formulare Seite 15 Bedeutung Default Format für Bilder 1 1 = JPEG 2 = Bitmap PicturePath Verzeichnis zur Ablage von Bilddateien <leer> PicturePathMode Export von Bildern in: 1 1 = Verzeichnis der HTML-Datei 2 = Explizites Verzeichnis PicturePräfix Expliziter Name für exportierte Bilder <leer> PicturePräfixMode Benennung von Bildern 1 1 = wie HTML-Datei 2 = Expliziter Name SubmitAction Übertragungsaktion <leer> SubmitEmail Mailadresse, an die gesendet wird, wenn SubmitType das Versenden einer Mail spezifiziert <leer> SubmitEncoding Submit Encoding <leer> text/plain url-encoded SubmitMethod Get post SubmitSubject Betreff der Mail, wenn SubmitType das Versenden einer Mail spezifiziert <leer> SubmitType 1 = versenden als Mail 2 = Explizite Aktion (SubmitAction) 1 TimeFormat Uhrzeitformat, welches verwendet wird, wenn Uhrzeiten in einem einheitlichen Übertragungsformat versendet werden (siehe Kapitel Formatdescriptoren) %H1:%U2 Title Titel der HTML Seite <leer> UpperFrame Oberer Rand in Mikrometern 5000 = Methode get = Methode post © Copyright 1994-2012 by Waimea Software GmbH Post www.waimea.de [e] forms & more XML-Format für Formulare Seite 16 3.4. <PDF-EXPORT> Der Tag <PDF-EXPORT> enthält alle Einstellungen eines Formulars, die für den Export nach PDF von Bedeutung sind. Alle Werte werden als eigenständige UnterTags unter dem Tag <PDF-EXPORT> formuliert. Die folgende Tabelle definiert alle möglichen Tags: Tag Bedeutung Default Author Autor, der in die PDF-Datei übertragen wird <leer> DateFormat Datums-Formatdescriptor wenn Uhrzeiten in einem einheitlichen Übertragungsformat versendet werden (Kapitel Formatdescriptoren) %Y2-%M2-%D2 Flags Bitliste mit Eigenschaften 0x0 FloatFormat Gleitkomma-Formatdescriptor wenn Gleitkommazahlen in einem einheitlichen Übertragungsformat versendet werden (Kapitel Formatdescriptoren) %D.%F02 GlobalJavaRoutines Globale Java-Routinen, die immer mitexportiert werden sollen. <leer> IntFormat Ganzzahl-Formatdescriptor wenn ganze Zahlen in einem einheitlichen Übertragungsformat versendet werden (Kapitel Formatdescriptoren) %T Keywords Stichwortiste, die immer in die PDFDatei übertragen wird <leer> PsPrinterDriver Druckertreiber für die Erzeugung der Postscript-Datei <leer> SubmitAction Übertragungsaktion <leer> SubmitEmail Mailadresse, an die gesendet wird, wenn SubmitType das Versenden einer Mail spezifiziert <leer> © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag SubmitEncoding XML-Format für Formulare Seite 17 Bedeutung Default Submit Encoding <leer> text/plain url-encoded SubmitMethod Get post SubmitSubject Betreff der Mail, wenn SubmitType das Versenden einer Mail spezifiziert <leer> SubmitType 1 = versenden als Mail 2 = Explizite Aktion (SubmitAction) 1 TimeFormat Uhrzeitformat, welches verwendet wird, wenn Uhrzeiten in einem einheitlichen Übertragungsformat versendet werden (siehe Kapitel Formatdescriptoren) %H1:%U2 Title Titel, der in die PDF-Datei übertragenwird <leer> = Methode get = Methode post Post 3.5. <MACROS> Der Tag <MACROS> beschreibt alle globalen Formularmakros. <MACROS> enthält für jeden definierten Makro-Event einen Unter-Tag der Form: <ITEM Name="EventName"> Macrocode </ITEM> Es sind folgende Events definiert: OnSessionOpen OnSessionClose OnSessionSave OnAnyObjectGetFocus OnAnyObjectKillFocus OnAnyObjectChange OnAnyObjectClick OnRecordAccess OnRecordUnselect OnPrintStart OnPrintEnd OnPrintCopyStart OnModalConfirmBeforeCreateOutput © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 18 Beispiel: <ITEM Name="OnSessionOpen"> SetText (“aaa”, “bbb”); </ITEM> 3.6. <TEMPLATES> Der Tag <TEMPLATES> enthält die Voreinstellungen, die verwendet werden, wenn im Editor eines der folgenden Objekte neu angelegt wird: Text Eingabefeld Auswahlfeld Ankreuzfeld Der Tag <TEMPLATES> ist syntaktisch identisch mit dem Aufbau des Tags <PAGE>, welcher eine vollständige Seite beschreibt und der weiter unten beschrieben wird. Insbesondere enthält der Tag <TEMPLATES> genau einen Unter-Tag <OBJECTS>, welcher wiederum die einzelnen Musterobjekte enthält. Bezüglich der Syntax der Objekte sei wie gesagt auf die Beschreibung des Tags <PAGE> verwiesen. 3.7. <PAGES> Der Tag <PAGES> beschreibt alle Seiten des Formulars. Wenn die XML-Datei von der Anwendung [e forms & more erzeugt wird, erhält der Tag <PAGES> ein informatives, aber optionales Attribut Total welches die Anzahl der Seiten insgesamt definiert: <PAGES Total=“5“> Für jede einzelne Seite des Formulars ist im Tag <PAGES> ein Unter-Tag <PAGE> vorhanden. Dieser enthält alle Basisinformationen über eine Seite sowie die Beschreibung aller Objekte, die auf einer Seite angeordnet sind. Der Tag <PAGE> ist im folgenden Kapitel beschrieben. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 19 4. Tag <PAGE> Der Tag <PAGE> definiert eine vollständige Seite eines Formulars. <PAGE> enthält niemals selbst Daten. Er enthält lediglich eine definierte Anzahl von Unter- Tags oder Attribute. Prinzipiell sind alle Tags oder Attribute optional, da es für alle Werte Defaults gibt. In der Regel sind aber alle Werte explizit vorhanden. 4.1. Attribute in <PAGE> Der Tag <PAGE> kann folgende Attribute enthalten: Tag Bedeutung Default BgrColor Hintergrundfarbe der Seite 192,192,192 BgrMode Modus, wie der Seitenhintergrund erzeugt wird : 1 1 = kein Hintergrund 2 = Hintergrund ist einfarbig 3 = Hintergrund ist eine Bitmap BgrPrint 0 = Hintergrund nicht drucken 1 = Hintergrund drucken 1 Height Höhe der Seite in Mikrometern 296000 Name Name der Seite <leer> Orient Seitenausrichtung als String: portrait portrait landscape Width = Hochformat = Querformat Breite der Seite in Mikrometern 209000 Beispiel: Der folgende Tag beschreibt eine DIN-A4-Seite im Hochformat: <PAGE Height=”296000” Width=”209000” Orient=”portrait” Name=”MyPage”> © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 20 4.2. Unter-Tags in <PAGE> Der Tag <PAGE> kann folgende Unter-Tags enthalten, die Seiteneigenschaften beschreiben: Tag Bedeutung Default BgrPictureCode BASE64-Codierung des Hintergrundbildes <leer> PicFrame Rechteck, welches die Position und Größe des Hintergrundbildes in Mikrometern definiert 0,0,0,0 PicHoriAlign Horizontale Ausrichtung des Hintergrundbildes im Rechteck: center left center right PicSizeMode = linksbündig = mittig = rechtsbündig Modus, wie das Bild ausgegeben und ob es verzerrt oder vergrößert wird: 2 1 = Größe anpassen, Ratio verzerren 2 = Größe anpassen, Ratio erhalten 3 = In Originalgröße ausgeben 4 = Zoomfaktor auf Oroginalgröße PicVertAlign Vertikale Ausrichtung des Hintergrundbildes im Rechteck: top center bottom center = oben = mittig = unten PicZoom Zoomfaktor, für den Fall, dass PicSizeMode = 4 ist 100 PrintFlag Flag, ob die Seite gedruckt wird oder nicht: 1 1 = Seite drucken 0 = Seite nicht drucken © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 21 4.3. Tag <OBJECTS> Neben den oben beschriebenen Tags zur Beschreibung von Seiteneigenschaften kann ein Tag <PAGES> genau einen Tag <OBJECTS> beinhalten. Dieser beinhaltet alle Objekte der Seite. Wenn die XML-Datei von der Anwendung [e] forms & more erzeugt wird, erhält der Tag <OBJECTS> ein informatives, aber optionales Attribut Total welches die Anzahl der Objekte auf der Seite nennt: <OBJECTS Total=“5“> Innerhalb des Tags <OBJECTS> werden alle Objekte der Reihe nach aufgelistet. Jedes Objekt wird durch einen eigenständigen Tag definiert. Das folgende Kapitel definiert die einzelnen Objekte und die zugehörigen Attribute und Unter-Tags. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 22 5. Tags zur Definition von Objekten Wie bereits im vorhergehenden Kapitel angedeutet, wird jedes Objekt einer Seite durch einen eigenständigen Unter-Tag innerhalb des Tags <OBJECTS> definiert. Dieses Kapitel erläutert die Tags aller verfügbaren Objekte sowie die möglichen Eigenschaften und Attribute für jedes einzelne Objekt. Folgende Tags sind für die einzelnen Objekte vorgesehen: Tag Objekt <BUTTON> Schaltfläche <CHECKBOX> Ankreuzfeld <CIRCLE> Kreis oder Ellipse <COMBO> Auswahlfeld <COPYNAME> Name der Ausfertigung <DATE> Datumseinblendung <EDIT> Eingabefeld <LINE> Linie <ODBCACC> Datenbankzugriff <PICTURE> Bild <RECT> Rechteck <RTF> RTF-Text <TEXT> Textobjekt <TABLE> Tabelle <TIME> Zeiteinblendung Jeder dieser Tags kann ein oder mehrere Attribute oder Unter-Tags haben, die das Objekt genau definieren. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 23 Die Attribute und Unter-Tags gliedern sich in zwei Gruppen: • • Allgemeine Attribute und Unter-Tags (für alle Objekte) Spezifische Attribute und Unter-Tags (für ein spezifisches Objekt) Die folgenden Kapitel erläutern die allegemeinen Attribute und Untertags, die für alle Objekte verwendet werden können. Für diejenigen Objekte, für die spezifische Attribute und Unter-Tags vorgesehen sind, werden auch diese einzeln erläutert. 5.1. Allgemeine Attribute Es gibt eine Reihe von Attributen, die für alle Objekttypen identisch sind. Sie können prinzipiell jedem Objekt anhaften. Nicht alle dieser Attribute machen für jedes Objekt Sinn. Z.B. sind Attribute, die die Textausrichtung definieren bei Objekten, in denen kein Text anzeigt wird, ohne Bedeutung. Sie schaden jedoch nicht. Die folgende Tabelle zeigt alle Attribute, die für alle Objekte verwendet werden können. Tag AlignHori Bedeutung Default Horizontale Ausrichtung des Textes, der in dem Objekt dargestellt wird: Left left = linksbündig center = mittig right = rechtsbündig Für Objekte, die keinen Text darstellen, ist dieses Attribut ohne Wirkung. AlignVert Vertikale Ausrichtung des Textes, der in dem Objekt dargestellt wird: Top top = oben center = mittig bottom = unten Für Objekte, die keinen Text darstellen, ist dieses Attribut ohne Wirkung. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 24 Bedeutung Default ColorBgr Hintergrundfarbe des Objekts 255,255,255 (weiß) ColorFrame Farbe des Randes. Ist ohne Bedeutung, wenn FrameType = 0 0,0,0 (schwarz) Format Formatdescriptor, der verwendet wird, um den Text des Objekts zu formatieren. <leer> Ist bei Objekten, in denen kein Text dargestellt wird, ohne Bedeutung. (sieh Kapitel Formatdescrptoren) FrameSize Dicke des Randes in Mikrometern 100 FrameType Typ des Objektrandes : 0 0 = kein Rand 1 = gepunkteter (gestrichelter) Rand 2 = durchgehender Rand 3 = 3D Rand Bei Linien ist dies der Linientyp. Name Name des Objekts <leer> Outline Position und Größe des Rechtecks, das das Objekt umschließt in Mikrometern relativ zur Seite <kein Default> (muss angegeben werden) Padding Abstand der Schrift vom Rand in Mikrometern 100 State Statusbits als Hexadezimalstring <kein Default> (muss angegeben werden) Beispiel: Der folgende Tag beschreibt ein Eingabefeld: <EDIT Outline=”10000,10000,40000,20000” AlignHorit=”left” Name=”MyEdit”> © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 25 5.2. Allgemeine Unter-Tags Neben den Attributen, die für alle Objekte verwendet werden können, gibt es noch eine Reihe von Eigenschaften, die durch Unter-Tags formuliert werden und die ebenfalls für alle Objektarten gemeinsam sind. Die folgende Tabelle zeigt alle Unter-Tags, die für jeglichen Objekttyp verwendet werden können: Tag Bedeutung Default GroupId ID, die für die Gruppierung von Objekten verwendet wird. 0 HtmlLink URL, die einem Hypertext angeheftet wird, um das Ziel der Verweigung zu definieren. <leer> top center bottom = oben = mittig = unten Für Objekte, die keinen Text darstellen, ist dieses Attribut ohne Wirkung. Text Text des Objekts <leer> (Ausgabetext bei Textobjekten, Eingabetext bei Eingabfeldern und Auswahlfeldern) Darüber hinaus gibt es noch folgende Tags, die nur für Eingabeobjekte verwendet werden können: Tag Bedeutung Default AccObject Name des assoziierten Datenzugriffsobjekts <leer> Comment Kommentar (Hilfstext) für dieses Objekt <leer> DataField Name des Datenfeldes der Datenquelle, mit dem ein Eingabeobjekt verknüpft werden soll <leer> © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 26 Bedeutung Default Hint Statuszeilentext <leer> JumpNext Codierung, was im Falle eines Vorwärtssprungs mit der Tabulatoroder Zeilenschaltungstaste zu tun ist: 1 1 = Gehe ins nächste Eingabeobjekt 2 = Springe auf explizites Objekt 3 = Anschlag mit akkustischem Ton 4 = Anschlag ohne akkustischen Ton 5 = Ein Makro bestimmt, welches Objelt das nächste ist JumpPrev Codierung, was im Falle eines Rückwärtssprungs mit der Tabulatortaste zu tun ist: 1 1 = Gehe ins vorige Eingabeobjekt 2 = Springe auf explizites Objekt 3 = Anschlag mit akkustischem Ton 4 = Anschlag ohne akkustischen Ton 5 = Ein Makro bestimmt, welches Objelt das nächste ist NextObjName Name des Objeks, das im Falle von JumpNext = 2 anzuspringen ist <leer> PrevObjName Name des Objeks, das im Falle von JumpPrev = 2 anzuspringen ist <leer> Neben den oben hier genannten Tags, die jeweils eine einzelne Eigenschaft bestimmen, gibt es noch folgende Tags, die in jedem Objekt angelegt werden können: <FONT> <SEPARATION> <JACASCRIPT-HTML <JACASCRIPT-PDF <MACROS> Schriftartforgabe Definition einer Unterteilung für Textdarstellung Eigenschaften für den HTML-Export Eigenschaften für den PD-Export Makros für das Reagieren auf objektspezifische Events 5.3. Unter-Tag <FONT> Der Tag <FONT> kann als Unter-Tag in jedem Objekt auftreten. Sinn macht er allerdings nur in Objekten, die einen Text abbilden. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 27 Der Tag <FONT> enthält keine Daten, aber verschiedene Attribute. Die folgende Tabelle zeigt alle Attribute, die ein <FONT> Tag haben kann: Tag Bedeutung Default Chset Zeichensatzart 0 Color Schriftfarbe 0,0,0 (schwarz) Escapement Drehung der Schrift in 1/10 Grad gegen den Uhrzeigersinn 0 Face Name der Schriftart Arial Height Höhe der Schrift in 1/10 Punkten 100 Italic 0 = nicht kursiv 1 = kursiv 0 Strikeout 0 = nicht durchgestrichen 1 = durchgestrichen 0 Underline 0 = nicht unterstrichen 1 = unterstrichen 0 Weight Gewicht der Schrift: 400 400 = Normal 700 = Fett Beispiel: Der folgende Tag beschreibt die Schrift Times New Roman 14: <FONT Face=”Times New Roman” Height=”140”> 5.4. Unter-Tag <SEPARATION> Der Tag <SEPARATION> definiert eine Unterteilung für Texte. Dieser Tag kann in allen Aus- und Eingabeobjekten verwendet werden, die Texte anzeigen. Auch dieser Tag enthält keine Daten, aber verschiedene Attribute. Die folgende Tabelle zeigt alle Attribute, die ein <SEPARATION> Tag haben kann: © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 28 Bedeutung Default Color Farbe der Separatorstriche 0,0,0 (schwarz) MainList Bitliste als Hexadezimalstring, welche alle Positionen durch ein Bit markiert, die Hauptteiler darstellen. 0x0 MainLng Länge der Striche für die Hauptteiler in Mikrometern 2000 MainState Statusbits der Hauptteiler als Hexadezimalstring 0x0 SecLng Länge der Striche für die Nebenteiler in Mikrometern 2000 SecState Statusbits der Nebenteiler als Hexadezimalstring 0x0 SecWidth Breite der Teilungsstriche in Mikrometern 100 Separators Anzahl der Teilungsstriche 0 Beispiel: Der folgende Tag beschreibt eine Unterteilung mit 5 Teilungsstrichen, ohne Hauptteiler in rot: <SEPARATION Separators=”5” Height=”2000” Width=”500” Color=”255,0,0”> 5.5. Unter-Tag <MACROS> Der Tag <MACROS> kann als Unter-Tag in jedem Objekt auftreten. Sinn macht er allerdings nur in Eingabeobjekten, da diese über Makro-Events verfügen. Der Tag <MACROS> beschreibt alle Makros eines Objekts. <MACROS> enthält für jeden definierten Makro-Event einen Unter-Tag der Form: <ITEM Name="EventName"> Macrocode </ITEM> Die möglichen Ebents hängen vom Typ des Objekts ab. Neben der vordefinierten Events können auch individuelle Events vom Benutzer angelegt werden. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 29 Beispiel: <ITEM Name="OnObjectGetFocus"> SetText (“aaa”, “bbb”); </ITEM> 5.6. Unter-Tag <JAVASCRIPT-HTML> Der Tag <JAVASCRIPT-HTML> kann als Unter-Tag in jedem Objekt auftreten. Sinn macht er allerdings nur in Eingabeobjekten, da diese über Javascripts für den Export nach HTML verfügen. Der Tag <JAVASCRIPT-HTML> beschreibt alle Javascripts, die für ein Objekt für den Export nach HTML hinterlegt sind. <JAVASCRIPT-HTML> enthält für jeden JavaEvent einen Unter-Tag der Form: <ITEM Name="EventName"> Macrocode </ITEM> Die möglichen Events hängen vom Typ des Objekts ab. 5.7. Unter-Tag <JAVASCRIPT-PDF> Der Tag <JAVASCRIPT-PDF> kann als Unter-Tag in jedem Objekt auftreten. Sinn macht er allerdings nur in Eingabeobjekten, da diese über Javascripts für den Export nach PDF verfügen. Der Tag <JAVASCRIPT-PDF> beschreibt alle Javascripts, die für ein Objekt für den Export nach PDF hinterlegt sind. <JAVASCRIPT-PDF> enthält für jeden Java-Event einen Unter-Tag der Form: <ITEM Name="EventName"> Macrocode </ITEM> Die möglichen Events hängen vom Typ des Objekts ab. 5.8. Spezifische Attribute und Tags für <BUTTON> Mit jedem Tag <BUTTON> wird eine Schaltfläche definiert. Als Attribute des Tags <BUTTON> können neben den allgemeinen Attributen, die weiter oben beschrieben sind, folgende spezifischen Attribute auftreten: Tag Bedeutung © Copyright 1994-2012 by Waimea Software GmbH Default www.waimea.de [e] forms & more Tag Action XML-Format für Formulare Seite 30 Bedeutung Default Aktion, die durch den Button ausgelöst wird: 1 1 = Makro ausführen 2 = Reset ausführen 3 = Submit (nur HTML) 4 = Javascript ausführen (nur HTML) 5 = Hilfetext anzeigen ColorDark Farbe des dunklen Schattens (rechts, unten) 96,96,96 ColorLight Farbe des hellen Schattens (links, oben) 255,255,255 Rop Raster Operation, mit der ein Bild angezeigt wird, sofern eines definiert ist: 1 1 = AND 2 = COPY Ferner können neben den gemeinsamen Unter-Tags für alle Objekte folgende spezifische Unter-Tags in auftreten: Tag Bedeutung Default HelpText Anzuzeigender Hilfetext, falls Action = 1 ist <leer> PictureCode Code eines Bildes, welches auf dem Button angezeigt wird als BASE64 codierter String <leer> Beispiel: Der folgende Tag beschreibt einen Button (nicht vollständig): <BUTTON Outline=”10000,10000,10000,10000” Text=”OK” Action=”1”> 5.9. Spezifische Attribute und Tags für <CHECKBOX> Mit jedem Tag <CHECKBOX> wird ein Ankreuzfeld definiert. Als Attribute des Tags <CHECKBOX> können neben den allgemeinen Attributen, die weiter oben beschrieben sind, folgende spezifischen Attribute auftreten: © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 31 Bedeutung Default CheckboxFlags Spezifische Checkbox-Flags als Bitliste in form eines hexadezimalen Strings 0x0 CrossColor Farbe des Kreuzes 0,0,0 (schwarz) CrossPadding Abstand des Kreuzes vom Rand 0 CrossWeight Dicke des Kreuzes in Mikrometern 200 Ferner können neben den gemeinsamen Unter-Tags für alle Objekte folgende spezifische Unter-Tags auftreten: Tag Bedeutung Default CheckText Text, der mit dem Ankreuzfeld assoziiert wird, wenn es angekreuzt ist <leer> Default Voreinstellung 0 NonCheckText Text, der mit dem Ankreuzfeld assoziiert wird, wenn es nicht angekreuzt ist <leer> RadioGroupName Name der Gruppe innerhalb derer sich Checkboxen wie Radio-Buttons gegenseitig auslösen <leer> Beispiel: Der folgende Tag beschreibt einen Button (nicht vollständig): <CHECKBOX Outline=”10000,10000,10000,10000” CrossColor=”255,0,0”> 5.10. Spezifische Attribute und Tags für <COMBO> Mit jedem Tag <COMBO> wird ein Auswahlfeld definiert. Als Attribute des Tags <COMBO> können neben den allgemeinen Attributen, die weiter oben beschrieben sind, folgende spezifischen Attribute auftreten: © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 32 Bedeutung Default ComboType 1 = nur Liste 2 = Eingabe oder Liste 1 DataType Datentyp des Eingabefeldes: text text int float date time = Textfeld = Ganzzahl = Gleitkommazahl = Datum = Uhrzeit Ferner können neben den gemeinsamen Unter-Tags für alle Objekte folgende spezifische Unter-Tags auftreten: Tag Bedeutung Default Default Vorbesetzung <leer> Semantic Semantik-Descriptor. Dies ist ein spezifischer String, der die Semantik des Eingabefeldes definiert. <leer> Zur Definition der Auswahlliste kann darüber hinaus ein Unter-Tag <LIST> definiert werden. Innerhalb des Tags <LIST> können ein oder mehrere Items der Form: <ITEM Display=”Herr” Value=”1” Color=”255,0,0”/> definiert werden. Beispiel: Der folgende Tag beschreibt ein Auswahlfeld (nicht vollständig): <COMBO Outline=”10000,10000,10000,10000” ComboType=”1”> <LIST> <ITEM Display=”Herr” Value=”1” Color=”255,0,0”/> <ITEM Display=”Frau” Value=”2” Color=”0,255,0”/> </LIST> </COMBO> 5.11. Spezifische Attribute und Tags für <EDIT> © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 33 Mit jedem Tag <EDIT> wird ein Eingabefeld definiert. Als Attribute des Tags <EDIT> können neben den allgemeinen Attributen, die weiter oben beschrieben sind, folgende spezifischen Attribute auftreten: Tag DataType Bedeutung Default Datentyp des Eingabefeldes: Text text int float date time = Textfeld = Ganzzahl = Gleitkommazahl = Datum = Uhrzeit Ferner können neben den gemeinsamen Unter-Tags für alle Objekte folgende spezifische Unter-Tags auftreten: Tag Bedeutung Default Default Vorbesetzung <leer> Semantic Semantik-Descriptor. Dies ist ein spezifischer String, der die Semantik des Eingabefeldes definiert. <leer> Beispiel: Der folgende Tag beschreibt einen Button (nicht vollständig): <EDIT Outline=”10000,10000,10000,10000” Default=”MyDefault”/> © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 34 5.12. Spezifische Attribute und Tags für <ODBCACC> Mit jedem Tag <ODBCACC> wird ein ODBC-Zugriffsobjekt definiert. Als Attribute des Tags <ODBCACC> können alle allgemeinen Attributen verwendet werden. Zusätzlich zu den allgemeinen Unter-Tags können sind folgende Unter-Tags definiert: Tag Bedeutung Default DsName Name der ODBC-Datenquelle <leer> DsPassword Passwort der ODBC-Datequelle <leer> DsUserId Benutzerkennung der ODBC-Datenquelle <leer> OrderBy ORDER BY-Klausel des SQL-Statements <leer> Select SELECT-Klausel des SQL-Statements <leer> Where WHERE-Klausel des SQL-Statements <leer> Beispiel: Der folgende Tag beschreibt ein ODBC-Zugriffsobjekt: <ODBCACC Outline=”10000,10000,10000,10000”> <DsName>Waimea</DsName> <Select>SELECT * FROM Personen</Select> <OrderBy>Name</OrderBy> </ODBCACC> 5.13. Spezifische Attribute und Tags für <PICTURE> Mit jedem Tag <PICTURE> wird ein Bild definiert. Als Attribute des Tags <PICTURE> können neben den allgemeinen Attributen, die weiter oben beschrieben sind, folgende spezifischen Attribute auftreten: Tag Bedeutung © Copyright 1994-2012 by Waimea Software GmbH Default www.waimea.de [e] forms & more Tag Rop XML-Format für Formulare Seite 35 Bedeutung Default Raster Operation, mit der ein Bild angezeigt wird, sofern eines definiert ist: 1 1 = AND 2 = COPY SizeMode Modus, wie das Bild ausgegeben und ob es verzerrt oder vergrößert wird: 2 1 = Größe anpassen, Ratio verzerren 2 = Größe anpassen, Ratio erhalten 3 = In Originalgröße ausgeben 4 = Zoomfaktor auf Originalgröße Source Bildquelle: 0 0 = kein Bild 1 = eingebetteter Bildcode 2 = Referenz auf eine Datei 3 = Zugriff auf Datenbank Zoom Vergrößerungsfaktor wenn SizeMode = 4 100 Ferner können neben den gemeinsamen Unter-Tags für alle Objekte folgende spezifische Unter-Tags in auftreten: Tag Bedeutung Default AccObject Name des Zugriffsobjektes, mit dem auf externe Datenbestände zugegriffen wird <leer> DataField Name des Datenfeldes in einer externen Datenquelle, an die das Bild angebunden ist. <leer> Mask Maskierung des Bildes: 255,255,255 1 = keine Maske 2 = Ellipse 3 = Kreis © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more Tag XML-Format für Formulare Seite 36 Bedeutung Default PictureCode Code des als BASE64 codierter String <leer> PictureFile Name der Bilddatei, falls das Bild eine Referenz auf eine Datei ist. <leer> 5.14. Spezifische Attribute und Tags für <RECT> Mit jedem Tag <RECT> wird ein Rechteck definiert. Als Attribute des Tags <RECT> können neben den allgemeinen Attributen, die weiter oben beschrieben sind, folgende spezifischen Attribute angegeben werden: Tag Bedeutung Default ColorInnerFrame Farbe des inneren Randes 192,192,192 Corner Eckentyp: 1 1 = scharf 2 = mittel 3 = rund ShadowSize Breite des Schattens in Mikrometern 100 Special Bitliste mit Spezialeffekten als Hexadezimaler String 0x0 Style 1 = flach 2 = 3D erhaben 3 = 3D vertieft 4 = transparent 3 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 37 5.15. Spezifische Attribute und Tags für <TABLE> Mit jedem Tag <TABLE> wird ein Tabellenobjekt definiert. Als Attribute des Tags <TABLE> können alle allgemeinen Attributen verwendet werden. Zusätzlich zu den allgemeinen Unter-Tags können sind folgende Unter-Tags definiert: Tag Descriptor Bedeutung Default Descriptor der Tabelle gemäß den Spezifikationen des Waimea GRID Objekts <leer> © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 38 6. Formatanweisungen Dieses Kapitel beschreibt die Formatdeskriptoren, die verwendet werden, um die Formatierung von Zahlen, Datums- und Uhrzeitangaben zu definieren. Insgesamt werden vier verschiedene Formate definiert: Format für ganze Zahlen Format für Gleitkommazahlen Format für Datumsangaben Format für Uhrzeiten Diese vier Formate werden in den folgenden Kapiteln erläutert. Sie sind inhaltlich verwandt, unterscheiden sich jedoch wesentlich voneinander. 6.1. Datumsformat Ein Datumsformat ist ein String, der aus einer Aneinanderreihung von Platzhaltern für die Komponenten Wochentag, Tag, Monat und Jahr besteht. Vor, zwischen und hinter den Platzhaltern kann ein beliebiger Text stehen, der Bestandteil des fertig formatierten Datums wird. Jeder Platzhalter beginnt mit einem Prozentzeichen. Dann folgt ein Buchstabe, der den Platzhaltertyp bestimmt. Es sind folgende Platzhalter definiert, die ein Datumsformat enthalten kann: %Wx %Dx %Mx %Yx Wochentagsname Tag Monat Jahresangabe Dahinter folgt eine Variantenbezeichnung x. Die Variantenbezeichnung ist eine einstellige Ziffer und bedeutet je nach Platzhalter: %W0 %W1 %W2 Keine Wochentagseinblendung Wochentag als zweibuchstabiges Kürzel einblenden Wochentag als vollen Namen einblenden © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 39 %D0 %D1 %D2 Keine Einblendung des Tages Tag als möglichst kurze Zahl ohne führende Null einblenden Tag als zweistellige Zahl, ggf. mit einer führenden Null einblenden %M0 %M1 %M2 %M3 %M4 Keine Einblendung des Monats Monat als möglichst kurze Zahl ohne führende Null einblenden Monat als zweistellige Zahl, ggf. mit einer führenden Null einblenden Monatsname als dreibuchstabige Abkürzung einblenden Monatsname in voller Länge einblenden %Y0 %Y1 %Y2 Keine Einblendung des Jahres Jahr als zweistellige Zahl ohne Jahrhundert einblenden Jahr als vierstellige Zahl mit Jahrhundert einblenden Durch die Reihenfolge der Platzhalter können auch die englischsprachige Anordnung (Monat, Tag, Jahr) und die sortierfreudige Anordnung (Jahr, Monat, Tag) bestimmt werden. insgesamt werden folgende Anordnungen der Platzhalter unterstützt: Tag, Monat, Jahr Monat, Tag, Jahr Jahr, Monat, Tag Zwischen den Platzhaltern dürfen beliebige Zeichen oder Textfolgen stehen. Die Anordnung der Wochentagsbezeichnung (%W) ist beliebig. Folgende Beispiele zeigen die Darstellung des Datums 3. Januar 1955 mit verschiedenen Datumsformaten: FormatDarstellung %W0%D1.%M1.%Y2 %W0%D2/%M2/%Y1 %W0%D1-%M3-%Y2 %W0%M3, %D1, %Y2 %W2, den %D1. %M4 %Y2 3.1.1955 03/01/55 3-Jan-1955 Jan, 3, 1955 Montag, den 3. Januar 1955 6.2. Uhrzeitformat Ein Uhrzeitformat ist ein String, der aus einer Aneinanderreihung von Platzhaltern für die Komponenten Stunden, Minuten und Sekunden besteht. Vor, zwischen und © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 40 hinter den Platzhaltern kann ein beliebiger Text stehen, der Bestandteil der fertig formatierten Uhrzeit wird. Jeder Platzhalter beginnt mit einem Prozentzeichen. Dann folgt ein Buchstabe, der den Platzhaltertyp bestimmt. Es sind folgende Platzhalter definiert, die ein Uhrzeitformat enthalten kann: %Hx %hx %Ux %Sx Stunden (24-Stunden-Anzeige) Stunden (12-Stunden-Anzeige) Minuten Sekunden Dahinter folgt eine Variantenbezeichnung x. Die Variantenbezeichnung ist eine einstellige Ziffer und bedeutet je nach Platzhalter: %H0 %H1 %H2 Keine Stundenanzeige Stunden als möglichst kurze Zahl ohne führende Null einblenden Stunden zweistellig, ggf. mit einer führenden Null einblenden Entsprechendes gilt für die 12-Stunden-Anzeige (%hx). %U0 %U1 %U2 Keine Einblendung der Minuten Minuten als möglichst kurze Zahl ohne führende Null einblenden Minuten zweistellig, ggf. mit einer führenden Null einblenden %S0 %S1 %S2 Keine Einblendung der Sekunden Sekunden als möglichst kurze Zahl ohne führende Null einblenden Sekunden zweistellig, ggf. mit einer führenden Null einblenden Die Reihenfolge der Platzhalter ist zwar im Prinzip beliebig, jedoch wird in der Praxis nur die gewohnte Reihenfolge (Stunden, Minuten, Sekunden) auftreten. Zwischen den Platzhaltern dürfen beliebige Zeichen oder Textfolgen stehen. Folgende Beispiele zeigen die Darstellung der Uhrzeit 13:03:22 mit verschiedenen Zeitformaten: Format Darstellung %H1:%U2%S0 %H1:%U2:%S2 %H1 Uhr %U2%S0 13:03 13:03:22 13 Uhr 03 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 41 6.3. Ganzzahlformat Anders als die Datums- und Zeitformate - aber ähnlich dem Gleitkommaformat bestehen Ganzzahlformate lediglich aus einer Reihe aneinandergereihter Steueranweisungen. Vor, zwischen und hinter den Steueranweisungen darf kein anderer Text stehen. Alle Steueranweisungen beginnen mit einem Prozentzeichen. Dahinter folgt ein Buchstabe, der den Typ der Anweisung bestimmt. Folgende Steueranweisungen sind möglich: %Wx %Tx %Bx %Ex %+ Definition der Stellenzahl Definition des Tausendertrenners Definition eines Präfix-Strings, der vor der Zahl eingeblendet wird Definition eines Postfix-Strings, der hinter der Zahl eingeblendet wird Anweisung, daß auch bei positiven Zahlen ein Vorzeichen erscheint Je nach Typ der Anweisung folgt hinter dem Kennbuchstaben noch weitere Information. Die Anweisung %Wx bestimmt die Anzahl Stellen, die die ganze Zahl haben soll. Die Stellenzahl folgt dem %W als einstellige Ziffer. Wenn die zu formatierende Zahl weniger Stellen hat, als gewünscht, werden führende Nullen erzeugt. Die Anweisung %Tx bestimmt den Tausendertrenner, mit dem Tausendergruppen voneinander getrennt werden sollen. Die Angabe x kann aus einem oder mehreren Zeichen bestehen. Im Normalfall wird in Deutschland nur ein Zeichen verwendet, nämlich der Punkt. Wenn kein Tausendertrenner erwünscht ist, so wird für x einfach nichts angegeben, sondern direkt mit der nächsten Steueranweisung fortgefahren. Die Anweisung %BX (begin) und %Ex (end) definieren Zeichenfolgen x, die bis zum nächsten Prozentzeichen reichen. Diese Zeichenfolgen werden als Präfix bzw. Postfix vor bzw. hinter die formatierte Zahl gekettet. Wenn kein Präfix oder Postfix erwünscht ist, wird für x einfach nichts angegeben und direkt mit der nächsten Steueranweisung fortgefahren. Die Anweisung %+ bewirkt, dass positive Zahlen mit einem Plus-Zeichen dargestellt werden. Negative Zahlen werden ohnehin mit einem Minus-Zeichen versehen. © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 42 Folgende Beispiele zeigen die Darstellung der Zahl 1234 mit verschiedenen Ganzzahlformaten: Format Darstellung %T. %T %BDM %T. %EZaster %+%W9%T,%EMio DM 1.234 1234 DM 1.234 Zaster +000,001,234 Mio DM 6.4. Gleitkommazahlformat Anders als die Datums- und Zeitformate - aber ähnlich dem Ganzzahlformat bestehen Gleitkommazahlformate lediglich aus einer Reihe aneinandergereihter Steueranweisungen. Vor, zwischen und hinter den Steueranweisungen darf kein anderer Text stehen. Alle Steueranweisungen beginnen mit einem Prozentzeichen. Dahinter folgt ein Buchstabe, der den Typ der Anweisung bestimmt. Folgende Steueranweisungen sind möglich: %Fx %Tx %Dx %Bx %Ex %+ Definition der Nachkommastellenzahl Definition des Tausendertrenners Definition des Dezimalkommas Definition eines Präfix-Strings, der vor der Zahl eingeblendet wird Definition eines Postfix-Strings, der hinter der Zahl eingeblendet wird Anweisung, dass bei positiven Zahlen ein Vorzeichen erscheint Die Anweisung %Fx bestimmt die Anzahl der Nachkommastellen, mit der die Zahl ausgegeben werden soll. Die Anzahl Nachkommastellen x wird als ein- oder zweistellige Zahl angegeben. Die Anweisung %Tx bestimmt den Tausendertrenner, mit dem Tausendergruppen voneinander getrennt werden sollen. Die Angabe x kann aus einem oder mehreren Zeichen bestehen. Im Normalfall wird in Deutschland nur ein Zeichen verwendet, nämlich der Punkt. Wenn kein Tausendertrenner erwünscht ist, so wird für x einfach nichts angegeben, sondern direkt mit der nächsten Steueranweisung fortgefahren. Die Anweisung %Dx bestimmt das Dezimalkomma. x besteht genau aus einem Zeichen, welches das Dezimalkomma repräsentiert. Im Normalfall wird in © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de [e] forms & more XML-Format für Formulare Seite 43 Deutschland das Komma verwendet. Wenn diese Angabe fehlt, wird ein Komma als Voreinstellung benutzt. Die Anweisung %Bx (begin) und %Ex (end) definieren Zeichenfolgen x, die bis zum nächsten Prozentzeichen reichen. Diese Zeichenfolgen werden als Präfix bzw. Postfix vor bzw. hinter die formatierte Zahl gekettet. Wenn kein Präfix oder Postfix erwünscht ist, wird für x einfach nichts angegeben und direkt mit der nächsten Steueranweisung fortgefahren. Die Anweisung %+ bewirkt, dass positive Zahlen mit einem Plus-Zeichen dargestellt werden. Negative Zahlen werden ohnehin mit einem Minus-Zeichen versehen. Folgende Beispiele zeigen die Darstellung der Zahl 12345,67 mit verschiedenen Gleitkommazahlformaten: Format Darstellung %T. %T.%F5 %BDM %T%F0 12.345,67 12.345,67000 DM 12346 © Copyright 1994-2012 by Waimea Software GmbH www.waimea.de