ListBox

[C#] ListBoxの選択をプログラムから解除する方法

2025-01-18更新日: 2025-01-18

C#のListBoxで選択をプログラムから解除するには、ListBox.ClearSelected()メソッドを使用します。

このメソッドは、ListBox内のすべての選択を解除し、選択されている項目がない状態にします。

例えば、myListBox.ClearSelected();とすることで、myListBoxの選択がすべて解除されます。

これにより、ユーザーが選択した項目をプログラム的にリセットしたい場合に便利です。

選択解除後、SelectedIndexプロパティは-1になり、SelectedItemプロパティはnullになります。

目次から探す

プログラムから選択を解除する方法
選択解除の応用例
まとめ

プログラムから選択を解除する方法

C#のListBoxコントロールでは、ユーザーが選択した項目をプログラムから解除する方法がいくつかあります。

ここでは、主に3つの方法を紹介します。

ClearSelectedメソッドの使い方

ClearSelectedメソッドを使用すると、指定したインデックスの項目の選択を解除できます。

このメソッドは、特定の項目を選択解除したい場合に便利です。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの項目を追加
        listBox1.Items.Add("項目1");
        listBox1.Items.Add("項目2");
        listBox1.Items.Add("項目3");
        
        // 1番目の項目を選択
        listBox1.SelectedIndex = 0;
        // 選択を解除
        listBox1.ClearSelected(); // すべての選択を解除
    }
}

上記のコードでは、ListBoxに3つの項目を追加し、最初の項目を選択した後、ClearSelectedメソッドを使って選択を解除しています。

SelectedIndexプロパティの活用

SelectedIndexプロパティを使用して、選択されている項目のインデックスを-1に設定することで、選択を解除することもできます。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの項目を追加
        listBox1.Items.Add("項目1");
        listBox1.Items.Add("項目2");
        listBox1.Items.Add("項目3");
        
        // 1番目の項目を選択
        listBox1.SelectedIndex = 0;
        // 選択を解除
        listBox1.SelectedIndex = -1; // 選択を解除
    }
}

この方法では、SelectedIndexを-1に設定することで、ListBox内のすべての選択を解除しています。

SelectedItemプロパティのリセット

SelectedItemプロパティを使用して、選択されている項目をnullに設定することでも選択を解除できます。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの項目を追加
        listBox1.Items.Add("項目1");
        listBox1.Items.Add("項目2");
        listBox1.Items.Add("項目3");
        
        // 1番目の項目を選択
        listBox1.SelectedIndex = 0;
        // 選択を解除
        listBox1.SelectedItem = null; // 選択を解除
    }
}

このコードでは、SelectedItemをnullに設定することで、選択を解除しています。

これにより、ListBox内の選択がクリアされます。

選択解除の応用例

ListBoxの選択解除は、さまざまなシナリオで活用できます。

ここでは、具体的な応用例を3つ紹介します。

フォーム初期化時の選択解除

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

これにより、ユーザーがフォームを開いたときに、何も選択されていない状態にすることができます。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの項目を追加
        listBox1.Items.Add("項目1");
        listBox1.Items.Add("項目2");
        listBox1.Items.Add("項目3");
        
        // フォーム初期化時に選択を解除
        listBox1.ClearSelected(); // 初期化時に選択を解除
    }
}

このコードでは、フォームが初期化されると同時に、ListBoxの選択が解除されます。

ボタン操作による選択解除

ボタンをクリックすることで、ListBoxの選択を解除することも可能です。

ユーザーが特定のアクションを行った際に、選択をクリアするのに便利です。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの項目を追加
        listBox1.Items.Add("項目1");
        listBox1.Items.Add("項目2");
        listBox1.Items.Add("項目3");
        
        // ボタンのクリックイベントを設定
        button1.Click += Button1_Click;
    }
    private void Button1_Click(object sender, EventArgs e)
    {
        // ボタンがクリックされたときに選択を解除
        listBox1.ClearSelected(); // ボタン操作で選択を解除
    }
}

この例では、ボタンがクリックされると、ListBoxの選択が解除されます。

条件に応じた選択解除

特定の条件に基づいて選択を解除することもできます。

たとえば、特定の項目が選択されている場合にのみ選択を解除することができます。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
        
        // ListBoxの項目を追加
        listBox1.Items.Add("項目1");
        listBox1.Items.Add("項目2");
        listBox1.Items.Add("項目3");
        
        // 条件に応じて選択を解除
        if (listBox1.SelectedIndex == 1) // 2番目の項目が選択されている場合
        {
            listBox1.ClearSelected(); // 選択を解除
        }
    }
}