ToolStrip.ImageScalingSize Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolStrip.cs

Gets or sets the size, in pixels, of an image used on a ToolStrip.

public:
 property System::Drawing::Size ImageScalingSize { System::Drawing::Size get(); void set(System::Drawing::Size value); };

public System.Drawing.Size ImageScalingSize { get; set; }

member this.ImageScalingSize : System.Drawing.Size with get, set

Public Property ImageScalingSize As Size

Property Value

Size

A Size value representing the size of the image, in pixels. The default is 16 x 16 pixels.

Examples

The following code example demonstrates the syntax for setting common ToolStrip properties, including the ImageScalingSize property.

// This is an example of some common ToolStrip property settings.
// 
toolStrip1.AllowDrop = false;
toolStrip1.AllowItemReorder = true;
toolStrip1.AllowMerge = false;
toolStrip1.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left)
            | System.Windows.Forms.AnchorStyles.Right)));
toolStrip1.AutoSize = false;
toolStrip1.CanOverflow = false;
toolStrip1.Cursor = System.Windows.Forms.Cursors.Cross;
toolStrip1.DefaultDropDownDirection = System.Windows.Forms.ToolStripDropDownDirection.BelowRight;
toolStrip1.Dock = System.Windows.Forms.DockStyle.None;
toolStrip1.GripMargin = new System.Windows.Forms.Padding(3);
toolStrip1.Items.AddRange(new System.Windows.Forms.ToolStripItem[] {
toolStripButton1});
toolStrip1.ImageScalingSize = new System.Drawing.Size(20, 20);
toolStrip1.LayoutStyle = System.Windows.Forms.ToolStripLayoutStyle.HorizontalStackWithOverflow;
toolStrip1.Location = new System.Drawing.Point(0, 0);
toolStrip1.Margin = new System.Windows.Forms.Padding(1);
toolStrip1.Name = "toolStrip1";
toolStrip1.Padding = new System.Windows.Forms.Padding(0, 0, 2, 0);
toolStrip1.RenderMode = System.Windows.Forms.ToolStripRenderMode.System;
toolStrip1.ShowItemToolTips = false;
toolStrip1.Size = new System.Drawing.Size(109, 273);
toolStrip1.Stretch = true;
toolStrip1.TabIndex = 0;
toolStrip1.TabStop = true;
toolStrip1.Text = "toolStrip1";
toolStrip1.TextDirection = System.Windows.Forms.ToolStripTextDirection.Vertical90;

' This is an example of some common ToolStrip property settings.
' 
toolStrip1.AllowDrop = False
toolStrip1.AllowItemReorder = True
toolStrip1.AllowMerge = False
toolStrip1.Anchor = CType(System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Left Or System.Windows.Forms.AnchorStyles.Right, System.Windows.Forms.AnchorStyles)
toolStrip1.AutoSize = False
toolStrip1.CanOverflow = False
toolStrip1.Cursor = Cursors.Cross
toolStrip1.Dock = System.Windows.Forms.DockStyle.None
toolStrip1.DefaultDropDownDirection = ToolStripDropDownDirection.BelowRight
toolStrip1.GripMargin = New System.Windows.Forms.Padding(3)
toolStrip1.ImageScalingSize = New System.Drawing.Size(20, 20)
toolStrip1.Items.AddRange(New System.Windows.Forms.ToolStripItem() {toolStripButton1})
toolStrip1.LayoutStyle = System.Windows.Forms.ToolStripLayoutStyle.HorizontalStackWithOverflow
toolStrip1.Location = New System.Drawing.Point(0, 0)
toolStrip1.Margin = New System.Windows.Forms.Padding(1)
toolStrip1.Name = "toolStrip1"
toolStrip1.Padding = New System.Windows.Forms.Padding(0, 0, 2, 0)
toolStrip1.RenderMode = System.Windows.Forms.ToolStripRenderMode.System
toolStrip1.ShowItemToolTips = False
toolStrip1.Size = New System.Drawing.Size(109, 273)
toolStrip1.Stretch = True
toolStrip1.TabIndex = 0
toolStrip1.TabStop = True
toolStrip1.Text = "toolStrip1"
toolStrip1.TextDirection = System.Windows.Forms.ToolStripTextDirection.Vertical90

Remarks

Use the ToolStripItemImageScaling property to control the default size of an image. Use SizeToFit to make the size of the image on a ToolStripItem to automatically adjust to fit on a ToolStrip while retaining the original image proportions.

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.