Anwendungsfälle
Die Referenzseiten beschreiben jede Dokumentfunktion einzeln. Die Anwendungsfälle zeigen, wie die Bausteine zusammenspielen: Jedes Beispiel führt von der Datenquelle bis zur Stelle im Dokument und enthält alle Konfigurationen vollständig und kopierfähig.
Beispiele
| Anwendungsfall | Datenquelle | Bausteine |
|---|---|---|
| Brief mit Empfänger aus einer Adressdatenquelle | Benutzer, Adressdatenquelle | Forms (Object, DataProvider), Fields, Feld binden |
| Geschäftsnummer aus der Fachanwendung in der Kopfzeile | Drittsystem über Connect | Data, Fields, Platzhalterzuordnung, Platzhalterdefinition, Globale Übersetzungen |
| Teilnehmerliste als Tabelle | Benutzer | Forms (ObjectCollection), Fields (WordTableRows), Feld binden |
Aufbau eines Beispiels
Jedes Beispiel folgt demselben Aufbau: Ausgangslage und Ergebnis, die beteiligten Bausteine mit Link zur Referenz, der Datenfluss, die Konfiguration Schritt für Schritt mit dem Grund für jeden nicht offensichtlichen Schritt, das Testen ohne Produktivsystem, Varianten und Stolpersteine.
Die Beispiele verwenden neutrale Bezeichnungen: Systeme nach ihrer Rolle («Fachanwendung», «Adressdatenquelle»), Ids auf Englisch, Beschriftungen direkt im Label. So laufen die Konfigurationen ohne Vorarbeit und lassen sich in eine eigene Datasource übernehmen. Für mehrsprachige Vorlagen translate-Label mit globalen Übersetzungen verwenden; nur das Beispiel mit der Geschäftsnummer setzt eine solche Übersetzung voraus, weil seine Beschriftung der Dokumentsprache folgen soll.
Datentypen im Überblick
Woher ein Typ kommt, was er im Code liefert und wie er ins Word-Dokument gelangt. Herkunft: Forms, Data, Fields, Profil, Snippets, Globale Übersetzungen. Einfügen: Feld binden, Platzhalter im Layout.
| Typ | Herkunft | Wert in JavaScript | Einfügen in Word |
|---|---|---|---|
Text | Forms, Data, Fields, Profil | String | Nur-Text-Inhaltssteuerelement («Feld binden») oder Text-Platzhalter im Layout |
Choice | Forms | gewählter Options-Value als String; Beschriftung über $.getChoiceLabel(…) | über ein Text-Field |
Date | Forms, Fields | Datumsobjekt; .Value für $.formatDate(…), $.getDateAsText(…) für den formatierten Text | Datums-Inhaltssteuerelement oder Text-Platzhalter im Layout |
YesNo | Forms, Fields | Boolean | nicht direkt; steuert Logik in Fields, in PowerPoint die Sichtbarkeit über Tags |
FormattedText | Data, Fields, Globale Übersetzungen, Snippets | FormattedText | RichText-Inhaltssteuerelement |
WordContent | Data, Fields, Snippets | WordContent | RichText-Inhaltssteuerelement, eigene Absätze |
InlineWordContent | Fields | InlineWordContent, genau ein Absatz | RichText-Inhaltssteuerelement innerhalb eines Absatzes |
WordTableRows | Fields | WordTableRows | die Inhaltszeile einer Tabelle, kopiert für jeden Eintrag |
Picture | Fields, Profil (z. B. Profile.Org.Logo) | Bild | Bild-Inhaltssteuerelement oder Picture-Platzhalter im Layout |
Object | Forms, Data, Fields | JavaScript-Objekt mit den Schema-Ids als Eigenschaften; null, wenn kein Eintrag angelegt wurde | nicht direkt; über ein Field ausgeben |
ObjectCollection | Forms, Data, Fields | Array solcher Objekte; leer ist [] | nicht direkt; über ein Field ausgeben, z. B. WordTableRows |
Details: Rückgabewert von Field-Typen, Objects und ObjectCollections im Code, Field-Typ pro Office-Anwendung.