This method shows the mapping user interface where users can assign mappings between HotDocs variables and source names.
bool ShowUserInterface ( bool showImport, bool showLoad, int windowHandle, string fromString, bool comboBox )
| Parameters | Description |
| showImport | [optional,defaultvalue(TRUE)] Show the Import button, which allows the user to an load existing HotDocs map (.HMF) file into the variable map. |
| showLoad | [optional,defaultvalue(TRUE)] Show the Load button, which allows the user to load components from a component file into the variable map. |
| windowHandle | [optional,defaultvalue(0)] The parent window for the variable map dialog. If this is non-null, then the variable map dialog is displayed modal to this parent window. |
| fromString | [optional] String to be displayed in the Map variables in box in the user interface. If this parameter is not specified, HotDocs will show the file path for the component file that was loaded. |
| comboBox | [optional,defaultvalue(FALSE)] Indicates whether the controls in the Map to column of the user interface are combo boxes or list boxes. If they are combo boxes, the interface will allow the user to add items to the HDVariables collection from the user interface. If they are list boxes, the user must select an existing item. |
Indicates if the user clicked the OK button or the Cancel button. If ok == true, then the user clicked the OK button.
The following Visual C# example displays the HotDocs Variable Mapping dialog box:
public class ExampleCode
{
static void Main()
{
HotDocs.VarMap vMap = new HotDocs.VarMap();
vMap.ShowUserInterface(true, false, vMap.Application.Hwnd, "", false);
}
}