SelectRow

Description

Highlights or removes highlights from rows in a DataWindow control or DataStore. You can select all rows or a single row. SelectRow does not affect which row is current. It does not select rows in the database.

Applies to

DataWindow type

Method applies to

PowerBuilder

DataWindow control, DataWindowChild object, DataStore object

Web

Client control

Web ActiveX

DataWindow control, DataWindowChild object

Syntax

PowerBuilder

integer dwcontrol.SelectRow ( long row, boolean select )

Web ActiveX

number dwcontrol.SelectRow ( number row, boolean select ) 

Argument

Description

dwcontrol

A reference to a DataWindow control, DataStore, or child DataWindow.

row

A value identifying the row you want to select or deselect. Specify 0 to select or deselect all rows.

select

A boolean value that determines whether the row is selected or not selected:

  • True – Select the row(s) so that they are highlighted.

  • False – Deselect the row(s) so that they are not highlighted.

Returns

Returns 1 if it succeeds and –1 if an error occurs. If any argument’s value is null, in PowerBuilder and JavaScript the method returns null. If there is no DataWindow object assigned to the DataWindow control or DataStore, the method returns 1.

Usage

If a row is already selected and you specify that it be selected (boolean is true), it remains selected. If a row is not selected and you specify that it not be selected (boolean is false), it remains unselected.

Examples

Example 1

This statement selects the fifteenth row in dw_employee:

dw_employee.SelectRow(15, true)

Example 2

As the script for a DataWindow’s Clicked event, this example removes highlighting from all rows and then highlights the row the user clicked. Row is an argument passed to the event script:

This.SelectRow(0, false)

This.SelectRow(row, true)

See also