home / documentation / reference / isgroupseparator

IsGroupSeparator

Description:

Boolean value indicating whether or not this item should be considered a group separator in vertical menus.

Value:

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

Applies To:

Menu Items.

Browser Compatibility:

IsGroupSeparator is supported in all browsers.

Comments:

IsGroupSeparator marks an item as being a group separator in vertically oriented menus (it has no effect on horizontal menu items). When an item is marked as a group separator, two special behaviors are implemented in HierMenus for this menu item.

First, no button or associated button behaviors are created for the item (even if a valid button class exists for the item). Second, the menu item itself is ignored for purposes of determining the overall width of variable width menus.

These two rules allow you to include special styling or images in group separator items with percentage based widths. For example, you can create a simple group separator item with the following basic configuration entries:

IsGroupSeparator:true,
IsRollover:false,
DisplayText:"<hr size='3' width='90%' />",

In most browsers this will result in a simple menu item consisting of a horizontal rule that extends for 90% of the width of the menu, even if the menu IsVariableWidth.

Note that you can also create very polished looking group separators without requiring an additional menu item, by using item specific settings for SeparatorSize and SeparatorStyle.

Examples:

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

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

Default:

false

See Also:

IsRollover, SeparatorSize, SeparatorStyle