如何获取WinForm上所有控件的列表,即使是SplitContainers或Panel中的控件

时间:2015-09-28 22:47:30

标签: c# winforms controls splitcontainer statusstrip

我的WinForm上有几个容器,如Panel,SpliContainer,StatusStrip ......这些容器中的每一个都包含按钮或文本框等基本元素。我需要通过所有表单控件(甚至是Panels,SplitContainers,StatusStrip中的那些)进行迭代以找到一些控件。我尝试使用递归函数

    ListAllControls(Control MainControl)
    {
        foreach (Control control in MainControl.Controls)
        {
            if (control.HasChildren)
            {
                ListAllControls(control);
            }
            else
            { 
                // do something with this control
            }
        }
    }

但是我没有得到容器中的控件!?

更新:

我有一个带有SplitContainer,Panel和StatuStrip的表单。在每个控件中,我有几个子控件,如StatuStrip1中的toolStripStatusLabel1。问题是当我试图通过函数ListAllControls在StatuStrip中找到例如控件toolStripStatusLabel1时我找不到它!?我不知道从表单获取所有控件的任何其他方法。完整的代码在这里:

class Control_Finder
{

    private Control founded_control = null;

    public Control Founded_Control
    {
        get { return founded_control; }
    }

    public void ListAllControls(Control MainControl, string SearchForControl)
    {
        foreach (Control control in MainControl.Controls)
        {
            if (control.HasChildren)
            {
                ListAllControls(control, SearchForControl);
            }
            else
            {
                // check if control has searched name
                if (control.Name == SearchForControl)
                {
                    founded_control = control;
                    return;
                }
            }
        }
    }
} // class

样品:

Form Me = this;
Control_Finder Test = new Control_Finder();
Test.ListAllControls(Me, "toolStripStatusLabel1");

if (Test.Founded_Control != null)
{
      MessageBox.Show("I found control " + Test.Founded_Control.Name + "!");
}
else
{
      MessageBox.Show("Didn't found! :(");
}

对于此示例,我得到未找到:(但是如果我使用StatusStrip1我得到“我找到了控制StatusStrip1!” 我希望这个问题现在比以前更清楚了。

1 个答案:

答案 0 :(得分:3)

最好提供明确显示您特定情况的a good, minimal, complete code example。但是,根据您添加到问题中的信息,我能够创建我认为具有代表性的代码示例。这个答案基于这个例子。


正如评论者LarsTech指出的那样,ToolStripStatusLabel不会继承ControlControlToolStripStatusLabel共享的最具体的基类是Component。所以至少,你在尝试返回Control类型的对象时遇到了一个大问题,但仍然找到ToolStripStatusLabel的实例。即使您确实找到了该对象,也无法将其强制转换为Control

另一个问题是虽然ToolStrip本身确实继承了Control类,但它不会将其子项存储在Controls属性中(即在ControlCollection对象中)。我认为这是因为它的子节点不是Control个对象,因此无法存储在ControlCollection中。在任何情况下,这意味着当您通过表单的对象图表进行递归时,您必须以ToolStrip的其他实例的方式处理Control,以便找到它的子项。


这是一个示例程序,演示了一种可行的方法(请参阅本文的底部,了解本示例中与Designer一起生成的代码):

<强> Form1.cs中:

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

    private void button1_Click(object sender, EventArgs e)
    {
        Component component = FindControl(this.Controls, "toolStripStatusLabel1");

        label2.Text = component != null ?
            "Found control named \"" + GetNameForComponent(component) + "\"" :
            "No control was found";
    }

    private static string GetNameForComponent(Component component)
    {
        Control control = component as Control;

        if (control != null)
        {
            return control.Name;
        }

        ToolStripItem item = component as ToolStripStatusLabel;

        if (item != null)
        {
            return item.Name;
        }

        return "<unknown Component type>";
    }

    private Component FindControl(IEnumerable controlCollection, string name)
    {
        foreach (Component component in controlCollection)
        {
            if (GetNameForComponent(component) == name)
            {
                return component;
            }

            IEnumerable childControlCollection = GetChildrenForComponent(component);

            if (childControlCollection != null)
            {
                Component result = FindControl(childControlCollection, name);

                if (result != null)
                {
                    return result;
                }
            }
        }

        return null;
    }

    private static IEnumerable GetChildrenForComponent(Component component)
    {
        ToolStrip toolStrip = component as ToolStrip;

        if (toolStrip != null)
        {
            return toolStrip.Items;
        }

        Control control = component as Control;

        if (control != null)
        {
            return control.HasChildren ? control.Controls : null;
        }

        return null;
    }
}

