AddCommandMenuItem - Develop Apps

This function is used to add a "Command Menu" item to the dynamic menu.

AddCommandMenuItem(uniqueComponentID,

menuItemCaption,

menuItemIconUrl,

commandType)

Parameter	Description	Range	Type
uniqueComponentID	The dynamic menu's unique ID	not null or empty	string
menuItemCaption	The text on the menu item	not null or empty	string
menuItemIconUrl	The URL of the icon which is displayed on the menu item	not null or empty	string
commandType	Text describing the executed command, such as CONTACTUS, ABOUT, CLEAN_HISTORY, etc.	not null or empty	string

An object that contains the following fields:

Field Name	Description	Type
returnValue	Indicates whether the operation was successful. True - The function adds a command menu item to the dynamic menu False - The command 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 Command 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 Command Item" onclick="AddCommandMenuItemToToolbar()" /></div> <br /> <div id="result"></div> </body> </html>

See code usage
See live demo usage
Live example