ToolStripItem.ImageScaling Property
Gets or sets a value indicating whether an image on a ToolStripItem is automatically resized to fit in a container.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Property Value
Type: System.Windows.Forms.ToolStripItemImageScalingOne 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:
-
ImageScalingSize is the scale of the final image as determined by the combination of the image's ImageScaling setting and the container's AutoSize setting.
-
If AutoSize is true (the default) and ToolStripItemImageScaling is SizeToFit, no image scaling occurs, and the ToolStrip size is that of the largest item, or a prescribed minimum size.
-
If AutoSize is false and ToolStripItemImageScaling is None, neither image nor ToolStrip scaling occurs.
-
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 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.
