Syntax:
INT LlSetOptionString (HLLJOB hJob, INT nMode, LPCTSTR pszValue);
Aufgabe:
Setzt diverse Einstellungen in List & Label.
Parameter:
hJob: List & Label-Job-Handle
nMode: Folgende Werte sind als Funktionsindex möglich:
LL_OPTIONSTR_CARD_PRJEXT
Die Dateinamenerweiterung ("Extension") eines Karteikartenprojekts. Voreinstellung: "crd".
LL_OPTIONSTR_CARD_PRVEXT
Die Dateinamenerweiterung ("Extension") der Bitmap eines Karteikartenprojekts, die im Datei-Lade-Dialog angezeigt wird. Voreinstellung: "crv".
LL_OPTIONSTR_CARD_PRNEXT
Die Dateinamenerweiterung ("Extension") der Druckereinstellungen eines Karteikartenprojekts. Voreinstellung: "crp".
LL_OPTIONSTR_CURRENCY
Die Zeichenkette, die als Währungssymbol ("€", "$", ...) zur Formatierung von Währungen bei der FStr$()-Funktion verwendet wird.
Wird automatisch auf die Benutzer-Einstellungen eingestellt bzw. auf die entsprechend lokalisierte Zeichenkette, wenn LL_OPTION_LCID eingestellt wird.
LL_OPTIONSTR_DECIMAL
Die Zeichenkette, die als Dezimalzeichen bei der FStr$()-Funktion verwendet wird.
Wird automatisch auf die Benutzer-Einstellungen eingestellt bzw. auf die entsprechend lokalisierte Zeichenkette, wenn LL_OPTION_LCID eingestellt wird.
Setzt das voreingestellte Designschema für neue Diagramme unabhängig vom eingestellten Projektdesignschema. Durch das Setzen auf eine leere Zeichenkette würde weiterhin das aktuelle Projektdesignschema verwendet werden. Voreinstellung: "combit2" (combit Pastell)
Die folgenden Werte können dabei verwendet werden: siehe LL_OPTIONSTR_DEFAULTSCHEME.
LL_OPTIONSTR_DEFAULTSCHEME
Setzt das voreingestellte Designschema für das Projekt. Beachten Sie dazu auch die Option LL_OPTION_FORCESAVEDESIGNSCHEME. Voreinstellung: leer (bzw. Wert "combit").
Die folgenden Werte können dabei verwendet werden:
Wert |
Bedeutung |
Antarctica |
Antarktis |
Artichoke |
Artischocke |
Blue |
Blau |
CityCruiser |
City Cruiser |
Classic |
Klassisch |
combit |
combit |
combit2 |
combit Pastell |
combit3 |
combit Pastell 2 |
combitBlue |
combit Blau |
combitColorWheel |
combit Farbkreis |
combitGreen |
combit Grün |
DeciduousTree |
Laubbaum |
DiscoPop |
Disco Pop |
Forester |
Waldmeister |
GrayScale |
Graustufen |
Green |
Grün |
Hibernation |
Winterschlaf |
HotAirBalloon |
Heißluftballon |
InTheJungle |
Im Dschungel |
IntoTheGreen |
Ab ins Grüne |
Oceanographer |
Meeresforscher |
OldTimes |
Alte Zeiten |
Poolside |
Swimmingpool |
Red |
Rot |
Remix |
Remix |
RetroForever |
Retro Forever |
SandyDesert |
Sandwüste |
SummerDay |
Sommertag |
Summermist |
Sommerdunst |
UnderWater |
Unter Wasser |
USERDEFINED |
Benutzerdefiniert |
LL_OPTIONSTR_DEFDEFFONT
Diese Option beschreibt die Schriftart, die als Voreinstellung für die Projekt-Schriftart verwendet wird.
Die Zeichenkette muss das Format haben:
"{(R,G,B),H, L}"
R = Rotanteil der Farbe, G =
Grünanteil der Farbe, B = Blauanteil der Farbe, H = Höhe der Schriftart in
Punkten, L = kommaseparierte Felder der LOGFONT-Struktur (siehe SDK)
Diese Schriftart kann auch über LL_OPTION_DEFDEFFONT gesetzt oder abgefragt werden.
LL_OPTIONSTR_EMBEDDED_EXPORTS
Über diese Option können Sie in einem Mehrpassverfahren verschiedene Exportformate in die Vorschau einbetten, so dass diese auch aus dem Viewer heraus verfügbar sind. Übergeben Sie eine semikolonseparierte Liste der gewünschten Formate, z. B. "DOCX;XLS". Beachten Sie, dass Ihre Anwendung den Drilldown-Event unterstützen muss, damit diese Funktion verfügbar ist. Die Datenbindung der .NET-Komponente bringt diese Unterstützung automatisch mit.
LL_OPTIONSTR_EXPORTS_ALLOWED
Über diese Funktion können Sie die möglichen Ausgabemedien beschränken, die der Benutzer bei LlPrintOptionsDialog() oder LlPrintOptionsDialogTitle() angezeigt bekommt. Im Designer stehen nur die hier erlaubten Exportformate unter Projekt > Seitenlayout > Ausgabemedien zur Verfügung.
Übergeben Sie hier auch eine semikolonseparierte Liste mit Kürzeln der Ausgabemedien, siehe LL_OPTIONSTR_EXPORTS_AVAILABLE
LL_OPTIONSTR_EXPORTS_ALLOWED_IN_PREVIEW
Über diese Funktion können Sie die möglichen Ausgabemedien beschränken, die der Benutzer im Vorschaufenster angezeigt bekommt. Übergeben Sie hier auch eine semikolonseparierte Liste mit Kürzeln der Ausgabemedien, siehe LL_OPTIONSTR_EXPORTS_AVAILABLE.
LL_OPTIONSTR_EXPORTS_AVAILABLE
Über diese Funktion können Sie die möglichen Ausgabemedien abfragen (read only).
Der Rückgabewert ist eine semikolon-separierte Zeichenkette, die aus den Kürzeln aller verfügbaren Ausgabemedien besteht, z. B. "PRN;PRV;FILE;HTML;RTF" (die vollständige Liste der verfügbaren Ausgabemedien finden Sie in Kapitel Die Exportmodule).
Die weiteren Einträge hängen von der über LlSetOptionString( LL_OPTIONSTR_LLXPATHLIST) gefundenen Liste von Exportmodulen ab.
Beispiel:
LlPrintStart(hJob,...,
LL_PRINT_EXPORT,...);
// allow only printer and preview (EXPORT sets
all bits)
LlSetOption(hJob, LL_OPTIONSTR_EXPORTS_ALLOWED,
"PRN;PRV");
// Default should be preview!
LlPrintSetOptionString(hJob,
LL_PRNOPTSTR_EXPORT, "PRV");
// printer dialog allows user to
change
LlPrintOptionsDialog(hJob,....);
// get the final
medium:
LlPrintGetOptionString(hJob,
LL_PRNOPTSTR_EXPORT,sMedium,sizeof(sMedium));
// ...print
job....
// finished
LlPrintEnd(hJob,0);
if (strcmp(sMedium, "PRV")
== 0) ...
LL_OPTIONSTR_EXPORTFILELIST
Diese Option kann nur gelesen und nicht gesetzt werden.
Über diese Funktion können Sie nach dem Druck abfragen, in welche Dateien ausgegeben wurde. Die Dateinamen sind Semikolon-separiert.
Insbesondere bei den Exportmodulen gilt: reservieren Sie genug Platz, oder vergrößern Sie den Puffer solange, bis Sie von LlGetOptionString() keine Fehlermeldung mehr bekommen (LL_ERR_BUFFERTOOSMALL).
Die Liste ist erst nach LlPrintEnd() verfügbar.
LL_OPTIONSTR_HELPFILENAME
Über diese Funktion können Sie den Namen der Hilfedatei vorgeben, wenn Sie z. B. Ihre eigene Hilfedatei angezeigt bekommen möchten.
LL_OPTIONSTR_FAX_RECIPNAME,
LL_OPTIONSTR_FAX_RECIPNUMBER,
LL_OPTIONSTR_FAX_SENDERNAME,
LL_OPTIONSTR_FAX_SENDERCOMPANY , LL_OPTIONSTR_FAX_SENDERDEPT,
LL_OPTIONSTR_FAX_SENDERBILLINGCODE
Mit diesen Optionen können voreingestellten Werte für die Einstellungen im Faxdialog (Projekt > Fax-Variablen) gesetzt werden. Wenn der Benutzer im Designer andere Formeln für die Einstellungen wählt bzw. im Projekt andere Einstellungen gespeichert wurden, so haben diese Vorrang. Wenn das Projekt auf das Fax-Exportmodul ausgedruckt wird, werden die hier bzw. im Projekt gewählten Einstellungen ausgewertet und das Projekt direkt als Fax verschickt. Alternativ bieten viele Faxprogramme die Möglichkeit, die Faxnummer in besonderer Formatierung zu übergeben. Details hierzu müssen Sie bei Ihrem Faxtreiber-Hersteller erfragen.
Wenn die Optionen nicht gesetzt werden und der Benutzer im Projekt keine Einstellungen gewählt hat, steht das Fax-Exportmodul nicht zur Verfügung.
LL_OPTIONSTR_LABEL_PRJDESCR, LL_OPTIONSTR_CARD_PRJDESCR, LL_OPTIONSTR_LIST_PRJDESCR, LL_OPTIONSTR_TOC_PRJDESCR, LL_OPTIONSTR_IDX_PRJDESCR, LL_OPTIONSTR_GTC_PRJDESCR
Mit diesen Parametern können Sie die Beschreibung des entsprechenden Projekttypen bestimmen. Diese Beschreibung erscheint in der Dateityp-Combobox der Laden- und Speichern-Dialoge. Es wird empfohlen, die entsprechenden _SINGULAR Optionen ebenfalls zu setzen.
LL_OPTIONSTR_LABEL_PRJDESCR_SINGULAR, LL_OPTIONSTR_CARD_PRJDESCR_SINGULAR, LL_OPTIONSTR_LIST_PRJDESCR_SINGULAR, LL_OPTIONSTR_TOC_PRJDESCR_SINGULAR, LL_OPTIONSTR_IDX_PRJDESCR_SINGULAR, LL_OPTIONSTR_GTC_PRJDESCR_SINGULAR
Mit diesen Parametern können Sie die Beschreibung des entsprechenden Projekttypen im Singular bestimmen. Diese Beschreibung erscheint in der Dateityp-Combobox der Laden- und Speichern-Dialoge. Diese Optionen werden im Repository-Modus verwendet und ggf. zukünftig auch an weiteren Stellen.
LL_OPTIONSTR_LABEL_PRJEXT
Die Dateinamenerweiterung ("Extension") eines Etikettenprojekts. Voreinstellung: "lbl".
LL_OPTIONSTR_LABEL_PRNEXT
Die Dateinamenerweiterung ("Extension") der Druckereinstellungen eines Etikettenprojekts. Voreinstellung: "lbp".
LL_OPTIONSTR_LABEL_PRVEXT
Die Dateinamenerweiterung ("Extension") der Bitmap eines Etikettenprojekts, die im Datei-Lade-Dialog angezeigt wird. Voreinstellung: "lbv".
LL_OPTIONSTR_LICENSINGINFO
Mit dieser Option wird der persönliche Lizenzschlüssel übergeben, der auch den Lizenzumfang bestimmt.
Wichtig: Vor der Redistribution müssen Sie unbedingt sicherstellen, über LL_OPTIONSTR_LICENSINGINFO Ihren persönlichen Lizenzschlüssel in allen Instanzen des "ListLabel"-Objektes zu setzen, um Fehlermeldungen bei Ihren Kunden zu vermeiden. Die VCL-, OCX- und .NET-Komponenten bieten eine Eigenschaft "LicensingInfo" zu diesem Zweck.
Die benötigten Informationen finden Sie in der Datei "PersonalLicense.txt" im Hauptverzeichnis Ihrer List & Label-Installation. Wenn mehrere Entwickler an einem Projekt arbeiten, kann jeder der Lizenzschlüssel verwendet werden.
Hinweis: In der Trial-Version ist das Setzen des Lizenzschlüssels nicht notwendig bzw. es kann ein Leerstring übergeben werden.
LL_OPTIONSTR_LIST_PRJEXT
Die Dateinamenerweiterung ("Extension") eines Listenprojekts. Voreinstellung: "lst".
LL_OPTIONSTR_LIST_PRNEXT
Die Dateinamenerweiterung ("Extension") der Druckereinstellungen eines Listenprojekts. Voreinstellung: "lsp".
LL_OPTIONSTR_LIST_PRVEXT
Die Dateinamenerweiterung ("Extension") der Bitmap eines Listenprojekts, die im Datei-Lade-Dialog angezeigt wird. Voreinstellung: "lsv".
LL_OPTIONSTR_LLFILEDESCR
Hierüber wird die Beschreibung für die List & Label-Vorschaudateien übergeben, die in der Dateityp-Combobox des Speichern-Dialogs in der Vorschau angezeigt wird.
LL_OPTIONSTR_LLXPATHLIST
Diese Option bestimmt die zu ladenden externen LLX-Module. Übergeben Sie hier eine semikolonseparierte Liste mit den Pfadnamen der Exportmodule, die Sie in Ihrer Applikation eingebunden haben möchten.
Als Voreinstellung, also beim Öffnen eines Jobs bzw. bei jedem Aufruf dieser Option, werden folgende Erweiterungen automatisch geladen:
CMLL30PW.LLX, CMLL30HT.LLX, CMLL30EX.LLX, CMLL30OC.LLX
sowie in der Professional-/Enterprise-Edition zusätzlich
CMLL30BC.LLX
Als Pfad dieser Dateien wird der Pfad der List & Label-DLL verwendet.
Sie können Wildcards als Dateimasken verwenden, um mehrere Module auf einmal zu laden.
Um eine Erweiterung zu unterdrücken, geben Sie den Dateinamen mit einem vorangestellten Dach-Symbol an, also "^CMLL30PW.LLX". Um alle voreingestellten Erweiterungen zu unterdrücken, geben Sie "^*" als ersten 'LLX-Namen' an, beispielsweise um einen anderen Pfad zu verwenden.
Bei der Abfrage über LlGetOptionString() wird eine semikolonseparierte Liste der geladenen Module zurückgegeben.
Bei eingeschaltetem Debug-Modus gibt List & Label aus, welche Module auf Grund welcher Regeln geladen oder entladen werden.
Mit dieser Option kann der Pfad und Dateiname (standardmäßig "%APPDATA%\COMBIT.LOG") von über LLSetDebug() (Parameter LL_DEBUG_CMBTLL_LOGTOFILE) aktivierten Debug-Ausgaben in eine Logdatei bestimmt werden.
Bitte beachten Sie dabei, dass Debwin auf dem betreffenden System, auf dem Sie das Logging durchführen möchten, nicht aktiv ist, da dieses den Pfad wieder überschreibt. I. d. R. verwenden Sie diese Option für ein Logging im Hintergrund.
LL_OPTIONSTR_MAILTO
Hier kann eine Adresse übergeben werden, die als voreingestellter Empfänger bei dem Senden aus der Vorschau in die E-Mail eingetragen wird. Mehrere Adressen können semikolonsepariert übergeben werden.
LL_OPTIONSTR_MAILTO_BCC
Hier kann eine Adresse übergeben werden, die als voreingestellter Empfänger bei dem Senden aus der Vorschau in die E-Mail als BCC (Blind Carbon Copy) eingetragen wird. Mehrere Adressen können semikolonsepariert übergeben werden.
LL_OPTIONSTR_MAILTO_CC
Hier kann eine Adresse übergeben werden, die als voreingestellter Empfänger bei dem Senden aus der Vorschau in die E-Mail als CC (Carbon Copy) eingetragen wird. Mehrere Adressen können semikolonsepariert übergeben werden.
LL_OPTIONSTR_MAILTO_SUBJECT
Hier kann ein Text übergeben werden, der bei dem Senden aus der Vorschau in die E-Mail als Betreff eingetragen wird.
LL_OPTIONSTR_NULLVALUE
Hier kann ein Text übergeben werden, der im Druck als Darstellung eines NULL-Wertes ausgegeben wird. Voreistellung: Leer ("").
Wird benötigt, um Dateien mit Relativpfad korrekt in der Designer-Vorschau anzeigen zu können. Weitere Informationen im Kapitel Direkter Druck und Export aus dem Designer.
LL_OPTIONSTR_PREVIEWFILENAME
Über diese Option kann der Name vorgegeben werden, der für die Erstellung von Preview-Dateien verwendet wird. Per Voreinstellung werden die Dateien im Verzeichnis des Projektes bzw. in einem alternativen Verzeichnis (s. LlPreviewSetTempPath()) mit dem Namen <Projektname>.LL angelegt. Mit dieser Option kann ein anderer Dateiname gewählt werden, der dann <Projektname> ersetzt.
LL_OPTIONSTR_PRINTERALIASLIST
Über diese Option kann eine Übersetzungstabelle für Drucker übergeben werden.
Um die Tabelle zu löschen, übergibt man NULL oder einen Leerstring.
Danach übergibt man für jeden Quelldrucker eine Übersetzungstabelle mit altem und einem oder mehreren neuen Druckern. Entweder geschieht das durch mehrere Aufrufe dieser Funktion hintereinander, oder man trennt die verschiedenen Tabellen mit '\n'.
Die Form einer Tabelle selbst ist:
"alter Drucker=neuer Drucker1[;neuer Drucker2[;...]]"
also beispielsweise
"\\server\eti=\\server\eti1;\\server_eti2"
"\\server\a4fast=\\server\standard"
Wenn nun der Drucker \\server\eti nicht benutzt werden kann, wird die Alias-Liste (in der definierten Reihenfolge) durchlaufen, bis einer der Drucker benutzt werden kann (oder die Liste zu Ende ist). Dabei bleibt das gewählte Seitenformat erhalten. Die Groß-/Kleinschreibung ist nicht signifikant.
LL_OPTIONSTR_PROJECTPASSWORD
Erlaubt es, Projekte zu verschlüsseln, um sie vor Verwendung in anderen Applikationen zu schützen. Das hier übergebene Passwort dient als Schlüssel, daher sollten Sie ein möglichst langes Passwort mit einer Vielzahl verschiedener Zeichen wählen, um die Verschlüsselung sicherer zu machen.
Im Designer ist es auch, beispielsweise zu Support-Zwecken, möglich, das Projekt unverschlüsselt zu speichern. Halten Sie hierzu die "SHIFT"-Taste gedrückt und speichern Sie das Projekt. Es erscheint ein Passwort-Dialog, in dem Sie das Passwort eingeben müssen.
Die Qualität der Verschlüsselung ist von der Passwort-Länge abhängig. Die Maximallänge ist 5 Zeichen, das entspricht 40 Bit Verschlüsselung, vorausgesetzt, dass die ASCII-Werte der Zeichen frei zwischen 1 und 255 verteilt sind. Das Passwort ist nicht (!) absolut sicher, da es per API übergeben wird. Die Hürde für den Projekt-Diebstahl ist aber sicherlich recht hoch.
Hierüber kann der Titel des Berichtsparameterdialogs gesetzt werden, der beim Export angezeigt wird.
LL_OPTIONSTR_SAVEAS_PATH
Der hierüber übergebene Parameter wird als voreingestellter Pfad für den "Speichern Als"-Vorgang im Preview benutzt. Der Pfad beinhaltet Verzeichnis und Dateiname.
LL_OPTIONSTR_SHORTDATEFORMAT
Die Zeichenkette, die zur automatischen Umwandlung eines Datums in eine Zeichenkette verwendet wird bei:
Date$(<Datum>, "%x")
automatischer Typkonvertierung (LlExprEval(), Concat$())
Format und Voreinstellung: Siehe Windows-API GetLocaleInfo(LOCALE_USER_DEFAULT, LOCALE_SSHORTDATE,...)
LL_OPTIONSTR_THOUSAND
Die Zeichenkette, die als Tausenderzeichen bei der fstr$()-Funktion verwendet wird.
Wird automatisch auf die Benutzer-Einstellungen eingestellt bzw. auf die entsprechend lokalisierte Zeichenkette, wenn LL_OPTION_LCID eingestellt wird.
LL_OPTIONSTR_TIMEZONE_CLIENT
Hiermit wird die Zeitzone bestimmt, die für alle Konvertierungen von Datums- und Zeitwerten bei Druck, Export und den Designer-Funktionen verwendet werden soll.
Das ist insbesondere für verteilte Anwendungen wie bspw. Server-/Client-Anwendungen oder auch Web-Anwendungen wichtig, bei denen sich Datenquellen, Anwendung und Clients auf unterschiedlichen Systemen in unterschiedlichen Zeitzonen befinden können. Die Werte für die möglichen Zeitzonen können in der Windows-Registrierung unter HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ermittelt werden und entsprechen dem Schlüsselnamen (siehe nachfolgendes Beispiel):
LlSetOptionString(hJob, LL_OPTIONSTR_TIMEZONE_CLIENT, L"W. Europe Standard Time");
LL_OPTIONSTR_TIMEZONE_DATABASE
Hiermit wird die Zeitzone bestimmt, die für alle Konvertierungen von Datums- und Zeitwerten von der Datenbank (LlDefineVariable..., LlDefineField... etc.) in die Zeitzone des Clients (siehe auch LL_OPTIONSTR_TIMEZONE_CLIENT) verwendet werden soll.
Das ist insbesondere für verteilte Anwendungen wie bspw. Server-/Client-Anwendungen oder auch Web-Anwendungen wichtig, bei denen sich Datenquellen, Anwendung und Clients auf unterschiedlichen Systemen in unterschiedlichen Zeitzonen befinden können. Die Werte für die möglichen Zeitzonen können in der Windows-Registrierung unter HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones ermittelt werden und entsprechen dem Schlüsselnamen (siehe nachfolgendes Beispiel):
LlSetOptionString(hJob, LL_OPTIONSTR_TIMEZONE_DATABASE, L"W. Europe Standard Time");
LL_OPTIONSTR_VARALIAS
Diese Option ermöglicht es, die in einem Projekt verwendeten Variablen- und Feldnamen zu lokalisieren, indem für den Namen ein Alias angegeben wird. Im Designer wird immer nur der Alias angezeigt, während im Projektfile immer nur der tatsächliche Name gespeichert wird. So kann durch Austausch des Alias' eine lokalisierte Version der Variablen- und Feldliste erreicht werden. Die Option muss für jede zu lokalisierende Variable einmal in der Form "<lokal>=<global>" gesetzt werden, also z. B.
LlSetOptionString(hJob,
LL_OPTIONSTR_VARALIAS,
"Vorname=FirstName");
LlDefineVariable(hJob, "FirstName", "John");
um eine Variable "FirstName" anzumelden, die im Designer als "Vorname" angezeigt wird.
Um alle angemeldeten Alias-Namen wieder zu löschen, rufen Sie einfach
LlSetOptionString(hJob, LL_OPTIONSTR_VARALIAS, "");
Auf.
Die .NET-, OCX- und VCL-Komponenten bieten eine eigene Dictionary-API an, mit der Ihnen das Setzen der Option komfortabel abgenommen wird. Details finden Sie in der Online-Hilfe der Komponenten.
pszValue: neuer Wert
Rückgabewert:
Fehlercode
Beispiel:
HLLJOB hJob;
hJob =
LlJobOpen(0);
LlSetOptionString(hJob,
LL_OPTIONSTR_LIST_PRJEXT, "list");
//
....
LlJobClose(hJob);
Siehe auch:
LlGetOptionString