收集编辑器数据在设计时丢失

时间:2015-08-27 15:00:13

标签: c# winforms collectioneditor

我正在尝试使用Collection<T>作为属性来创建WinForms用户控件(其中T代表一些自定义类)。我已经阅读了很多关于这个主题的内容,但是我不能让它在设计时正常工作(在运行时一切正常)。更确切地说:当我单击属性窗口中的“...”按钮时,集合编辑器显示正常,我可以添加和删除项目。但是,当我单击“确定”按钮时没有任何反应,当我重新打开收集编辑器时,所有项目都将丢失。当我看一下设计器文件时,我看到我的属性被赋值为null,而不是组合集合。我会告诉你最重要的代码:

用户控件:

[Browsable(true),
 Description("The different steps displayed in the control."),
 DesignerSerializationVisibility(DesignerSerializationVisibility.Content),
 Editor(typeof(CustomCollectionEditor), typeof(UITypeEditor))]
public StepCollection Steps
{
    get
    {
        return wizardSteps;
    }
    set
    {
        wizardSteps = value;
        UpdateView(true);
    }
}

StepCollection类:

public class StepCollection : System.Collections.CollectionBase
{
    public StepCollection() : base() { }
    public void Add(Step item) { List.Add(item); }
    public void Remove(int index) { List.RemoveAt(index); }
    public Step this[int index]
    {
        get { return (Step)List[index]; }
    }
}

步骤类:

[ToolboxItem(false),
DesignTimeVisible(false),
Serializable()]
public class Step : Component
{
    public Step(string name) : this(name, null, StepLayout.DEFAULT_LAYOUT){ }
    public Step(string name, Collection<Step> subSteps) : this(name, subSteps, StepLayout.DEFAULT_LAYOUT){ }
    public Step(string name, Collection<Step> subSteps, StepLayout stepLayout)
    {
        this.Name = name;
        this.SubSteps = subSteps;
        this.Layout = stepLayout;
    }
    // In order to provide design-time support, a default constructor without parameters is required:
    public static int NEW_ITEM_ID = 1;
    public Step()
        : this("Step" + NEW_ITEM_ID, null, StepLayout.DEFAULT_LAYOUT)
    {
        NEW_ITEM_ID++;
    }
    // Some more properties
}

CustomCollectionEditor:

class CustomCollectionEditor : CollectionEditor
{
    private ITypeDescriptorContext mContext;

    public CustomCollectionEditor(Type type) : base(type) { }

    public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value)
    {
        mContext = context;
        return base.EditValue(context, provider, value);
    }
    protected override object CreateInstance(Type itemType)
    {
        if (itemType == typeof(Step))
        {
            Step s = (Step)base.CreateInstance(itemType);
            s.parentContext = mContext; // Each step needs a reference to its parentContext at design time
            return s;
        }
        return base.CreateInstance(itemType);
    }
}

我已经尝试过的事情:

完成此帖后,我刚刚找到了这个主题:Simplest way to edit a collection in DesignMode? 这与我遇到的问题完全相同,但我不能使用建议的答案,因为我不使用标准集合。

2 个答案:

答案 0 :(得分:1)

检查CodeProject上的这篇Greate文章,我测试了它们并且它们都有效。

我认为你不适用的主要关键区别是:

  • 支持PropertyChanged为您的收藏
  • 为支持InstanceDescriptor的Collection Item Class创建TypeConverter。

答案 1 :(得分:0)

Reza Aghaei提到的文章非常有趣。但是,我认为我已经找到了解决问题的更简单方法:

正如我已经注意到的,尽管向集合中添加了项目,但collectionForm的EditValue属性仍保持为null。现在,我真的不确定集合编辑器的EditValue方法中发生了什么,但我猜它会捕获一个异常,因为我的集合的初始值为null(它没有在构造函数中初始化),因此返回null而不是创建一个新的集合。通过在我的自定义集合编辑器类中进行以下更改,我得到了非常有希望的结果:

