ToolStripItem.ImageIndex 属性

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

获取或设置在该项上显示的图像的索引值。

public:
 property int ImageIndex { int get(); void set(int value); };

[System.ComponentModel.Browsable(false)]
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.NoneExcludedImageIndexConverter))]
[System.Windows.Forms.RelatedImageList("Owner.ImageList")]
public int ImageIndex { get; set; }

[<System.ComponentModel.Browsable(false)>]
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.NoneExcludedImageIndexConverter))>]
[<System.Windows.Forms.RelatedImageList("Owner.ImageList")>]
member this.ImageIndex : int with get, set

Public Property ImageIndex As Integer

属性值

Int32

ImageList 中为该项显示的图像的从零开始的索引。 默认值为 -1，表明图像列表为空。

属性

BrowsableAttribute TypeConverterAttribute RelatedImageListAttribute

例外

ArgumentOutOfRangeException

value 小于 -1。

注解

ImageKey 并且 ImageIndex 是互斥的，这意味着如果设置了一个，另一个设置为无效值并忽略。 如果设置该 ImageKey 属性，该 ImageIndex 属性将自动设置为 -1。 或者，如果设置 ImageIndex 属性，则 ImageKey 会自动将此属性设置为空字符串 (“”) 。

ImageAlign、Image、ImageIndexImageKey和ImageScaling属性与图像处理的各个方面有关。 通过直接设置这些属性或设置仅ImageList运行时属性，在控件中使用ToolStrip图像。

图像缩放由两者ToolStripToolStripItem中的属性交互决定，如下所示：

• ImageScalingSize 是最终映像的规模，由映像 ImageScaling 设置和容器 AutoSize 设置的组合决定。

  • true 如果AutoSize (默认) 且ToolStripItemImageScalingSizeToFit不发生图像缩放，并且ToolStrip大小为最大项或规定的最小大小。

  • 如果是AutoSize且ToolStripItemImageScaling不是None，则不会发生图像和ToolStrip缩放。false

ImageList如果属性值更改为 null，则ImageIndex属性返回其默认值 -1。 但是，分配ImageIndex的值在内部保留，并在为属性分配ImageList另一个ImageList对象时使用。 如果分配给ImageList该属性的新ImageList属性的ImageList.ImageCollection.Count属性值小于或等于分配给ImageIndex该属性的值减去一 (，以考虑集合为从零开始的索引) ，则ImageIndex属性值将调整为小于Count属性值的一个值。 例如，请考虑一个按钮控件，该 ImageList 控件具有三个图像，其 ImageIndex 属性设置为 2。 如果为按钮分配了只有两个图像的新 ImageList 图像，则 ImageIndex 该值将更改为 1。