公式属性

如果属性值需要依赖公式的计算结果动态变化，可以通过标注FormulaPropertyAttribute 的方式设置。
注意，标注FormulaPropertyAttribute的属性类型必须是 object

    public class MyPluginCellType : CellType
    {
        [FormulaProperty]
        public object MyProperty { get; set; }
    }

在设计器中效果如下

为支持公式属性，单元格对应的JavaScript类也需要对应的处理，可以通过evaluateFormula方法计算公式的值

class MyPluginCellType extends Forguncy.Plugin.CellTypeBase {
    content = null;
    createContent() {
        this.content = $("<div style='width:100%;height:100%;'></div>");
        return this.content;
    }
    onPageLoaded() {
        const prop = this.CellElement.CellType.MyProperty;
        const result = this.evaluateFormula(prop)
        this.content.text(result)
    }
}
Forguncy.Plugin.CellTypeHelper.registerCellType("MyPlugin.MyPluginCellType, MyPlugin", MyPluginCellType);

相信看了以上示例代码之后一定会有小伙伴有所疑惑，为什么不在createContent函数里计算公式的值，而是在onPageLoaded函数中呢？

因为createContent函数是用来构建当前单元格的，页面上的每一个单元格都会一个一个的调用一个方法来构建，如果在createContent函数中计算公式值，如公式又刚好依赖了还没有被构建好的单元格，会导致计算结果不正确。解决方案就是吧计算逻辑延后到 onPageLoaded 函数中。这个函数会在所有单元格被构建完成后调用。

另外，我们注意到，使用了上述的JavaScript代码，单元格属性的初始值经过了计算，但是如果依赖单元格的值发生了变化，不会重新计算公式属性值。为了解决这个问题，需要监听onDependenceCellValueChanged回调函数，这个回调函数会自动分析当前单元格依赖的其他单元格，当依赖的单元格值发生变化时会触发这个回调。所以JavaScript代码的改进版如下

class MyPluginCellType extends Forguncy.Plugin.CellTypeBase {
    content = null;
    createContent() {
        this.content = $("<div style='width:100%;height:100%;'></div>");
        return this.content;
    }
    onPageLoaded() {
        const calcFormulaProps = () => {
            const prop = this.CellElement.CellType.MyProperty;
            const result = this.evaluateFormula(prop)
            this.content.text(result)
        }
        calcFormulaProps();
        this.onDependenceCellValueChanged(() => {
            calcFormulaProps();
        })
    }
}
Forguncy.Plugin.CellTypeHelper.registerCellType("MyPlugin.MyPluginCellType, MyPlugin", MyPluginCellType);

使用onDependenceCellValueChanged有一个弊端，如果单元格上有多个公式属性，任何一个公式属性发生变化，都会触发onDependenceCellValueChanged方法的执行，并且再onDependenceCellValueChanged方法中无法区分具体是哪个属性发生了变化。在 V10.0.0.0 中新增了一个方法 onFormulaResultChanged 可以解决上述问题

class MyPluginCellType extends Forguncy.Plugin.CellTypeBase {
    content = null;
    createContent() {
        this.content = $("<div style='width:100%;height:100%;'></div>");
        return this.content;
    }
    onPageLoaded() {
        this.onFormulaResultChanged(this.CellElement.CellType.MyProperty, result => {
            this.content.text(result)
        });
    }
}
Forguncy.Plugin.CellTypeHelper.registerCellType("MyPlugin.MyPluginCellType, MyPlugin", MyPluginCellType);

WARNING

在V10以后，不再推荐使用 onDependenceCellValueChanged方法，而应该使用 onFormulaResultChanged 方法。代码更简洁，性能更好，并且支持和组件属性绑定

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

1. 提供备选列表
   1. 设置FormulaPropertyAttribute 的 RecommendedValues 属性
      使用“|”分隔多个候选项
   2. 代码

    public class MyPluginCellType : CellType
    {
        [FormulaProperty(RecommendedValues = "学生|教师|工人")]
        public object MyProperty { get; set; }
    }

3. 效果  

2. 支持输入多行文本 1. 设置FormulaPropertyAttribute 的 AcceptsReturn 属性 2. 代码

    public class MyPluginCellType : CellType
    {
        [FormulaProperty(AcceptsReturn = true)]
        public object MyProperty { get; set; }
    }

3. 效果  

3. 支持多语言 1. 所有公式属性，默认会开启多语言支持，可以通过设置FormulaPropertyAttribute 的 CanSelectResource 属性关闭多语言支持。 2. 代码

    public class MyPluginCellType : CellType
    {
        [FormulaProperty(CanSelectResource = false)]
        public object MyProperty { get; set; }
    }

3. 此特性为 10.0.0.0 新增

更新: 2024-02-17 10:04:21
原文: https://www.yuque.com/robert-bh51n/ea8l6c/keoludxsp0diwbgk