ResultVariable
When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions
Application.GetDialogProperties
OverviewExamples
table Application.GetDialogProperties ( string DialogName )
De s cr ip t ion
Returns a table containing the properties of the specified dialog.
P arame t er s
DialogName
(string) The name of the dialog whose properties you want.
Re t u r n s
(table) A table containing the dialog's properties indexed by the following keys. If the dialog doesn't exist or an error occurs, nil is returned.
|
KEY |
TYPE DESCRIPTION |
|
|
DialogTitle |
string |
The window title of the dialog. |
|
Movable |
boolean |
True if the dialog is set to be movable, or false if it is not. |
|
AlwaysOnTop |
boolean |
True if the dialog window is set to always appear on top of all other windows, or false if it is not. |
|
Width |
number |
The width of the dialog surface, in pixels. |
|
Height |
number |
The height of the dialog surface, in pixels. |
|
DialogStyle |
number |
The window style of the dialog: DIALOG_STYLE_STANDARD (0), DIALOG_STYLE_BORDERED (1), DIALOG_STYLE_FLAT (2), DIALOG_STYLE_CUSTOM_MASK (3). |
|
Resizable |
boolean |
True if the dialog is set to be resizable, or false if it is not. |
|
MinWidth |
number |
The minimum dialog width to use if Resizable is set to true. |
|
MinHeight |
number |
The minimum dialog height to use if Resizable is set to true. |
|
UseCustomIcon |
boolean |
True if a custom icon is set to be shown in the top left corner of the dialog, or false if it is not. |
|
CustomIcon |
string |
The path to the custom icon to show if UseCustomIcon is true, and DialogStyle is set to DIALOG_STYLE_STANDARD. |
|
UseCustomSettings |
boolean |
True if custom colors are being used, or false if the default background color for windows applications is being used. Note: If you skin your application, the default color will come from your skin file. |
|
BackgroundType |
number |
The type of background: BG_SOLID (0), BG_GRADIENT (1), BG_IMAGE (2) |
|
BackgroundColor |
number |
The numeric value of the background color. |
|
GradientColorTop |
number |
The numeric value of the gradient top color. Only applicable if BackgroundType = BG_GRADIENT. |
|
ImageFilename |
string |
The path to the image file to be used for the background image if BackgroundType = BG_IMAGE. |
|
ImageStretchMode |
number |
The type of image stretching to be performed if BackgroundType = BG_IMAGE. Choose from BG_IMAGE_FITPAGE (0), BG_IMAGE_TILE (1), BG_IMAGE_ACTUALSIZE (2). |
|
CustomMask |
string |
The path to the file that is being used as the window mask when DialogStyle is set to DIALOG_STYLE_CUSTOM_MASK. |
|
FitCustomMaskToWindow |
boolean |
True if the mask file is set to resize to match the dimensions of the dialog, false if it is not. |