AddLinkMenuItem - Develop Apps

This function is used to add a Menu item to the dynamic menu which is used to navigate to a web page.

AddLinkMenuItem(uniqueComponentID,

menuItemCaption,

menuItemIconUrl,

linkUrl,

linkTarget)

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 menu item	not null or empty	string
linkUrl	The URL of the web page which is displayed when selecting this menu item	not null or empty	string
linkTarget	The target for the navigation: 1. _self- Displays the linked page in the main browser, replacing the current page 2. _new- Displays the linked page in a new browser window 3. _tab- Displays the linked page in a new browser tab 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 the navigation menu item to a dynamic menu False - The navigation 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 "Link 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 - AddLinkMenuItem</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 AddLinkMenuItemToToolbar(){
        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.AddLinkMenuItem(oResult.menusInfo[j].componentID, 
                                                        "Conduit", 
                                                        "http://www.conduit.com/image/logo.gif",
                                                        "http://www.conduit.com",
                                                        "_self");
                    if(oRes.returnValue){
                        resultDiv.innerHTML += "Link menu item 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 += "Link menu 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 link menu 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 Link Menu Item" onclick="AddLinkMenuItemToToolbar()" /></div> <br /> <div id="result"></div> </body> </html>

See code usage
See live demo usage
Live example