<Table>.RefreshVisible (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Table functions

Prefix syntax

RefreshVisible

Presentation

Example

See also

<Table>.RefreshVisible (Function)

In french: <Table>.RafraîchissementVisible

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

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

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

This function is available in WINDEV and is used only in simulator mode. In a WINDEV application, this function has no effect.

Example

// "Pull to refresh" process of Table control
// ---------------------------------------------------------
// Check the display of selection bar because the refresh of
// Table control data will be performed in a secondary thread.
// Otherwise, the refresh bar would be automatically hidden at the
// end of process execution.
TABLE_Data.RefreshVisible(True)
// Refreshes the data of Table control in a secondary thread
ThreadExecute("ThreadUpdTable", threadNormal, ProcThreadUpdTable)

//----------------------------------------------------
// Procedure used to update the data in the Table control
PROCEDURE ProcThreadTableUpdate()
// Run an HTTP request
HTTPRequest(...)
// Goes back to the main thread to add the request content into the Table control
ExecuteMainThread(ProcUpdTable, HTTPGetResult())
END

// ---------------------------------------------------
// Procedure for filling data in the Table control
PROCEDURE ProcUpdateTable(sData is string)
// Process the received data in order to populate the Table control
...
// The Table control data is updated, hide the refresh bar
TABLE_Data.RefreshVisible(False)
END

Syntax

Changing the state of the refresh bar Hide the details

<Table control>.RefreshVisible(<Visible>)

<Table control>: Control name

Name of the control to be used. This control can correspond to:
a Table control.
a TreeView Table control.

<Visible>: Boolean

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

Getting the state of the refresh bar Hide the details

<Result> = <Table control>.RefreshVisible()

<Result>: Boolean

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

<Table control>: Control name

Name of the control to be used. This control can correspond to:
a Table control.
a TreeView Table control.

Remarks

During a "Pull to refresh", the refresh bar corresponds to the area displayed above the rows of the Table control during the data refresh.
<Table>.RefreshVisible is used for example to check the display of refresh bar when the data found in the Table control is refreshed in a secondary thread. This prevents the application from freezing (the example uses this method).
When <Table>.RefreshVisible makes the refresh bar visible, the "Pull to refresh" event of the Table control is not executed.
Remark: You can force the execution of this event by using ExecuteProcess with the trtPullToRefresh constant.
To hide the refresh bar, <Table>.RefreshVisible(False) must be called as many times as <Table>.RefreshVisible(True) was run.

Component: wd280java.dll