GetColumn method (DataWindows)
Description
Obtains the number of the current column. The current column
is the column that has focus.
Controls
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control, DataWindowChild object, DataStore |
|
Web |
Client control, server component |
|
Web ActiveX |
DataWindow control, DataWindowChild object |
Syntax
[PowerBuilder]
|
1 |
integer <span>dwcontrol</span>.<span>GetColumn</span> ( ) |
[Web DataWindow client control and Web ActiveX]
|
1 |
number <span>dwcontrol</span>.<span>GetColumn</span> ( ) |
[Web DataWindow server component]
|
1 |
short <span>dwcontrol</span>.<span>GetColumn</span> ( ) |
|
Argument |
Description |
|---|---|
|
dwcontrol |
A reference to a DataWindow control DataStore, |
Return Values
Returns the number of the current column in dwcontrol.
Returns 0 if no column is current (because all the columns have
a tab value of 0, making all of them uneditable), and –1
if an error occurs.
If dwcontrol is null, in PowerBuilder
and JavaScript the method returns null.
Usage
GetColumn and GetClickedColumn,
when called in the Clicked or DoubleClicked event, can return different
values. The column the user clicked does not become current until
after the event.
Use GetColumnName (instead of GetColumn)
when you need the column’s name. Use SetColumn to
change the current column.
PowerBuilder environment
For use with PowerBuilder ListView controls, see GetColumn in
the PowerScript Reference.
The current column
A column becomes the current column after the user tabs to
it or clicks it or if a script calls the SetColumn method.
A column cannot be current if it cannot be edited (if it has a tab
value of 0).
A DataWindow always has a current column, even when the control
is not active, as long as there is at least one editable column.
Examples
These statements return the number of the current
column in dw_Employee:
|
1 |
integer li_ColNum |
|
1 |
li_ColNum = dw_employee.<span>GetColumn</span>() |