system.db.refresh

Description

This function will programmatically cause a SQL Query or DB Browse property binding to execute immediately. This is most often used for bindings that are set to Polling - Off. In this way, you cause a binding to execute on demand, when you know that the results of its query will return a new result. To use it, you simply specify the component and name of the property on whose binding you'd like to refresh.

Syntax

system.db.refresh(component, propertyName)

Parameters

JComponent component - The component whose property you want to refresh

String propertyName - The name of the property that has a SQL Query binding that needs to be refreshed

Returns

boolean - True (1) if the property was found and refreshed successfully.

Scope

Client

Examples

This example could be placed in the actionPerformed event of a Button, to be used to refresh the data of a Table. Remember to use the scripting name of the property that you're trying to refresh, and that the property names are case-sensitive.

table = event.source.parent.getComponent("Table")

system.db.refresh(table, "data")