AddLinkButton - Develop Apps | Community Toolbar

This function is used to add to a customized button the Toolbar which is used in order to navigate to a web page.

AddLinkButton(buttonLabel,

buttonIcon,

buttonTooltip,

linkTargetUrl,

linkTarget,

optionsDisplayText,

optionsDisplayIcon,

uniqueComponentID)

Parameter	Description	Range	Type
buttonLabel	The text to display on the button	not null or empty	string
buttonIcon	The URL of the icon which is displayed on the button	not null or empty	string
buttonTooltip	The tooltip text that appears when the mouse cursor is placed over the button	not null or empty	string
linkTargetUrl	The URL of the web page which is displayed when clicking the linkbutton	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	not null or empty	string
optionsDisplayText	The text to display in the toolbar's options dialog.	Optional. When the parameter is null, the button label text is displayed in the toolbar's options dialog	string
optionsDisplayIcon	The icon to display in the toolbar's options dialog	Optional. When the parameter is null, the button icon is displayed in the toolbar's options dialog	string
uniqueComponentID	The unique ID of the link button. If the parameter is left empty, a unique ID is automatically created	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 customized button to the toolbar that links to a web page False - The button is not added to the toolbar. 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

All function must be called with at least one of the following parameters (which contain a value): "ButtonLabel" and/or "ButtonIcon". If both parameters are left empty, the button will not appear on the Toolbar.
*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 Button" item to 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 - AddLinkButton</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 AddLinkButtonToToolbar(){
        var resultDiv = document.getElementById('result');
        resultDiv.innerHTML = "";            
        var oToolbar = new TPI.Toolbar("CT2275160");           
        var oResult = oToolbar.AddLinkButton("CNN.com", 
                                             "http://www.conduit.com/storage/29/96/CT965829/Images/Buttons2.xml-12-Classic-633268352362618750.gif", 
                                             "CNN.com",
                                             "http://cnn.com");
        // Check the results
        if(oResult.returnValue){
                resultDiv.innerHTML += "Link button was added to toolbar id: CT2275160<br/>";                                                                            
        }
        else{ 
            if(oResult.errorCode == 5){
                resultDiv.innerHTML += "Link button already exist on toolbar id: CT2275160<br/>";    
            }
            else{                                                           
                resultDiv.innerHTML += "Failed to add Link button to toolbar id: CT2275160, Error Code: " + oResult.errorCode + "<br/>";    
            }
        }
    }
</script>  </head> <body>  <div><input type="button" value="Add Link Button" onclick="AddLinkButtonToToolbar()" /></div> <br /> <div id="result"></div> </body> </html>

See code usage
See live demo usage
Live example