GetMainFrameUrl - Develop Apps

Conduit API

Case Study

HTML Apps -> GetMainFrameUrl

- Description

This function is used to get the current URL in the main browser.

- Syntax

GetMainFrameUrl()

- Parameters

None.

- Return Value

Description	Type
The main browser's current URL.	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 GetMainFrameUrl

that when clicked, will navigate you to the URL of the main frame.

<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>
</head>
<body>
<img alt="GetMainFrameUrl" style="vertical-align:bottom" src="http://www.conduit.com/developers/api/Images/Toolbars/HTML/GetMainFrameUrl.gif" onclick="alert('Going to navigate to ' + GetMainFrameUrl());OpenFloatingWindow(GetMainFrameUrl(), 300, 300)" />
</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>
</head>
<body>
<input type="button" value="Get Main Frame Url" onclick="alert('Main frame url is: ' + GetMainFrameUrl())" />
</body>
</html>

- Code Usage

See code usage for HTML component
See code usage for gadget