public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value)
{
    mContext = context;
    if (value == null) value = new Collection<Step>();
    Collection<Step> result = (Collection<Step>)base.EditValue(context, provider, value);
    if (result != null && result.Count == 0) return null;
    return result;
}

注意方法内的第二行,它将新的Collection分配给初始值。通过这样做,我的收藏被持久化,一切都很好。

我现在唯一要修复的是序列化到设计器文件。目前正在制作类似的东西:

// wizardStepsControl1
// ...
this.wizardStepsControl1.Steps.Add(this.step1);
// ...

// step1
// Initialization of step1

此代码将提供异常,因为wizardStepsControl1.Steps永远不会初始化为集合。我想要制作的是这样的:

this.wizardStepsControl1.Steps = new Collection<Step>();
this.wizardStepsControl1.Steps.Add(step1);
// ...

更好的是,整个集合首先被初始化,然后分配给我的控制步骤属性。 我将看到我能做些什么来让它工作并在这里发布一些更新,也许这需要实现一个InstanceDescriptor或让我的自定义Collection类继承自Component(因为组件总是在设计器文件中初始化)

我知道这是一个完全不同于我的第一个问题,所以也许我会为此开始一个新问题。但如果有人知道答案,那么在这里听到它会很棒!

<强>更新 我找到了解决问题的方法。

继承自Component和CollectionBase是不可能的,因为C#不允许它。实现将我的自定义集合转换为InstanceDescriptor的TypeConverter也不起作用(我不知道为什么,我猜它是因为Collection以与普通自定义类不同的方式序列化)

但是通过创建CodeDomSerializer,我能够将代码添加到生成的设计师代码中。这样,如果在设计时添加了一些项目,我就可以初始化我的集合:

public class WizardStepsSerializer : CodeDomSerializer
{
    /// <summary>
    /// We customize the output from the default serializer here, adding
    /// a comment and an extra line of code.
    /// </summary>
    public override object Serialize(IDesignerSerializationManager manager, object value)
    {
        // first, locate and invoke the default serializer for 
        // the ButtonArray's  base class (UserControl)
        //
        CodeDomSerializer baseSerializer = (CodeDomSerializer)manager.GetSerializer(typeof(WizardStepsControl).BaseType, typeof(CodeDomSerializer));

        object codeObject = baseSerializer.Serialize(manager, value);

        // now add some custom code
        //
        if (codeObject is CodeStatementCollection)
        {

            // add a custom comment to the code.
            //
            CodeStatementCollection statements = (CodeStatementCollection)codeObject;
            statements.Insert(4, new CodeCommentStatement("This is a custom comment added by a custom serializer on " + DateTime.Now.ToLongDateString()));

            // call a custom method.
            //
            CodeExpression targetObject = base.SerializeToExpression(manager, value);
            WizardStepsControl wsc = (WizardStepsControl)value;
            if (targetObject != null && wsc.Steps != null)
            {
                CodePropertyReferenceExpression leftNode = new CodePropertyReferenceExpression(targetObject, "Steps");
                CodeObjectCreateExpression rightNode = new CodeObjectCreateExpression(typeof(Collection<Step>));
                CodeAssignStatement initializeStepsStatement = new CodeAssignStatement(leftNode, rightNode);
                statements.Insert(5, initializeStepsStatement);
            }

        }

        // finally, return the statements that have been created
        return codeObject;
    }
}

通过将此序列化程序与DesignerSerializerAttribute的自定义控件相关联,可在设计器文件中生成以下代码:

// 
// wizardStepsControl1
// 
// This is a custom comment added by a custom serializer on vrijdag 4 september 2015
this.wizardStepsControl1.Steps = new System.Collections.ObjectModel.Collection<WizardUserControl.Step>();
// ...
this.wizardStepsControl1.Steps.Add(step1);
// ...

这正是我想要的。

我从https://msdn.microsoft.com/en-us/library/system.componentmodel.design.serialization.codedomserializer(v=vs.110).aspx

中获取了大部分代码