SetColumn

Description

Sets the current column in a DataWindow control or DataStore.

Applies to

DataWindow type

Method applies to

PowerBuilder

DataWindow control, DataWindowChild object, DataStore object


Syntax

PowerBuilder

integer dwcontrol.SetColumn ( string column)
integer dwcontrol.SetColumn ( integer column)

Argument

Description

dwcontrol

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

column

The column you want to make current. Column can be a column number or a column name.


Return value

Returns 1 if it succeeds and -1 if an error occurs. If column is less than 1 or greater than the number of columns, SetColumn fails.

If any argument's value is null, in PowerBuilder and JavaScript the method returns null.

Usage

SetColumn moves the cursor to the current column but does not scroll the DataWindow control.

Only a visible editable column can be current. (A column is editable when its tab order value is greater than 0 and its Protect property is not set to 1.) Do not try to set a noneditable column as the current column. If you try to set an invisible editable column as the current column, then the focus will automatically switch to the next visible editable column.

PowerBuilder environment

For use with PowerBuilder ListView controls, see the section called “SetColumn” in PowerScript Reference.

Events

SetColumn can trigger these events:

ItemChanged
ItemError
ItemFocusChanged

Avoiding infinite loops

Never call SetColumn in the ItemChanged, ItemError, or ItemFocusChanged event. Because SetColumn can trigger these events, such a recursive call can cause a stack fault.

Examples

This statement makes the 15th column in dw_Employee the current column:

dw_Employee.SetColumn(15)

See also

GetColumn

GetRow

SetRow