home / documentation / reference / ispermhilite

IsPermHilite

Description:

Boolean value indicating whether or not a menu item should be permanently highlighted; that is, always displayed as if the mouse is currently hovering over it.

Value:

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

Applies To:

Menu Items.

Browser Compatibility:

IsPermHilite is supported in all browsers.

Comments:

IsPermHilite can be used as a shortcut way to create menu item labels; i.e., instead of specifying an exact color scheme for the menu item in question, you can instead simply set IsPermHilite to true. The menu item will then always appear as it would when the mouse was hovering over it. Rolling the mouse over permanently highlighted items will have no effect on the item's display.

If an item is marked both IsPermHilite and IsSelected, IsPermHilite will take precedence.

Examples:

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

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

Default:

false

See Also:

IsRollover, KeepHilite, IsSelected