CloseDbox()
Summary
Closes a toolbox or toolbar.
Changes
In Version 2017 added optional options array and two options, Run Close Action and Force Close.
Syntax
CloseDbox(string tbox_name [, array options])
| Argument | Contents |
|---|---|
| tbox_name | The name of the toolbox or toolbar to close |
| Option | Type | Contents |
|---|---|---|
| Run Close Action | Boolean | "True" to run the dialog box's close-do-enditem, "False" (default) otherwise. |
| Force Close | Boolean | Used when Run Close Action is true. If running the close action does not close the dbox, setting this to "True" (default) forces it to close anyway. |
Notes
-
The options array is an optional argument.
-
CloseDbox() closes the specified toolbox or toolbar without running its close macro. The Close() macro runs only if the user chooses Close from the toolbox system menu or double-clicks the close box.
-
Use Return() to close a regular dialog box.
Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The specified toolbox or toolbar is not open |
See Also
| Function | Summary |
|---|---|
| ShowDbox() | Shows a previously hidden dialog box, toolbox, or toolbar |
| HideDbox() | Hides a dialog box, toolbox, or toolbar |
| UpdateDbox() | Runs the update macro of a toolbox or toolbar |