LooperRefreshVisible (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

See also

LooperRefreshVisible (Function)

In french: ZoneRépétéeRafraîchissementVisible

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

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

Display the Looper control description window.
In the "Details" tab, in the "Moves and gestures" area, check "Pull to refresh".
Validate.

This function is available in WINDEV only in order to be used in simulator mode. Used in a WINDEV application, this function has no effect.

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.

Example

// Event "Pull to refresh" of a Looper control
// -----------------------------------------------------------------------------
// Asks to check the display of selection bar because the refresh of
// Looper control data will be performed in a secondary thread.
// Otherwise, the refresh bar would be automatically hidden at the
// end of process execution.
LooperRefreshVisible(LOOP_Data, True)
// Refreshes the data of the Looper control in a secondary thread
ThreadExécute("threadUPDLoop", threadNormal, ProcThreadUPDLoop)

// Procedure for refreshing the data of the Looper control
PROCÉDURE ProcThreadUPDLoop()
// Run an HTTP request
HTTPRequest(...)
// Go back to the main thread to add the request content into the
// Looper control
ExecuteMainThread(ProcUPDLoop, HTTPGetResult())
END

// Procedure for filling data in the Looper control
PROCÉDURE ProcUPDLoop(sData is string)
// Process the received data in order to fill the Looper control
...
// The Looper control data is refreshed,
// hide the refresh bar
LooperRefreshVisible(LOOP_Data, False)

END

Syntax

Modifying the visibility status of refresh bar Hide the details

LooperRefreshVisible(<Looper control> , <Visible>)

<Looper control>: Control name

Name of Looper control 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> = LooperRefreshVisible(<Looper control>)

<Result>: Boolean

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

<Looper control>: Control name

Name of Looper control to use.

Remarks

During a "Pull-to-refresh", the refresh bar corresponds to the area displayed above the cells of the Looper control during the data refresh.
The LooperRefreshVisible function allows, for example, to control the display of the refresh banner when updating Looper control data in a secondary thread. This prevents the application from being locked (the example is using this method).
When LooperRefreshVisible makes the refresh bar visible, the event "Refreshing by pull/release" of the Looper control is not run.
Remark: It is possible to force the execution of this event by using function ExecuteProcess with the constant trtPullToRefresh.
To hide the refresh banner, it is necessary to call LooperRefreshVisible(False) as many times as LooperRefreshVisible(True) has been executed.

Component: wd260java.dll