WARNING: The information on this documentation will change as the development on this version of DHTML Menu Builder progresses.
It is VERY important that you always refer to the information provided in this document prior to testing new versions of the DynAPI code.

objid dmbAPI_getItemByCaption(Caption, Frame, [ParentItem])

Description

Retrieves the id of an item whose caption is the text passed on the Caption parameter.
The returned id can be used with all functions that expect a parameter type of 'objid'. The function will return null if no item is found.

Code sample

var id = dmbAPI_getItemByCaption("My Command");

This sample demonstrates how to obtain a reference to a menu item based on its caption.

---

Code sample

var id = dmbAPI_getItemByCaption("Products", cFrame, 2);

This sample demonstrates how to obtain a reference to a toolbar item whose caption is "Products" and its located in the toolbar whose index is 2.

---

Code sample

var id = dmbAPI_getItemByCaption("Contact Us", mFrame, "MyGroup");

This sample demonstrates how to obtain a reference to a command whose caption is "Contact Us" and its located in the group whose name is "MyGroup".

Parameters