Method XbpStatusBar():getItem() Foundation

Retrieves an item (panel) from the XbpStatusBar object's item array.

:getItem( <nItem> | <cItemKey ) => oPanel
<nItem> is a numeric value that specifies the ordinal position of the status bar panel to be retrieved. Item positions are counted starting from one.
The item to be retrieved may also be specified using its unique identifier. For this, a character string must be passed in parameter <cItemKey>.

The method :getItem() returns a XbpStatusBarPanel() object.


The method :getItem() can be used by an Xbase++ application to retrieve reference to one of the status bar panels defined. The reference can be used to modify the status bar panel's properties. Thus, assignment of a new caption string or modification of the image displayed by a statusbar panel object, is made possible at run time.

The item to be retrieved may be specified using either its ordinal position or key. Addressing the item via it unique key string is recommended for better readability of the source code and easier source code maintenance.


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.