OpenGadget - Develop Apps | Community Toolbar

Conduit API

Case Study

HTML Apps -> OpenGadget

This function is used to open a gadget window with specified features.
The gadget can be launched only from within another HTML components and Gadgets.

- Syntax

OpenGadget(URL, width, height, features)

- Parameters

Parameter	Description	Range	Type
URL	The URL that the gadget will contain.	Valid URL	string
Width	The width (in pixels) of the new gadget window	>0	int
Height	The height (in pixels) of the new gadget window	>0	int
Features	String that contains a list of items separated by commas. Each item consists of an option and a value, separated by an equals sign (for example, " resizable=yes, scrollbars=yes"). See supported features below.	String or Null	string

The following features are supported:

resizable = { yes | no | 1 | 0 }

Specifies whether to display resize handles at the corners of the window. The default is yes.

hscroll = = { yes | no | 1 | 0 }

Specifies whether to display horizontal scroll bar. The default is yes.

vscroll = = { yes | no | 1 | 0 }

Specifies whether to display vertical scroll bar. The default is yes.

titlebar = { yes | no | 1 | 0 }

Specifies whether to display a Title Bar for the window. The default is yes.

closeonexternalclick = { yes | no | 1 | 0 }

Specifies whether the gadget behaves like a regular window or like a menu and is closed when focus is lost. The default is no.

closebutton = { yes | no | 1 | 0 }

Specifies whether to display the close button. The default is yes.

savelocation = { yes | no | 1 | 0 }

Specifies whether to save the location the gadget was last opened. The default is yes.

saveresizedsize = { yes | no | 1 | 0 }

Specifies whether to save the size the gadget was last manually resized to. The default is yes.

openposition = { click | alignment:(T;B;L;R) | center | offset:(x;y) }

Specifies where the gadget should open. The default is click.

alignment values can be: T(top), B (bottom) ,R (right), L (left). T/B are mutually exclusive. L/R are mutually exclusive.

Offset is the number of pixels from the top of the container (x,y)

Notice: when using the openposition feature, always add savelocation=0 to the features list to overrun the default behavior.

- Return Value

None.

- Remarks

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>
<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></style>
<!-- Conduit API script declaration -->
<script type="text/javascript" language="javascript" src="http://api.conduit.com/BrowserCompApi.js"></script>
<script language="javascript" type="text/javascript">
    function OpenNewGadgetWindow() {
        var width = document.getElementById('txtWidth').value;
        var height = document.getElementById('txtHeight').value;
        var strUrl = document.getElementById('txtUrl').value;
        OpenGadget(strUrl, width, height,"resizable=no,scrollbars=yes,titlebar=no");
    }
</script>
</head>
<body>
<div>Width:<input type="text" id="txtWidth" /></div>
<div>Height:<input type="text" id="txtHeight" /></div>
<div>URL:<input type="text" id="txtUrl" /></div>
<div><input type="button" onclick="OpenNewGadgetWindow()" value="Open Gadget Window" /></div>
</body>
</html>

- Code Usage

See code usage for HTML component
See code usage for gadget