NTPExportReport (PDF)

 

NTPExportReport ( <ReportHandle>, <PageNr>, <ExportFormat>, <OutputFile>, <StretchSize>, <PaperOptions>, <PDFOptions>, <DocSummary>, <PaperFormat>, <Security> ) -> <ErrorCode>

 

 

Beschreibung

 

Mit diesem Befehl wird der PDF Exportfilter aufgerufen. Es handelt sich dabei um einen Befehl, der durch NotesToPaper zur Verfügung gestellt wird, d .h. nach der Einbindung von NotesToPaper in die Anwendung steht dieser Befehl automatisch zur Verfügung. Über NTPExportReport wird die Export-Schnittstelle von NotesToPaper angesprochen und es können alle installierten Exportfilter benutzt werden. Die Aufgabe der einzelnen Parameter unterscheidet sich je nach verwendetem Exportfilter (vergleichen Sie dazu auch die Definition des Befehls in der NotesToPaper Online-Hilfe).

 

Bei der Verwendung von NotesToPaper PDF können einzelne Seiten oder der gesamte Report exportiert werden. Darüber hinaus lassen sich Einstellungen wie z. B. Auflösung, Ausrichtung, Skalierung oder PDF Optionen vornehmen. Die einzelnen Parameter werden weiter unten aufgelistet und erklärt.

 

Voraussetzung für den Export eines Reports ist, dass der Report für die Vorschau erstellt wurde (siehe NTPProcessReport...in der NotesToPaper Online-Hilfe) und die Option NTPOPTION_KEEPREPORT mit dem Befehl NTPSetOption aktiviert wurde.

 

Hinweis: Alle Befehle und eine Beschreibung finden Sie in der NotesToPaper Online-Hilfe im Kapitel "Funktionen".

 

Durch die Option NTPOPTION_KEEPREPORT wird verhindert, dass der Report nach der Erstellung (und Anzeige) nicht sofort gelöscht wird. Dieses ist wichtig, da der Exportfilter auf die bestehende Report-Datei (Vorschau-Datei) zugreift und mit dieser den PDF Export erstellt.

 

Hinweis: NotesToPaper unterscheidet zwei Formen des Report-Exports: Über NTPExportReport werden Reports nach ihrer Erstellung als Vorschau Datei in ein anderes Dateiformat konvertiert. Diese Umwandlung muss über die Programmierung durchgeführt werden. Hingegen erzeugen die Exportfilter, die direkt im Druckerdialog gewählt werden können, den Report direkt in dem gewünschten Format und gehen nicht über die Vorschau Datei. Diese Exportfilter stehen daher ohne weiteren Programmieraufwand zur Verfügung.

 

 

Deklaration für Lotus Script

 

Declare Function NTPExportReport Lib "NTP.DLL" ( ByVal ReportHandle As Long, ByVal PageNr As Long, ByVal ExportFormat As Long, ByVal OutputFile As String, ByVal StretchSize As Long, ByVal PaperOptions As Long, ByVal PDFOptions As Long, ByVal DocSummary As String, ByVal PaperFormat As String, ByVal Security As String ) As Long

 

 

Parameter

 

<ReportHandle> (LONG)

Report-Handle, das bei Aufruf von NTPInit  bzw . NTPInitFromDatabase zurückgeliefert wurde.

 

<PageNr> (LONG)

Seitennummer des Reports, die exportiert werden soll. Wird hier 0 angegeben, so werden alle Seiten exportiert.

 

<ExportFormat> (LONG)

Grafik-Format für den Export. Bei NotesToPaper PDF muss hier 6 ( = PDF Format für NotesToPaper) übergeben werden

 

<OutputFile> (STRING)

Dateinamen für den Grafik-Export. Dieser Dateiname kann z. B. von der Funktion NTPCreateTempFile erstellt werden und muss die Extension .PDF enthalten. Der Dateiname sollte inkl. Pfadangabe sein.

 

Hinweis: Bei den nachfolgenden Parametern werden Konstanten benutzt. Diese Konstanten stehen für die entsprechenden Text- oder Zahlenwerte. Sie finden die Definition dieser Konstanten im Anhang dieser Dokumentation. Sie sollten diese Konstanten in Ihre Script-Programmierung übernehmen oder Sie müssen diese durch die entsprechenden Werte bei der Parameterübergabe ersetzen.

 

