Rows.select()

Rows.select()

Changes the selection state of one or more of the rows.

Returns a Promise object or the 'this' object, except when you pass the “multiple” argument without a value argument (the first syntax option shown below), in which case the multiple selection value of the first row object is returned. This value indicates whether the row is in the set of rows currently selected. If this is the case, the row is not necessarily the current row. From USoft 10.0.1I, returns a udbPromise instead of a Promise object.

rows.select( "multiple" )
rows.select( "multiple", value )
rows.select( options )

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

boolean-value  ::=  { true | false }
string-value  ::=   { extend | replace | toggle }

options     ::=  {
     promise:  promise,
     success:  success-function,
     error:  error-function
}

promise     ::=  { true | false }

• If you pass the “multiple” literal without a value, the selection state of the current row is changed.
• If you pass the “multiple” literal with a value, the selection state of all the rows in the set is changed to value.
• If you pass options, the first record in the set is selected, thereby potentially changing the selection state of other rows in the set.

The optional value can be passed as a boolean or a string. Boolean values of value can be:

String values of value can be:

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.

Examples

This example changes the selection state of the current row:

$.udb('EMP').rows().select('multiple');

This example unsets the selection state of all selected rows:

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

This example sets the selection state of all rows in scope:

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

Each of these examples selects the first record in the row set, thereby potentially changing the selection state of rows in the set.

$.udb('EMP').rows().select();
$.udb('EMP').rows(0).select();

Related events