Syntax:

INT LlSetOptionString (HLLJOB hJob, INT nMode, LPCTSTR pszValue);

Task:

Sets string options in List & Label.

Parameter:

hJob: List & Label job handle

nMode: Mode index, see below

pszValue: New value

Return Value:

Error code

Hints:

Most of the options need to be set before LlDefineLayout() and before the functions LlPrint...Start(), preferably directly after LlJobOpen()/LlJobOpenLCID(). If an option needs to be set at a different time, this will be stated in that option's description.

The file extension for a file card project. Default "crd".

The file extension for the bitmap of a file card project that will be shown in the File Open dialog. Default "crv".

The file extension for the printer definition file of a file card project. Default "crp".

This represents the string that is used as currency symbol in the fstr$() function.

The default is the value of the user settings in the system, but will be set to the respective locale value on LL_OPTION_LCID.

This represents the string that is used as decimal char in the fstr$() function.

The default is the value of the user settings in the system, but will be set to the respective locale value on LL_OPTION_LCID.

Sets the default design scheme for new charts independent of the set project design scheme. Setting it to an empty string would still use the current project design scheme. Default: "combit2" (combit Pastel)

Sets the default design scheme for the project. See also the LL_OPTION_FORCESAVEDESIGNSCHEME option. Default: empty (or value "combit").

The following values can be used:

Sets the font to be used as default for the project font.

The parameter must have the following format:

"{(R,G,B),H,L}"
R = Red intensity, G = Green intensity, B = Blue intensity
H = Height in points, L = Comma-separated fields of the LOGFONT structure (See SDK)

This DEFDEFFONT can be set using LL_OPTION_DEFDEFFONT as handle.

With this option you can embed different export formats in the preview in a multi-pass procedure so that they are also available in the viewer. Pass a semicolon-separated list of the desired formats, e.g. "DOCX;XLS". Note that your application must support the drilldown event for this feature to be available. The data binding of the .NET component provides this support automatically.

This property can be used to restrict the output list presented to the user in the LlPrintOptionsDialog[Title]() dialog. Also, only the allowed export formats can be configured in the designer.

Pass a semicolon-separated list of allowed export IDs, see LL_OPTIONSTR_­EXPORTS_­AVAILABLE

Example:

LlPrintStart(hJob,...,LL_PRINT_EXPORT,...);

