Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

ToolStripItem.AutoToolTip Property

.NET Framework 4

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
C#
C++
F#
VB
Copy 
public bool AutoToolTip { get; set; }

Property Value

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

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.

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#
C++
VB
Copy 

		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);

		}

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Let me save you hours...
Let me save you some time. This portion of the documentation in the remarks section is unclear:
To use this property, you must also set ShowItemToolTips to true.
This property must be set on the parent StatusStrip that this ToolStripItem is contained within. Even the code block is not clear about that as it refers to the magical "toolStrip1" variable that is not defined in the codeblock.
History