onbeforerefresh |
This event is fired before the view or component has been refreshed on click of Refresh button of the Control Bar.
Syntax
| DesignTime | This is a design-time property and can be set through the property sheet of the control. |
Event Information
| To invoke | Click the Refresh button in the control bar to fire this event. |
| Default Action | Initiates any events associated with this event. |
| Named Script | onbeforerefresh |
Event Object Properties
An event handler can access the event object and its properties through the eventObject available as a parameter on the handler.
| Property | Description |
|---|---|
| returnValue | Boolean that denotes whether the Refresh operation can be continued or not. To cancel the event, user can set the value of this property to false. |
| true | Default. Refresh operation should be continued. |
| false | Refresh operation should not be continued. |
| srcElement | Reference to the Refresh button. |