// allow only printer and preview (EXPORT sets all bits)
LlSetOptionString(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:
LlPrintGetOption(hJob, LL_PRNOPTSTR_EXPORT, sMedium, sizeof(sMedium));
// ...print job....
// finished
LlPrintEnd(hJob,0);

if (strcmp(sMedium,"PRV") == 0) ...

This property can be used to restrict the list of possible output formats in the preview dialog.

Pass a semicolon-separated list of allowed export IDs, see LL_OPTIONSTR_­EXPORTS_­AVAILABLE

This is a read-only property.

This function returns a semicolon-separated list of all output media (usually "PRN;PRV;FILE" and the list of the export modules, if any are loaded by LL_OPTIONSTR_LLXPATHLIST), for example "PRN;PRV;FILE;HTML;RTF"

The following IDs are predefined if the corresponding modules are installed:

The following formats are not supported anymore and are only available for compatibility reasons. If you still want to use the format you have to enable it explicitly via LlSetOptionString(hJob, LL_OPTIONSTR_LEGACY_EXPORTERS_ALLOWED,...) or via LL.Core.LlSetOptionString(...).

This is a read-only property.

After LlPrintEnd(), you can use this function to get a list of files that have been created by the export process.

The return value is a semicolon-separated list of the path names of the files.

This list can be very large, so please allocate sufficient buffer and check the return value of LlSetOption() on the error value (LL_ERR_BUFFERTOOSMALL).

You can use this function to force the help file name, e.g. if you want to display your own help file.

These options set a default value for the variables in the fax dialog (Project > Fax Variables). Any changes made by the user in the Designer will override these values.

If the project is sent by fax, these expressions will be evaluated and directly used as parameters for the MS Fax module.

As an alternative, these expressions are also available as variables (LL.Fax.xxxx), so that they can be placed in the project in a special format to be used by other fax drivers. For details, please see the fax software manual.

If these options are not set and the user has not entered any expressions in the fax dialog, the "MS FAX" export will not be available.

Use this parameter to set the description of the corresponding project types. This description is displayed in the file type combobox of the load and save dialogs. It is recommended to set the corresponding _SINGULAR options as well.

Use this parameter to set the description of the corresponding project types in the singular. This description is displayed in the file type combobox of the load and save dialogs. These options are used in the repository-mode and might be used otherwise in the future as well.

The file extension for a label project. Default "lbl".

The file extension for the printer definition file of a label project. Default "lbp".

The file extension for the bitmap of a label project that will be shown in the File Open dialog. Default "lbv".

This option defines the licensing. You need to set your own personal license key here.

The file extension for a list project. Default "lst".

The file extension for the printer definition file of a list project. Default "lsp".

The file extension for the bitmap of a list project that will be shown in the File Open dialog. Default "lsv".

Sets the description for List & Label preview files for the "save as" dialog in the preview.

This option defines the extension modules (LLX files) to be loaded. You must pass a list of file paths, separated by semicolons, for the extension modules that you want to use in your application.

The following extension modules are loaded automatically by default, i.e. whenever opening a job or setting this option:

CMLL29PW.LLX, CMLL29HT.LLX, CMLL29EX.LLX, CMLL29OC.LLX

Additionally, for the Professional and Enterprise Edition:

CMLL29BC.LLX

These files are loaded from the DLL's path.

You can use Wildcards ("?", "*") to load multiple modules simultaneously.

To suppress loading of a default extension, pass its file name preceded by a "^", e.g. "^CMLL29PW.LLX". To suppress all default extensions, pass "^*" as first "filename".

When this parameter is used for LlGetOptionString() you will get a list of available extension modules (for example "CMLL29PW.LLX;CMLL29HT.LLX").

If debug mode is switched on, List & Label will issue the rules and tell you why which module has been loaded or unloaded.

This option can be used to specify the path and file name (by default "%APPDATA%\COMBIT.LOG") of debug output activated via LLSetDebug() (parameter LL_DEBUG_CMBTLL_LOGTOFILE) to a log file.

Please make sure that Debwin is not active on the system where you want to do the logging, because it overwrites the path again. Usually you use this option for logging in the background.

Can be used to preset the address of the recipient when sending the preview file from the preview. Multiple recipients can be separated by ";".

Can be used to preset the address of a BCC recipient when sending the preview file from the preview. Multiple recipients can be separated by ";".

Can be used to preset the address of a CC recipient when sending the preview file from the preview. Multiple recipients can be separated by ";".

Can be used to preset the subject when sending the preview file from the preview.

Can be used to preset the representation of a NULL value at print time. Default value: empty("").

Is needed to display files with relative path correctly in Designer preview. For more information, see the Direct Print and Export From the Designer chapter.

Can be used to preset the name of the preview file. By default, the files are created in the project file's directory or an alternative directory (see LlPreviewSetTempPath()). The default file name is <Project file name>.LL. This option can be used to preset another name that replaces the <Project file name> part.

Allows you to define printer alias tables, i.e. tables that define which printers are to be used if any one of the "default project" printers is not available.

To delete the table, pass NULL or an empty string ("") to this option.

For each printer, you can provide a translation table with the old printer and one or more replacement printers. You can do this by calling this function more than once, or by issuing multiple definitions for the individual printers, separated by a line break "\n".

A table is defined by the line format:

"old printer=new printer 1[;new printer 2[;...]]"

so for example

"\\server\eti=\\server\eti1;\\server_eti2"

"\\server\a4fast=\\server\standard"

This list will cause List & Label to try the alias list "\\server\eti1;\\server_eti2" (in that order) if the printer "\\server\eti" is not available, until a printer is available or the list is finished. The original paper format will be used for the replacement printers. The parameters are not case-sensitive.

Encrypts the project files to protect them against unauthorized use. The password given here is used for the encryption. The password itself is not stored in the project, so do not forget it!

You can store encrypted projects in unencrypted format in the Designer by pressing a shift key when you save it. A password dialog will pop up and allow you to enter the original password. This is useful for debugging or support cases.

The maximum password length is 5 characters in the range of 1 to 255 (ASCII code), resulting in 40-bit encryption. The password is not (!) absolutely secure, as it is passed by an API. However, the barrier to stealing project files is quite high.

This can be used to set the title of the report parameter dialog that will be displayed during export.

The passed parameter will be used as default path for "save as" from the preview. The path may contain path and file name.

The string used to convert a date in a string in:

date$(<Date>, "%x")

and for automatic type conversion (LlExprEval(), Concat$())

Format and Default: See Windows API GetLocaleInfo(LOCALE_­USER_­DEFAULT, LOCALE_­SSHORTDATE,...)

This represents the string that is used as thousands separator in the fstr$() function.

The default is the value of the user settings in the system, but this will be set to the respective locale value on LL_OPTION_LCID.

This option enables you to localize the field and variable names for the Designer. The provided alias will be displayed within the Designer instead of the field/variable name. Only the original names will be stored when saving the file. The project can thus be localized by supplying suitable alias names. The option string needs to be set for each name that should be localized in the form "<alias>=<original name>", e.g.

LlSetOptionString(hJob, LL_­OPTIONSTR_­VARALIAS, "Vorname=FirstName");
LlDefineVariable(hJob, "FirstName", "John");

in order to pass a variable "FirstName" that should be displayed as "Vorname" in the Designer.

To delete all passed alias names, just use

LlSetOptionString(hJob, LL_­OPTIONSTR_­VARALIAS, "");

The .NET, OCX and VCL components offer a custom dictionary API that makes using this option even easier. See the components' help file for more information.

Example:

HLLJOB   hJob;

LlSetDebug(TRUE);
hJob = LlJobOpen(0);
// all label projects will be called <somewhat>.label
v = LlSetOptionString(hJob, LL_OPTIONSTR_LABEL_PRJEXT, "label");
// ...
LlJobClose(hJob);

See also:

LlGetOption, LlGetOptionString, LlSetOptionString