.select( options )

Previous Next

Selects the first record in the row set, thereby potentially changing the selection state of rows in the set. Contrast with .select( "multiple" ) and .select( "multiple", value ).

Returns a Promise object or the 'this' object.


.select( options )


options     ::=  {

     promise:  promise

     success:  success-function

,    error:  error-function



promise     ::=  true | false }

Options is a struct that can have the following items, all of which are optional.

If promise has the value 'true' (the default), a Promise object is returned. If promise has the value 'false', the ‘this’ object is returned instead.

Success-function is a function called after the records are successfully removed.

Error-function is a function called if an error occurs.

NOTE: Before the .select operation is performed, the 'rowpreselect' event is triggered. if the event handler sets the 'success' member of the result object parameter to 'false', then the action is aborted and the current row will not change. Otherwise, the action is performed and following it, the 'rowpostselect' event is triggered as a final step.




See also

.select( "multiple" )

.select( "multiple", value )