home / documentation / reference / keephilite

KeepHilite

Description:

Boolean value indicating whether or not parent items of child menus should remain in their selected states when the mouse rolls over the child menu.

Value:

Boolean (true or false), Integer (1=true, 0=false), or JavaScript expression that returns a boolean value.

Applies To:

Menu Items.

Browser Compatibility:

KeepHilite is supported in all browsers.

Comments:

When KeepHilite is set to true, parent items (menu items that spawn child menus), remain in their selected state when the user rolls over the child menu (or any grandchild menus of the child menu). If false, the menu item always returns to its default state when the user rolls off the menu item.

Items that are marked with IsSelected or IsPermHilite set to true, or IsRollover set to false, do not change their color schemes on rollover; therefore, they are unaffected by KeepHilite.

Examples:

// Ok:
KeepHilite:true,
KeepHilite:0,
KeepHilite:(window.thisPage=="cf")?1:0, 
    // if the user defined variable "thisPage" is "cf", 
    // KeepHilite is true

// Incorrect:
KeepHilite:"false",  // quotes not allowed around booleans
KeepHilite:"0",
KeepHilite:'(window.thisPage=="cf")?1:0', // no quoted expressions

Default:

false

See Also:

IsRollover, IsPermHilite, IsSelected