home / documentation / reference / itembackgroundimage

ItemBackgroundImage

Description:

The src, i.e., server location, of a background image that should be applied to this menu item.

Value:

String, null, or JavaScript expression that returns a String/null.

Applies To:

Menu Items.

Browser Compatibility:

ItemBackgroundImage is not supported in Netscape 6.0x or Netscape 4.x. Additionally, support can be inconsistent in Internet Explorer 4.

Comments:

The configuration parameter ImageDir has no effect on the setting for ItemBackgroundImage. Rather, HierMenus only looks exactly to the URL location you specify in ItemBackgroundImage for the location of the image graphic itself.

Include only the actual server location (URL) of the graphic in ItemBackgroundImage. You can specify additional parameters, such as repeat-x, etc. in ItemBackgroundProperties.

When using item background images, the item's background color will be covered by the image. Therefore, BGColorOver and BGColorSelected will not appear to function. They should still be set, however, for the benfit of those browsers for which HM does not support item background images or for users who specifically have image displays disabled in their browsers.

Examples:

// Ok:
ItemBackgroundImage:"ItemBack.gif",
ItemBackgroundImage:"http://myserver.com/myHMImages/ItemBack.gif",
ItemBackgroundImage:null,
ItemBackgroundImage:(window.showBack)?"ItemBack.gif":null,
    // if the user defined variable "showBack" is true,
    // then use "ItemBack.gif"

// Incorrect:
ItemBackgroundImage:ItemBack.gif,      // Strings must be quoted
ItemBackgroundImage:"null",            // null must NOT be quoted
ItemBackgroundImage:'(window.showBack)?"ItemBack.gif":null', 
    // no quoted expressions

Default:

null

See Also:

MenuBackgroundImage, MenuBackgroundProperties, ScrollBackgroundImage, ItemBackgroundProperties