xforms-onfind

This event is fired when a business object(s) is searched by using the Find button.

Syntax

To invoke

Click the Find button on the pagination bar.

Event Information

To invoke	Click the Find button on the pagination bar.
Default Action	Initiates any action associated with this event.
Named Script	xforms-onfind

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
parameters	Collection that denotes the parameters available for performing the search. The collection has the following elements: parameter: Denotes the name of the search parameter. value: Default value of the parameter. This is a read-only property.
request	Denotes the complete request object that will be fired when performing a search.
returnValue	Boolean that denotes whether the Find operation should be performed or not. To cancel the event, user can set the value of this property to false. true: Default. Find operation should be continued. false: Find operation should not be continued.
scope	String that defines the scope of the search. The following are the possible values: default: Performs a local search and, if the object is not found, performs a global search. This is the default value. local: Performs a local search. global: Performs a global search.

Remarks

If the parameters specified in the event do not match the original parameters in the request, then only the existing dataset is searched. This event does not work with non-transactional models. It will not fire when the search is performed using the find() method of the model.

Applies to