xforms-select-before-data-fill

This event is fired when the values of the Select or List control are populated.

Syntax

DesignTime

This is a design-time property and can be set through the property sheet of the control.

Event Information

To invoke	Open a form that contains the Select or List control
Default Action	Fires when the values of the Select or List box control are populated. It is fired for each value that is populated.
Named Script	xforms-select-before-data-fill

Event Object Properties

Property	Description
description	Description of the option added to the control
inputOption	Object that denotes the option object that is used to fill the Select or List controls. This option object consists of the value, description, xml, and businessObject properties.
returnValue	Boolean that denotes whether the fill operation should continue or not. To cancel the event, user can set the value of this property to false. true: Default. Fill operation should be continued. false: Fill operation should not be continued.
srcElement	Control that fired the event
xml	Business object bound to the control
oFormatType	Object. Format object that contains the dataType and other formatting attributes. This object must be retrieved using the getFormatType() method.

An event handler can access the event object and its properties through the eventObject available as a parameter on the handler.

Remarks

This event fires when the Select and List controls are set to be filled automatically. However, if you use the addOption and addOptions methods to manually fill the Select and List controls, this event does not fire.

Applies to