<StretchSize> (LONG)

Über diesen Parameter wird bestimmt, ob die Größe einer Seite in der Report Datei an die Größe einer Seite in der PDF Datei angepasst wird oder ob der Report ohne Skalierung exportiert werden soll. Wird keine Skalierung angegeben, so sollte die Papiergröße des Reports mit der Papiergröße des PDF übereinstimmen.

 

Hinweis: Diese Einstellung hat nur in Verbindung mit einem „benutzerdefinierten Papierformat" eine Bedeutung.

 

NTPEXPORT_PDF_DRAWMODE_NORMAL

= Original-Größe

NTPEXPORT_PDF_DRAWMODE_FIT

= In Seite einpassen

 

<PaperOptions> (LONG)

Mit diesem Parameter können eine Reihe von Optionen für die Seitendarstellung der PDF Datei gesetzt werden. Die Werte dieses Parameters werden als Bit-Mask behandelt, d .h. sie müssen oder-verknüpft (addiert) werden.

 

Papierausrichtung

Mit den folgenden Werten können Sie die Ausrichtung des Papiers im PDF Format festlegen.

Hinweis: Diese Einstellung hat nur in Verbindung mit einem „benutzerdefinierten Papierformat" eine Bedeutung.

 

NTPEXPORT_PDF_PORTRAIT

Hochformat (Portrait)

NTPEXPORT_PDF_LANDSCAPE

Querformat (Landscape)

 

Ansichtsmodus

Mit den Optionen "page mode"  können Sie festlegen, wie eine PDF Datei im entsprechenden Anzeigeprogramm geöffnet wird (sofern diese Einstellung vom Anzeigeprogramm berücksichtigt wird).

 

NTPEXPORT_PDF_PAGEMODE_FULLSCREEN

PDF Datei wird im Vollbilschirmmodus geöffnet

NTPEXPORT_PDF_PAGEMODE_THUMBNAILS

PDF Datei wird mit geöffneten Piktogrammen (Thumbnails) angezeigt

NTPEXPORT_PDF_PAGEMODE_OUTLINE

PDF Datei wird mit geöffnetem Lesezeichen (Outlines) angezeigt

                         

Vergrößerungsmodus

Über die Option "zoom mode" können Sie die Darstellung der Seite im Anzeigeprogramm wählen, wenn die PDF Datei geöffnet wird.

 

NTPEXPORT_PDF_ZOOMMODE_FITHORIZONTAL

die Seite wird auf horizontal maximale Größe eingepasst

NTPEXPORT_PDF_ZOOMMODE_FITVERTICAL

die Seite wird auf vertikal maximale Größe eingepasst

NTPEXPORT_PDF_ZOOMMODE_FITPAGE

die Seite wird so eingepasst, dass die ganze Seite sichtbar ist

         

<PDFOptions> (LONG)

Mit diesem Parameter können eine Reihe von Optionen für die PDF Datei gesetzt werden. Die Werte dieses Parameters werden als Bit-Mask behandelt, d .h. sie müssen oder-verknüpft (addiert) werden.

 

Fonts

Über diese Option können Sie einstellen, ob TrueType Schriftarten in die PDF Datei eingebunden werden sollen oder nicht. Beachten Sie, wenn Sie die Schriftarten nicht einbinden, dass dann möglicherweise die PDF Dateien falsch angezeigt werden, wenn die Schriftart auf einem System nicht verfügbar ist. Auf der anderen Seite müssen Sie beachten, dass die Schriftarteinbindung die Größe der PDF Datei erheblich beeinflusst.

 

NTPEXPORT_PDF_FONT_USE_TRUETYPE

TrueType Schriften benutzen aber nicht die Daten der Schriftart einbinden

NTPEXPORT_PDF_FONT_EMBED_TRUETYPE

Daten aller TrueType Schriftarten einbinden die benutzt werden

NTPEXPORT_PDF_FONT_EMBED_TRUETYPE_SYMBOL

Nur die Symbol TrueType Schriftarten (WingDings etc.) einbinden

