IsSupportedFunction - Develop Apps

Conduit API

Case Study

Web Page API -> IsSupportedFunction

This function is used in order to check whether a specific function is supported by at least one of the toolbars which are installed.

- Syntax

IsSupportedFunction(strFunctionName)

- Parameters

Parameter	Description	Range	Type
strFunctionName	The name of the function	not null or empty	string

- Return Value

An array that contains the following fields (for each cell):

Field Name	Description	Type
returnValue	Indicates whether the operation was successful. True - The function is supported by at least one toolbar False - The function is not supported by any toolbar	boolean
errorCode	Specific error code. See Error Code Table for additional information.	int

- Remarks

*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 if one of the installed and visible Conduit powered toolbars supports the function "AddAlert". 
<!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 ToolbarManager API - IsSupportedFunction</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 IsToolbarsSupportedFunction(){
        var resultDiv = document.getElementById('result');
        resultDiv.innerHTML = "";
        // First get the list of all toolbars currently installed and visible.
        var oManager = new TPI.Manager();
        var oResult = oManager.IsSupportedFunction("AddAlert");
        if(oResult.returnValue){
            resultDiv.innerHTML = "The function \"AddAlert\" is supported";
        }
        else{
            resultDiv.innerHTML = "The function \"AddAlert\" is not supported";
        }
    }
</script>  </head> <body>  <div><input type="button" value="Is Supported Function" onclick="IsToolbarsSupportedFunction()" /></div> <br /> <div id="result"></div> </body> </html>                                                  

- Code Usage

See code usage
See live demo usage
Live example