Dialog control IDs

The installer dialog boxes in InstallMate are internally implemented as Windows dialog resources. As such, the usual rules for dialogs and their controls apply and each control must have a numerical identifier. This topic discusses the way control identifiers are assigned to the dialog controls that you create on the Dialogs project page.

Note: The Control ID is separate from the Name attribute; the latter is for use in InstallMate only.

Control identifiers

InstallMate requires that all controls in a dialog box have unique numerical identifiers. Furthermore, some control identifiers have a specific meaning to InstallMate and Windows; you should use these only for their intended purpose.

The Control ID attribute of each dialog control attribute pane determines which identifier a control will use in the installer. It consists of a drop-down list that contains a number of standard identifiers; you can also enter your own numerical identifier in this field. Standard control identifiers are handled internally by the installer, unless you create an event handler for the control that overrides the default handling. The default handling is used to control the execution of the action sequence that opened the dialog box.

EndDialog action Modal result codes

In addition to their use as control identifiers proper, the same standard identifiers are also available in EndDialog actions. An EndDialog action terminates a modal dialog box as if the user pressed a PushButton control to close the dialog box. To indicate which button was pressed, you set the EndDialog action's Modal result attribute to one of the standard control identifiers. (This works even if there is no actual PushButton with that identifier in the dialog box.)

Standard control identifiers

The following standard Control ID values are available.

Control ID Description Default action
Automatic Lets InstallMate assign a control ID when the project is built. Automatically assigned control IDs start at 1001. No default action
IDABORT Represents the "Abort" button in a dialog box. Closes the dialog box and exits the action sequence that opened the dialog box.
IDBACK Represents the "Back" button in a dialog box. Closes the dialog box and continues with the previous Run Dialog action in the action sequence that opened the dialog box.
IDCANCEL Represents the "Cancel" button in a dialog box. Closes the dialog box and exits the action sequence that opened the dialog box.
IDCLOSE Represents the "Close" button in a dialog box. Closes the dialog box and continues with the next action in the action sequence that opened the dialog box.
IDCONTINUE Represents the "Continue" button in a dialog box. Closes the dialog box and continues with the next action in the action sequence that opened the dialog box.
IDFINISH Represents the "Finish" button in a dialog box. Closes the dialog box and continues with the next action in the action sequence that opened the dialog box.
IDHELP Represents the "Help" button in a dialog box. No default action; reserved for future use.
IDIGNORE Represents the "Ignore" button in a dialog box. Closes the dialog box and continues with the next action in the action sequence that opened the dialog box.
IDNEXT Represents the "Next" button in a dialog box. Closes the dialog box and continues with the next action in the action sequence that opened the dialog box.
IDNO Represents the "No" button in a dialog box. Closes the dialog box and exits the action sequence that opened the dialog box.
IDOK Represents the "OK" button in a dialog box. Closes the dialog box and continues with the next action in the action sequence that opened the dialog box.
IDRETRY Represents the "Retry" button in a dialog box. Closes the dialog box and continues with the previous action in the action sequence that opened the dialog box.
IDTRYAGAIN Represents the "Try Again" button in a dialog box. Closes the dialog box and continues with the previous action in the action sequence that opened the dialog box.
IDYES Represents the "Yes" button in a dialog box. Closes the dialog box and continues with the next action in the action sequence that opened the dialog box.
(other) Enter your own numeric ID. To avoid conflicts with automatically assigned control IDs, we recommend that you use values 2000..2999 for your own identifiers. No default action if the control ID is within the range 2000..2999. User-defined control IDs are intended for future use.