ToolStripItem::ImageIndex Property
Gets or sets the index value of the image that is displayed on the item.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
public: [BrowsableAttribute(false)] [RelatedImageListAttribute("Owner.ImageList")] property int ImageIndex { int get(); void set(int value); }
Property Value
Type: System::Int32The 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 | Condition |
|---|---|
| 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.
Available since 2.0