ToolBarButton.ImageIndex ToolBarButton.ImageIndex ToolBarButton.ImageIndex ToolBarButton.ImageIndex Property

Definition

Gets or sets the index value of the image assigned to the button.

public:
 property int ImageIndex { int get(); void set(int value); };
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ImageIndexConverter))]
public int ImageIndex { get; set; }
member this.ImageIndex : int with get, set
Public Property ImageIndex As Integer

Property Value

The index value of the Image assigned to the toolbar button. The default is -1.

Exceptions

Examples

The following code example creates a ToolBar and three ToolBarButton controls, assigns the buttons to the toolbar, and sets some of the buttons' common properties. This code requires that a MenuItem, ImageList, ToolTip and a Form have been created and the ImageList has at least one Image assigned to it.

public:
   void InitializeMyToolBar()
   {
      // Create the ToolBar, ToolBarButton controls, and menus.
      ToolBarButton^ toolBarButton1 = gcnew ToolBarButton( "Open" );
      ToolBarButton^ toolBarButton2 = gcnew ToolBarButton;
      ToolBarButton^ toolBarButton3 = gcnew ToolBarButton;
      ToolBar^ toolBar1 = gcnew ToolBar;
      MenuItem^ menuItem1 = gcnew MenuItem( "Print" );
      array<MenuItem^>^ temp1 = {menuItem1};
      System::Windows::Forms::ContextMenu^ contextMenu1 =
         gcnew System::Windows::Forms::ContextMenu( temp1 );
      
      // Add the ToolBarButton controls to the ToolBar.
      toolBar1->Buttons->Add( toolBarButton1 );
      toolBar1->Buttons->Add( toolBarButton2 );
      toolBar1->Buttons->Add( toolBarButton3 );
      
      // Assign an ImageList to the ToolBar and show ToolTips.
      toolBar1->ImageList = imageList1;
      toolBar1->ShowToolTips = true;
      
      /* Assign ImageIndex, ContextMenu, Text, ToolTip, and 
         Style properties of the ToolBarButton controls. */
      toolBarButton2->Style = ToolBarButtonStyle::Separator;
      toolBarButton3->Text = "Print";
      toolBarButton3->Style = ToolBarButtonStyle::DropDownButton;
      toolBarButton3->ToolTipText = "Print";
      toolBarButton3->ImageIndex = 0;
      toolBarButton3->DropDownMenu = contextMenu1;
      
      // Add the ToolBar to a form.
      Controls->Add( toolBar1 );
   }
public void InitializeMyToolBar()
 {
    // Create the ToolBar, ToolBarButton controls, and menus.
    ToolBarButton toolBarButton1 = new ToolBarButton("Open");
    ToolBarButton toolBarButton2 = new ToolBarButton();
    ToolBarButton toolBarButton3 = new ToolBarButton();
    ToolBar toolBar1 = new ToolBar();
    MenuItem menuItem1 = new MenuItem("Print");
    ContextMenu contextMenu1 = new ContextMenu(new MenuItem[]{menuItem1});

     
    // Add the ToolBarButton controls to the ToolBar.
    toolBar1.Buttons.Add(toolBarButton1);
    toolBar1.Buttons.Add(toolBarButton2);
    toolBar1.Buttons.Add(toolBarButton3);
 
    // Assign an ImageList to the ToolBar and show ToolTips.
    toolBar1.ImageList = imageList1;
    toolBar1.ShowToolTips = true;
 
    /* Assign ImageIndex, ContextMenu, Text, ToolTip, and 
       Style properties of the ToolBarButton controls. */
    toolBarButton2.Style = ToolBarButtonStyle.Separator;
    toolBarButton3.Text = "Print";
    toolBarButton3.Style = ToolBarButtonStyle.DropDownButton;
    toolBarButton3.ToolTipText = "Print";
    toolBarButton3.ImageIndex = 0;
    toolBarButton3.DropDownMenu = contextMenu1;
 
    // Add the ToolBar to a form.
    Controls.Add(toolBar1);
 }
 
   Public Sub InitializeMyToolBar()
       ' Create the ToolBar, ToolBarButton controls, and menus.
       Dim toolBarButton1 As New ToolBarButton("Open")
       Dim toolBarButton2 As New ToolBarButton()
       Dim toolBarButton3 As New ToolBarButton()
       Dim toolBar1 As New ToolBar()
Dim menuItem1 As New MenuItem("Print")
Dim contextMenu1 As New ContextMenu(New MenuItem(){menuItem1})
       
       ' Add the ToolBarButton controls to the ToolBar.
       toolBar1.Buttons.Add(toolBarButton1)
       toolBar1.Buttons.Add(toolBarButton2)
       toolBar1.Buttons.Add(toolBarButton3)
       
       ' Assign an ImageList to the ToolBar and show ToolTips.
       toolBar1.ImageList = imageList1
       toolBar1.ShowToolTips = True
       
       ' Assign ImageIndex, ContextMenu, Text, ToolTip, and
       ' Style properties of the ToolBarButton controls. 
       toolBarButton2.Style = ToolBarButtonStyle.Separator
       toolBarButton3.Text = "Print"
       toolBarButton3.Style = ToolBarButtonStyle.DropDownButton
       toolBarButton3.ToolTipText = "Print"
       toolBarButton3.ImageIndex = 0
       toolBarButton3.DropDownMenu = contextMenu1
       
       ' Add the ToolBar to a form.
       Controls.Add(toolBar1)
   End Sub

Remarks

The ImageIndex value references the indexed value of the images in an ImageList assigned to the parent ToolBar control.

Applies to

See also