GetSearchTerm - Develop Apps | Community Toolbar

Conduit API

Case Study

HTML Apps -> GetSearchTerm

- Description

This function is used to get the search term that appears in the search box.

- Syntax

GetSearchTerm()

- Parameters

None.

- Return Value

Description	Type
The search term appearing in the search box.	string

- Remarks

In order to retrieve the main frame URL, you will need to apply the following security settings for your toolbar.
This function can be used both with the HTML component and with the gadget window.
*Notice: API methods must be invoked after the web page has triggered the "onload" event.

- Code Example

HTML | Gadget

This example contains an icon GetSearchTerm

that when clicked, returns a message to the user, containing the search term appearing in the toolbar's search box.

<html> <head> <style type= "text/css"> BODY { margin-left:0; margin-right:0; margin-top:0; margin-bottom:0; width:100%; height:100%; overflow:hidden; background-color:threedface; } </style> <!-- Conduit API script declaration --> <script type="text/javascript" language="javascript" src="http://api.conduit.com/BrowserCompApi.js"></script> <script type="text/javascript" language="javascript">
 
    function GetMainSearchTerm() {
        var searchTerm = GetSearchTerm();
        if (searchTerm != "") {
            alert('The current search term is: ' + searchTerm)
        }
        else{
            alert('No search term in the search bar');
        }
    }        
</script> </head> <body> <img alt="GetSearchTerm" style="vertical-align:bottom" src="http://www.conduit.com/developers/api/Images/Toolbars/HTML/GetSearchTerm.gif" onclick="GetMainSearchTerm()" /> </body> </html>

<html> <head> <style type= "text/css"> BODY { margin-left:0; margin-right:0; margin-top:0; margin-bottom:0; width:100%; height:100%; overflow:hidden; background-color:threedface; } </style> <!-- Conduit API script declaration --> <script type="text/javascript" language="javascript" src="http://api.conduit.com/BrowserCompApi.js"></script> <script type="text/javascript" language="javascript">
 
    function GetMainSearchTerm() {
        var searchTerm = GetSearchTerm();
        if (searchTerm != "") {
            alert('The current search term is: ' + searchTerm)
        }
        else{
            alert('No search term in the search bar');
        }
    }        
</script> </head> <body> <input type="button" value="Get Search Term" onclick="GetMainSearchTerm()" /> </body> </html>

- Code Usage

See code usage for HTML Component
See code usage for Gadget