| Property Name | Return Type | Description |
|---|---|---|
| buttons | string | Specifies the buttons that are displayed at the bottom of the dialog. These buttons are used to close the dialog. The Show method returns a value indicating which button was chosen (and this value is also available in the result property). Multiple button strings must be separated with vertical bar characters (|). If a button has more than one button then by definition the last one is the "cancel" button. For example: To specify accelerators for the buttons prefix the desired key with an ampersand (&) character. For example: Buttons can also have drop-down menus attached to them, by separating the drop-down items with plus signs (+). For example: Within drop-down menus, you can specify that certain menu items can be accessed directly from the main button by holding Shift, Ctrl or Shift+Ctrl. This is done by adding an equals sign and then the label the button should display when the key is held down (usually an abbreviated version of the menu item label, or a repetition of the label itself if it is already short enough). The keys are automatically assigned and you can only do this for at most three items. For example: <WRAP prewrap> </WRAP> |
| choices | object:Vector(string) or array(string) | This property uses either a Vector or an array of strings to provide a list of multiple options that can be shown to the user. The list can be presented in one of three ways:
When shown as a checkbox list the dialog is resizable; you can set the initial size using the cx and cy properties (and retrieve them afterwards if you want to save the size). |
| confirm | bool | In a text entry dialog (i.e. the max property has been specified) setting confirm to True will require that the user types the entered text again (in a second text field) to confirm it (e.g. for a password). |
| cx | int | For script dialogs marked as resizable, this property lets you override the width of the dialog defined in the resource - although note you can't resize a dialog smaller than its initial size. |
| cy | int | For script dialogs marked as resizable, this property lets you override the height of the dialog defined in the resource - although note you can't resize a dialog smaller than its initial size. |
| defvalue | string | In a text entry dialog (i.e. the max property has been specified) this property allows you to initialize the text field with a default value. (Old scripts may use "default" instead of "defvalue"; this is deprecated because it does not work in JScript where "default" is a reserved keyword.) |
| defid | int | Allows you to change the default button (i.e. the action that will occur if the user hits enter) in the dialog. Normally the first button is the default - this has a defid of 1. The second button would have a defid of 2, and so on. If a dialog has more than one button then by definition the very last button is the "cancel" button, and this has a defid of 0. |
| detach | bool | Set to True if you want a script dialog to run in “detached” mode, where your script provides its message loop. |
| disable_window | object:Lister or object:Tab *or object:*Dialog\ or int | Use this to cause the dialog to automatically disable another window when it's displayed. The user will be unable to click or type in the disabled window until the dialog is closed. Normally if you use this you would set this to the same value as the window property. You can provide either a Lister or a Tab object, or another Dialog. If you are showing this dialog in response to the OnAboutScript event, you can also pass the value of the AboutData.window property. |
| icon | string or object:Image | Displays one of several standard icons in the top-left corner of the dialog, which can be used, for example, to indicate the severity of an error condition. The valid values for this property are warning, error, info and question. When used with a script dialog this property lets you control the icon shown in the dialog's title bar. In this instance, instead of a string you can also provide an Image object that you obtained from the DOpus.LoadImage or Script.LoadImage methods. Note that the image must have been loaded from a .ico file. |
| input | string | In a text entry dialog, this property returns the text string that the user entered (i.e. once the Show method has returned). |
| language | string | Set this property to create a script dialog in a particular language (if one or more language overlays have been provided), rather than the currently selected language. |
| list | object:Vector(bool) or array(bool)\ or// int// | In conjunction with the choices property, this will cause the choices to be presented as a checkbox list. You can initialize this Vector or array with the same number of items as the choices property, and set each one to True or False to control the default state of each checkbox. Or, simply set this value to** 0** to activate the checkbox list without having to initialize the state of each checkbox. When the Show method returns, this property will return a Vector of bools that provide the state of each checkbox as set by the user. |
| max | int | This property enables text entry in the dialog - a text field will be displayed allowing the user to enter a string. Set this property to the maximum length of the string you want the user to be able to enter (or 0 to have no limit). When the Show method returns the text the user entered will be available in the input property. |
| menu | object:Vector(int) or array(int) or int | In conjunction with the choices property, this will cause the choices to be presented as a popup menu rather than in a dialog. The menu will be displayed at the current mouse coordinates. You can initialize this Vector or array with the same number of items as the choices property, and set each one to a value representing various flags that control the appearance of the menu item. The available flags are as follows - their values must be added together if you need to specify more than one flag per item. You can also simply set this value to 0 or 1 to activate the popup menu without having to provide flags for each item (if set to 1, the top item in the menu will appear bolded). The Show method returns the index of the menu item the user chose (with 1 being the first item), or 0 if the menu was cancelled. |
| 1 | bold (indicates the default item) | |
| 2 | checked (a checkmark will appear next to the item) | |
| 4 | radio (a radio button will appear next to the item) | |
| 8 | disabled (the user will not be able to select the item) | |
| message | string | Specifies the message text displayed in the dialog. |
| msgonly | bool | Set to True before creating the dialog to create a message-only dialog. A message-only dialog will never be visible, but still runs a normal message loop. This lets you use things like WatchTab or HTTPRequest without needing a visible dialog (or resorting to opacity tricks). No dialog template is needed when using this mode. Note that only detached dialogs support this option. |
| opacity | int | For script dialogs this property retrieves or sets the current dialog opacity level, from 0 (totally transparent) to 255 (totally opaque). |
| options | collection:DialogOption | This is a collection of five options that will be displayed as checkboxes in the dialog. Unlike the choices / list scrolling checkbox list, these options are displayed as physical checkbox controls. By default the five checkboxes are uninitialized and won't be displayed, but if you assign a label to any of them they will be shown to the user. When the Show method returns you can obtain the state of the checkboxes using the state property of each DialogOption object. |
| password | bool | In a text entry dialog, set this property to True to make the text entry field a password field. In a password field the characters the user enters are not displayed. |
| position | string | When used with a script dialog this property lets you control the dialog's position on screen. Accepted values are: Except when set to "center" the x and y properties can be used to adjust the dialog's position. |
| center | center the dialog over the parent window (the default) | |
| absolute | specify an absolute position using the x and y properties | |
| parent | position relative to the parent window (using x and y) | |
| monitor | position relative to the current monitor (using x and y) | |
| position_fix | bool | By default, Opus checks the size and position of your dialog just before it opens and fixing them if they would place any of the dialog off-screen. Positioning a dialog off-screen is usually an accident caused by saving window positions on one system and restoring them on another with different monitor resolutions or arrangements. In the rare cases where you want your dialog to open off-screen, where the user cannot see some of all of it, set this property to False. |
| result | int | This property returns the index of the button chosen by the user to close the dialog. The left-most button is index 1, the next button is index 2, and so on. If a dialog has more than one button then by definition the last (right-most) button is the "cancel" button and so this will return index 0. If any buttons have associated drop-down menus then the contents of the menus also contribute to the index value. For example, if button index 2 has an additional item in a drop-down menu, then that item would be index 3, and the next button would be index 4. |
| select | bool | In a text entry dialog, set this property to True to automatically select the contents of the input field (as specified by the defvalue property) when the dialog opens. |
| selection | int | In a drop-down list dialog (one with the choices property set without either list or menu), this property returns the index of the item chosen from the drop-down list after the Show method returns. |
| singleton | string | If you only want one instance of your dialog to be open at once, set this property to a unique name before creating the dialog. When the dialog is created, Opus will check if another dialog with same singleton name is already open. If it is, the existing dialog will be brought to the front and your script will receive a False return from the Create or Show methods. You should check for this an exit your script in that case. |
| sort | bool | Set this property to True if the list of choices given by the choices property should be sorted alphabetically. |
| state | string | Returns a string indicating the current state of the dialog. Possible values are "visible" (normal state, open and visible), "hidden" (dialog has been hidden), "min" (dialog is minimized), "max" (dialog is visible and maximized). |
| template | string | Lets you create a script dialog. The template property can be set to the name of the script dialog to display (as defined in your script resources), or a string that contains raw XML defining the dialog. |
| title | string | Specifies the title text of the dialog. |
| top | bool | Set this property to True to make the dialog "top level", or False to allow it to go behind other non-top level windows. |
| want_close | bool | Set this property to True if you want the script dialog to generate close events in your message loop when the user clicks the window close button. You'll need to close the dialog yourself using the EndDlg method. |
| want_resize | bool | Set this property to True if you want the script dialog to generate resize events in your message loop when the user resizes the dialog. |
| window | object:Lister or object:Tab or *object:*Dialog or int | Use this to specify the parent window of the dialog. The dialog will appear centered over the top of the specified window. You can provide either a Lister or a Tab object, or another Dialog. If you are showing this dialog in response to the OnAboutScript event, you can also pass the value of the AboutData.window property. You only need to set this property if you obtain the Dialog option from the DOpus.Dlg method. If the Dialog object comes from one of the other objects (e.g. Tab.Dlg) then its parent window will already be set to the window which launched the action your script is responding to. |
| x | int | Specifies the x-position of a script dialog. Use the position property to control how the position is interpreted. After the dialog has been displayed you can change this property to move the dialog around on-screen. |
| y | int | Specifies the y-position of a script dialog. Use the position property to control how the position is interpreted. After the dialog has been displayed you can change this property to move the dialog around on-screen. |
\
\[\
Lets a script dialog register one or more custom messages that can then be sent to it from other scripts.
Messages are registered by name. If a message is already registered the method will fail unless you set the optional force parameter to true.
Use DOpus.SendCustomMsg to send messages to dialogs. The dialog will receive a "custom" Msg in their message loop.
| | | AddHotkey |\
\
Creates a hotkey (or keyboard accelerator) for the specified key combination. When the user presses this key combination in your dialog, a hotkey event will be triggered.
The name parameter is a name you assign that lets you identify the hotkey. The key parameter specified the actual key combination; this can optionally combine the qualifiers ctrl, shift and alt with a character or name of a special key. For example, ctrl+t or alt+shift+F7.
This method returns true if successful, or false on failure (e.g. if the hotkey already exists).
| | | AutoSize | *none* | *none* | If a dialog has auto-sizing controls that depend on the sizes of other controls, and you make changes to their sizes at runtime, you can call this method to force the dialog to recalculate all relative control sizes once you've made the required changes. | | | CancelWatchClipboard | *none* | *none* | Cancels monitoring of the system clipboard for changes previously established by a call to the **WatchClipboard** method. | | | CancelWatchDir | \When creating a script dialog, calling this method creates the underlying dialog but does not display it. This lets you create the dialog and then initialize its controls before it is shown to the user.
Using Create implies a detached dialog; the detach property will be set True automatically. However, you can call RunDlg afterwards if you don't need a custom message loop and just want to set up some controls before displaying the dialog.
Once the dialog has been created and its controls initialized, you should call Show or RunDlg to make it visible to the user. It will also go visible at the first GetMsg call if it hasn't already been shown.
| | | CreateFont |\
\[\
\[\
Creates a font object that can be given to dialog controls to make them use a non-standard font. The name parameter specifies the name of the font (e.g. "Arial") - you can also use "\*" which means the default dialog font. The size parameter specifies the desired point size (use 0 to get the default dialog font size). The styles string can consist of one or more characters indicating the desired font style - "b" for bold, "i" for italic, "u" for underline.
The return value can be used with the Control.SetFont method.
Fonts you create are automatically destroyed when the dialog closes but if you want to delete them manually to free up resources, use the DestroyFont method.
| | | Control |\
\[\
\[\
Returns a Control object corresponding to one of the controls on a script dialog. The control is identified by its name, as defined in the script dialog resource.
The optional second and third parameters are only used when the control is in a tab control (that is, when it's in a dialog that's a child of another dialog). The dialog parameter specifies the name of its parent dialog. The tab parameter specifies the name of the tab control hosting the child dialog. You would only need to specify the name of the tab if you have multiple tab controls and the same dialog is hosted inside more than one of them (this would be quite a rare occurrence).
Note that none of the controls will exist until Create has been called.
| | | DelHotkey | \Deletes a hotkey you previously created with the AddHotkey method.
This method returns true if successful, or false on failure (e.g. if the hotkey does not exist).
| | | Drag |object:Items
\
Allows the user to drag and drop one or more files from your dialog (and drop them in another window or application).
You would usually call this in response to a drag event you receive from a static or list view control.
The first parameter is an Items object representing the files to be dragged. (You can also pass a Vector of Item or Path objects, or full path strings, instead of an Items object. Or a StringSet or UnorderedSet of full path strings.)
The optional second parameter lets you control which actions are available. This should be a string containing one or more of copy, move, link. The default action can be indicated by prefixing it with a \* (e.g. copy,\*move,link). If you don't specify this parameter the default is to only allow copy.
The string this method returns indicates the result of the drag. For a left button drag, this will be "copy", "move", "link" or "drop". For a right-button drag it will always be "drop". If the drag is cancelled it will return "cancel".
| | | DestroyFont | \\
\
\
\
Displays a "Browse for Folder" dialog letting the user select a folder. The optional parameters are:
A Path object is returned to indicate the folder chosen by the user. This object will have an additional result property that will be False if the user cancelled the dialog - the other normal Path properties will only be valid if result is True.
| | | FlushMsg | *none* | *int* | Flushes the dialog's message queue. Any unretrieved messages will be discarded. The return value tells you how many messages were in the queue. | | | GetMsg | *none* | *object:*[**Msg**](/directory-opus/manual/reference/scripting_reference/scripting_objects/msg.md) |Returns a Msg object representing the most recent input event in a script dialog (only used in detached mode).
The return value will evaluate to False when the dialog is closed, which is when you should exit your message loop.
If the dialog is not already visible (because Show has not been called) then it will become visible when you first call GetMsg.
| | | GetString |\
\
\
\
\
\
\
Displays a text entry dialog allowing the user to enter a string. The optional parameters are:
The return value is the entered string, or an empty value if the dialog was cancelled. The index of the button selected by the user will be available via the result property once this method returns. The left-most button is index 1, the next button is index 2, and so on. If a dialog has more than one button then by definition the last (right-most) button is the "cancel" button and so this will return index 0.
| | | KillTimer | \\
\
Restores the previously saved position of a script dialog. The position must have previously been saved by a call to the SavePosition method.
The id string is a string that Opus can use to identify your dialog or the script it comes from. The template name of the dialog will be automatically appended to this. For example, you might specify id as "kundal" - Opus would then internally save the position of a dialog called "dialog1" as "kundal!dialog1". Make sure you pick a string that other script authors are unlikely to use as Opus has no other way of telling the saved positions apart.
The optional type parameter lets you control which position elements are restored - specify "pos" to only restore the position, "size" to only restore the size, or "pos,size" to restore both (this is also the default, so you can also omit the argument all together).
| | | Multi |\
\
\
\
Displays a "Browse to Open File" dialog that lets the user select one or more files. The optional parameters are:
The optional type parameter consists of one or more pairs of strings, separated by exclamation marks (!). The first string of each pair is the plain text string shown in the drop-down, and the second string of each pair is the actual file extension. You can also specify multiple extensions for the one type by separating them with semicolon. If you want the default "All files" item to be added to the list, add a # character at the start of the string. For example, #Text Files!*.txt!Doc Files!*.doc.
An Items object is returned to indicate the files selected by the user. The returned object will have a result property that you should check first - the collection of items is only valid if result returns True. If it returns False it means the user cancelled the dialog.
| | | NewHTTPReq | *none* | *object:*[**HTTPRequest**](/directory-opus/manual/reference/scripting_reference/scripting_objects/httprequest.md) |Creates a new HTTPRequest object attached to this dialog. This object provides a simple way to send an HTTP request to a server asynchronously, and retrieve the response.
Events from HTTP requests will come through your dialog's message loop, so you must use a detached dialog in order to use this functionality.
| | | NotifyIcon |\
arguments...
Allows a script to add an icon to the system taskbar notification area.
The method argument specifies one of four actions, each of which has its own set of arguments.
For the add and update methods, the icon argument can be a string or Image object - see the documentation for the icon property above for more details. If the dialog has been assigned an icon via this property then that icon will be used automatically if none is provided.
The tooltip argument provides a tooltip string that the system will display when the user moves the mouse over the icon. If the dialog's title property has been set then the title will be used if no explicit tooltip is given.
The notify method lets you show a system notification associated with your dialog. This method is similar to the DOpus.Notify method - see the description of that method for more information on the arguments.
Once your script has added an icon, the user can interact with it using the mouse. Mouse activity will generate click, dblclk and rclick events in your dialog's message loop. The Msg.control property will be set to notifyicon.
The icon is automatically removed when your dialog closes. It's also restored automatically if Explorer restarts after the icon has been added.
Please note that only one icon per dialog is supported.
| | | method | Arguments | Description | | | | **add** |\
\
\
\
\