NTPEXPORT_PDF_FONT_USE_14BASE_TYPE1

Keine TrueType Schriftarten benutzen. Ist dieser Modus aktiviert, dann können nur die Schriftarten Arial, Courier New und Times New Roman benutzt werden.

 

Wenn die Daten der Schriftarten eingebunden werden sollen, dann gibt es die Möglichkeit nicht die kompletten Schriftarten (wie oben beschrieben) einzubinden, sondern nur die benutzen Teile innerhalb der Schriftart.

 

NTPEXPORT_PDF_FONT_EMBED_TRUETYPE_CSET

Bindet die Daten der benutzen TrueType Schriftarten ein und zwar alle, die entsprechend der aktuellen Codepage gebraucht werden. Beachten Sie, dass die Einbindung entsprechend der Codepage gemacht wird, auf dem die PDF Datei erstellt wird.

NTPEXPORT_PDF_FONT_EMBED_TRUETYPE_USED

Bindet die Daten der benutzen TrueType Schriftarten ein und nur die Zeichen, die auch in der PDF Datei benutzt werden.

 

Das CID-Format ist ein PostScript-Format, das von Adobe speziell für umfangreiche Zeichensätze, wie z. B. chinesische, japanische oder koreanische, entwickelt wurde. Das CID-Format ermöglicht die Erstellung von PDF-Dateien mit eingebetteten Schriftzeichen. CID steht für "Character Identifier", was sich auf die "Character Identifier Numbers" bezieht, die zum Indizieren und Auffinden der einzelnen Zeichen im Font benutzt werden. Ein CID-Font besteht aus einer großen Datei mit den Outline-Beschreibungen der Zeichen und einer kleinen "CMap" Datei, die die Zeichenliste, Kodierung und "Character Identifier" beinhaltet.

 

NTPEXPORT_PDF_FONT_CIDMODE_UNICODE

Aktiviert die Erstellung von CID-Fonts bzw. die Nutzung von CMaps für den Aufbau der PDF-Datei.

 

Dateigröße (Grafik und Inhalts—Komprimierung)        

Mit der nachfolgenden Einstellung wird der Inhalt der PDF Datei komprimiert ("deflate" Methode). Durch Aktivierung der Komprimierung wird der Inhalt als binäre und nicht als ASCII Information abgelegt.

 

NTPEXPORT_PDF_COMPRESSION

Aktivierung der Komprimierung des PDF Inhalts

 

Die Optionen zur JPEG Komprimierung sind nur für TrueColor Bilder geeignet.

 

NTPEXPORT_PDF_JPEGLEVEL_LOWEST

beste Komprimierung, schlechteste Bildqualität

NTPEXPORT_PDF_JPEGLEVEL_LOW

...

NTPEXPORT_PDF_JPEGLEVEL_MEDIUM

...

NTPEXPORT_PDF_JPEGLEVEL_HIGH

...

NTPEXPORT_PDF_JPEGLEVEL_HIGHEST

schlechteste Komprimierung, beste Bildqualität

 

Sonstiges

 

NTPEXPORT_PDF_LAUNCH_APPLICATION

Startet, nach der Erstellung der Datei, den im Betriebssystem gesetzten Viewer für PDF Dateien.

NTPEXPORT_PDF_CONVERT_HYPERLINK

Wandelt Text, der einen Hyerlink beschreibt, in einen echten Link um. Wichtig: Dieses funktioniert nur in Hyperlinks die nicht innerhalb eines Textes stehen, sondern als einzelne Textobjekte vorhanden sind.

NTPEXPORT_PDF_CREATE_THUMBNAILS

Erstellt Piktogramme für jede Seite in der PDF Datei.Wichtig: Diese Einstellung sollte nur benutzt werden, wenn die PDF Datei für alte Versionen des Acrobat Reader (vor 5) erstellt wird. Ab der Version 5 erstellt der Acrobat Reader diese Piktogramme selbst und sie sind von besserer Qualität.

                 

<DocSummary> (STRING)

Über diesen Parameter lassen sich Eigenschaften der Dokumentenzusammenfassung der PDFs einstellen. Diese Dokumentenzusammenfassung lässt sich z. B. beim Arcobat Reader über die Dokumenten-Eigenschaften abrufen.

