WinForms ComboBox包含式自动补全崩溃问题修复及提示需求

问题背景 #

需要实现一个ComboBox控件，能自动查找并提示字典中包含任意输入单词的短语。现有方案在特定输入场景下会崩溃，抛出System.ArgumentOutOfRangeException（提示“InvalidArgument=Value of '0' is not valid for 'index'”）：

• 输入orser、erot等曾部分匹配字典内容的文本，点击窗体时崩溃
• 输入abc、zui等完全无匹配内容时无异常

字典短语：

• Doors opening elements
• exterior doors
• interior doors
• sliding doors

原代码：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;

namespace WindowsFormsApp
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            listOriginal.Add("Doors opening elements");
            listOriginal.Add("exterior doors");
            listOriginal.Add("interior doors");
            listOriginal.Add("sliding doors");

            this.comboBx.Items.AddRange(listOriginal.ToArray());
        }

        // Bind default keywords
        List<string> listOriginal = new List<string>();
        // save new keywords
        List<string> listNew = new List<string>();
        private void comboBx_TextUpdate(object sender, EventArgs e)
        {
            //clear combobox
            this.comboBx.Items.Clear();
            //clear listNew
            listNew.Clear();
            foreach (var item in listOriginal)
            {
                // call ToLower() .. not case sensitive
                if (item.ToLower().Contains(this.comboBx.Text))
                {
                    //add to ListNew
                    listNew.Add(item);
                }
            }
            this.comboBx.Items.AddRange(listNew.ToArray());
            this.comboBx.SelectionStart = this.comboBx.Text.Length;
            Cursor = Cursors.Default;
            // Automatically pop up drop-down
            this.comboBx.DroppedDown = true;
        }
    }
}

异常堆栈：

System.ArgumentOutOfRangeException
  HResult=0x80131502
  Message=InvalidArgument=Value of '0' is not valid for 'index'.
Parameter name: index
  Source=System.Windows.Forms
  StackTrace:
   at System.Windows.Forms.ComboBox.ObjectCollection.get_Item(Int32 index)
   at System.Windows.Forms.ComboBox.get_Text()
   at System.Windows.Forms.ComboBox.WmReflectCommand(Message& m)
   at System.Windows.Forms.ComboBox.WndProc(Message& m)
   at System.Windows.Forms.NativeWindow.DebuggableCallback(IntPtr hWnd, Int32 msg, IntPtr wparam, IntPtr lparam)
   at System.Windows.Forms.UnsafeNativeMethods.SendMessage(HandleRef hWnd, Int32 msg, IntPtr wParam, IntPtr lParam)
   at System.Windows.Forms.Control.SendMessage(Int32 msg, IntPtr wparam, IntPtr lparam)
   at System.Windows.Forms.Control.ReflectMessageInternal(IntPtr hWnd, Message& m)
   at System.Windows.Forms.Control.WmCommand(Message& m)
   at System.Windows.Forms.Control.WndProc(Message& m)
   at System.Windows.Forms.Form.WndProc(Message& m)
   at System.Windows.Forms.NativeWindow.DebuggableCallback(IntPtr hWnd, Int32 msg, IntPtr wparam, IntPtr lparam)
   at System.Windows.Forms.UnsafeNativeMethods.DispatchMessageW(MSG& msg)
   at System.Windows.Forms.Application.ComponentManager.System.Windows.Forms.UnsafeNativeMethods.IMsoComponentManager.FPushMessageLoop(IntPtr dwComponentID, Int32 reason, Int32 pvLoopData)
   at System.Windows.Forms.Application.ThreadContext.RunMessageLoopInner(Int32 reason, ApplicationContext context)
   at System.Windows.Forms.Application.ThreadContext.RunMessageLoop(Int32 reason, ApplicationContext context)
   at WindowsFormsApp.Program.Main() in C:\Users\denis\source\repos\WindowsFormsApp\WindowsFormsApp\Program.cs:line 15

崩溃原因分析 #

原代码在TextUpdate事件中直接清空ComboBox.Items，之后访问comboBx.Text时，ComboBox内部会尝试通过选中索引获取Item内容。当输入文本从“有部分匹配”变为“无匹配”时，控件内部的选中索引状态未同步清空，此时Items集合为空，访问Items[0]就会触发索引越界异常。

修复方案及代码实现 #

修复关键点：

1. 先保存当前输入的文本到临时变量，避免清空Items后访问comboBx.Text出错
2. 清空Items后手动设置ComboBox的Text为临时变量，同步控件内部状态
3. 添加标记避免无匹配时重复弹出MessageBox
4. 无匹配时收起下拉框，避免控件状态混乱

修复后的完整代码：

using System;
using System.Collections.Generic;
using System.Windows.Forms;

namespace WindowsFormsApp
{
    public partial class Form1 : Form
    {
        // 原始字典短语
        private readonly List<string> _originalPhrases = new List<string>
        {
            "Doors opening elements",
            "exterior doors",
            "interior doors",
            "sliding doors"
        };

        // 标记是否已弹出无匹配提示，避免重复触发
        private bool _noMatchPromptShown;

        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            comboBx.Items.AddRange(_originalPhrases.ToArray());
        }

        private void comboBx_TextUpdate(object sender, EventArgs e)
        {
            // 先保存当前输入的文本，避免清空Items后访问Text出错
            var currentText = comboBx.Text.Trim();
            // 清空Items前先收起下拉框
            comboBx.DroppedDown = false;
            comboBx.Items.Clear();

            var matchedItems = _originalPhrases.FindAll(item => 
                item.IndexOf(currentText, StringComparison.OrdinalIgnoreCase) >= 0);

            if (matchedItems.Count > 0)
            {
                comboBx.Items.AddRange(matchedItems.ToArray());
                comboBx.DroppedDown = true;
                // 有匹配时重置提示标记
                _noMatchPromptShown = false;
            }
            else
            {
                // 无匹配且未弹出过提示时，显示MessageBox
                if (!_noMatchPromptShown && !string.IsNullOrEmpty(currentText))
                {
                    MessageBox.Show("未找到匹配的短语", "提示", MessageBoxButtons.OK, MessageBoxIcon.Information);
                    _noMatchPromptShown = true;
                }
            }

            // 恢复光标位置到文本末尾
            comboBx.Text = currentText;
            comboBx.SelectionStart = currentText.Length;
            Cursor = Cursors.Default;
        }
    }
}

功能说明 #

1. 包含式匹配：不区分大小写，只要短语包含输入文本就会被筛选出来
2. 崩溃修复：通过提前保存输入文本、同步控件Text状态，避免了索引越界异常
3. 无匹配提示：当输入无匹配内容时，仅弹出一次提示框，不会重复触发
4. 状态同步：有匹配时自动展开下拉框，无匹配时收起下拉框，保持控件状态稳定

内容的提问来源于stack exchange，提问作者Denis