客制化控件 + 实现客户端设备集成 （仅支持到WPF的GUI客户端）

本篇基础：BOS平台的二开编程(论坛)，C#编程(ms)，WPF编程(ms)，Python语法, XML语法，VistualStudio2012(up)工具(ms)，C/S基础知识，x86与x64基础知识

【从老论坛中搬家到帖子里，原贴地址【客制化控件插件实现客户端设备集成（桌面客户端功能）】

论坛不支持评论编辑和附件，也不支持回车换行。

如果实在看不清楚可以参考老论坛帖子：https://vip.kingdee.com/article/39283 

】

( 建议所有使用这篇文章指导进行客制化控件二开项目的同学，回帖简单说明你的项目简介，这样也可以协助推广你的项目，其他需要类似项目的同学也可以通过帖子联系你进行商务协助 -- 这个仅是一个建议 )

一、背景

    1、应用背景：在企业应用中广泛存在一些接入设备，如电子行业的激光扫描设备，IC卡刷卡设备，医疗行业的电子秤，射频读卡器，影像设备等。接口类型没有同一标准，有的采用RS232，RS485，USB等，有的采用FTP文件服务器，有的采用Smart Card接口组件，驱动设备也各行其是。K/3 Cloud作为一个通用平台，不能包罗所有的第三方接入驱动。因此，我们开放一个桌面端的接口模型，实现这些设备的二次开发接入。

    2、开发技术要求：基于DotNet FrameWork 4.0的WPF编程技术，基于C#编程语言，有C/S编程基础概念，有VistualStudio工具使用经验。

二、部署二次开发组件

1、在K/3 Cloud服务器安装目录 的【WebSite\ClientBin\K3CloudClient\controlplugins】目录下部署二次开发.deploy组件。具体部署方法参考《答疑3：通过BOSIDE新建解决方案或应用方案》

2、BOSIDE中拖放自定义控件

2.1、在自定义控件的属性列表中找到【引用组件】属性，把相关参考组件注册到该属性里面。

--2.2、相关依赖组件注册在BOSIDE中的菜单【文件--引用组件管理】功能进行关联依赖组件注册。(如果是用1的安装包方式部署，可以不用设置引用组件)。

--2.3、如果更新组件，则修改参考组件列表中对应组件的版本信息即可。(如果是用1的安装包方式部署，可以不用设置引用组件)。

--2.4、如果使用了这个BOSIDE注册相关组件的方法，那么就不需要做下面“3、配置MainDownloadList.xml注册文件（备选方案）”这个步骤了，该步骤可以忽略。

--3、配置MainDownloadList.xml注册文件（备选方案，有需要请到答疑部分查看，用1的安装包方式部署，可以不需要关注这种方式）

4、启动K/3 Cloud客户端桌面版程序（双击桌面的快捷图标），这时程序会自动按照服务器地址设定检查组件版本，并按需要下载相关客制化组件到本地的 【%Program Files %\Kingdee\K3Cloud\DeskClient\K3CloudClient\controlplugins】目录下。按多数客户的需求将把客制化组件目录调整到Kingdee.BOS.Xpf.App.exe执行文件所在目录的子目录controlplugins下，一般会在【%Program Files %\Kingdee\K3Cloud\DeskClient\K3CloudClient\controlplugins】这个位置里面，方便二开程序定位自己的数据文件。）

5、客制化控件关联引用需要部署到controlplugins,或者需要引用K3CloudClient目录组件时，可以配置Kingdee.BOS.XPF.App.exe.config文件增加如下配置（6.0或5.0 2015-07-09补丁已经默认配置，如没有成功配置，可以手工添加）：

<?xml version="1.0"?>
<configuration>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <probing privatePath="controlplugins"/>
    </assemblyBinding>
  </runtime>
</configuration>

三、客制化组件开发

1、在Visual Studio 2012中新增类库工程；如果需要新增有WPF界面元素的，必须新建WPF类库类型的工程。（注意，如果使用的控件是32位平台的，那么客制化组件工程文件指定目标平台为x86）

2、引用服务器安装目录下【WebSite/ClientBin/CustomControl/WPF/Kingdee.BOS.XPF.ControlPlugins.Contracts.dll】基础组件；

