This documentation is archived and is not being maintained.

ToolStripItem.ImageIndex Property

Gets or sets the index value of the image that is displayed on the item.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

[TypeConverterAttribute(typeof(NoneExcludedImageIndexConverter))] 
[LocalizableAttribute(true)] 
public int ImageIndex { get; set; }
/** @property */
public int get_ImageIndex ()

/** @property */
public void set_ImageIndex (int value)

public function get ImageIndex () : int

public function set ImageIndex (value : int)

Not applicable.

Property Value

The zero-based index of the image in the ImageList that is displayed for the item. The default is -1, signifying that the image list is empty.

Exception typeCondition

ArgumentException

The value specified is less than -1.

The ImageIndex property specifies the position of the image in the image list. The ImageKey property specifies the image itself.

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.

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: