Dialog Objects

To display a dialog box and let users interact with it, you do the following:

  1. Create a dialog object.

  2. Alter the dialog object to suit your needs by setting properties and calling methods.

  3. Display the dialog box by calling the dialog object's Execute method.

Below are three tables that list the methods and properties belonging to the dialog object. The first table lists the most useful methods and properties. The second table lists useful, but unusual methods and properties. The third table lists methods and properties you will probably never need to use.

At this time, only the "Basic Methods and Properties" and "Specialized Methods and Properties" are detailed in this help file.

Basic Methods and Properties

 

AddButtonColumn

Adds a column of push buttons

 

AddButtons

Adds a row of push buttons.

 

AddCheckboxes

Adds a group of checkboxes.

 

AddImageButtons

Adds a row of images that act as buttons.

 

AddLine

Adds a horizontal line.

 

AddMonoText

Adds monospaced text.

 

AddMultiSelectList

Adds a list of items that can be multi-selected.

 

AddPasswordField

Adds a password entry field.

 

AddRadios

Adds a group of radio buttons.

 

AddSelectMenu

Adds a drop-down list of items.

 

AddSelectList

Adds a list of items of which only one can be selected.

 

AddSpacing

Adds vertical space between rows of controls.

 

AddText

Adds a paragraph of text.

 

AddTextArea

Adds a multi-line text field.

 

AddTextField

Adds a single-line text field.

 

Execute

Executes the dialog box.

 

GetBounds

Returns the left position, top position, width, and height of the dialog box.

 

MsgBox

Displays a simple message in a separate dialog box.

 

SetBounds

Sets the left position, top position, width, and height of the dialog box.

 

Title

Gets or sets the title of the dialog box.

Specialized Methods and Properties

 

AllowFind

Turns on or off the end user's ability to do a find in the dialog box.

 

AllowViewDimensions

Turns on or off the end user's ability to view the dimensions of the dialog box.

 

AllowViewSource

Turns on or off the end user's ability to view the HTML source of the dialog box.

 

BGColor

Gets or sets the background color.

 

CancelButton

The caption of the push button that gets activated when the ESC key is pressed.

 

CloseButton

Controls whether the dialog box has a close button "X" in the top-right corner of the title bar.

 

DefaultButton

The caption of the push button that gets activated when the Enter key is pressed.

 

FocusControl

Identifies the control that will receive focus when the dialog box is shown.

 

InlineStyles

Gets or sets the inline styles for a paragraph, checkbox, or label.

 

NumericValues

Gets and sets whether checkbox group items and menu items have values that are the same as their captions, or whether they have numeric values that are the same as their positions among their peer items.

 

Sizeable

Property that controls whether the user can resize the dialog box.

Advanced Methods and Properties
Ignore the following methods and properties until you are an advanced user of ScriptDialogs

 

Action

Sets the Action value for the HTML form on the dialog box.

 

AddHidden

Adds a hidden field to the smart HTML form on the dialog box.

 

AddHtml

Adds raw HTML code to the dialog box.

 

AddRow

Adds a row of raw HTML content to the dialog box.

 

BodyAttributes

Gets or sets the attributes of the HTML BODY tag for the dialog box.

 

CellPadding

Gets or sets the cell padding for the HTML table that holds the controls for the dialog box.

 

CellSpacing

Gets or sets the cell spacing for the HTML table that holds the controls for the dialog box.

 

Close

Closes the dialog box.

 

CloseOnSubmit

Turns on or off whether the dialog box closes when a button is pushed.

 

EncloseInHtml

Turns on or off whether the dialog box HTML form is enclosed in HTML, HEAD, and BODY tags.

 

EscapeText

Returns a string that is safe for use in the dialog box (escapes characters that are dangerous in HTML).

 

Html

Gets or sets the raw HTML code for the dialog box contents.

 

InsertBRs

Returns a string that preserves the carriage returns and line feeds when text is to be displayed in the dialog box.

 

PageTitle

Sets the value of the HTML TITLE tag.

 

PlainText

Sets the value of the dialog box contents using plain text rather than HTML.

 

Reset

Clears the internal HTML contents of the dialog box.

 

Script

Gets or sets the dialog object's reference to the script.

 

Styles

Gets or sets the styles on the dialog box's HTML page.

 

Update

Forces the dialog box to realize its HTML contents.