ToolStripItem.AutoToolTip Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolStripItem.cs

Gets or sets a value indicating whether to use the Text property or the ToolTipText property for the ToolStripItem ToolTip.

C#

public bool AutoToolTip { get; set; }

Property Value

Boolean

true to use the Text property for the ToolTip; otherwise, false. The default is true.

Examples

The following code example demonstrates how to set the Image, ImageScaling, and ImageTransparentColor for a ToolStripItem. In addition, it demonstrates how to set and show a custom ToolTip for the item.

C#

internal ToolStripButton imageButton;

private void InitializeImageButtonWithToolTip()
{

    // Construct the button and set the image-related properties.
    imageButton = new ToolStripButton();
    imageButton.Image = new Bitmap(typeof(Timer), "Timer.bmp");
    imageButton.ImageScaling = ToolStripItemImageScaling.SizeToFit;

    // Set the background color of the image to be transparent.
    imageButton.ImageTransparentColor = Color.FromArgb(0, 255, 0);

    // Show ToolTip text, set custom ToolTip text, and turn
    // off the automatic ToolTips.
    toolStrip1.ShowItemToolTips = true;
    imageButton.ToolTipText = "Click for the current time";
    imageButton.AutoToolTip = false;

    // Add the button to the ToolStrip.
    toolStrip1.Items.Add(imageButton);
}

Remarks

ToolStripItem uses the Text property as the default source for the ToolTip content. Set AutoToolTip to false to use ToolTipText as the source for ToolTip content.

To use this property, you must also set ShowItemToolTips to true.

Applies to