This documentation is archived and is not being maintained.

ToolBarButton.ToolTipText Property

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

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

[LocalizableAttribute(true)] 
public string ToolTipText { get; set; }
/** @property */
public String get_ToolTipText ()

/** @property */
public void set_ToolTipText (String value)

public function get ToolTipText () : String

public function set ToolTipText (value : String)

Not applicable.

Property Value

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

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.

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 = 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 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.get_Buttons().Add(toolBarButton1);
    toolBar1.get_Buttons().Add(toolBarButton2);
    toolBar1.get_Buttons().Add(toolBarButton3);

    // Assign an ImageList to the ToolBar and show ToolTips.
    toolBar1.set_ImageList(imageList1);
    toolBar1.set_ShowToolTips(true);

    /* Assign ImageIndex, ContextMenu, Text, ToolTip, and 
     * Style properties of the ToolBarButton controls. 
     */
    toolBarButton2.set_Style(ToolBarButtonStyle.Separator);
    toolBarButton3.set_Text("Print");
    toolBarButton3.set_Style(ToolBarButtonStyle.DropDownButton);
    toolBarButton3.set_ToolTipText("Print");
    toolBarButton3.set_ImageIndex(0);
    toolBarButton3.set_DropDownMenu(contextMenu1);

    // Add the ToolBar to a form.
    get_Controls().Add(toolBar1);
} //InitializeMyToolBar

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0
Show: