NTPSetOption ( <ReportHandle>, <OptionID>, <OptionValue> ) -> <ErrorCode>

 

 

Beschreibung

 

Mit diesem Befehl können verschiedene Optionen für die Erstellung bzw. Ausführung des Reports gesetzt werden. Das Setzen einer Option mit diesem Befehl bezieht sich immer auf den in <ReportHandle> angegebenen Report.

 

 

Deklaration für Lotus Script

 

Declare Function NTPSetOption Lib "NTP.DLL"( ByVal ReportHandle As Long, ByVal OptionID As Long,

ByVal OptionValue As Long ) As Long

 

 

Parameter

 

<ReportHandle> (LONG)

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

 

<OptionID> (LONG)

Die möglichen Einstellungen die verändert werden können.

 

NTPOPTION_KEEPREPORT

NTPOPTION_SHOWPREVIEWWINDOW

NTPOPTION_MANUALPRINTERCOPIES

NTPOPTION_DEFAULTMAILCLIENT

NTPOPTION_MAXRTFVERSION

NTPOPTION_SHOWMESSAGES

NTPOPTION_REALTIMEFUNCTIONS

NTPOPTION_USEDEFAULTDESTINATION

NTPOPTION_CHECKVARNAMES

NTPOPTION_PRINTOFFSETX

NTPOPTION_PRINTOFFSETY

NTPOPTION_DELAYTABLEHEADER

NTPOPTION_RTF_REPLACEFIELDS

NTPOPTION_RTF_REPLACEVARIABLES

NTPOPTION_PRINTERDIALOG_DESTINATION

NTPOPTION_PRINTERDIALOG_COPIES

NTPOPTION_PRINTERDIALOG_PAGE

NTPOPTION_PRINTERDIALOG_FIRSTPAGE

NTPOPTION_PRINTERDIALOG_LASTPAGE

NTPOPTION_PRINTERDIALOG_LABELOFFSET

NTPOPTION_PRINTERDIALOG_LABELPRINTERCOPY

NTPOPTION_PRINTJOB_PAGESPERJOB

NTPOPTION_PREVWIN_....

NTPOPTION_RESET_PROJECT_STATE

NTPOPTION_AUTO_PRINT_PREVIEW

NTPOPTION_INCLUDE_FONT_DESCENDERS

NTPOPTION_USENULLVALUE

 

 

<OptionValue> (LONG)

Die neue Einstellung der NotesToPaper Option.

 

NTPOPTION_KEEPREPORT

 

0 =        Die erstellte Preview-Datei wird nach der Anzeige automatisch gelöscht. Default!

 

1 =        Die erstellte Preview-Report-Datei wird nicht nach der Anzeige automatisch gelöscht. Diese Einstellung ist vorzunehmen, wenn z. B. der erstellte Report        in ein Notes-Dokument aufgenommen werden soll oder über NTPExportReport exportiert werden soll. Das Script muss die Datei selbständig löschen.        Der Dateiname der erstellten Preview-Datei kann über die Funktion NTPGetReportFileName ermittelt werden.

 

NTPOPTION_SHOWPREVIEWWINDOW

 

0 =        Es wird kein Preview-Fenster angezeigt. Diese Funktion ist notwendig, wenn eine Preview-Datei erstellt werden soll (z. B. zur Aufnahme in einem Notes-        Dokument) und keine direkte Ausgabe zum Drucker erfolgen soll und ausserdem kein Preview-Fenster gewünscht ist (z. B. Script läuft auf Server).

1 =        Es wird das Preview-Fenster angezeigt. Default!

 

NTPOPTION_MANUALPRINTERCOPIES

 

0 =        Die Anzahl der zu druckenden Kopien wird vom Drucker unterstützt und soll nicht durch NotesToPaper "manuell" vorgenommen werden. Default!

 

1 =        Der gewählte Drucker unterstützt keine automatischen Mehrfachkopien. Die Anzahl der Kopien wird daher durch NotesToPaper "manuell" realisiert.

 

 

Hinweis: Wird, bei einem Drucker der Mehrfachkopien unterstützt, die "manuelle" Unterstützung von Mehrfachkopien aktiviert, so stimmt die gedruckte Anzahl der Kopien nicht mit der Eingabe überein!

 

 

NTPOPTION_DEFAULTMAILCLIENT

 

0 =        Es wird der unter Windows eingerichtete Default-Mail-Client zur Versendung von Reports benutzt. (Default)

 

1 =        Es wird der bei NotesToPaper integrierte Mail-Dialog für Lotus Notes zur Versendung von Reports benutzt.

 

 

NTPOPTION_MAXRTFVERSION

 

Mit dieser Option legen Sie die Version des zu benutzenden Microsoft RichText Controls fest. Dieses Control bestimmt die Ausgabe von RichText-Inhalten in Reports.

 

