[C#] ListBoxの選択インデックスを取得・設定する方法

Q: 選択インデックスが-1になるのはなぜ？

SelectedIndexプロパティが-1になるのは、ListBoxにおいて何も選択されていない状態を示しています。 具体的には、以下のような場合に-1が返されます。 ユーザーがアイテムを選択していない場合 プログラムで選択をクリアした場合(例：listBox1.ClearSelected()を使用した場合) ListBoxが初期化された直後で、まだ選択が行われていない場合 この状態を考慮して、選択されていない場合の処理を行うことが重要です。

Q: 複数選択を有効にするにはどうすればいい？

ListBoxで複数選択を有効にするには、SelectionModeプロパティを設定する必要があります。 以下の手順で設定できます。 ListBoxのプロパティウィンドウを開く。 SelectionModeプロパティをMultiSimpleまたはMultiExtendedに設定する。 MultiSimple: ユーザーが複数のアイテムを選択できるが、CtrlやShiftキーを使用しなくても選択可能。 MultiExtended: CtrlやShiftキーを使用して複数のアイテムを選択することができる。 これにより、ユーザーは複数のアイテムを選択できるようになります。

Q: ListBoxの選択をクリアする方法は？

ListBoxの選択をクリアするには、ClearSelectedメソッドを使用します。 このメソッドを呼び出すことで、すべての選択を解除することができます。 以下は、選択をクリアする方法の例です。 例：listBox1.ClearSelected(); このコードを実行すると、ListBox内のすべての選択が解除され、SelectedIndexプロパティは-1になります。 また、特定のインデックスの選択を解除したい場合は、SelectedIndexプロパティに-1を設定することでも選択をクリアできます。

2024-09-15

C#のListBoxコントロールで選択インデックスを取得するには、SelectedIndexプロパティを使用します。

このプロパティは、現在選択されている項目のインデックスを返します。

選択されている項目がない場合は-1を返します。

選択インデックスを設定するには、SelectedIndexプロパティにインデックス番号を代入します。

例えば、listBox.SelectedIndex = 2;とすることで、3番目の項目を選択できます。

複数選択が可能な場合は、SelectedIndicesプロパティを使用して選択されたすべてのインデックスを取得できます。

これにより、ユーザーの選択状態をプログラムで制御することが可能です。

この記事でわかること

ListBoxの選択インデックスの取得方法
選択インデックスの設定方法
複数選択の管理方法
選択変更時のイベント処理
ListBoxのデータ操作の実例

目次から探す

選択インデックスの取得方法

SelectedIndexプロパティの使い方

ListBoxの選択インデックスを取得するためには、SelectedIndexプロパティを使用します。

このプロパティは、現在選択されているアイテムのインデックスを返します。

選択されていない場合は、-1が返されます。

以下は、SelectedIndexプロパティを使用したサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの選択インデックスを取得
        int selectedIndex = listBox1.SelectedIndex; // listBox1はListBoxの名前
        
        // インデックスを表示
        MessageBox.Show($"選択されているインデックス: {selectedIndex}");
    }
}

このコードを実行すると、選択されているアイテムのインデックスがメッセージボックスに表示されます。

選択されていない場合の処理

SelectedIndexプロパティが-1を返す場合、ListBoxには何も選択されていないことを意味します。

この場合の処理を行うことが重要です。

以下のサンプルコードでは、選択されていない場合の処理を示しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの選択インデックスを取得
        int selectedIndex = listBox1.SelectedIndex; // listBox1はListBoxの名前
        
        // 選択されていない場合の処理
        if (selectedIndex == -1)
        {
            MessageBox.Show("何も選択されていません。");
        }
        else
        {
            MessageBox.Show($"選択されているインデックス: {selectedIndex}");
        }
    }
}

このコードでは、選択されていない場合に「何も選択されていません。」というメッセージが表示されます。

複数選択時のインデックス取得

ListBoxが複数選択を許可している場合、選択されているすべてのインデックスを取得することができます。

SelectedIndicesプロパティを使用すると、選択されているアイテムのインデックスのコレクションを取得できます。

以下はそのサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // 複数選択されたインデックスを取得
        var selectedIndices = listBox1.SelectedIndices; // listBox1はListBoxの名前
        
        // 選択されたインデックスを表示
        foreach (int index in selectedIndices)
        {
            MessageBox.Show($"選択されているインデックス: {index}");
        }
    }
}

このコードを実行すると、選択されているすべてのインデックスがメッセージボックスに表示されます。

複数選択を有効にするには、ListBoxのプロパティでSelectionModeをMultiSimpleまたはMultiExtendedに設定する必要があります。

選択インデックスの設定方法

SelectedIndexプロパティの設定

ListBoxの選択インデックスを設定するには、SelectedIndexプロパティを使用します。

このプロパティにインデックスを代入することで、指定したインデックスのアイテムを選択状態にすることができます。

