ToolBar.Wrappable Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets a value indicating whether the toolbar buttons wrap to the next line if the toolbar becomes too small to display all the buttons on the same line.

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

public bool Wrappable { get; set; }

member this.Wrappable : bool with get, set

Public Property Wrappable As Boolean

Property Value

Boolean

true if the toolbar buttons wrap to another line if the toolbar becomes too small to display all the buttons on the same line; otherwise, false. The default value is true.

Examples

The following code example creates a ToolBar control, sets some of its common properties, and adds it to a Form. Delegates are also added to the ButtonClick and ButtonDropDown events. This example requires that a ToolBar named toolBar1 and an ImageList named imageList1 have been declared.

void AddToolBar()
{
   
   // Add a toolbar and set some of its properties.
   toolBar1 = gcnew ToolBar;
   toolBar1->Appearance = System::Windows::Forms::ToolBarAppearance::Flat;
   toolBar1->BorderStyle = System::Windows::Forms::BorderStyle::None;
   toolBar1->Buttons->Add( this->toolBarButton1 );
   toolBar1->ButtonSize = System::Drawing::Size( 24, 24 );
   toolBar1->Divider = true;
   toolBar1->DropDownArrows = true;
   toolBar1->ImageList = this->imageList1;
   toolBar1->ShowToolTips = true;
   toolBar1->Size = System::Drawing::Size( 292, 25 );
   toolBar1->TabIndex = 0;
   toolBar1->TextAlign = System::Windows::Forms::ToolBarTextAlign::Right;
   toolBar1->Wrappable = false;
   
   // Add handlers for the ButtonClick and ButtonDropDown events.
   toolBar1->ButtonDropDown += gcnew ToolBarButtonClickEventHandler( this, &MyToolBar::toolBar1_ButtonDropDown );
   toolBar1->ButtonClick += gcnew ToolBarButtonClickEventHandler( this, &MyToolBar::toolBar1_ButtonClicked );
   
   // Add the toolbar to the form.
   this->Controls->Add( toolBar1 );
}

private void AddToolBar()
{
   // Add a toolbar and set some of its properties.
   toolBar1 = new ToolBar();
   toolBar1.Appearance = System.Windows.Forms.ToolBarAppearance.Flat;
   toolBar1.BorderStyle = System.Windows.Forms.BorderStyle.None;
   toolBar1.Buttons.Add(this.toolBarButton1);
   toolBar1.ButtonSize = new System.Drawing.Size(24, 24);
   toolBar1.Divider = true;
   toolBar1.DropDownArrows = true;
   toolBar1.ImageList = this.imageList1;
   toolBar1.ShowToolTips = true;
   toolBar1.Size = new System.Drawing.Size(292, 25);
   toolBar1.TabIndex = 0;
   toolBar1.TextAlign = System.Windows.Forms.ToolBarTextAlign.Right;
   toolBar1.Wrappable = false;
   
   // Add handlers for the ButtonClick and ButtonDropDown events.
   toolBar1.ButtonDropDown += 
     new ToolBarButtonClickEventHandler(toolBar1_ButtonDropDown);
   toolBar1.ButtonClick += 
     new ToolBarButtonClickEventHandler(toolBar1_ButtonClicked);

   // Add the toolbar to the form.
   this.Controls.Add(toolBar1);
}

Private Sub AddToolBar()
   ' Add a toolbar and set some of its properties.
   toolBar1 = New ToolBar()
   toolBar1.Appearance = System.Windows.Forms.ToolBarAppearance.Flat
   toolBar1.BorderStyle = System.Windows.Forms.BorderStyle.None
   toolBar1.Buttons.Add(Me.toolBarButton1)
   toolBar1.ButtonSize = New System.Drawing.Size(24, 24)
   toolBar1.Divider = True
   toolBar1.DropDownArrows = True
   toolBar1.ImageList = Me.imageList1
   toolBar1.ShowToolTips = True
   toolBar1.Size = New System.Drawing.Size(292, 25)
   toolBar1.TabIndex = 0
   toolBar1.TextAlign = System.Windows.Forms.ToolBarTextAlign.Right
   toolBar1.Wrappable = False

   ' Add handlers for the ButtonClick and ButtonDropDown events.
   AddHandler toolBar1.ButtonDropDown, AddressOf toolBar1_ButtonDropDown
   AddHandler toolBar1.ButtonClick, AddressOf toolBar1_ButtonClicked

   ' Add the toolbar to the form.
   Me.Controls.Add(toolBar1)
End Sub

Remarks

Toolbar buttons can be divided into logical groups by using separators. A separator is a toolbar button with the Style property set to ToolBarButtonStyle.Separator. If the Wrappable property is set to true and the toolbar becomes too small to display all the buttons on the same line, the toolbar is broken into additional lines, with the breaks occurring at the separators. This ensures that button groups stay together. Toolbar buttons that are not in a group can be separated when the toolbar wraps. The toolbar can become too small to display all its buttons on the same line if its parent Form is resized.

See also

• ToolBarButtonStyle