Als Wert können bei dieser Option die folgenden Konstanten benutzt werden:

 

CONST NTPRTFVERSION1

 

CONST NTPRTFVERSION2

 

CONST NTPRTFVERSION3

 

 

NTPOPTION_SHOWMESSAGES

 

Diese Option erlaubt es, alle Nachrichten, die z. B. auf Grund eines Fehlers erscheinen können, zu deaktivieren. Dieses ist besonders wichtig, wenn NotesToPaper auf einem Server läuft, da dieser in der Regel nicht die Möglichkeit zur Bildschirmanzeige hat.

 

0 =        Es werden keine Nachrichten ausgegeben.

 

1 =        Es werden alle notwendigen Nachrichten ausgegeben.

 

NTPOPTION_REALTIMEFUNCTIONS

 

Wird in einem Report die aktuelle Uhrzeit oder das aktuelle Datum ausgegeben, so werden diese Angaben am Anfang des Reports ermittelt und dann im gesamten Report benutzt. Manchmal ist es allerdings notwendig diese Werte zu bestimmen, wenn Sie benötigt werden. Mit dieser Option können Sie die "real time" Berechnung von Uhrzeit und Datum aktivieren

 

0 =        keine "real time" Berechnung (Default)

 

1 =        "real time" Berechnung von Uhrzeit und Datum

 

 

NTPOPTION_USEDEFAULTDESTINATION

 

Über NotesToPaper Setup kann im Report-Layout ein Default-Ausgabeformat (Vorschau, Drucker, Datei, RTF, XML, ...) eingestellt werden. Ob dieses Ausgabeformat auch als Standard im Druckerauswahl-Dialog eingestellt wird, können Sie über diese Option bestimmen.

 

0 =        Es wird nicht das Ausgabeformat des Layouts voreingestellt (Default)

 

1 =        Es wird das Ausgabeformat des Layouts als Vorgabe im Druckerdialog aktiviert.

 

 

NTPOPTION_CHECKVARNAMES

 

Mit dieser Option kann die Generierung des Reports beschleunigt werden. Normalerweise überprüft NotesToPaper alle übergebenen Variablen bei NTPProcessReportExt. Sie können diese Überprüfung abschalten und somit die Verarbeitungsgeschwindigkeit erhöhen.

 

0 =        Variablen/Felder werden nicht überprüft

 

1 =        Variablen/Felder werden überprüft (Default)

 

 

NTPOPTION_PRINTOFFSETX und NTPOPTION_PRINTOFFSETY

 

Mit diesen Optionen kann der Ausdruck eines Reports in X- und Y-Richtung verschoben werden. Durch Angabe der Werte wird der Report bei einem Ausdruck relativ zu seiner Position im Layout (zur linken oberen Ecke des Papiers) verschoben. Als "Default" ist keine Verschiebung eingestellt.

 

NTPOPTION_DELAYTABLEHEADER

Mit dieser Option kann die Verwendung von Feldern in einem Tabellenkopf aktiviert werden. Normalerweise wird eine Kopfzeile in einer Tabelle vor dem ersten Datensatz gedruckt. Zu diesem Zeitpunkt sind allerdings noch keine Felder mit Daten gefüllt. Wird jetzt ein Feld in einer Kopfzeile ausgegeben, so enthält es keine gültigen Daten. Wird diese Option aktiviert, so wird der Tabellenkopf erst gedruckt, wenn der erste Datensatz der Tabelle "geladen" ist und somit werden in der Kopfzeile auch gültige Feldwert angezeigt.

 

0 =        Kopfzeile vor erstem Datensatz drucken.

 

1 =        Kopfzeile erst dann drucken, wenn erster Datensatz geladen ist.

 

Hinweis: Diese Option hat keine Auswirkung für Reporte mit Multi-Tabellen-Layout.

 

 

NTPOPTION_RTF_REPLACEFIELDS und NTPOPTION_RTF_REPLACEVARIABLES

Mit diesen beiden Optionen kann die Ersetzung von Platzhaltern in RichText Inhalten durch NotesToPaper Felder oder Variablen aktiviert werden. Eine Beschreibung der Funktionalität finden Sie in dem Dokument "Platzhalter" im Anhang unter dem Abschnitt "Rich Text Felder"

 

0 =        Keine Ersetzung von Platzhaltern in RichText Feldern

 

1 =        Ersetzung von Platzhaltern in RichText Feldern aktiviert

 

 

NTPOPTION_PRINTERDIALOG_DESTINATION

 

Auswahl des Zieles für die Druckausgabe.

