Export (0) Print
Expand All
Expand Minimize

ToolStripItemImageScaling Enumeration

Specifies whether the size of the image on a ToolStripItem is automatically adjusted to fit on a ToolStrip while retaining the original image proportions.

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

public enum ToolStripItemImageScaling

Member nameDescription
NoneSpecifies that the size of the image on a ToolStripItem is not automatically adjusted to fit on a ToolStrip.
SizeToFitSpecifies that the size of the image on a ToolStripItem is automatically adjusted to fit on a ToolStrip.

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.

To control the image size, use the ImageScalingSize property.

The following code example applies the SizeToFit member to a ToolStripButton.

		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.6, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft