home / documentation / reference / scrollenabled

ScrollEnabled

Description:

Boolean value indicating whether the menu should be scrollable.

Value:

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

Applies To:

Menus.

Browser Compatibility:

ScrollEnabled is supported in all browsers.

Comments:

Menus that are ScrollEnabled will display scroll bars at their top and/or bottom when they are taller than the user's browser window, allowing the user to scroll the menu and see all the available menu items without having to scroll the page itself.

If the menu's KeepInWindow parameters have not been overridden, then the menu will be displayed using the full height (or near full height, in some browsers) of the browser window. If the menu's KeepInWindow parameters have been set to false, then the menu will be displayed in its normal location, and the menu will be made scrollable only if the bottom of the menu extends below the edge of the browser window.

In HierMenus versions prior to version 6, all horizontal menus, permanently visible menus, and child menus positioned with PositionChild were automatically set with ScrollEnabled set to false. This setting could not be overridden by end users. In HierMenus version 6, this restriction has been removed. If you wish to emulate the pre-version 6 behavior, you will therefore need to specifically disable scrolling for all horizontal, permanently visible, or PositionChild child menus.

Scroll enabling a menu adds a small amount of additional processing to the creation of each menu. Therefore, you should only set ScrollEnabled to true when you know you will need the scrolling menu feature.

Examples:

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

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

Default:

false

See Also:

ScrollOver, ScrollInterval, ScrollBarHeight, ScrollBarColor, ScrollImgAltTop, ScrollImgSrcTop, ScrollImgAltBot, ScrollImgSrcBot, ScrollImgWidth, ScrollImgHeight, ScrollBothBars, ScrollHeightMin