Xdialog Function Reference

Alpha Five provides the following Xdialog functions.

Function

 

Description

A5_GENERIC_PRINT()

V6

Prints the contents of a text control on an Xdialog form.

A5_GENERICSEARCHREPLACE()

V6

Allows you to search and replace text in a control on an Xdialog form.

A5_OWNER_DRAW_LIST_FMT()

V5

Adds 'owner-draw' formatting command to a CR-LF delimited list.

A5_XdialogPreProcess()

V6

Adds help text to an Xdialog.

KEYLIST_BUILD()

V5

Returns specially formatted data for display of advanced record lists in an Xdialog form.

UI_DLG_BOX()

V5

Displays a dialog box and returns a character string.

UI_DLG_COMMIT()

V5

Forces a dialog to commit its contents.

UI_DLG_CONTROL_

ANCHOR_FROM_POS()

V6

Detects which anchor button receives the button click.

UI_DLG_CONTROL_FROM_POS()

V6

Returns the definition of the control that the mouse is over.

UI_DLG_CREATE()

V5

Creates an invisible modeless dialog, which can later be displayed.

UI_DLG_CTL_CURRENT()

V5

Retrieves the definition of the current control in the named dialog.

UI_DLG_CTL_GOTO()

V5

Sets focus to a control in a dialog.

UI_DLG_DOM()

V6

Creates a pointer that allows you to manipulate the size and position of objects within an Xdialog box.

UI_DLG_EVAL()

V6

Evaluates an expression in the context of a modeless Xdialog.

UI_DLG_EVAL_VALID()

V6

Determines whether a variable exists in a modeless dialog.

UI_DLG_EVENT()

V5

Invokes an action event in the specified dialog.

UI_DLG_HELP()

V5

Displays a help topic for the current dialog.

UI_DLG_HIDE()

V5

Hides the specified dialog.

UI_DLG_IS_ACTIVE()

V6

Returns .T. (TRUE) if any component of an Xdialog has focus.

UI_DLG_IS_MAXIMIZED()

V5

Indicates whether the specified dialog is maximized.

UI_DLG_IS_MINIMIZED()

V5

Indicates whether the specified dialog is minimized.

UI_DLG_MAXIMIZE()

V5

Maximizes the specified dialog.

UI_DLG_MINIMIZE()

V5

Minimizes the specified dialog.

UI_DLG_MODAL()

V5

Makes a modeless dialog box behave like a modal dialog box.

UI_DLG_MOVE()

V5

Moves a dialog to a new position.

UI_DLG_NAVIGATE()

V6

Moves the cursor to the next or previous control on an Xdialog form.

UI_DLG_OPTIONAL_EVENT()

V6

Sends an event to a modeless dialog, but does not generate an error if the dialog does not exist.

UI_DLG_PANEL()

V8

 

UI_DLG_PARENT_GET()

V8

When used by an embedded dialog, returns the name of its parent dialog.

UI_DLG_REFRESH()

V5

Refreshes the contents of a dialog.

UI_DLG_REFRESH_TARGETED()

V6

Refreshes a selected list of controls on a dialog.

UI_DLG_REMEMBERED_CLEAR()

V5

Clears any remembered alignment, size, or position data.

UI_DLG_REMEMBERED_GET()

V5

Retrieves alignment, size, and position data for a dialog box.

UI_DLG_RESIZE()

V5

Resizes a dialog box.

UI_DLG_SHOW()

V5

Displays a dialog box.

UI_INFO_DLG_

DEF_CLIENT_HEIGHT()

V6

Returns the height of the specified embedded Xdialog.

UI_INFO_DLG_

DEF_CLIENT_WIDTH()

V6

Returns the width of the specified embedded Xdialog.

UI_INFO_DLG_DEF_EVENTS()

V5

Retrieves events for a dialog.

UI_INFO_DLG_DEF_HEIGHT()

V5

Retrieves the height of a dialog in units (specified by the {UNITS} command).

UI_INFO_DLG_DEF_LISTS()

V5

Retrieves the lists for a dialog.

UI_INFO_DLG_DEF_VARS()

V5

Retrieves the variables of a dialog.

UI_INFO_DLG_DEF_WIDTH()

V5

Retrieves the width of a dialog in units (specified by the {UNITS} command).

UI_MODELESS_DLG_BOX()

V5

Creates a modeless dialog.

UI_MODELESS_DLG_BUTTON()

V5

Returns the name of the button being pressed on a modeless dialog box.

UI_MODELESS_DLG_

BUTTON_RESET()

V5

Resets the value of a button on a modeless dialog box.

UI_MODELESS_DLG_CLOSE()

V5

Closes a modeless dialog box.

UI_MODELESS_DLG_EXIST()

V5

Indicates whether a modeless dialog box exists.

UI_MODELESS_DLG_REFRESH()

V5

Refreshes a modeless dialog box.

UI_MODELESS_DLG_SETFOCUS()

V5

Sets focus to a modeless dialog box.

UI_MODELESS_DLG_SIZING()

V6

Returns .T. (TRUE) when a modeless dialog box is in the process of being resized.

UI_WAIT_UNTIL()

V8

Pauses a script until UI_MODELESS_DLG_EXIST() returns .T. (TRUE) or .F. (FALSE). Use this function when the testing if some UI component is present.