GetClickedColumn method (DataWindows)
Description
Obtains the number of the column the user clicked or double-clicked
in a DataWindow control or DataStore object.
Controls
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control, DataWindowChild object, DataStore |
|
Web |
Client control |
|
Web ActiveX |
DataWindow control, DataWindowChild object |
Syntax
[PowerBuilder]
|
1 |
integer <span>dwcontrol</span>.<span>GetClickedColumn</span> ( ) |
[Web DataWindow client control and Web ActiveX]
|
1 |
number <span>dwcontrol</span>.<span>GetClickedColumn</span> ( ) |
|
Argument |
Description |
|---|---|
|
dwcontrol |
A reference to a DataWindow control, |
Return Values
Returns the number of the column that the user clicked or
double-clicked in dwcontrol. Returns 0 if the
user did not click or double-click a column (for example, the user
double-clicked outside the data area, in text or spaces between
columns, or in the header, summary, or footer area).
If dwcontrol is null, in PowerBuilder
and JavaScript the method returns null.
Usage
Call GetClickedColumn in the Clicked or
DoubleClicked event for a DataWindow control.
When the user clicks on the column, that column becomes the
current column after the Clicked or DoubleClicked event is finished.
During those events, GetColumn and GetClickedColumn can
return different values.
If the user arrived at a column by another means, such as
tabbing, GetClickedColumn cannot identify that
column. Use GetColumn instead to identify the
current column.
Examples
These statements return the number of the column
the user clicked or double-clicked in dw_employee:
|
1 |
integer li_ColNbr |
|
1 |
li_ColNbr = dw_employee.<span>GetClickedColumn</span>() |