• ui_dlg_background_refresh Function
• UI_DLG_BOX Function
• ui_dlg_card_embed Function
• ui_dlg_card_embed_can_close Function
• ui_dlg_card_embed_close Function
• ui_dlg_card_embed_object Function
• ui_dlg_card_embed_on_close Function
• ui_dlg_column_adjust Function
• UI_DLG_COMMIT Function
• UI_DLG_CONTROL_ANCHOR_FROM_POS Function
• ui_dlg_control_commit Function
• ui_dlg_control_embedded_get Function
• UI_DLG_CONTROL_FROM_POS Function
• ui_dlg_control_item_get Function
• ui_dlg_control_item_set Function
• UI_DLG_CREATE Function
• UI_DLG_CTL_COMMAND Function
• UI_DLG_CTL_CURRENT Function
• UI_DLG_CTL_GOTO Function
• ui_dlg_ctl_visible Function
• ui_dlg_dock Function
• ui_dlg_dock_topology Function
• ui_dlg_docked_panel_dock Function
• ui_dlg_docked_panel_undock Function
• ui_dlg_docked_state_end Function
• ui_dlg_docked_state_get Function
• ui_dlg_docked_state_group Function
• ui_dlg_docked_state_position Function
• ui_dlg_docked_state_set Function
• ui_dlg_docked_state_start Function
• ui_dlg_docking_listener_add Function
• ui_dlg_docking_listener_drop Function
• UI_DLG_DRAG_TEXT_GET Function
• UI_DLG_DRAG_TEXT_SET Function
• ui_dlg_editor_active Function
• ui_dlg_editor_get Function
• UI_DLG_EVAL Function
• UI_DLG_EVAL_VALID Function
• UI_DLG_EVENT Function
• ui_dlg_event_occurred Function
• ui_dlg_hdc_render Function
• UI_DLG_HIDE Function
• ui_dlg_hotspot_query Function
• ui_dlg_hotspot_refresh Function
• UI_DLG_IS_ACTIVE Function
• UI_DLG_IS_MAXIMIZED Function
• UI_DLG_IS_MINIMIZED Function
• UI_DLG_MAXIMIZE Function
• UI_DLG_MINIMIZE Function
• UI_DLG_MODAL Function
• UI_DLG_MOVE Function
• UI_DLG_NAVIGATE Function
• ui_dlg_navigation Function
• ui_dlg_object_get Function
• UI_DLG_OPTIONAL_EVENT Function
• UI_DLG_PANEL Function
• ui_dlg_panel_destroy Function
• ui_dlg_panel_name Function
• UI_DLG_PARENT_GET Function
• ui_dlg_query Function
• UI_DLG_REFRESH Function
• UI_DLG_REFRESH_TARGETED Function
• UI_DLG_REMEMBERED_CLEAR Function
• UI_DLG_REMEMBERED_GET Function
• UI_DLG_RESIZE Function
• ui_dlg_return Function
• ui_dlg_session_refresh_expr Function
• ui_dlg_session_refresh_result Function
• UI_DLG_SHOW Function
• ui_dlg_size_to_content Function
• ui_dlg_to_html Function
• ui_dlg_undock Function
• UI_INFO_DLG_DEF_CLIENT_HEIGHT Function
• UI_INFO_DLG_DEF_CLIENT_WIDTH Function
• ui_info_dlg_def_conditions Function
• ui_info_dlg_def_controls_get Function
• UI_INFO_DLG_DEF_EVENTS Function
• UI_INFO_DLG_DEF_HEIGHT Function
• UI_INFO_DLG_DEF_LISTS Function
• ui_info_dlg_def_tooltip_get Function
• UI_INFO_DLG_DEF_VARS Function
• UI_INFO_DLG_DEF_WIDTH Function
• UI_MODELESS_DLG_BOX Function
• UI_MODELESS_DLG_BUTTON Function
• UI_MODELESS_DLG_BUTTON_RESET Function
• UI_MODELESS_DLG_CLOSE Function
• UI_MODELESS_DLG_EXIST Function
• ui_modeless_dlg_hover Function
• UI_MODELESS_DLG_REFRESH Function
• UI_MODELESS_DLG_SETFOCUS Function
• UI_MODELESS_DLG_SIZING Function

UI_DLG_BOX Function

Syntax

Arguments

titleCharacter

The title of the dialog. The title may also be specified dynamically using the syntax:

Title = "@=" +  Title_Var_Name

dialog_formatCharacter

A series of Xdialog commands that describe the appearance of the dialog box. The basic structure of the Format section is:

<<%dlg%
Xdialog_Code
%dlg%

Argument

Description

<<%dlg%

The only optional part of this argument is the "dlg" sequence of characters (the marker), which can be any string of characters, as long as it is unique within this instance of the UI_DLG_BOX() function. The character sequence <<%dlg% is specifically recommended because it is supported by bubble help.

Xdialog_Code

One or more statements, each of which must be on a separate line from the <<%dlg% and %dlg% arguments.

%dlg%

The marker characters can be any string of characters, as long as they match those in the first argument ( <<%dlg% ).

codeCharacter

Xbasic code that describes what should happen when various events happen when the user is interacting with the dialog box. For example, what should happen when the user presses a button, or when the user tabs out of a field. The basic structure of the Event Handling section is:

<<%code%
Xbasic_code
%code%

Argument

Description

<<%code%

Indicates the start of a code block.

Xbasic_code

One or more statements, each of which must be on a separate line from the <<%code% and %code% arguments.

%code%

Indicates the end of a code block.

Returns

ResultCharacter

The value returned by the dialog. This is typically the name of the BUTTON that was pressed to close the dialog.

Description

Displays a dialog and returns the value of which button was pressed.

Discussion

The UI_DLG_BOX() function displays a modal dialog box and returns a character string.

Example

This example of an extremely simple dialog box with the text "Hello World."

ui_dlg_box("Title","Hello World")

Alternatively:

format = <<%dlg%
"Hello World"
%dlg%
ui_dlg_box("Title", format)

Here is what this dialog box looks like:

Message box displaying the text "Hello World"

Here is a dialog box with a title defined after the dialog box is displayed. The "@" is the indirection operator.

dim dlg_title as C
dlg_title = "Title1"
ui_dlg_box("@=dlg_title",<<%dlg%
<Set Title!settitle>
%dlg%,<<%code%
if a_dlg_button = "settitle" then
    dlg_title = ui_get_text("","Set new title",dlg_title)
     a_dlg_button = ""
end if
%code%)

Message with a button to change the title

Dialog shown when the Set Title button is clicked

Message updated to show the new title

Limitations

Desktop applications only.

See Also

• UI_MODELESS_DLG_BOX Function
• Xdialogs Are Built from Strings
• Xdialog Function Reference
• Xdialog Control Reference