Refresh Grid event

Official Content
This documentation is valid for:

Defines an action that must be taken before the Grid control is loaded. It is executed immediately before loading the grid. Data shown in the form is loaded from the database into the grid.

Syntax

Event grid_control.Refresh
     event_code
EndEvent

Where:
grid_control
     Name of the grid control.
event_code
     Code associated with the event.

Example

A Web Panel object or a Panel object displays Customer Invoices for a certain date range.

The conditions are:

SupplierId = &SupplierId;
PoDate >= &Date1;
PoDate <= &Date2;

So, if the end-user were to change the values of &SupplierId, &Date1, or &Date2, the grid must be reloaded to display the new information that satisfies the new condition.
Thus, the refresh event associated with that grid is executed.

Notes

The Refresh event is triggered (i.e. the grid is reloaded):

  • After the Start Event.
  • When the Refresh command has been executed from within another Event (usually the Enter event, or a User Defined event).
  • On Web Generator:
    • When executing Refresh command and Web User Experience property is Smooth, the Refresh of the grid is not executed in a POST HTTP unless the Grid Refresh method is executed.
    • Anytime the user chooses the Refresh option from the Menu Bar (or presses F5).
    • If Automatic refresh property of the web panel is "When variables in conditions change" when a variable appearing in Conditions is modified by the user (a Web Panel that displays attribute values) the Refresh event of the grid is triggered. This is because the value of the variables used in conditions will determine the range of attributes to be displayed in the Grid. 

 

Scope

Objects Web Panel objectPanel objectWork With for Smart Devices object
Controls Grid control
Platforms Web (.NET, Java), Smart Devices (iOS, Android)

 

See Also