c# - 为什么在修改所选项目时会在 ListBox 中触发 SelectedIndexChanged 事件？

Question

我们得到一个从 Microsoft Visual Studio 模板(PasteBin 上的设计器代码 1 2 3 4 )创建的 Windows 窗体应用程序，带有默认的 ListBox exampleListBox 和 Button 示例按钮。

我们用 1 到 10 的数字填充 ListBox。

for (int i = 0; i < 10; ++i)
{
    exampleListBox.Items.Add(i);
}

然后我们添加两个事件处理程序。

exampleListBox_SelectedIndexChanged 只会将当前选定的索引写入控制台。

private void exampleListBox_SelectedIndexChanged(object sender, EventArgs e)
{
    Console.WriteLine(exampleListBox.SelectedIndex);
}

exampleButton_Click 会将当前选定索引处的项目设置为其自身。如此有效，这绝对不会改变任何东西。

private void exampleButton_Click(object sender, EventArgs e)
{
    exampleListBox.Items[exampleListBox.SelectedIndex] = exampleListBox.Items[exampleListBox.SelectedIndex];
}

单击按钮时，我希望不会发生任何事情。然而，这种情况并非如此。单击该按钮会触发 exampleListBox_SelectedIndexChanged 事件，即使 SelectedIndex 没有更改。

例如，如果我点击 exampleListBox 中索引为 2 的项目，则 exampleListBox.SelectedIndex 将变为 2。如果我按下 exampleButton ，然后 exampleListBox.SelectedIndex 仍然是 2。然而，然后 exampleListBox_SelectedIndexChanged 事件触发。

为什么即使所选索引未更改，事件也会触发？

此外，是否有办法防止这种行为的发生？

Answer 1

当您修改 ListBox 中的项目(或者实际上是 ListBox 的关联 ObjectCollection 中的项目)时，底层代码实际上会删除并重新创建该项目。然后它选择这个新添加的项目。因此，选定的索引已更改，并引发相应的事件。

对于控件为何以这种方式运行，我没有特别令人信服的解释。它要么是为了编程方便而完成的，要么只是 WinForms 原始版本中的一个错误，出于向后兼容的原因，后续版本必须保持该行为。此外，后续版本必须保持相同的行为即使该项目未被修改。这是您观察到的违反直觉的行为。

而且，遗憾的是，它是 not documented — 除非您了解它发生的原因，然后您知道 SelectedIndex 属性实际上在您不知情的情况下在幕后发生了变化。

Quantic 发表评论指向 the relevant portion of the code in the Reference Source :

internal void SetItemInternal(int index, object value) {
    if (value == null) {
        throw new ArgumentNullException("value");
    }

    if (index < 0 || index >= InnerArray.GetCount(0)) {
        throw new ArgumentOutOfRangeException("index", SR.GetString(SR.InvalidArgument, "index", (index).ToString(CultureInfo.CurrentCulture)));
    }

    owner.UpdateMaxItemWidth(InnerArray.GetItem(index, 0), true);
    InnerArray.SetItem(index, value);

    // If the native control has been created, and the display text of the new list item object
    // is different to the current text in the native list item, recreate the native list item...
    if (owner.IsHandleCreated) {
        bool selected = (owner.SelectedIndex == index);
        if (String.Compare(this.owner.GetItemText(value), this.owner.NativeGetItemText(index), true, CultureInfo.CurrentCulture) != 0) {
            owner.NativeRemoveAt(index);
            owner.SelectedItems.SetSelected(index, false);
            owner.NativeInsert(index, value);
            owner.UpdateMaxItemWidth(value, false);
            if (selected) {
                owner.SelectedIndex = index;
            }
        }
        else {
            // NEW - FOR COMPATIBILITY REASONS
            // Minimum compatibility fix for VSWhidbey 377287
            if (selected) {
                owner.OnSelectedIndexChanged(EventArgs.Empty); //will fire selectedvaluechanged
            }
        }
    }
    owner.UpdateHorizontalExtent();
}

在这里，您可以看到，在初始运行时错误检查之后，它会更新 ListBox 的最大项目宽度，在内部数组中设置指定的项目，然后检查是否已创建 native ListBox 控件。实际上，所有 WinForms 控件都是 native Win32 控件的包装器，ListBox 也不异常(exception)。在您的示例中， native 控件肯定已创建，因为它在表单上可见，因此 if (owner.IsHandleCreated) 测试评估为 true。然后它比较项目的文本以查看它们是否相同:

• 如果它们不同，它会删除原始项目，删除选择，添加新项目，如果选择了原始项目，则选择它。这会引发 SelectedIndexChanged 事件。

• 如果它们相同并且项目当前处于选中状态，则如注释所示，“出于兼容性原因”，将手动引发 SelectedIndexChanged 事件。

我们刚刚分析的这个 SetItemInternal 方法是从 ListBox.ObjectCollection 对象的默认属性的 setter 调用的:

public virtual object this[int index] {
    get {
        if (index < 0 || index >= InnerArray.GetCount(0)) {
            throw new ArgumentOutOfRangeException("index", SR.GetString(SR.InvalidArgument, "index", (index).ToString(CultureInfo.CurrentCulture)));
        }

        return InnerArray.GetItem(index, 0);
    }
    set {
        owner.CheckNoDataSource();
        SetItemInternal(index, value);
    }
}

这是您的代码在 exampleButton_Click 事件处理程序中调用的内容。

没有办法阻止这种行为的发生。您必须通过在 SelectedIndexChanged 事件处理程序方法中编写您自己的代码来找到解决它的方法。您可能会考虑从内置的 ListBox 类派生自定义控件类，覆盖 OnSelectedIndexChanged 方法，并将您的解决方法放在这里。这个派生类将为您提供一个方便的位置来存储状态跟踪信息(作为成员变量)，并且它将允许您在整个项目中使用修改后的 ListBox 控件作为直接替换，而无需修改 SelectedIndexChanged 事件处理程序无处不在。

但老实说，这应该不是什么大问题，也不是您需要解决的任何问题。您对 SelectedIndexChanged 事件的处理应该是微不足道的——只需更新表单上的某些状态，例如依赖控件。如果没有发生外部可见的变化，它触发的变化本身基本上是空操作。