home / documentation / reference / topkeepinwindowy

TopKeepInWindowY

Description:

Boolean value indicating whether or not the menu should be automatically repositioned from its default location vertically so that the entire menu appears within the user's browser window. TopKeepInWindowY applies only to menus that are displayed as top level menus.

Value:

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

Applies To:

Menus.

Browser Compatibility:

TopKeepInWindowY is supported in all browsers.

Comments:

Note that this parameter defines the menu's vertical KeepInWindow behavior when the menu is being displayed as a top level menu. Compare this parameter to ChildKeepInWindowY, which defines the menu's vertical KeepInWindow behavior when the menu is used as a child 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 settings depending on how the menu is currently being utilized.

All of the KeepInWindow behaviors are true by default; meaning that HierMenus will always attempt to reposition the menu both horizontally and vertically so that it appears within the user's browser window. In versions of HierMenus prior to version 6, permanently displayed menus and PositionChild child menus were not repositioned via the KeepInWindow behavior. If you wish to emulate the pre-version 6 behavior, you will need to set the appropriate KeepInWindow behaviors to false on those types of menus.

Examples:

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

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

Default:

true

See Also:

RepositionOnScroll, IsPermanent, PositionChild, TopKeepInWindowX, ChildKeepInWindowX, ChildKeepInWindowY