RequestRefreshUI (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Window management functions

RequestRefreshUI

Presentation

Example

"Request for refreshing the display" event

"Presenter" attribute

See also

RequestRefreshUI (Function)

In french: DemandeMiseAJourUI

Warning
From version 24, RequestUpdateUI is kept for backward compatibility. This function is replaced by RequestRefreshUI.

Requests the execution of the event "Request display update" (and returns the hand without waiting for the execution of the event).

Remarks:

The event "Display Update Request" is available on windows, internal windows, pages, internal pages, field templates and superfields.
If this function is called several times, calls with the same parameters not yet executed are ignored.
In the case of a call in main the thread, the execution(s) of the "Display Update Request" event will be performed at the end of the current processing.
In the case of a call in a secondary thread, the execution(s) of the "Display Update Request" event will be performed when the window is refreshed.

Uses: This function is mainly used:

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

Caution: This function is available for the Android applications from version 200066.

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

// Process records
// The graphic interface will have to be refreshed
RequestRefreshUI()

// -----------------------------------------------------------------
// -- Request for refreshing the display of WIN_Contact_Form
// Refresh the title of the window
MySelf..Title = gpclContactForm.p_sFullname

// Refresh the linked controls of the window
SourceToScreen()

Syntax

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

<Parameter 1>: Optional parameter corresponding to the type expected by the event "Request for refreshing the display"

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

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

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

Remarks

"Request for refreshing the display" event

One of the events associated with the window is "Request for refreshing the display". This event is used to group the code for refreshing the window 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
PROCÉDURE 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. When these functions are called, you can specify the value of the parameters expected by "Request for refreshing the display".
Remark: The element whose event "Request for display update" is executed depends on the code from which the functionRequestRefreshUI was called up.. If it is a class having the presenterattribute, the element considered will be the window associated with the class, otherwise it will be the element from which the code was launched.
New in version 22
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 element whose event "Request for display update" is executed depends on the code from which the functionRequestRefreshUI was called up.. If it is a class having the presenterattribute, the element considered will be the window associated with the class, otherwise it will be the element from which the code was launched.
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 element whose event "Request for display update" is executed depends on the code from which the functionRequestRefreshUI was called up.. If it is a class having the presenterattribute, the element considered will be the window associated with the class, otherwise it will be the element from which the code was launched.

"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 in WINDEV.

For example:

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

Thanks to this attribute, the call of the "Display Update Request" event in the window will be triggered by:

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

See MVP RAD: "Presenter" attribute for more details.

Business / UI classification: Neutral code

Component: wd260vm.dll