Die Werte werden in einem String, der die verschiedenen Werte  getrennt durch Semikolon (;) enthält, in der folgenden Reihenfolge angegeben:

- Titel

- Thema

- Autor

- Stichwörter

- Erstellt mit

 

<PaperFormat> (STRING)

Über diesen Parameter können Sie ein individuelles Papierformat festlegen. Die Werte werden in einem String, der die verschiedenen Werte  getrennt durch Semikolon (;) enthält, angegeben.

 

Hinweis: Sie sollten diesen Parameter nur benutzen, wenn Sie ein von dem Report abweichendes Papierformat in der PDF Datei benutzen. Wenn Sie bei diesem Parameter keine Einstellung machen, dann wird das Papierformat automatisch erkannt.

 

Bsp. "1;5000;4000;600;600"

 

Der erste Wert in dem String legt das Papierformat fest. Es sind folgende Werte erlaubt:

1 = Letter 8 ½ x 11 in

5 = Legal 8 ½ x 14 in

8 = A3 297x420 mm

9 = A4 210x297 mm

256 = benutzerdefinierte Größe

 

Hinweis: Wird der Wert 256 angegeben, so muss über die nachfolgenden Werte die Papiergröße bestimmt werden.

 

Hinweis: Wird die Papiergröße individuell angegeben, so wird der erste Wert (Papierformat) automatisch auf 256 (benutzerdefinierte Größe) gesetzt und die ursprüngliche Angabe wird ignoriert.

 

Die Werte zwei und drei legen die Breite und die Höhe des Papiers fest. Die Werte werden in Zehntel-Millimeter (mm/10) angegeben.

 

Die Werte vier und fünf legen den horizontalen und den vertikalen Rand fest. Die Werte werden in Zehntel-Millimeter (mm/10) angegeben. Der Vorgabewert für die Ränder ist 60 (6 mm).

 

<Security> (STRING)

Über diesen Parameter werden die Kennwörter (Benutzer- und Hauptkennwort), die Sicherheit-Flags (Drucken, Ändern, Kopieren, Ausfüllen) für den Zugriff auf die PDF Datei und die Art der Verschlüsselung (40 oder 128bit) gesetzt. Die Werte werden in einem String, der die verschiedenen Werte  getrennt durch Semikolon (;) enthält, angegeben. Die Werte werden in der Reihenfolge

 

- Hauptkennwort,

- Benutzerkennwort,

- Drucken erlaubt,

- Änderungen erlaubt,

- Kopieren erlaubt,

- Anmerkungen und Formularfelder erlaubt,

- Verschlüsselungsebene

 

angegeben.

 

Die ersten beiden Parameter legen die Kennwörter fest, während die Parameter drei bis sechs die Flags für die Sicherheitseinstellungen bestimmen. Über den Parameter sieben wird die Verschlüsselungsebene gesetzt.

 

Als Standard-Einstellung sind alle Flags gesetzt ("1"), d .h. alle Operationen mit dem PDF sind erlaubt. Wollen Sie einzelne Operationen nicht erlauben, so müssen Sie den entsprechenden Parameter auf "0" setzen. Die Verschlüsselungsebene ist als Standard auf 128bit gesetzt ("1").

 

Hinweis: Für weitere Informationen zu den Kennwörtern und den Sicherheitseinstellungen lesen Sie bitte das Dokument "PDF Sicherheitseinstellungen"

 

Beispiel: "Owner ; User; 1; 0; 1; 0; 1"

Durch diesen Parameter-String wird das Hauptkennwort auf "Owner" und das Benutzerkennwort auf "User" gesetzt. Weiterhin ist der Druck und das Kopieren mit der PDF Datei erlaubt. Die Operationen "Änderungen" und "Formularfelder" sind hingegen nicht erlaubt. Die gesamte Datei wird mit 128bit verschlüsselt.

 

 

Rückgabe

 

<ErrorCode> (LONG)

Nummer des aufgetretenen Fehlers (0 = kein Fehler). Eine Auflistung aller Fehlernummern finden Sie im Dokument "Fehlernummern".