GetSupportedUserAddMenu - Develop Apps

Conduit API

Case Study

Web Page API -> GetSupportedUserAddMenu

- Description

This function is used in order to get an array of the toolbar's menus, which may be used in order to add menu items.

- Syntax

GetSupportedUserAddMenu()

- Parameters

None.

- Return Value

An object that contains the following fields:

Field Name	Description	Type
returnValue	Indicates whether the operation was successful. True - The function returns the current toolbar information successfully False - The toolbar information is not retrieved and the function was not completed successfully. 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
menusInfo	Array of objects containing information about the menus	array

Each menusInfo contains the following menu's information:

Field Name	Description	Type
componentID	Menu's component ID	string
caption	Text of the toolbar's menu button.	string
iconUrl	URL of the toolbar's button icon.	string

- Remarks

Since this function returns an array of objects - the array's length field may be used.
*Notice: API methods must be invoked after the web page has triggered the "onload" event.

- Code Example

This example contains a button that when clicked upon will retrieve information regarding all available menus, which may be added from all installed and visible Conduit powered toolbars. 
<!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 powered toolbar API - GetSupportedUserAddMenu</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 GetToolbarsSupportedUserAddMenu(){
        var resultDiv = document.getElementById('result');
        resultDiv.innerHTML = "";
        // First get the list of all toolbars currently installed and visible.
        var oToolbar = new TPI.Manager();
        var oList = oToolbar.GetAllToolbarsInfo();
 
        // Handle the case where no toolbars are installed.
        if (!oList.length){
            resultDiv.innerHTML = "There are no Conduit powered toolbars installed on your browser. Please install a Conduit powered toolbar in order to see this example demo.";
        }
        // If the case is that at least one toolbar
        // is installed, add the Gadget to each toolbar.
        else{
            for(var i=0;i<oList.length;i++){
                var oToolbar = new TPI.Toolbar(oList[i].CTID);
                var oResult = oToolbar.GetSupportedUserAddMenu();
                if(oResult.returnValue){
                    resultDiv.innerHTML += "<a style=\"text-decoration:underline\"><strong>" + oList[i].CTID + "</strong> info:</a><br/>";
                    if(oResult.menusInfo.length == 0){	
                        resultDiv.innerHTML += "No menus to add items to toolbar<br/>";
                    }
                    else{
                        for(var i=0; i<oResult.menusInfo.length; i++){
                            resultDiv.innerHTML += i+1 + ". Caption: " + oResult.menusInfo[i].caption + "<br/>" +
                                                         "  Component id: " + oResult.menusInfo[i].componentID + "<br/>" +
                                                         "  Icon url: " + oResult.menusInfo[i].iconUrl + "<br/>";
                        }
                    }
                    resultDiv.innerHTML += "<br/>---------------------------------------------<br/>"; 
                }
                else
                {
                    resultDiv.innerHTML += i + ". Failed to retrive information for toolbar id = " + oList[i].CTID + "<br/>";
                }                                                            
            }
        }
    }
</script>  </head> <body>  <div><input type="button" value="Get Supported User Add Menu" onclick="GetToolbarsSupportedUserAddMenu()" /></div> <br /> <div id="result"></div> </body> </html>                                                  

- Code Usage

See code usage
See live demo usage
Live example