3、新建类，编写客制化控件桌面客户端代码如下：

    /// <summary>

    /// 有界面插件，如果不需要界面展示的，无须继承任何FrameworkElement的子类

    /// </summary>

    public class SmartCardReader : ContentControl, IKDCustomControl
        , IDynamicFormSupported
    {

        /// <summary>

        /// 下载客户端后，在 Program Files (x86)\Kingdee\K3Cloud\DeskClient\K3CloudClient\目录下有Kingdee.BOS.Client.Core.dll 等相关组件可供引用

        /// 实现单据代理接口，以便通过this.FormProxy.ControlFactoryProxy.GetCmp(Key)即可获取到其他单据上其他字段的Proxy,从而控制其他字段的内容。

        /// 接口IDynamicFormSupported 来自Kingdee.BOS.Client.Core.dll（2015-06-18以及之后的补丁提供该接口）；

        /// 如果不需要操控表单其他控件元素，就不需要实现这个接口。（可以通过this.FormProxy.ControlFactoryProxy.GetCmp(控件标识).GetControl()获取控件实例，实现定制交互逻辑）；

        /// </summary>

        public IKDDynamicFormProxy FormProxy { get; set; }

        /// <summary>

        /// 设置单据头字段数据

        /// <summary>

        private void SetFNumberValue()

        {

                var itemCt = this.ControlFactoryProxy.GetCmp("FNUMBER") as IKDItemContainerProxy;

                var innEditor = itemCt.ControlProxy as IKDControlProxy;

                var edit = ((innEditor as IKDControlProxy).GetControl() as DevExpress.Xpf.Editors.IBaseEdit);

                edit.EditValue = "AABBCC";

        }

        public IKDCustomControlProxy Proxy { get; set; }

        TextBlock _txtDsp = null;

        protected void FireOnCustomEvent(CustomEventArgs e)

        {

            if (this.Proxy != null)

            {

                this.Proxy.FireCustomEvent(e);

            }

        }

        /// <summary>

        /// 界面组件初始化，如果没有界面要求，这里保留为空即可。

        /// </summary>

        public void InitComponent()

        {

            var label = "This is Custom control in Kingdee.XPF.CustomControlPlugins, named SmartCardReader";

            this._txtDsp = new TextBlock()

            {

                ToolTip = label,

                TextWrapping = System.Windows.TextWrapping.Wrap,

                Text = label

            };

            this.Content = new Border()

            {

                BorderThickness = new Thickness(1),

                BorderBrush = new SolidColorBrush(Colors.Blue),

                Child = this._txtDsp

            };

        }

        /// <summary>

        /// 用于资源释放，在单据关闭时调用

        /// </summary>

        public void Release()

        {

            this.Content = null;

        }

///************以下接口按自己需要添加*************////

        /// <summary>

        /// 定制控件入口，服务端调用方法：this.View.GetControl("FCUSTOMCONTROL").InvokeControlMethod("DoCustomMethod","WriteString",args)，args是对象数组

        /// </summary>

        /// <param name="data"></param>

        public void WriteString(string data)

        {

            this.Dispatcher.BeginInvoke(new Action(() =>

            {

                if (this._txtDsp != null)

                {

                    this._txtDsp.Text = data;

                    this.Proxy.FireCustomEvent(new CustomEventArgs("", "Success", "{message:'WriteString() Success!'}"));

                }

                else

                {

                    this.Proxy.FireCustomEvent(new CustomEventArgs("", "Error", "{message:'WriteString() Error, component uninitilization!'}"));

                }

            }));

        }

    }

4、编写客制化控件服务端表单插件代码如下：

4.1、在BOS IDE中拖放自定义控件：（推荐方案）

4.1.1、直接在BOSIDE中拖放一个【通用控件--自定义控件】，然后填写属性【程序集】，【类名】，【命名空间】就可以了。（这个方法将替代4.2步骤，在2015-05-07号补丁后， 下面4.2步骤就可以省略了。）

4.1.2、如果存在相关参考依赖组件，可以在BOSIDE的菜单【文件】-【引用组件管理】中设置

(* 注意：如果是用安装包方式部署相关依赖组件，可以不用设置引用组件，同时【禁止自定义控件下载】属性应该勾选)。

如下图：（设置比较简单，界面上也有说明！）

4.2、构造插件方式实现客制化控件：（备选方案， 参考答疑5）

4.3、表单业务插件：如下代码（以Python为例，可以自行翻译为C#代码）：

C#代码例子：

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

namespace Kingdee.Texst.CustomControl
{
    [Description("测试客制化控件业务插件")]
    public class CustomControl : AbstractBillPlugIn
    {//实现定制控件的自定义接口调用
        public override void CustomEvents(CustomEventsArgs e)
        {
            base.CustomEvents(e);
            if (e.Key == " FCUSTOMCONTROL ")
            {
                var recData = e.EventArgs;
            }
        }

        public override void ButtonClick(ButtonClickEventArgs e)
        {
            if (e.Key == "FWRITESTRING")
            {
                var str1 = this.Model.GetValue("FTEXT");
                var args = new object[1];
                args[0] = str1;
                //#实现定制控件的自定义接口调用
                this.View.GetControl("FCUSTOMCONTROL").InvokeControlMethod("DoCustomMethod", "WriteString", args);
                // 特别注意：这里的args参数应对是一个对象数组，在C#中如下编码；
                //0个参数的情况： var args = new object[1]; args[0] = null;
                //1个参数的情况： var args = new object[1]; args[0] = str1;
                //2个参数的情况： var args = new object[2]; args[0] = str1; args[1] = str2;
                //n个参数的情况： var args = new object[n]; args[0] = str1; args[1] = str2; ... args[n-1] = strn;
            }
        }
    }
}

python代码例子：

from System import *
from Kingdee.BOS.Core.DynamicForm.PlugIn.ControlModel import *

def ButtonClick(e):
    if(e.Key=="FWRITESTRING"):
        str1 = this.Model.GetValue("FTEXT")
        args =[ str1]
        #实现定制控件的自定义接口调用
        this.View.GetControl("FCUSTOMCONTROL").InvokeControlMethod( "DoCustomMethod", "WriteString", args)
        #特别注意：这里的args参数应对是一个对象数组，在C#中如下编码；
        #0个参数的情况： var args = new object[1]; args[0] = null;
        #1个参数的情况： var args = new object[1]; args[0] = str1;
        #2个参数的情况： var args = new object[2]; args[0] = str1; args[1] = str2;
        #n个参数的情况： var args = new object[n]; args[0] = str1; args[1] = str2; ... args[n-1] = strn;

#这里获取服务端发送的数据
def CustomEvents(e):
    if(e.Key==" FCUSTOMCONTROL "):
        recData = e. eventArgs

四、屏蔽其他端使用该表单：

    因为本功能仅允许在桌面使用，其他端必须进行功能屏蔽。