IsVisible - Develop Apps | Community Toolbar

Conduit API

Case Study

Web Page API -> IsVisible

- Description

This function is used in order to check whether there is an installed and visible toolbar.

- Syntax

IsVisible()

- Parameters

None.

- Return Value

An object that contains the following fields:

Field Name	Description	Type
returnValue	Indicates whether the operation was successful. True - The toolbar is installed and visible False - The toolbar is either not installed or invisible, or the function was not completed successfully. Check the value of the errorCode to determine the specific situation.	boolean
errorCode	Specific error code. See Error Code Table for additional information.	int

- Remarks

This function can only communicate with a visible toolbar.
*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 check whether the Conduit demo toolbar is installed and visible.

 
<!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 - IsVisible</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 IsToolbarVisible(){
        var resultDiv = document.getElementById('result');
        resultDiv.innerHTML = "";            
        var oToolbar = new TPI.Toolbar("CT2275160");
        var oReturn = oToolbar.IsVisible();
            if(oReturn.returnValue)
                resultDiv.innerHTML += "The Toolbar identified as CT2275160 is installed and visible<br/>";
            else
                resultDiv.innerHTML += "The Toolbar identified as CT2275160 is not installed or not visible, Error Code: " + oReturn.errorCode + "<br/>";               
    }
</script> 
</head>
<body> 
<div><input type="button" value="Is Visible" onclick="IsToolbarVisible()" /></div>
<br />
<div id="result"></div>
</body>
</html>

- Code Usage

See code usage
See live demo usage
Live example