MenuItem.BarBreak Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets a value indicating whether the MenuItem is placed on a new line (for a menu item added to a MainMenu object) or in a new column (for a submenu item or menu item displayed in a ContextMenu).

public:
 property bool BarBreak { bool get(); void set(bool value); };

[System.ComponentModel.Browsable(false)]
public bool BarBreak { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.BarBreak : bool with get, set

Public Property BarBreak As Boolean

Property Value

Boolean

true if the menu item is placed on a new line or in a new column; false if the menu item is left in its default placement. The default is false.

Attributes

BrowsableAttribute

Examples

The following code example creates a MenuItem with two submenu items. The two submenu items are displayed horizontally instead of vertically using the BarBreak property.

public:
   void CreateMyMenus()
   {
      // Create three top-level menu items.
      MenuItem^ menuItem1 = gcnew MenuItem( "&File" );
      MenuItem^ menuItem2 = gcnew MenuItem( "&New" );
      MenuItem^ menuItem3 = gcnew MenuItem( "&Open" );
      // Set the BarBreak property to display horizontally.
      menuItem2->BarBreak = true;
      menuItem3->BarBreak = true;
      // Add menuItem2 and menuItem3 to the menuItem1's list of menu items.
      menuItem1->MenuItems->Add( menuItem2 );
      menuItem1->MenuItems->Add( menuItem3 );
   }

public void CreateMyMenus()
{
   // Create three top-level menu items.
   MenuItem menuItem1 = new MenuItem("&File");
   MenuItem menuItem2 = new MenuItem("&New");
   MenuItem menuItem3 = new MenuItem("&Open");
   // Set the BarBreak property to display horizontally.
   menuItem2.BarBreak = true;
   menuItem3.BarBreak = true;
   // Add menuItem2 and menuItem3 to the menuItem1's list of menu items.
   menuItem1.MenuItems.Add(menuItem2);
   menuItem1.MenuItems.Add(menuItem3);
}

Public Sub CreateMyMenus()
    ' Create three top-level menu items.
    Dim menuItem1 As New MenuItem("&File")
    Dim menuItem2 As New MenuItem("&New")
    Dim menuItem3 As New MenuItem("&Open")
    ' Set the BarBreak property to display horizontally.
    menuItem2.BarBreak = True
    menuItem3.BarBreak = True
    ' Add menuItem2 and menuItem3 to the menuItem1's list of menu items.
    menuItem1.MenuItems.Add(menuItem2)
    menuItem1.MenuItems.Add(menuItem3)
End Sub

Remarks

You can use the BarBreak property to create a menu where each menu item is placed next to each other horizontally instead of in a vertical list. You can also use this property to create a menu bar that contains multiple rows of top-level menu items.

This property differs from the Break property in that a bar is displayed on the left edge of each menu item that has the Break property set to true. The bar is only displayed when the menu item is not a top-level menu item.

See also

• Break