HomeButton Meta Tag

HomeButton (META Tag) Syntax
<META HTTP-Equiv="HomeButton" content="[parameter>

Items listed in this section indicate parameters, or attributes which can be set.

Name	Possible Values	Description	Default Value
Left:[Value]	Positive number, representing pixels	Sets the X position of the Home Button.	To the right of the address bar
Top:[Value]	Positive number, representing pixels	Sets the Y position of the Home Button.	To the right of the address bar
Height:[Value]	Positive number, representing pixels	Sets the height of the Home Button.	Dependant on screen resolution
Width:[Value]	Positive number, representing pixels	Sets the width of the Home Button.	Dependant on screen resolution
ImageUp:[Value]	URL	Sets the image to be displayed when the Home Button is in the up state. See Remarks.	Default image
ImageDown:[Value]	URL	Sets the image to be displayed when the Home Button is in the down state. See Remarks.	Default image
Visibility:[Value]	Visible, Hidden	Sets the visibility of the Home button.	Hidden

Copy parameters template to clipboard:

META Tags

Javascript

<!-- The HomeButton META Tag is an action tag used to set the parameters of the Home Button. When the home button is clicked PocketBrowser will navigate to the start page as defined in the configuration. --> <!-- <META HTTP-Equiv="HomeButton" Content="Left:[Value]"> --> <!-- Sets the X position of the Home Button. --> <!-- <META HTTP-Equiv="HomeButton" Content="Top:[Value]"> --> <!-- Sets the Y position of the Home Button. --> <!-- <META HTTP-Equiv="HomeButton" Content="Height:[Value]"> --> <!-- Sets the height of the Home Button. --> <!-- <META HTTP-Equiv="HomeButton" Content="Width:[Value]"> --> <!-- Sets the width of the Home Button. --> <!-- <META HTTP-Equiv="HomeButton" Content="ImageUp:[Value]"> --> <!-- Sets the image to be displayed when the Home Button is in the up state. See Remarks. --> <!-- <META HTTP-Equiv="HomeButton" Content="ImageDown:[Value]"> --> <!-- Sets the image to be displayed when the Home Button is in the down state. See Remarks. --> <!-- <META HTTP-Equiv="HomeButton" Content="Visibility:[Value]"> --> <!-- Sets the visibility of the Home button. -->

<script> /* The HomeButton META Tag is an action tag used to set the parameters of the Home Button. When the home button is clicked PocketBrowser will navigate to the start page as defined in the configuration. */ function doHomeButtonInit() { var objGeneric = new ActiveXObject("PocketBrowser.Generic"); //objGeneric.InvokeMETAFunction('HomeButton', 'Left:[Value]'); /* Sets the X position of the Home Button. */ //objGeneric.InvokeMETAFunction('HomeButton', 'Top:[Value]'); /* Sets the Y position of the Home Button. */ //objGeneric.InvokeMETAFunction('HomeButton', 'Height:[Value]'); /* Sets the height of the Home Button. */ //objGeneric.InvokeMETAFunction('HomeButton', 'Width:[Value]'); /* Sets the width of the Home Button. */ //objGeneric.InvokeMETAFunction('HomeButton', 'ImageUp:[Value]'); /* Sets the image to be displayed when the Home Button is in the up state. See Remarks. */ //objGeneric.InvokeMETAFunction('HomeButton', 'ImageDown:[Value]'); /* Sets the image to be displayed when the Home Button is in the down state. See Remarks. */ //objGeneric.InvokeMETAFunction('HomeButton', 'Visibility:[Value]'); /* Sets the visibility of the Home button. */ } </script>

The following example shows the Home button, sets its left and top coordinates to 50, and its width and height to 30 pixels.

<META HTTP-Equiv="HomeButton" Content="Visibility:Visible"> <META HTTP-Equiv="HomeButton" Content="Left:50"> <META HTTP-Equiv="HomeButton" Content="Top:50"> <META HTTP-Equiv="HomeButton" Content="Width:30"> <META HTTP-Equiv="HomeButton" Content="Height:30">

Copy example to clipboard

<!-- The following example shows the Home button, sets its left and top coordinates to 50, and its width and height to 30 pixels. --> <META HTTP-Equiv="HomeButton" Content="Visibility:Visible"> <META HTTP-Equiv="HomeButton" Content="Left:50"> <META HTTP-Equiv="HomeButton" Content="Top:50"> <META HTTP-Equiv="HomeButton" Content="Width:30"> <META HTTP-Equiv="HomeButton" Content="Height:30">

The follwing example shows the Home button, sets its width to 30 pixels, its left coordinate to 50, and displays the home_up.gif / home_down.gif image on it (reszing the images if necessary).

<META HTTP-Equiv="HomeButton" Content="Width:30; Left:50; ImageUp:url('http://myaddress/home_up.gif'); ImageDown:url('http://myaddress/home_down.gif'); Visibility:Visible">

Copy example to clipboard

<!-- The follwing example shows the Home button, sets its width to 30 pixels, its left coordinate to 50, and displays the home_up.gif / home_down.gif image on it (reszing the images if necessary). --> <META HTTP-Equiv="HomeButton" Content="Width:30; Left:50; ImageUp:url('http://myaddress/home_up.gif'); ImageDown:url('http://myaddress/home_down.gif'); Visibility:Visible">

Use of Images on Buttons.

Images can be specified as local to the device or on an HTTP / FTP server, just specify the required protocol as part of your URL (file://\, HTTP:// and FTP://). Image will be scaled to the size of the button. JPEG and GIF images are only supported on WM devices. Both CE and WM support BMP files.

Default Positions

By default this control will be placed a the top of the screen. On Windows Mobile if the 'FullScreen' configuration setting is disabled the control will need to be moved, otherwise it will appear beneath the task bar.

Switching to Other Applications

All controls are designed to be shown on top of PocketBrowser. If you require to switch to an application other than PocketBrowser you should minimize PB to ensure the buttons do not remain shown.

Screen Orientation

When the screen orientation changes, either using the ScreenOrientation tag or by rotating a device with hardware support, the command areas will automatically move and resize to fit the new layout. However the buttons themselves are not moved and in some cases this may result in them being off the screen or not in the expected position. If so they must be moved manually by detecting the ScreenOrientationEvent.

Supported Platforms	Windows CE, Windows Mobile
Persistence	This tag is persistent.
Min. Requirements	None.