Method XbpBrowse():insColumn() Foundation

Inserts a column (XbpColumn object) into an XbpBrowse object.

Syntax
:insColumn( <nColPos>, <oXbpColumn> ) --> oXbpColumn
or
:insColumn( <nColPos>, <bDataLink>, ;
                      [<nWidth>], ;
                      [<cHeading|nHeadID>], ;
                      [<cFooting|nFootID>], ;
                      [<nType>] ) --> oXbpColumn
Parameters
<nColPos>
<nColPos> is a numeric value indicating the position in the browser's column array at which the XbpColumn object should be inserted.
<...>
All other parameters are identical to the parameters of method :addColumn(). See there.
Return

:insColumn() returns a reference to the newly inserted XbpColumn object.

Description

:insColumn() inserts an XbpColumn object into an XbpBrowse object. The numeric value <nColPos> must be passed and indicates the position in the browser's column array at which the column object should be inserted. The second parameter must be a configured XbpColumn object or a data code block. In the latter case, the XbpBrowse object creates an XbpColumn object and inserts it into itself.

Except for the first parameter, the parameters of :insColumn() are identical to the ones of :addColumn() and are described there.

After :insColumn() completes, the column's unique position in the browser's column array is reflected in the :index member variable of the column. This position is used as the column's identifier in methods like :delColumn().

Feedback

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.