Method XbpToolBar():getItem() Foundation

Retrieves an item (button) from the XbpToolBar object's item array.

:getItem( <nItem> | <cItemKey ) => oButton
<nItem> is a numeric value that specifies the ordinal position of the tool bar button to be retrieved. Item positions are counted beginning 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 XbpToolBarButton object.


The method :getItem() can be used by an Xbase++ application to retrieve a reference to one of the tool bar buttons defined. The reference can be used to modify the tool bar button's properties. This allows to assign a new caption string at run time or to modify the image displayed by a toolbar button object.

The item to be retrieved may be specified using either its ordinal position or key. Addressing the item via it's unique key string is actually recommended for better source code readability and easier 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.