ExecuteRefreshUI (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Functions for managing windows

ExecuteRefreshUI

Presentation

Example

"Request for refreshing the display" event

MVP: "Presenter" attribute

See also

ExecuteRefreshUI (Function)

In french: ExécuteMiseAJourIHM

Warning
From version 24, ExecuteUpdateUI is kept for backward compatibility. This function is replaced by ExecuteRefreshUI.

Immediately runs the event "Request for refreshing the display" of the window, page, internal window, internal page, control template or supercontrol.

If the function is called several times during a process, the refresh event will be run several times.

Remark: This function is mainly used:

when refreshing the interface via threads.
when using MVP (Model - View - Presenter) programming. See MVP overview: Model - View - Presenter for more details.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 24 and later

This function is now available for WEBDEV sites in Windows.

This function is now available for WEBDEV sites in Linux.

New in version 24

This function is now available for WEBDEV sites in Windows.

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

This function is now available for WEBDEV sites in Linux.

Example

ExecuteRefreshUI()

Syntax

ExecuteRefreshUI([<Parameter 1> [... [, <Parameter N>]]])

<Parameter 1>: Type of value expected by the event "Request for refreshing the display"

First parameter that will be passed to the event "Request for refreshing the display" of the window or page.

<Parameter N>: Type of value expected by the event "Request for refreshing the display"

Nth parameter that will be passed to the event "Request for refreshing the display" of the window or page.

Remarks

"Request for refreshing the display" event

One of the events associated with the window (or page) is "Request for refreshing the display". This event is used to group the code for refreshing the window (or page) controls: content of controls, state (visible, grayed, etc.), caption to refresh, etc.

This event can receive parameters. Simply declare a procedure in the event. For example:

// Request for refreshing the display
PROCEDURE AskForRefresh(RefreshType is boolean)

This event is started upon request by the following functions:

RequestRefreshUI: Runs the event "Request for refreshing the display" at the end of the current process (asynchronous execution).
ExecuteRefreshUI: Immediately runs the event "Request for refreshing the display".
Versions 22 and later
RequestRefreshUIParent: Runs the event "Request for refreshing the display" of the higher level at the end of the current process (asynchronous execution).
New in version 22
RequestRefreshUIParent: Runs the event "Request for refreshing the display" of the higher level at the end of the current process (asynchronous execution).
RequestRefreshUIParent: Runs the event "Request for refreshing the display" of the higher level at the end of the current process (asynchronous execution).
Versions 22 and later
ExecuteRefreshUIParent: Immediately runs the event "Request for refreshing the display" of the higher level.
New in version 22
ExecuteRefreshUIParent: Immediately runs the event "Request for refreshing the display" of the higher level.
ExecuteRefreshUIParent: Immediately runs the event "Request for refreshing the display" of the higher level.

When these functions are called, you can specify the value of the parameters expected by "Request for refreshing the display".

Remark: The event "Request for refreshing the display" can also be immediately run by ExecuteProcess with the following syntax:

ExecuteProcess(<Element name>, trtRequestUpdate)

MVP: "Presenter" attribute

The presenter attribute is used to associate a class of the presenter layer with a view (window, page or report). This attribute is mainly used in the global declaration of the windows generated by the MVP RAD.

For example:

PROCEDURE WIN_Table_MyExampleFile(...
gclPresenter is PTableMyExampleFile dynamic <presenter>=Null)

When this attribute is used, the call to the "Request for refreshing the display" event of the window (or page) will be triggered by:

any call to RequestRefreshUI from a class declared as <presenter>,
any call from any class associated with the <presenter> class.

For more details, see MVP RAD: "Presenter" attribute.

Business / UI classification : Neutral code

Component : wd260vm.dll