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)

[LocalizableAttribute(true)] 
public ToolStripItemImageScaling ImageScaling { get; set; }
/** @property */
public ToolStripItemImageScaling get_ImageScaling ()

/** @property */
public void set_ImageScaling (ToolStripItemImageScaling value)

public function get ImageScaling () : ToolStripItemImageScaling

public function set ImageScaling (value : ToolStripItemImageScaling)

Not applicable.

Property Value

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:

  • 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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: