.select( "multiple", value )

Previous Next

Changes the selection state of rows in a set. Contrast with the Rows.select( "multiple" ) function, which changes the selection state of the current row.

Returns the 'this' object.

Syntax

.select( "multiple"value )

 

value   ::=  { boolean-value string-value }

 

boolean-value  ::=  { true | false }

string-value  ::=  { extend | replace | toggle }

The required literal string "multiple" distinguishes this function from the Rows.select(options) function.

The optional value can be a boolean or a string. Boolean values of value have the following meaning:

Value

Description

true

Sets the selection state of all records in scope.

false

Unsets the selection state of all records in scope.

If value is a string value, the following values are allowed:

Value

Description

extend

Sets the selection state of all records in scope.

replace

Unsets the selection state of all records in scope.

toggle

Toggles the selection state of all records in scope.

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.

 

Examples

$.udb('EMP').rows('selected').select('multiple', false);

 

$.udb('EMP').rows([5,6,7,8]).select('multiple', 'extend');

 

See also

.select( options )

.select( "multiple" )