AddGadgetMenuItem - Develop Apps

This function is used to add a Customized Gadget Menu item to the dynamic menu.

AddGadgetMenuItem(uniqueComponentID

menuItemCaption,

menuItemIconUrl,

linkUrl,

width,

height,

defaultTarget)

Parameter	Description	Range	Type
uniqueComponentID	The dynamic menu’s unique ID. The new item is added to this dynamic menu	not null or empty	string
menuItemCaption	The text to display on the dynamic menu item	not null or empty	string
menuItemIconUrl	The URL of the icon which is displayed on the dynamic menu item	not null or empty	string
linkUrl	The URL of the web page which is displayed, when selecting this gadget	not null or empty	string
width	The width of the Gadget (in pixels)	>0	int
height	The height of the Gadget (in pixels)	>0	int
defaultTarget	A Gadget is an HTML document that may include links. The default target for these links can be one of the following: 1. _self - Displays the link in the same window or frame that contains the Gadget 2. _main - Displays the link in the full browser window, replacing the current page 3. _new - Displays the link in a new browser window Default: _self.	Optional.	string

An object that contains the following fields:

Field Name	Description	Type
returnValue	Indicates whether the operation was successful. True - The function adds a customized Gadget menu item to the dynamic menu False - The menu item is not added to the dynamic menu. Check the value of the errorCode to determine the specific reason for the function failure	boolean
errorCode	Specific error code. See Error Code Table for additional information.	int

*Notice: API methods must be invoked after the web page has triggered the "onload" event.

This example contains a button that when clicked upon will insert a Gadget Menu item for each available dynamic menu on the Conduit demo toolbar.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head>    <title>Conduit Toolbar API - AddCommandMenuItem</title> <!-- Conduit API script declaration --> <script language="javascript" type="text/javascript" src="http://api.conduit.com/ToolbarApi.js"></script>  <script language="javascript" type="text/javascript">
    function AddCommandMenuItemToToolbar(){
        var resultDiv = document.getElementById('result');
        resultDiv.innerHTML = "";
        var oToolbar = new TPI.Toolbar("CT2275160");
        var oResult = oToolbar.GetSupportedUserAddMenu();
        if(oResult.returnValue){
            if(oResult.menusInfo.length == 0){	
                resultDiv.innerHTML += "No menus to add items to toolbar<br/>";
            }
            else{ 
                for(var j=0; j<oResult.menusInfo.length; j++){
                    var oRes = oToolbar.AddCommandMenuItem(oResult.menusInfo[j].componentID,
                                                           "Conduit",
                                                           "http://www.conduit.com/image/logo.gif",
                                                           "ABOUT");
                    if(oRes.returnValue){
                        resultDiv.innerHTML += "Command item was successfully added to toolbar id: CT2275160, component id: " + oResult.menusInfo[j].componentID + ", component caption: " + oResult.menusInfo[j].caption +  "<br/>";
                    }
                    else{
                        if(oRes.errorCode == 12){
                            resultDiv.innerHTML += "Command item already exist in toolbar id: CT2275160, component id: " + oResult.menusInfo[j].componentID + ", component caption: " + oResult.menusInfo[j].caption + "<br/>";
                        }
                        else{
                            resultDiv.innerHTML += "Failed to add Command item to toolbar id: CT2275160, component id: " + oResult.menusInfo[j].componentID + ", component caption: " + oResult.menusInfo[j].caption + ", ErrorCode = " + oRes.errorCode + "<br/>";
                        }
                    }
                }
            }                         
        }
        else{
            resultDiv.innerHTML += "Failed to retrive information for toolbar id = CT2275160<br/>";
        }
    }
</script>  </head> <body>  <div><input type="button" value="Add Gadget Item" onclick="AddGadgetMenuItemToToolbar()" /></div> <br /> <div id="result"></div> </body> </html>

See code usage
See live demo usage
Live example