Änderungen von Dokument Print-Service-Plugin


Von Version 16.1
bearbeitet von awa
am 14.06.2022, 13:44
Änderungskommentar: Add changelog
Auf Version 16.4
bearbeitet von awa
am 14.06.2022, 14:23
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -207,9 +207,11 @@
207 207  
208 208  Um das Plugin zu nutzen, klicken Sie im Workflow auf neue Aktion und wählen das Print-Plugin aus. Die folgenden Optionen werden zum Konfigurieren der Plugin-Aktion verwendet:
209 209  
210 -; **Druck-Modus**
211 -: Formular mit textueller Ausgabe von Werten: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
212 -Formular mit Eingabefeldern: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
210 +; Druck-Modus
211 +:; Formularfelder in Text umwandeln
212 +:: Eingabefelder werden in Text umgewandelt und das Formular wird in der Breite entsprechend angepasst, siehe nächster Abschnitt.
213 +:; Formularfelder bewahren
214 +:: Das Formular wird so in dem PDF ausgegeben wie es auch im Browser aussieht.
213 213  
214 214  ; Papiergröße
215 215  : Angabe des Formats für das gedruckte Dokument.
... ... @@ -261,9 +261,32 @@
261 261  
262 262  == CSS-Anpassungen für Druckbild ==
263 263  
266 +Allgemeine CSS-Anpassungen für den Druck können über eine entsprechende Media-Query umgesetzt werden:
267 +
268 +{{code language="css"}}
269 +@media print {
270 + /* general CSS for printing */
271 +}
272 +{{/code}}
273 +
274 +Hier ist zu beachten, dass dieses CSS auch angwandt wird, wenn das Formular etwa direkt über den Browser gedruck wird.
275 +
276 +Weiterhin gibt es speziell für den Print-Service noch folgende spezielle CSS-Klassen, welche immer an das //form.xm-form//-Element angefügt werden (erfordert mindestens Print-Plugin Version 4.2.0 und Print-Server-Plugin 1.4.0).
277 +
278 +; xm-print
279 +: Wird immer angefügt.
280 +; xm-print--mode-plain
281 +: Wird angefügt, wenn als Druckmodus //Formularfelder bewahren// ausgewählt ist.
282 +; xm-print--mode-dynamic
283 +: Wird angefügt, wenn als Druckmodus //Formularfelder in Text umwandeln// ausgewählt ist.
284 +; xm-print--style-filled
285 +: Wird angefügt, wenn die Option //Blankodruck// deaktiviert ist.
286 +; xm-print--style-blank
287 +: Wird angefügt, wenn die Option //Blankodruck// aktiviert ist.
288 +
264 264  === Textfelder und Auswahllisten ===
265 265  
266 -Zur Optimierung des PDF-Dokuments für den Druck werden Formularelemente vom Typ [[Eingabefeld>>Formcycle.Designer.Form.FormElements.Input]], [[Textarea>>Formcycle.Designer.Form.FormElements.Textarea]] und [[Auswahl>>Formcycle.Designer.Form.FormElements.Selection]] (Drop-Down) in reine Textfelder umgewandelt, falls als **Druckmodus Formular mit textueller Ausgabe von Werten** eingestellt ist. Zudem werden diese mit der CSS-Klasse //print// und //XSpan// versehen, welches für Anpassungen des Aussehens verwendet werden kann. Um etwas die Schriftgröße zu ändern, kann folgendes CSS verwendet werden:
291 +Zur Optimierung des PDF-Dokuments für den Druck werden Formularelemente vom Typ [[Eingabefeld>>Formcycle.Designer.Form.FormElements.Input]], [[Textarea>>Formcycle.Designer.Form.FormElements.Textarea]] und [[Auswahl>>Formcycle.Designer.Form.FormElements.Selection]] (Drop-Down) in reine Textfelder umgewandelt, falls als Druckmodus //Formularfelder in Text umwandeln// eingestellt ist. Zudem werden diese mit der CSS-Klasse //print// und //XSpan// versehen, welches für Anpassungen des Aussehens verwendet werden kann. Um etwas die Schriftgröße zu ändern, kann folgendes CSS verwendet werden:
267 267  
268 268  {{code language="css"}}
269 269  .print.XSpan {
... ... @@ -349,6 +349,41 @@
349 349  
350 350  In Schriftarten vom Typ //TrueType// und //OpenType// können Informationen über die Einbettbarkeit der Schriftart direkt mitgespeichert werden. Je nachdem, was dort konfiguriert ist, kann eine Schriftart gegebenenfalls nicht eingebettet werden und wird vom //Print-Service-Plugin// stattdessen nur als Vektorgrafik in die erstellten PDF-Dokumente gerendert.
351 351  
377 +== JavaScript-Anpassungen für Druckbild
378 +
379 +Manchmal kann es erforderlich sein, vor dem Druck noch JavaScript auszuführen. Hierzu kann die Funktion //$.xutil.onPrint// verwendet werden, welche folgende Signatur hat
380 +
381 +{{code language="text"}}
382 +function onPrint(callback: () => Promise<void> | void): void
383 +{{/code}}
384 +
385 +Mit dieser Funktion können ein oder mehrere Callbacks registriert werden, welche vor dem Druck ausgeführt werden. Wenn ein Callback ein //Promise// zurückliefert, wird mit dem Druck gewartet, bis das Promise erfüllt ist. Falls das Promise abgewiesen wird, wird der Fehler gelogged, der Print aber nicht abgebrochen. Zu beachten ist weiterhin, dass die Registrierung der Callbacks vor dem Druck erfolgen muss, also beispielsweise innerhalb eines JQuery-Document-Ready-Handlers (//$(callback)//).
386 +
387 +Falls beispielsweise ein AJAX-Request fertig ausgeführt werden soll, bevor mit dem Druck begonnen wird:
388 +
389 +{{js}}
390 + $.xutil.onPrint(async () => {
391 + const response = await fetch("http://some-url.de");
392 + // do something with response
393 + });
394 +{{/js}}
395 +
396 +{{jsIE}}
397 + $.xutil.onPrint(function() {
398 + return new Promise(function(resolve, reject) {
399 + $.ajax("http://some-url.de", {
400 + success: function(data, textStatus, jqXHR) {
401 + // Do something with the response data
402 + resolve(undefined);
403 + },
404 + error: function(jqXHR, textStatus, errorThrown) {
405 + reject("HTTP request error: " + textStatus + " - " + errorThrown);
406 + },
407 + });
408 + });
409 + });
410 +{{/jsIE}}
411 +
352 352  == Versionshistorie
353 353  
354 354  === 4.2.0