【应用场景】使用列表插件读写用户参数。

【案例演示】采购订单，列表界面，在列表插件中读写用户参数。

【实现步骤】

<1>编写列表插件，实现读写用户参数的功能，代码如下。

using Kingdee.BOS.Core;

using Kingdee.BOS.Core.DynamicForm.PlugIn.Args;

using Kingdee.BOS.Core.List.PlugIn;

using Kingdee.BOS.ServiceHelper;

using Kingdee.BOS.Util;

using Kingdee.BOS.Web.List;

using System.ComponentModel;

namespace Jac.XkDemo.BOS.Business.PlugIn

{

    /// <summary>

    /// 【列表插件】读写用户参数

    /// </summary>

    [Description("【列表插件】读写用户参数"), HotUpdate]

    public class ReadAndWriteUserParameterListPlugIn : AbstractListPlugIn

    {

        public override void BarItemClick(BarItemClickEventArgs e)

        {

            base.BarItemClick(e);

            if (e.BarItemKey.EqualsIgnoreCase("tbReadUserParameter"))

            {

                var auxMustInput = ReadUserParameter("AuxMustInput");

                // var auxMustInput = ReadUserParameter2("AuxMustInput"); // 另一种读取用户参数的方法

                this.View.ShowMessage("用户参数【辅助属性必录】：" + auxMustInput);

                return;

            }

            if (e.BarItemKey.EqualsIgnoreCase("tbWriteUserParameter"))

            {

                var isOk = WriteUserParameter("AuxMustInput", true);

                this.View.ShowMessage(isOk ? "用户参数保存成功" : "用户参数保存失败");

                return;

            }

        }

        /// <summary>

        /// 读取用户参数（直接从数据库读取）

        /// </summary>

        /// <param name="parameterName">用户参数的实体属性名</param>

        /// <returns></returns>

        private object ReadUserParameter(string parameterName)

        {

            // 获取用户参数的业务对象标识

            var formId = this.View.BillBusinessInfo.GetForm().ParameterObjectId;

            if (formId == null || formId.Trim().Length == 0)

            {

                formId = FormIdConst.BOS_BillUserParameter;

            }

            var formMetadata = FormMetaDataCache.GetCachedFormMetaData(this.Context, formId);

            // 读取用户参数包

            var parameterData = UserParamterServiceHelper.Load(this.Context, formMetadata.BusinessInfo, this.Context.UserId, this.View.BillBusinessInfo.GetForm().Id, KeyConst.USERPARAMETER_KEY);

            // 从用户参数包中获取某一个参数

            if (parameterData != null && parameterData.DynamicObjectType.Properties.Contains(parameterName))

            {

                return parameterData[parameterName];

            }

            return null;

        }

        /// <summary>

        /// 读取用户参数（从Model中读取）

        /// </summary>

        /// <param name="parameterName">用户参数的实体属性名</param>

        /// <returns></returns>

        private object ReadUserParameter2(string parameterName)

        {

            // 获取列表视图

            var listView = (ListView) this.View;

            // 从用户参数包中获取某一个参数

            if (listView.Model.ParameterData != null && listView.Model.ParameterData.DynamicObjectType.Properties.Contains(parameterName))

            {

                return listView.Model.ParameterData[parameterName];

            }

            return null;

        }

        /// <summary>

        /// 保存用户参数

        /// </summary>

        /// <param name="parameterName"></param>

        /// <param name="parameterValue"></param>

        /// <returns></returns>

        private bool WriteUserParameter(string parameterName, object parameterValue)

        {

            // 获取用户参数的业务对象标识

            var formId = this.View.BillBusinessInfo.GetForm().ParameterObjectId;

            if (formId == null || formId.Trim().Length == 0)

            {

                formId = FormIdConst.BOS_BillUserParameter;

            }

            var formMetadata = FormMetaDataCache.GetCachedFormMetaData(this.Context, formId);

            // 读取用户参数包

            var parameterData = UserParamterServiceHelper.Load(this.Context, formMetadata.BusinessInfo, this.Context.UserId, this.View.BillBusinessInfo.GetForm().Id, KeyConst.USERPARAMETER_KEY);

            // 从用户参数包中获取某一个参数

            if (parameterData != null && parameterData.DynamicObjectType.Properties.Contains(parameterName))

            {

                // 保存用户参数

                parameterData[parameterName] = parameterValue;

                return UserParamterServiceHelper.Save(this.Context, formMetadata.BusinessInfo, parameterData, this.View.BillBusinessInfo.GetForm().Id, this.Context.UserId, KeyConst.USERPARAMETER_KEY);

            }

            return false;

        }

    }

}

/*

-- 查询用户参数

SELECT * FROM T_BAS_USERPARAMETER 

*/

<2>拷贝插件组件到应用站点的WebSite\Bin目录下，重启IIS。

<3>BOSIDE扩展采购订单，列表菜单添加两个菜单，注册列表插件，保存元数据，开发完毕。

现在可以登录业务站点，打开采购订单列表，检验一下插件效果啦。

读取用户参数：

修改用户参数后再次读取：

保存用户参数：

【知识点】

<1>BOSIDE，打开单据，找到单据的属性【用户参数对象】，可获得当前打开的用户参数的标识。

<2>如何快速获取当前单据所绑定的用户参数的业务对象标识？通过Http数据抓包，点选项按钮后，可获得当前打开的用户参数的标识。

<3>BOSIDE打开用户参数，获取用户参数的实体属性名称。

<4>用户参数存储在哪个表？

SELECT * FROM T_BAS_USERPARAMETER 

【金蝶云星空BOS二次开发案例演示】https://vip.kingdee.com/article/94751030918525696