This documentation is archived and is not being maintained.

ToolStripItem.ImageScaling Property

Gets or sets a value indicating whether an image on a ToolStripItem is automatically resized to fit in a container.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public ToolStripItemImageScaling ImageScaling { get; set; }

Property Value

Type: System.Windows.Forms.ToolStripItemImageScaling
One of the ToolStripItemImageScaling values. The default is SizeToFit.

The Image, ImageAlign, ImageIndex, ImageKey, and ImageScaling properties pertain to various aspects of image handling. Use images in ToolStrip controls by setting these properties directly or by setting the run-time–only ImageList property.

Image scaling is determined by the interaction of properties in both ToolStrip and ToolStripItem, as follows:

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.

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

		}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: