Description

This class is the automation API for IQ application dialogs.

Object Model





Remarks

These objects are contained in the McApplication.Dialogs collection. Each one of them is defined by a .dlg file in the Resources\Dialogs directory.

Members

Methods
Click

Emulates a user click on one of the buttons contained in Control.

Close

Closes and unloads a dialog.

Hide

Hide a dialog.

LoadSettings

Loads the layout of a dialog from an McSettings compatible file or object.

SaveSettings

Saves the layout of a dialog to an McSettings compatible file or object.

Show

Displays a dialog and select the active page.


Properties
ActivePageRead-only property

Returns a reference to the currently active (visible) page.

ApplicationRead-only property

Returns a reference to the McApplication object controlling this dialog.

CaptionRead-write property

Get or set the Title of this dialog.

ControlRead-only property

Returns an object controlling the dialog.

ControlAsObjectRead-only property

Returns an Object (IDispatch) reference to the Active X Control managing this dialog (the OK, Cancel buttons...)

EnabledRead-write property

Enables or disables this entire dialog. Returns the current state.

HeightRead-write property

Get or set the height of the dialog in pixels.

HelpContextRead-write property

Get or set an URL linking to a help page for the dialog.

hWndRead-only property

Returns the window handle for this dialog.

IconRead-write property

Get or set the icon file for a dialog.

InstanceRead-only property

Returns the instance number.

LeftRead-write property

Get or set the x origin of the dialog in pixels.

ModalRead-write property

Get or set whether this dialog should be modal when displayed.

NameRead-only property

Returns the Name of this dialog.

PagesRead-only property

Returns the collection of pages for this dialog.

TopRead-write property

Get or set the y origin of the dialog in pixels.

TypeRead-only property

Returns the dialog type.

UserDataRead-write property

Get or set a user defined value to associate with a dialog.

VisibleRead-write property

Get or set the visibility of a dialog.

WidthRead-write property

Get or set the width of the dialog in pixels.


Events
Click

The event fired when dialog control buttons are clicked.

Close

The event fired when a dialog is removed from the collection before being destroyed.

Dock

The event fired when a dialog is docked.

Float

The event fired when a dialog starts floating.

Hide

The event fired when dialogs and pages are hidden.

Initialize

The event fired when dialogs and pages are initialized.

MDIFloat

The event fired when a dialog becomes an MDI child.

Show

The event fired when dialogs and pages are displayed.

Terminate

The event fired when dialogs and pages are destroyed.