This documentation is archived and is not being maintained.

ToolStripItem.ImageScaling Property

Note: This property is new in the .NET Framework version 2.0.

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)

Property Value

One of the ToolStripItemImageScaling values. The default is SizeToFit.

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 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: