home / documentation / reference / childuponhide

ChildUponHide

Description:

JavaScript code to be executed each time the menu is hidden (but only if the menu was being displayed as a child menu).

Value:

null, or String JavaScript expression.

Applies To:

Menus.

Browser Compatibility:

ChildUponHide is supported in all browsers.

Comments:

This parameter defines JavaScript code that should be executed when the menu is being hidden, but only if the menu was being displayed as a child menu. Compare this parameter to TopUponHide, which defines JavaScript code that should be executed when the menu is being hidden after having been displayed as a top level menu. A single menu can be used as both a top level menu and a child menu on the same page. This Child vs. Top distinction allows you to define different JavaScript code depending on how the menu is currently being utilized.

When using a String JavaScript expression (i.e., a JavaScript expression contained within quotes), that expression will not be evaluated until just before the menu is hidden. It will then be reevaluated every time the menu is hidden.

Examples:

// Ok:
ChildUponHide:null,       // cancel inherited UponHide
ChildUponHide:"HM_f_ToggleElementList(true,['select'],'tag')", 
    // show all select elements

// Incorrect:
ChildUponHide:"null",     // no quotes around null
ChildUponHide:HM_f_ToggleElementList(true,['select'],'tag'),
    // must have quotes around String JavaScript Expressions

Default:

null

See Also:

TopUponDisplay, TopUponHide, ChildUponDisplay, Bulletin 6: Hiding Page Elements, Bulletin 12: Synchronizing Link Rollovers