Method XbpToolBarButton():getItem()

Retrieves a menu item from a tool bar button's drop-down menu.

:getItem( <nItem> | <cItemKey ) => oMenuItem

<nItem>

<nItem> is a numeric value that specifies the ordinal position of the menu item in tool bar button's menu item array. 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 reference to the XbpToolBarButtonMenuItem object representing the menu item.

The method :getItem() can be used by an Xbase++ application to retrieve a reference to one of the menu items defined for an XbpToolBarButton object. The reference can be used to item's properties. This allows to assign a new caption string at run time.

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.

Method XbpToolBarButton():getItem() Foundation