对象列表属性

如果一个属性的类型是List类型，List的每一项又包含了子属性，那么可以通过标注ObjectListPropertyAttribute，使得活字格设计器可以通过弹出二级对话框来编辑该属性。

注意，

1. ItemType属性里声明的类型必须与项目属性类型一致
2. 自定义对象必须实现 INamedObject 接口
3. 属性的返回值必须是 List<INamedObject>
4. 自定义对象的类型应该从 ObjectPropertyBase 类派生，以确保在单元格复制的时候，子属性可以被正确的深克隆（ObjectPropertyBase实现了默认的深克隆逻辑）

using GrapeCity.Forguncy.Commands;
using GrapeCity.Forguncy.Plugin;
using System.Collections.Generic;

namespace MyPlugin
{
    public class MyPluginCommand : Command
    {
        [ObjectListProperty(ItemType = typeof(MyObj))]
        public List<INamedObject> MyProperty { get; set; } = new List<INamedObject>();
    }

    public class MyObj : ObjectPropertyBase, INamedObject
    {
        public string Name { get; set; }
        public string SubProperty1 { get; set; }
        public string SubProperty2 { get; set; }
        public string SubProperty3 { get; set; }
        public string SubProperty4 { get; set; }
    }
}

在设计器中效果如下

列表项目的子属性也可以通过标注来控制属性编辑控件

下面例子中，额外声明了两个属性分别使用公式编辑器和命令编辑器。具体标注的用法请参考之前的章节

    public class MyPluginCommand : Command
    {
        [ObjectListProperty(ItemType = typeof(MyObj))]
        public List<INamedObject> MyProperty { get; set; } = new List<INamedObject>();
    }

    public class MyObj: ObjectPropertyBase
    {
        public string Name { get; set; }
        public string Description { get; set; }

        [FormulaProperty]
        public object FormulaProperty { get; set; }

        [CustomCommandObject]
        [DisplayName("点击命令")]
        public object ClickCommand { get; set; }
    }

在设计器中效果如下

如果需要更细致的控制，可以通过ObjectListPropertyAttribute的其他属性来控制

1. 控制列表最大元素个数
   1. 设置ObjectListPropertyAttribute 的 MaxCount 属性
   2. 代码

    public class MyPluginCommand : Command
    {
        [ObjectListProperty(ItemType = typeof(MyObj), MaxCount = 4)]
        public List<INamedObject> MyProperty { get; set; } = new List<INamedObject>();
    }

    public class MyObj : ObjectPropertyBase, INamedObject
    {
        public string Name { get; set; }
        public string SubProperty1 { get; set; }
        public string SubProperty2 { get; set; }
        public string SubProperty3 { get; set; }
        public string SubProperty4 { get; set; }
    }

2. 控制默认结点名称
   1. 设置ObjectListPropertyAttribute 的 DefaultName 属性
   2. 代码

    public class MyPluginCommand : Command
    {
        [ObjectListProperty(ItemType = typeof(MyObj), DefaultName = "结点")]
        public List<INamedObject> MyProperty { get; set; } = new List<INamedObject>();
    }

    public class MyObj : ObjectPropertyBase, INamedObject
    {
        public string Name { get; set; }
        public string SubProperty1 { get; set; }
        public string SubProperty2 { get; set; }
        public string SubProperty3 { get; set; }
        public string SubProperty4 { get; set; }
    }

ListProperty Vs ObjectListProperty

ListPropertyAttribute和ObjectListPropertyAttribute解决的是完全相同的问题，只是表现方式不同，ObjectListPropertyAttribute 更适合项目子属性比较多的情况，而ListProperty则在子属性比较少的时候比较适用

更新: 2023-02-22 20:30:09