Mögliche Werte sind:

 

 NTPOPTION_PRINTDESTINATION_PRN

         Ausgabe auf den Drucker

 

 NTPOPTION_PRINTDESTINATION_PRV

               Ausgabe auf den Bildschirm (Vorschau)

 

 NTPOPTION_PRINTDESTINATION_FILE

               Ausgabe in eine Druck-Datei

 

 NTPOPTION_PRINTDESTINATION_HTML

         Ausgabe (Export) im HTML Format

 

 NTPOPTION_PRINTDESTINATION_RTF

         Ausgabe (Export) im RTF Format

 

 NTPOPTION_PRINTDESTINATION_PICTURE_JPEG

         Ausgabe (Export) im JPEG Grafikformat

 

 NTPOPTION_PRINTDESTINATION_PICTURE_EMF

         Ausgabe (Export) im EMF Grafikformat

 

 NTPOPTION_PRINTDESTINATION_PICTURE_BMP

               Ausgabe (Export) im BMP Grafikformat

 

 NTPOPTION_PRINTDESTINATION_PICTURE_PNG

               Ausgabe (Export) im BMP Grafikformat

 

 NTPOPTION_PRINTDESTINATION_MHTML

         Ausgabe (Export) im MHTML Format

 

 NTPOPTION_PRINTDESTINATION_XML

         Ausgabe (Export) im XML Format

 

 NTPOPTION_PRINTDESTINATION_PDF

         Ausgabe (Export) im PDF Format

 

 NTPOPTION_PRINTDESTINATION_XLS

         Ausgabe (Export) im XLS Format

 

 NTPOPTION_PRINTDESTINATION_TXT

         Ausgabe (Export) im TXT Format

 

 NTPOPTION_PRINTDESTINATION_PICTURE_TIFF

         Ausgabe (Export) im TIFF Grafikformat

 

 NTPOPTION_PRINTDESTINATION_PICTURE_MTIFF

         Ausgabe (Export) im Multipage TIFF Grafikformat

 

 NTPOPTION_PRINTDESTINATION_XPS

         Ausgabe (Export) im XPS Format

 

 NTPOPTION_PRINTDESTINATION_XHTML

         Ausgabe (Export) im XHTML Format

 

 

NTPOPTION_PRINTERDIALOG_COPIES

Anzahl der Kopien des Reports

 

 

NTPOPTION_PRINTERDIALOG_PAGE

Nummer der ersten Seite in dem Report

 

 

NTPOPTION_PRINTERDIALOG_FIRSTPAGE

Erste Seite die gedruckt werden soll

 

 

NTPOPTION_PRINTERDIALOG_LASTPAGE

Letzte Seite die gedruckt werden soll

 

 

NTPOPTION_PRINTERDIALOG_LABELOFFSET

Offset Positionen für den Etiketten-Druck, d .h. die Anzahl der Etiketten, die übersprungen werden sollen. Wo der Druck startet, richtet sich nach der Auswahl der Druckreihenfolge, welche in dem Report festgelegt ist.

 

 

NTPOPTION_PRINTERDIALOG_LABELPRINTERCOPY

Normalerweise wird die Erstellung von Kopien beim Etikettendruck durch NotesToPaper übernommen, d .h. NotesToPaper dupliziert entsprechend der gewünschten Anzahl die Etiketten. Damit ist bereits in der Druckvorschau die Anzahl der Etiketten sichtbar. Bei manchen speziellen Etikettendrucker führt dies allerdings zu einer langsamen Ausführung des Drucks. Bei diesen Druckern ist es besser, wenn die Kopien durch den Drucker selbst übernommen werden. Mit dieser Option kann NotesToPaper veranlasst werden, das die Erstellung der Kopien dem Drucker überlassen wird und dadurch der Etikettendruck schneller wird. Nachteil ist allerdings, das in der Vorschau nicht die Gesamtanzahl der Etiketten zu sehen ist, das dies erst durch den Drucker bestimmt wird.

 

0 =        Kopien für Etiketten werden durch NotesToPaper erstellt.

 

1 =        Die Kopien für Etiketten werden dem Drucker überlassen

 

 

NTPOPTION_PRINTJOB_PAGESPERJOB

Mit dieser Option kann bestimmt werden, wieviele Seiten pro Auftrag im Druckspooler erstellt werden. Normalerweise werden alle Seiten des Reports in einen einzigen Druckauftrag gestellt. Da aber erst der Druckauftrag beginnt, wenn alle Seiten vorhanden sind, ist es manchmal sinnvoll kleinere Druckaufträge zu definieren, damit der Druck frühzeitig beginnen kann.

 

 

NTPOPTION_PREVWIN_....

Über die Optionen NTPOPTION_PREVWIN_... können verschiedene Einstellungen für das Vorschau-Fenster vorgenommen werden. Eine detailierte Übersicht finden Sie unter "NTPSetOption (Report-Vorschau)"

 

 

