• 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_OPTIONAL_EVENT Function

Syntax

Arguments

title

The name of the dialog.

event

The name of the event to pass.

immediate

Optional. Default = .F. Whether to wait until the event is processed. .T. = Wait until event is processed. .F. = Do not wait.

Description

Invoke an action event in the named dialog, but only if named dialog exists.

Discussion

The UI_DLG_OPTIONAL_EVENT() function invokes an action event in the specified dialog, but only if the specified dialog exists. This allows you to leave out code in your script that tests to see if the dialog actually exists (using the ui_modeless_dlg_exist() function).

Example

This example receives and displays status from multiple user defined functions.

function status_list as v ()
dim completed as C
dim message2 as C
completed = ""
ui_modeless_dlg_box("StatusList",<<%dlg%
Completed:;
[.100,5^#completed];
Current task:;
[.100message2?.t.];
;
%dlg%,<<%code%
if (a_dlg_button = "close") then
       ui_modeless_dlg_close("statuslist")
end if
if (atc("Completed:",a_dlg_button) = 1) then
       completed_i = substr(a_dlg_button,11)
       completed = completed + crlf()+ completed_i
       completed = remove_blank_lines(completed)
       ui_modeless_dlg_refresh("statuslist")
end if
if (atc("Working:",a_dlg_button) = 1) then
       message2 = substr(a_dlg_button,9)
       ui_modeless_dlg_refresh("statuslist")
end if
%code%)
end function

The calling user defined function calls the StatusList dialog with variations of the following syntax:

ui_dlg_optional_event("StatusList", "working:Listing files in " + directory, .t.)
ui_dlg_optional_event("StatusList", "completed:Adding " + directory + " files to database", .t.)

The following example sends an event from the parent modeless dialog to the embedded child modeless dialog.

ui_modeless_dlg_box("ParentDialog",<<%dlg%
{startup=init}
{frame=1,1}
{embedded=40,20:ChildDialog};
{lf};
{sp};
%dlg%,<<%code%
if a_dlg_button = "Hello" then
       ui_dlg_optional_event("ChildDialog","Hello",.t.)
       ui_msg_box("","Another message from the parent dialog")
end if
if a_dlg_button = "init" then
       a_dlg_button = ""
       show_embedded(local_variables())
end if
if a_dlg_button = "close" then
       ui_modeless_dlg_close("ParentDialog")
end if
%code%)
function show_embedded as v (vars as P)
       with vars
ui_modeless_dlg_box("ChildDialog",<<%dlg%
{wrap=40}
This is an embedded dialog box that responds to the Hello event sent to it from its parent.;
{lf};
Name: [.20name];
{lf};
Enter a name into the Name field and click this button. After 2 seconds, the "Hello" dialog box will appear.;
{lf};
;
%dlg%,<<%code%
if a_dlg_button = "Hello" then
       sleep(2)
       ui_msg_box("","Hello: " + name)
end if
%code%)
 
       end with
end function

Limitations

Desktop applications only.

See Also

• Xdialog Function Reference
• UI_MODELESS_DLG_EXIST()
• UI_DLG_EVENT()