由于您正在处理的对象的对象继承的不相交性质,必须进行一些特殊处理:

  1. 您找到的项目可能是Control的实例。 Control的实例将其名称存储在Control.Name属性中,但显然不是Control个对象的实例不会。需要通过识别存储其name属性的类型(在本例中为ToolStripItem.Name)来专门处理它们,但请注意,还有其他非Control类型继承Component和每个都必须单独处理)。我添加了一个GetNameForComponent(Component)方法来封装它。
  2. 在您找到 Control个实例的项目中,有些会将其子项存储在Controls集合中,而其他项目则不会,而是使用其他属性引用存储子项的集合。同样,提供了一个辅助方法(在本例中为GetChildrenForComponent(Component))来封装这种差异。
  3. 解决了这两个问题后,可以轻松编写搜索图表的基本递归方法。请注意,与您的方法相比,我对方法的基本架构进行了一些更改。我认为将此代码作为一个完整的类本身实现是不必要的,并且在任何情况下将结果存储在该类的成员中而不是简单地由该方法返回是特别错误的。

    在我的示例中,我将其简单地实现为单个方法,如果找到则返回有问题的对象。

    另请注意,您的实现不会找到任何本身就是对象容器的对象。我也在我的例子中纠正过这个问题。


    最后一点:遵循上述策略,您必须为每个感兴趣的基类添加代码。也许上面的内容足以满足您的需求,或者您可能有其他容器类型包含非Control对象且不继承ToolStrip。如果是这样,则必须在每个辅助方法中添加适用于这些类型的其他案例。

    另一种方法是使用反射来查找包含例如这个名字和孩子。假设名称始终存储在名为Name的属性中,那么该部分将相对简单。

    但即使在这个简单的例子中,使用反射来获得孩子也相当复杂。不是孩子总是在一个收集对象中,而是从一个名为例如Controls,在一种情况下是名称,但在另一种情况下,名称是Items。人们可以深入挖掘,例如确定在集合中找到的对象的类型,但代码在那时开始变得过于复杂。

    鉴于将ToolStrip儿童视为一种形式的常规Control儿童,这是否真的有意义是值得商榷的,我不建议在真正的一般化解决方案上投入大量精力。最好根据需要处理个别情况,提醒自己,你所做的事情首先并不是一个好主意。 :)


    Form1.Designer.cs:

    partial class Form1
    {
        /// <summary>
        /// Required designer variable.
        /// </summary>
        private System.ComponentModel.IContainer components = null;
    
        /// <summary>
        /// Clean up any resources being used.
        /// </summary>
        /// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        protected override void Dispose(bool disposing)
        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }
    
        #region Windows Form Designer generated code
    
        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        private void InitializeComponent()
        {
            this.statusStrip1 = new System.Windows.Forms.StatusStrip();
            this.toolStripStatusLabel1 = new System.Windows.Forms.ToolStripStatusLabel();
            this.button1 = new System.Windows.Forms.Button();
            this.label1 = new System.Windows.Forms.Label();
            this.label2 = new System.Windows.Forms.Label();
            this.statusStrip1.SuspendLayout();
            this.SuspendLayout();
            // 
            // statusStrip1
            // 
            this.statusStrip1.ImageScalingSize = new System.Drawing.Size(20, 20);
            this.statusStrip1.Items.AddRange(new System.Windows.Forms.ToolStripItem[] {
            this.toolStripStatusLabel1});
            this.statusStrip1.Location = new System.Drawing.Point(0, 228);
            this.statusStrip1.Name = "statusStrip1";
            this.statusStrip1.Size = new System.Drawing.Size(282, 25);
            this.statusStrip1.TabIndex = 0;
            this.statusStrip1.Text = "statusStrip1";
            // 
            // toolStripStatusLabel1
            // 
            this.toolStripStatusLabel1.Name = "toolStripStatusLabel1";
            this.toolStripStatusLabel1.Size = new System.Drawing.Size(111, 20);
            this.toolStripStatusLabel1.Text = "Strip status text";
            // 
            // button1
            // 
            this.button1.Location = new System.Drawing.Point(12, 12);
            this.button1.Name = "button1";
            this.button1.Size = new System.Drawing.Size(75, 23);
            this.button1.TabIndex = 1;
            this.button1.Text = "button1";
            this.button1.UseVisualStyleBackColor = true;
            this.button1.Click += new System.EventHandler(this.button1_Click);
            // 
            // label1
            // 
            this.label1.AutoSize = true;
            this.label1.Location = new System.Drawing.Point(12, 38);
            this.label1.Name = "label1";
            this.label1.Size = new System.Drawing.Size(52, 17);
            this.label1.TabIndex = 2;
            this.label1.Text = "Result:";
            // 
            // label2
            // 
            this.label2.AutoSize = true;
            this.label2.Location = new System.Drawing.Point(70, 38);
            this.label2.Name = "label2";
            this.label2.Size = new System.Drawing.Size(0, 17);
            this.label2.TabIndex = 3;
            // 
            // Form1
            // 
            this.AutoScaleDimensions = new System.Drawing.SizeF(8F, 16F);
            this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
            this.ClientSize = new System.Drawing.Size(282, 253);
            this.Controls.Add(this.label2);
            this.Controls.Add(this.label1);
            this.Controls.Add(this.button1);
            this.Controls.Add(this.statusStrip1);
            this.Name = "Form1";
            this.Text = "Form1";
            this.statusStrip1.ResumeLayout(false);
            this.statusStrip1.PerformLayout();
            this.ResumeLayout(false);
            this.PerformLayout();
    
        }
    
        #endregion
    
        private System.Windows.Forms.StatusStrip statusStrip1;
        private System.Windows.Forms.ToolStripStatusLabel toolStripStatusLabel1;
        private System.Windows.Forms.Button button1;
        private System.Windows.Forms.Label label1;
        private System.Windows.Forms.Label label2;
    }