以下は、SelectedIndexプロパティを設定するサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの選択インデックスを設定
        listBox1.SelectedIndex = 2; // listBox1はListBoxの名前
        
        // 選択されたインデックスを表示
        MessageBox.Show($"選択されたインデックス: {listBox1.SelectedIndex}");
    }
}

このコードを実行すると、ListBoxの3番目のアイテムが選択され、選択されたインデックスがメッセージボックスに表示されます。

無効なインデックスを設定した場合の挙動

SelectedIndexプロパティに無効なインデックス(例えば、-1やListBoxのアイテム数以上のインデックス)を設定した場合、ListBoxの選択は変更されません。

以下のサンプルコードでは、無効なインデックスを設定した場合の挙動を示しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // 無効なインデックスを設定
        listBox1.SelectedIndex = -1; // 何も選択されない
        
        // 選択されたインデックスを表示
        MessageBox.Show($"選択されたインデックス: {listBox1.SelectedIndex}"); // -1が表示される
    }
}

このコードを実行すると、選択されたインデックスは-1のままで、何も選択されていない状態が維持されます。

初期選択の設定

フォームが初期化される際に、ListBoxの初期選択を設定することができます。

これにより、アプリケーション起動時に特定のアイテムを自動的に選択することが可能です。

以下は、初期選択を設定するサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxにアイテムを追加
        listBox1.Items.Add("アイテム1");
        listBox1.Items.Add("アイテム2");
        listBox1.Items.Add("アイテム3");
        
        // 初期選択を設定
        listBox1.SelectedIndex = 0; // 最初のアイテムを選択
        
        // 選択されたインデックスを表示
        MessageBox.Show($"初期選択されたインデックス: {listBox1.SelectedIndex}");
    }
}

このコードを実行すると、ListBoxの最初のアイテムが選択され、初期選択されたインデックスがメッセージボックスに表示されます。

これにより、ユーザーがアプリケーションを起動した際に、すぐに選択された状態を確認できます。

応用例

複数選択の管理

ListBoxで複数選択を管理する場合、SelectionModeプロパティをMultiSimpleまたはMultiExtendedに設定する必要があります。

これにより、ユーザーは複数のアイテムを選択できるようになります。

以下は、複数選択を管理するサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの選択モードを設定
        listBox1.SelectionMode = SelectionMode.MultiExtended; // 複数選択を許可
        
        // アイテムを追加
        listBox1.Items.Add("アイテム1");
        listBox1.Items.Add("アイテム2");
        listBox1.Items.Add("アイテム3");
        
        // 初期選択を設定
        listBox1.SelectedIndex = 0; // 最初のアイテムを選択
    }
}

このコードを実行すると、ユーザーは複数のアイテムを選択できるようになります。

選択されたアイテムは、後で処理することができます。

選択変更時のイベント処理

ListBoxの選択が変更されたときに特定の処理を行うには、SelectedIndexChangedイベントを使用します。

このイベントは、選択されているアイテムが変更されたときに発生します。

以下は、選択変更時のイベント処理を示すサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // アイテムを追加
        listBox1.Items.Add("アイテム1");
        listBox1.Items.Add("アイテム2");
        listBox1.Items.Add("アイテム3");
        
        // 選択変更時のイベントハンドラを追加
        listBox1.SelectedIndexChanged += ListBox1_SelectedIndexChanged;
    }
    private void ListBox1_SelectedIndexChanged(object sender, EventArgs e)
    {
        // 選択されたインデックスを取得
        int selectedIndex = listBox1.SelectedIndex;
        
        // 選択されたアイテムを表示
        MessageBox.Show($"選択されたアイテム: {listBox1.Items[selectedIndex]}");
    }
}

このコードを実行すると、ユーザーがListBoxの選択を変更するたびに、選択されたアイテムがメッセージボックスに表示されます。

選択インデックスを用いたデータ操作

選択インデックスを使用して、ListBoxに表示されているデータを操作することができます。

例えば、選択されたアイテムを削除する場合、SelectedIndexを利用して対象のアイテムを特定し、削除処理を行います。

以下は、選択インデックスを用いたデータ操作のサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // アイテムを追加
        listBox1.Items.Add("アイテム1");
        listBox1.Items.Add("アイテム2");
        listBox1.Items.Add("アイテム3");
        
        // 削除ボタンのクリックイベントを設定
        buttonDelete.Click += ButtonDelete_Click;
    }
    private void ButtonDelete_Click(object sender, EventArgs e)
    {
        // 選択されたインデックスを取得
        int selectedIndex = listBox1.SelectedIndex;
        
        // 選択されている場合のみ削除
        if (selectedIndex != -1)
        {
            listBox1.Items.RemoveAt(selectedIndex); // 選択されたアイテムを削除
            MessageBox.Show("アイテムが削除されました。");
        }
        else
        {
            MessageBox.Show("削除するアイテムを選択してください。");
        }
    }
}

このコードを実行すると、ユーザーが選択したアイテムを削除することができ、削除後にメッセージボックスが表示されます。

選択されていない場合は、削除を促すメッセージが表示されます。