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 のイメージの 0 から始まるインデックス。 既定値は -1 です。これは、イメージ リストが空であることを意味します。

属性

BrowsableAttribute TypeConverterAttribute RelatedImageListAttribute

例外

ArgumentOutOfRangeException

value が -1 未満です。

注釈

ImageKey は ImageIndex 相互に排他的です。つまり、一方が設定されている場合、もう一方は無効な値に設定され、無視されます。 プロパティを ImageKey 設定すると、 ImageIndex プロパティは自動的に -1 に設定されます。 または、プロパティを ImageIndex 設定すると、 ImageKey 自動的に空の文字列 ("") に設定されます。

Image、ImageAlign、ImageIndex、ImageKey、ImageScaling の各プロパティは、画像処理のさまざまな側面に関連します。 コントロールで ToolStrip イメージを使用する場合は、これらのプロパティを直接設定するか、実行時専用 ImageList プロパティを設定します。

画像の拡大縮小は、次のように、ToolStrip と ToolStripItem 両方のプロパティの相互作用によって決定されます。

• ImageScalingSize は、画像の ImageScaling の設定とコンテナーの AutoSize の設定の組み合わせによって決定される最終的な画像のスケールです。

  • AutoSize が true (既定値) であり ToolStripItemImageScaling が SizeToFit の場合は、画像の拡大縮小は行われず、ToolStrip のサイズは最大の項目のサイズまたは指定された最小サイズになります。

  • AutoSize が false で、ToolStripItemImageScaling が None の場合は、画像と ToolStrip のどちらの拡大縮小も行われません。

プロパティ値が ImageList 変更 nullされた場合、プロパティは ImageIndex 既定値 -1 を返します。 ただし、割り当てられた ImageIndex 値は内部的に保持され、別 ImageList のオブジェクトがプロパティに ImageList 割り当てられるときに使用されます。 プロパティにImageList割り当てられた新しいImageListプロパティ値がImageList.ImageCollection.Count、プロパティに割り当てられたImageIndex値から 1 を引いた値以下の場合 (コレクションが 0 から始まるインデックスを考慮するため)ImageIndex、プロパティ値はプロパティ値よりCount小さい値に調整されます。 たとえば、3 つの画像がありImageIndex、プロパティが ImageList 2 に設定されているボタン コントロールを考えてみます。 ボタンに 2 つの画像しか割り当てされていない新しい ImageList イメージが割り当てられている場合、値は ImageIndex 1 に変わります。