自定义用户控件未在自动生成的代码中初始化

Question

这种情况以前发生过很多次，但我从来没有费心去弄清楚为什么，现在我厌倦了：

例如，我从RichTextBox或Panel派生一个类，我重建我的项目以将类添加到VS设计器工具箱，然后我拖动并将自定义用户控件拖放到窗体中。一切正常，我可以运行我的项目...

当我通过设计器编辑表单或自定义用户控件的属性时，问题就出现了。有时，设计器从其代码隐藏中删除初始化行，从而导致设计器和可执行文件出现异常，因为控件仍未初始化。

换句话说，从 Form1.Designer.cs 中删除了以下行：

this.customRichTextBox1=new CustomRichTextBox();

代码隐藏中没有删除其他行，因此自定义控件的属性仍然被设置，尽管变量保持未初始化状态。

我的解决方案一直是在设计器代码隐藏中手动初始化我的用户控件，但设计器最终再次将其删除。

我相信当我通过设计器构建自定义用户控件时不会发生这种情况（但我不完全确定这一点）。仅当我手动定义如下内容时才会发生这种情况：

class CustomRichTextBox:RichTextBox{}

这太烦人了。我做错了什么？

---

正如@Cody 所要求的，以下是重现问题的步骤。我正在使用 VS2010，但我认为自 2005 年以来我就遇到了这个问题。

步骤 1. 创建新的 Windows 窗体应用程序，任何框架

步骤 2. 在主 Form 类下面添加以下类：（恰好这是导致我这次出现此问题的控件。）

class CustomRichTextBox : RichTextBox
{
    Timer tt = new Timer();

    internal CustomRichTextBox()
    {
        tt.Tick += new EventHandler(tt_Tick);
        tt.Interval = 200;
    }


    protected override void OnTextChanged(EventArgs e)
    {
        tt.Stop();
        tt.Start();
    }

    void tt_Tick(object sender, EventArgs e)
    {
        System.Diagnostics.Trace.WriteLine("Hello world!");
    }
}

步骤 3. 按 F6 重建。

步骤 4. 通过从工具箱中拖放，将 CustomRichTextBox 控件添加到表单中。

步骤 5. 如果您愿意，可以按 F5 来测试应用程序，但它应该可以工作。关闭正在运行的应用程序。

步骤 6. 按 F6 进行重建，此时，设计器应该崩溃并显示以下消息：“变量‘customRichTextBox1’未声明或从未分配。” （在一种情况下，整个 VS 完全崩溃，但错误通常包含在设计器内。）

步骤 7. 要纠正问题，请进入代码隐藏并初始化变量，但下次重建时，初始化行将会消失。

Answer 1

感谢所有尝试回答我的问题以及发表评论帮助我诊断和解决问题的人。

将“internal”关键字与控件的构造函数一起使用时会出现此问题。将其更改为“公共”可以解决问题。出现此行为的原因可能是设计者自己的类无法看到构造函数，因为它们不在我的类的命名空间内，除非将其标记为公共。这一切都是有道理的，从现在开始我将使用 public 关键字。

该类不需要位于其自己的单独文件中，也不需要像其他答案所建议的那样成为文件中第一个声明的类。

下面的类运行良好，因为构造函数的关键字已更改为 public。

class CustomRichTextBox : RichTextBox
{
    Timer tt = new Timer();

    public CustomRichTextBox()
    {
        tt.Tick += new EventHandler(tt_Tick);
        tt.Interval = 200;
    }


    protected override void OnTextChanged(EventArgs e)
    {
        tt.Stop();
        tt.Start();
    }

    void tt_Tick(object sender, EventArgs e)
    {
        System.Diagnostics.Trace.WriteLine("Hello world!");
    }
}

Answer 2

您的构建设置为“调试”还是“发布”？
我认为它已发布，因为我认为编译器优化了代码并删除了设计器生成的行。

Answer 3

您是否尝试过将控制代码放在自己的文件中？过去，当设计器代码不是文件中的第一类时，即使是表单设计器，我也遇到过问题。

Answer 4

我遇到了类似的问题，这篇文章帮助我解决了。我有一个扩展 ComboBox 的 CustomControl，该类包含一个内部私有类 YearItem。我试图仅突出显示理解问题和解决方案所需的代码。

public class YearsCbo : ComboBox //Inherits ComboBox
{
    public YearsCbo() { 
        fill();
    }
    private void fill() { // <<<=== THIS METHOD ADDED ITEMS TO THE COMBOBOX
        for(int idx = 0; idx < 25; idx++) {
            this.Items.Add(new YearItem());
        }
    }
    // Other code not shown
    private class YearItem {} // <<<=== The VS designer can't access this class and yet 
        // it generated code to try to do so.  That code then fails to compile.
        // The compiler error rightfully says it is unable to access 
        // the private class YearItem
}

我可以将该控件 YearsCbo 拖放到表单上，它可以正常工作，但在我返回并编辑表单后，VS 设计器生成的代码无法编译。有问题的代码是这样的：

Dim YearItem1 As my.ns.YearsCbo.YearItem = New my.ns.YearsCbo.YearItem()
Dim YearItem2 As my.ns.YearsCbo.YearItem = New my.ns.YearsCbo.YearItem()
// This was repeated 25 times because in my constructor I created 25 of these
Me.YearsCbo1.Items.AddRange(New Object() {YearItem1, 2, 3, ..., YearItem25 });

请注意，设计器生成的代码试图访问私有类。它不需要这样做，但出于某种原因它这样做了。

通过反复试验，以及这篇文章： 如何判断.NET代码是否正在由Visual Studio设计器运行提出了一个解决方案：

我添加了一个属性来判断我是否正在设计器中运行。

public bool HostedDesignMode
{
    get
    {
        if (System.ComponentModel.LicenseManager.UsageMode == System.ComponentModel.LicenseUsageMode.Designtime)
            return true;
        else
            return false;
    }
}

我还更改了构造函数，以便它不会调用 fill()，因此当设计器运行时，ComboBox 中没有项目，因此设计器感觉不需要手动创建这些项目。

“固定”代码如下所示：

public class YearsCbo : ComboBox //Inherits ComboBox
{
    public YearsCbo() { 
        if ( ! HostedDesignMode ) {
            fill();
        }
    }
    private class YearItem {} // <<<=== Now the VS Designer does not try to access this
}

该代码是在 Win7x64 操作系统上使用 VS2012 Premium 编写的（以防万一）。