Application.SetDialogProperties

Application.SetDialogProperties ( 

string  DialogName,

table   Properties )

Description

Sets the properties of a dialog.

Parameters

DialogName

(string) The name of the dialog whose properties you want to modify.

Properties

(table) A table containing the properties you want to modify, indexed by name.

KEY

TYPE

DESCRIPTION

DialogTitle

string

The window title of the dialog.

Movable

boolean

True if the dialog should be movable, or false if it should not. Note: This value can only be set if the dialog is not currently visible. If the dialog is already visible, this setting will be reflected the next time the dialog is shown.

AlwaysOnTop

boolean

True if the dialog window should always appear on top of all other windows, or false if it should not.

Width

number

The width of the dialog surface, in pixels. You cannot set a width less than the value defined in MinWidth.

Height

number

The height of the dialog surface, in pixels. You cannot set a height less than the value defined in MinHeight.

DialogStyle

number

The window style to set for 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 should be resizable, or false if it should not.

MinWidth

number

The minimum dialog width to set if Resizable is set to true. If Width is less than this value, it will also be set.

MinHeight

number

The minimum dialog height to set if Resizable is set to true. If Height is less than this value, it will also be set.

UseCustomIcon

boolean

True if a custom icon should be shown in the top left corner of the dialog, or false if it should 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 the dialog background should use custom colors or false if the default background

color for windows applications should be 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 to be used as the window mask when DialogStyle is set to DIALOG_STYLE_CUSTOM_MASK. You can pass an empty string ("") to clear the window mask.

FitCustomMaskToWindow

boolean

True to resize the mask file to match the dimensions of the dialog, false to not.

Returns

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

See also:  Related Actions