ToolBar.TextAlign Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets the alignment of text in relation to each image displayed on the toolbar button controls.

public:
 property System::Windows::Forms::ToolBarTextAlign TextAlign { System::Windows::Forms::ToolBarTextAlign get(); void set(System::Windows::Forms::ToolBarTextAlign value); };

public System.Windows.Forms.ToolBarTextAlign TextAlign { get; set; }

member this.TextAlign : System.Windows.Forms.ToolBarTextAlign with get, set

Public Property TextAlign As ToolBarTextAlign

Property Value

ToolBarTextAlign

One of the ToolBarTextAlign values. The default is ToolBarTextAlign.Underneath.

Exceptions

InvalidEnumArgumentException

The assigned value is not one of the ToolBarTextAlign values.

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

The Text can be aligned underneath or to the right of the image displayed on the ToolBarButton controls.

See also

• ToolBarTextAlign