对象属性

默认情况下，如果一个属性的类型是对象类型，这个类型又包含了一些子属性，那么可以通过标注ObjectPropertyAttribute，使得活字格设计器可以通过弹出二级对话框来编辑该属性。

注意，ObjType属性里声明的类型必须与属性类型一致。

自定义对象的类型应该从 ObjectPropertyBase 类派生，以确保在单元格复制的时候，子属性可以被正确的深克隆（ObjectPropertyBase实现了默认的深克隆逻辑）。

using GrapeCity.Forguncy.Commands;
using GrapeCity.Forguncy.Plugin;

namespace MyPlugin
{
    public class MyPluginCommand : Command
    {
        [ObjectProperty(ObjType = typeof(MyObj))]
        public MyObj MyProperty { get; set; }
    }

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

在设计器中效果如下：

对象的子属性也可以通过标注来控制属性编辑控件。

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

    public class MyPluginCommand : Command
    {
        [ObjectProperty(ObjType=typeof(MyObj))]
        public MyObj MyProperty { get; set; }
    }

    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; }
    }

在设计器中效果如下：

高级配置

1.添加描述：

设置 DescriptionAttribute。

代码如下：

    public class MyPluginCommand : Command
    {
        [ObjectProperty(ObjType=typeof(MyObj))]
        public MyObj MyProperty { get; set; }
    }

    [Description("* 添加一段描述文字，帮助使用者更好的理解这个对象的设置，如果描述文字很长，会自动折行，所以不用担心长度限制")]
    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; }
    }

设计器中的效果：
此特性为10.0.0.0版本新增的特性。

2.给对象添加自定义校验：

给属性添加DesignerAttribute 重写Validate方法添加自定义校验。

代码如下：

    public class MyPluginCommand : Command
    {
        [ObjectProperty(ObjType = typeof(MyObj))]
        public MyObj MyProperty { get; set; }
    }
    [Designer(typeof(MyObjectDesigner))]
    public class MyObj : ObjectPropertyBase
    {
        [Required]
        public string Name { get; set; }
        public string Description { get; set; }

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

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

    public class MyObjectDesigner : ObjectDesigner
    {
        public override string Validate()
        {
            if (this.Obj is MyObj myObj)
            {
                if (myObj.FormulaProperty == null && myObj.Description == null)
                {
                    return "FormulaProperty 和 Description 属性至少有一个不能为空";
                }
            }
            return base.Validate();
        }
    }

设计器中的效果：
此特性为10.0.0.0版本新增的特性。

3.内嵌显示。

给对象标注 FlatObjectProperty 可以实现对象的内嵌显示。

代码如下：

    public class MyPluginCommand : Command
    {
        [DisplayName("姓名")]
        public string Name { get; set; }

        [FlatObjectProperty]
        [DisplayName("地址")]
        public Address Address { get; set; } = new Address();
    }

    public class Address : ObjectPropertyBase
    {
        [DisplayName("省份")]
        public string Province { get; set; }
        [DisplayName("城市")]
        public string City { get; set; }
    }

设计器中的效果：

4.内嵌显示联动。

给对象标注 FlatObjectProperty 实现子对象属性内嵌显示，同时通过属性值联动在不同情况下显示不同的子属性。

代码如下：

     [Designer(typeof(MyCommandDesigner))]
    public class MyPluginCommand : Command
    {
        [ComboProperty(ValueList = "Type1|Type2")]
        public string Type { get; set; } = "Type1";

        [FlatObjectProperty]
        public object SubProperty { get; set; } = new Type1SubProperty();
    }
    public class Type1SubProperty : ObjectPropertyBase
    {
        public string SubProperty1 { get; set; }
    }
    public class Type2SubProperty : ObjectPropertyBase
    {
        public string SubProperty2 { get; set; }
        [ColorProperty]
        public string SubProperty3 { get; set; }
    }
    public class MyCommandDesigner : CommandDesigner
    {
        public override void OnPropertyEditorChanged(string propertyName, object propertyValue, Dictionary<string, IEditorSettingsDataContext> properties)
        {
            if (propertyName == nameof(MyPluginCommand.Type))
            {
                if (Equals(propertyValue, "Type1"))
                {
                    properties[nameof(MyPluginCommand.SubProperty)].Value = new Type1SubProperty();
                }
                else
                {
                    properties[nameof(MyPluginCommand.SubProperty)].Value = new Type2SubProperty();
                }
            }
            base.OnPropertyEditorChanged(propertyName, propertyValue, properties);
        }
    }

设计器中的效果：