NTPOPTION_HTMLEXP_..., NTPOPTION_RTFEXP_..., NTPOPTION_GRAPHICEXP_..., NTPOPTION_XMLEXP_..., NTPOPTION_MHTMLEXP_..., NTPOPTION_PDFEXP_..., NTPOPTION_XLSEXP_..., NTPOPTION_TXTEXP_...

 

Über diese Optionen können verschiedene Parameter für den Export eines Reports in ein anderes Format angegeben werden. Die Einstellungen für jeden dieser Export-Filter finden Sie in den folgenden Dokumenten:

 

•HTML Export (NTPOPTION_HTMLEXP_...)

•RTF Export (NTPOPTION_RTFEXP_...)

•Grafik-Export (NTPOPTION_GRAPHICEXP_...)

•XML Export (NTPOPTION_XMLEXP_...)

•MHTML Export (NTPOPTION_MHTMLEXP_...)

•PDF - Export (NTPOPTION_PDFEXP_...)

•XLS - Export (NTPOPTION_XLSEXP_...)

•TXT - Export (NTPOPTION_TXTEXP_...)

 

 

NTPOPTION_RESET_PROJECT_STATE

Mit dieser Option kann ein Reset des gesamten Projekts nach jedem Datensatz erreicht werden. Wird diese Option aktiviert, dann wir nach jedem Datensatz (NTPEndDocument) das gesamte Layout auf den Ausgangszustand zurückgesetzt, so als ob gerade die erste Seite gedruckt wird. Diese Option wird besonders bei der Generierung von Serienbriefen benutzt. Ein Beispiel für die Anwendung dieser Option finden Sie in der Beispiel-Datenbank "NTPSL.NSF"

 

0 =        Kein Reset des Projekts nach jedem Datensatz

 

1 =        Nach jedem Datensatz wird das Projekt in den Ausgangszustand versetzt (Reset)

 

 

NTPOPTION_AUTO_PRINT_PREVIEW

Über diese Option kann gesteuert werden, ob ein für die Vorschau erstellter Report direkt auf den Drucker geschickt werden soll oder nicht. Diese Option ist nur notwendig, wenn eine Verkettung von Reports mit "NTPProcessAndAppend" durchgeführt wird. In dem Fall der Report-Verkettung müssen alle Reports für die Vorschau erstellt werden. Möchte man am Ende der Verkettung, also bei Ausführung des "Master"-Reports, nicht die Reports am Bildschirm anzeigen, sondern direkt drucken, so kann diese Option verwendet werden. Ist die Option aktiv, wird bei Ausführung des "Master"-Reports die Ausführung direkt auf den Drucker geschickt und nicht, obwohl als Parameter bei NTPProcessReportExt gesetzt, am Bildschirm angezeigt.

 

0 =        kein direkter Druck bei verketteten Reports

 

1 =        Verkettete Reports werden bei Ausführung des "Master"-Reports direkt gedruckt

 

 

NTPOPTION_INCLUDE_FONT_DESCENDERS

Die Berechnung der Zeilenhöhe zur Textausgabe wird in Abhängigkeit der eingestellten Schriftart und -größe mit einer festen Formel berechnet. Es gibt allerdings einige Zeichensätze, die mit extremen Unterlängen bei den Buchstaben arbeiten. Bei diesen Schriftarten kann es daher vorkommen, das die Unterlängen abgeschnitten werden. Um auch bei diesen Schriftarten eine korrekte Ausgabe zu erreichen, kann die Formel zur Berechnung der Zeilenhöhe umgestellt werden, so das die Unterlängen der jeweiligen Schriftart mit in die Berechnung einfliessen. Um diese Berechnung zu aktivieren, müssen Sie diese Option setzen.

 

Hinweis: Verwenden Sie diese Option nur, wenn Sie Problem mit den Unterlängen der Schriftarten haben. Die Aktivierung dieser Option führt generell zu einer etwas größern Zeilenhöhe und würde bei bestehenden Reports möglicherweise zu einer Verschiebung von Textinhalten bzw. den Zeilenabständen führen.

 

0 =        Die Formel zur Berechnung der Zeilenhöhe berücksichtigt nicht die Unterlängen der Schriftarten

1 =        Die Formel zieht die exakten Unterlängen der Schriftarten zur Berechnung der Zeilenhöhe hinzu

 

NTPOPTION_USENULLVALUE

Wenn ein Feld deklariert wurde, aber aus dem Skript heraus mit keinen Inhalten gefüllt wurde, wird es als Null-Wert behandelt. Mit dieser Einstellung lässt sich festlegen, wie NotesToPaper mit solchen Werten umgeht.

 

 

 

 

 

 

 

 

 

Rückgabe

 

<ErrorCode> (LONG)

Nummer des aufgetretenen Fehlers (0 = kein Fehler)