Method XbpBrowse():getColumn() Foundation

Retrieves a reference to a column (XbpColumn object ) in an XbpBrowse object.

:getColumn( <nColPos> ) --> oXbpColumn
<nColPos> is a numeric value which indicates which XbpColumn object reference is required.

:getColumn() returns a reference to the XbpColumn object held in position <nColPos>.


When the numeric value <nColPos> is passed to the method :getColumn(), the XbpBrowse object returns a reference to the corresponding column object. Using the reference, changes to the column can be made that also update the column definition stored with the XbpBrowse. However, such changes are not immediately realized. Only when the XbpBrowse is notified explicitly through a :configure() or :refreshAll() will the changes to the column be visible.

:getColumn() examines columns in the order they were added to the browse. This so-called creation order may be different from the order the columns are displayed on-screen. This is because column ordering may be changed at runtime, for example using the :setLeftFrozen() method. The value in <nColPos> specifies the ordinal number of the desired column in creation order.


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.