ButtonBase.ImageIndex プロパティ

.NET Framework クラス ライブラリ リファレンス

ButtonBase.ImageIndex プロパティ

ボタン コントロールに表示されているイメージのイメージ リスト内でのインデックス値を取得または設定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

<LocalizableAttribute(True)> _
Public Property ImageIndex As
 Integer

Visual Basic (使用法)

Dim instance As ButtonBase
Dim value As Integer

value = instance.ImageIndex

instance.ImageIndex = value

C#

[LocalizableAttribute(true)] 
public int ImageIndex { get;
 set; }

C++

[LocalizableAttribute(true)] 
public:
property int ImageIndex {
    int get ();
    void set (int value);
}

J#

/** @property */
public int get_ImageIndex ()

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

JScript

public function get ImageIndex
 () : int

public function set ImageIndex
 (value : int)

プロパティ値
ImageList 内でのイメージの位置を表す 0 から始まるインデックス。既定値は -1 です。

例外

例外の種類	条件
ArgumentOutOfRangeException	代入された値が ImageIndex の下限値より小さいです。

解説

ImageIndex プロパティまたは ImageList プロパティが設定されている場合は、Image プロパティが既定値の null 参照 (Visual Basic では Nothing) に設定されます。

メモ

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

使用例

派生クラス Button を使用して、ImageList プロパティと ImageIndex プロパティを設定するコード例を次に示します。このコードでは、ImageList が作成されており、そこに Image が 1 つ以上割り当てられている必要があります。また、C:\Graphics ディレクトリに MyBitMap.bmp という名前のビットマップ イメージが格納されている必要もあります。

Visual Basic

Private Sub AddMyImage()
    ' Assign an image to the ImageList.
    ImageList1.Images.Add(Image.FromFile("C:\Graphics\MyBitmap.bmp"))
    ' Assign the ImageList to the button control.   
    button1.ImageList = ImageList1
    ' Select the image from the ImageList (using the ImageIndex property).
    
    button1.ImageIndex = 0
End Sub 'AddMyImage

C#

private void AddMyImage()
 {
    // Assign an image to the ImageList.
    ImageList1.Images.Add(Image.FromFile("C:\\Graphics\\MyBitmap.bmp"));
    // Assign the ImageList to the button control.   
    button1.ImageList = ImageList1;
    // Select the image from the ImageList (using the ImageIndex property).
    
    button1.ImageIndex = 0;
 }
 

C++

private:
   void AddMyImage()
   {
      // Assign an image to the imageList.
      imageList1->Images->Add( Image::FromFile( "C:\\Graphics\\MyBitmap.bmp"
 ) );
      // Assign the imageList to the button control.
      button1->ImageList = imageList1;
      // Select the image from the ImageList (using the ImageIndex property).
      button1->ImageIndex = 0;
   }

J#

private void AddMyImage()
{
    // Assign an image to the ImageList.
    imageList1.get_Images().Add(Image.FromFile(
        "C:\\Graphics\\MyBitmap.bmp"));
    // Assign the ImageList to the button control.   
    button1.set_ImageList(imageList1);
    // Select the image from the ImageList (using the ImageIndex property).
    
    button1.set_ImageIndex(0);
} //AddMyImage

JScript

private function AddMyImage()
 {
    // Assign an image to the ImageList.
    ImageList1 = new ImageList;
    ImageList1.Images.Add(Image.FromFile("C:\\Graphics\\MyBitmap.bmp"));
    // Assign the ImageList to the button control.   
    button1.ImageList = ImageList1;
    // Select the image from the ImageList (using the ImageIndex property).
    
    button1.ImageIndex = 0;
 }
 

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
ButtonBase クラス
ButtonBase メンバ
System.Windows.Forms 名前空間
ImageList