Method LaunchAppliCat

LaunchAppliCat(string, string, IntPtr)

Opens an AppliCat from the catalog.

Declaration

public string LaunchAppliCat(string applicatCode, string initialValues, IntPtr parentWindowHandle)

Parameters

Type	Name	Description
string	applicatCode	Code of the AppliCat to open.
string	initialValues	Defines the initial state of the AppliCat that is to say the content of all its controls. See remarks for the format description.
IntPtr	parentWindowHandle	Handle of the KitchenDraw window. When the method is called from a KitchenDraw plugin, this parameter can be set to `0` to indicate main KitchenDraw window. When the method is callod from a standalone session, the handle should be provided explicitly.

Returns

Type Description

Type	Description
string	The character string representing the resulting script. The content of the controls of the Applicat is indicated in the `@COMMENT("")` section of the string with the same format as the Value parameter mentioned above. Therefore, if you want to use the Applicat as a dialog box in a plugin you will have to parse the content of the `@COMMENT("")` section of the return string to get the user settings.

string

The character string representing the resulting script. The content of the controls of the Applicat is indicated in the @COMMENT("") section of the string with the same format as the Value parameter mentioned above. Therefore, if you want to use the Applicat as a dialog box in a plugin you will have to parse the content of the @COMMENT("") section of the return string to get the user settings.

Remarks

The format of the initialValues parameter should be the following: COMMENT("EDIT_NAME=100|COMBO_NAME=3:BLC|CASE_NAME=1"). The controls are separated by the | pipe character, and the text of each edit control is placed directly after the equal = sign. For a combobox a zero-based rank of the selected item should be places instead of the text. For a checkbox only values 0 and 1 are allowed, meaning switched off and turned on respectively.