WinRefreshVisible (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Window management functions

Constants for managing the windows

Constants for object visibility

ExecuteRefreshUIParent

FullScreen

Functions for managing windows

RequestRefreshUIParent

WinGiveSuitableHeight

This content has been translated automatically. Click here to view the French version.

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

WinRefreshVisible (Function)

In french: FenRafraîchissementVisible

Modifies or returns the visibility status of refresh bar in a window.

This function can be used when the window supports the "Pull-to-refresh" option. To enable this option in a window:

Open the window description.
In the "Details" tab, in the "Other parameters" area, check "Pull to refresh".
Validate.

Example

// Evénement "Rafraîchissement des données" de la fenêtre
// -------------------------------------------------------------
// Demande à contrôler l'affichage du bandeau de sélection car l'actualisation des
// données de la fenêtre va être effectuée dans un thread secondaire.
// Dans le cas contraire, le bandeau de rafraîchissement serait automatiquement masqué à la
// fin de l'exécution de l'événement.
FenRafraîchissementVisible(FEN_Produits, Vrai)
// Exécute l'actualisation des données de la fenêtre dans un thread secondaire
ThreadExecute("threadMajFen", threadNormal, ProcThreadMajFen)

//----------------------------------------------------
// Procédure de mise à jour des données de la fenêtre
PROCEDURE ProcThreadMajFen()
// Exécution d'une requête HTTP
HTTPRequête(...)
// Retourne dans le thread principal pour afficher le contenu de la requête dans la fenêtre
ExécuteThreadPrincipal(ProcMajUI, HTTPDonneRésultat())
FIN

// ---------------------------------------------------
// Procédure d'actualisation de l’interface de la fenêtre
PROCEDURE ProcMajUI(sDonnees est une chaîne)
// Traitement des données reçues
// ...
// Les données sont à jour, on masque le bandeau de rafraîchissement
FenRafraîchissementVisible(FEN_Produits, Faux)
FIN

Syntax

Modifying the visibility status of refresh bar Hide the details

WinRefreshVisible(<Window> , <Visible>)

<Window>: Window name

Name of window to use.

<Visible>: Boolean

True to display the refresh bar,
False to hide it.

Finding out the visibility status of refresh bar Hide the details

<Result> = WinRefreshVisible(<Window>)

<Result>: Boolean

True if the refresh bar is displayed,
False if the refresh bar is hidden.

<Window>: Window name

Name of window to use.

Remarks

During a "Pull to refresh", the refresh bar corresponds to the area displayed at the top of window during the data refresh.
WinRefreshVisible is used for example to check the display of refresh bar when the data found in the window is refreshed in a secondary thread. This prevents the application from being locked (the example is using this method).
When the refresh banner is made visible by the WinRefreshVisiblefunction, the "Refresh by dragging/releasing" event of the window is not executed.
Remark: It is possible to force the execution of this event by using the ExecuteProcess function with the trtPullToRefreshconstant.
To hide the refresh bar, WinRefreshVisible(False) must be called as many times as WinRefreshVisible(True) was run.

Component: wd260android.aar