This documentation is archived and is not being maintained.

ToolBarButton.ToolTipText Property

Gets or sets the text that appears as a ToolTip for a control.

[Visual Basic]
Public Property ToolTipText As String
[C#]
public string ToolTipText {get; set;}
[C++]
public: __property String* get_ToolTipText();
public: __property void set_ToolTipText(String*);
[JScript]
public function get ToolTipText() : String;
public function set ToolTipText(String);

Property Value

The text that is displayed when the mouse pointer moves over the toolbar button. The default is an empty string ("").

Remarks

To enable the display of the ToolTip text when the mouse pointer is moved over the button, set the ShowToolTips property of the button's parent ToolBar to true.

Example

[Visual Basic, C#, C++] The following example creates a ToolBar and three ToolBarButton controls, assigns the buttons to the toolbar, and sets some of the buttons' common properties. This code assumes a MenuItem, ImageList, ToolTip and a Form have been created and the ImageList has at least one Image assigned to it.

[Visual Basic] 
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


[C#] 
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);
 }
 

[C++] 
public:
void InitializeMyToolBar()
 {
    // Create the ToolBar, ToolBarButton controls, and menus.
    ToolBarButton* toolBarButton1 = new ToolBarButton(S"Open");
    ToolBarButton* toolBarButton2 = new ToolBarButton();
    ToolBarButton* toolBarButton3 = new ToolBarButton();
    ToolBar* toolBar1 = new ToolBar();
    MenuItem* menuItem1 = new MenuItem(S"Print");

    MenuItem* temp1 [] = {menuItem1};
    System::Windows::Forms::ContextMenu* contextMenu1 = new 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 = S"Print";
    toolBarButton3->Style = ToolBarButtonStyle::DropDownButton;
    toolBarButton3->ToolTipText = S"Print";
    toolBarButton3->ImageIndex = 0;
    toolBarButton3->DropDownMenu = contextMenu1;
 
    // Add the ToolBar to a form.
    Controls->Add(toolBar1);
 }
 

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

ToolBarButton Class | ToolBarButton Members | System.Windows.Forms Namespace | ShowToolTips | ToolTip

Show: