外挂Exc程序（发布为平台插件）---调用自定义对话框 - .Net 平台应用与技巧

# 一、概述
有时候需要写一个外挂Exe程序发布成平台插件，且Exe程序需要使用对话框，如果自行开发的话，太浪费时间了，很难达到目标效果，因此对超级对话框进行扩扩展，是外挂Exe程序能够使用超级对话框。

# **二、步骤**：
1、在用VS开发窗体程序时，添加对OrBitUserDialog.dll、OrBitScript.Dll引用

# **三、使用**
#### 1、继承实现接口IOrBitExApi，例子：
```csharp

using OrBitUserDialog.API;
using System;
using System.Collections.Generic;
using System.Data;
using System.Data.SqlClient;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Test_窗体1
{
    class MyOrBitExApi : IOrBitExApi
    {
        /*
            注意：请根据具体情况实现IOrBitExApi接口，本文只是例子
         */

/// <summary>
        /// 插件的命令
        /// </summary>
        public string PlugInCommand { 
            get => "IQC8D"; 
            set => PlugInCommand = value; 
        }

/// <summary>
        /// 插件的名字
        /// </summary>
        public string PlugInName {
            get => "8D报告"; 
            set => PlugInName = value;
        }

/// <summary>
        /// 语言ID
        /// </summary>
        public string LanguageId { 
            get => "2"; 
            set => LanguageId = value;
        }
        /// <summary>
        /// 用户ID
        /// </summary>
        public string OrBitUserId { 
            get => "SUR1000003NL";
            set => OrBitUserId = value;
        }
        /// <summary>
        /// 用户名
        /// </summary>
        public string OrBitUserName {
            get => "HH0102"; 
            set => OrBitUserName = "HH0102"; 
        }
        /// <summary>
        /// 资源(电脑)ID
        /// </summary>
        public string ResourceId {
            get => "RES100000109"; 
            set => ResourceId = value; 
        }
        /// <summary>
        /// 资源名
        /// </summary>
        public string ResourceName { 
            get => "Gu"; 
            set => ResourceName = value; 
        }

/// <summary>
        /// 执行SQL获取数据集
        /// </summary>
        /// <param name="SQLString"></param>
        /// <returns></returns>
        public DataSet GetSqlDataSet(string SQLString)
        {
            #region Demo

string ConnectionString = "Data Source=" + "." +
                          ";Initial Catalog=" + "OrBitMOM_Dev" +
                          ";password=" + "sa" +
                          ";Persist Security Info=True;User ID=" + "sa";

DataSet ds = new DataSet();
            using (var connection = new SqlConnection(ConnectionString))
            {
                connection.Open();

using (SqlCommand cmd = new SqlCommand(SQLString, connection))    //这种写法可解决：DataReader 必须首先将它关闭   的问题
                {
                    SqlDataAdapter da = new SqlDataAdapter(cmd);
                    da.Fill(ds);
                    da.Dispose();
                }

connection.Close();

}
            return ds;
            #endregion
        }

/// <summary>
        /// 系统语言翻译
        /// </summary>
        /// <param name="owner">所有者</param>
        /// <param name="module">模块名</param>
        /// <param name="controlName">控件名</param>
        /// <param name="defaultText">默认文本</param>
        /// <returns></returns>
        public string GetUIText(string owner, string module, string controlName, string defaultText)
        {
            //Demo
            return string.IsNullOrWhiteSpace(defaultText) ? module : defaultText;
        }

/// <summary>
        /// 发消息到状态栏
        /// </summary>
        /// <param name="Message">Message</param>
        public void SendToStatusBar(string Message)
        {
            //Demo
        }

/// <summary>
        /// 上传文件
        /// </summary>
        /// <param name="FtpFileId">输出FtpFileId</param>
        /// <param name="FileName">文件全名</param>
        /// <param name="ButtonName">按钮名</param>
        /// <returns>上传结果</returns>
        public bool UploadFile(out string FtpFileId, string FileName, string ButtonName)
        {
            //Demo
            FtpFileId = "";
            return false; 
        }

/// <summary>
        /// 下载文件
        /// </summary>
        /// <param name="FtpFileId">FtpFileId</param>
        /// <param name="FileName">FileName</param>
        /// <param name="ButtonName">ButtonName</param>
        /// <returns>下载结果</returns>
        public bool DownloadFile(string FtpFileId, string FileName, string ButtonName)
        {
            //Demo
            return false;
        }

/// <summary>
        /// 显示SOP文件
        /// </summary>
        /// <param name="sopURL">文件url 或 FtpFileId</param>
        /// <param name="sopName">文件名</param>
        public void ShowSOP(string sopURL, string sopName)
        {
            //Demo
        }

/// <summary>
        /// 获取界面参数值
        /// </summary>
        /// <param name="ParameterName">ParameterName</param>
        /// <returns></returns>
        public string GetParameterValue(string ParameterName)
        {
            return ParameterName;//Demo
        }

/// <summary>
        /// 设置界面参数值。主要用于MES事务（OrBitAPI）
        /// </summary>
        /// <param name="ParameterName">参数名</param>
        /// <param name="ParameterValue">参数值</param>
        public void SetParameterValue(string ParameterName, string ParameterValue)
        {
            //Demo
        }

/// <summary>
        /// 显示冒泡消息
        /// </summary>
        /// <param name="Message">Message</param>
        /// <param name="IsSay">IsSay</param>
        public void ShowPopMessage(string Message, bool IsSay)
        {
            //Demo
        }

/// <summary>
        /// 标签打印
        /// </summary>
        /// <param name="MrzFiles">标签：FtpFileId</param>
        /// <param name="SourceDataSet">数据源</param>
        /// <param name="IsPreview">是否预览</param>
        /// <returns>打印结果</returns>
        public bool PrintMRZReport(string MrzFiles, DataSet SourceDataSet, bool IsPreview)
        {
            return false;//Demo
        }

/// <summary>
        /// 获取标签，可以多个
        /// </summary>
        /// <param name="panelApi">自定义对话框面板API</param>
        /// <param name="tabIndex">对话框页签索引</param>
        /// <param name="parentGridRowId">双网格时，A网格行Id</param>
        /// <param name="dataSubmit">网格数据，单网格时为A网格、双网格时为B网格</param>
        /// <param name="btnName">按钮名称：固定“提交按钮” 或 自定义按钮</param>
        /// <returns>标签。“Tuple,string为标签，bool为是否预览”</returns>
        public List<Tuple<string, bool>> GetMrzFiles(PanelApi panelApi, int tabIndex, string parentGridRowId, string dataSubmit, string btnName)
        {
            //Demo
            List<Tuple<string, bool>> list = new List<Tuple<string, bool>>();
            list.Add(new Tuple<string, bool>("FTP1000001GC", true));
            return list;
        }
    }
}

```

#### 2、调用
```csharp
private void button1_Click(object sender, EventArgs e)
{
	//建议用OrBitAPI
    //OrBitScript.OrBitMetaAPI Scripter = new OrBitScript.OrBitMetaAPI();
    OrBitScript.OrBitAPI Scripter = new OrBitScript.OrBitAPI();

EventInject eventInject = new EventInject();
    eventInject.GridAfterCellUpdate = UltraGrid_AfterCellUpdate;
    eventInject.FormLoad = Form_Load;
    eventInject.FormClosed = Form_Closed;
    eventInject.BtnSubmitClickBefore = BtnSubmit_ClickBefore;
    eventInject.OrBitExApi = new MyOrBitExApi();

OrBitUserDialog.Dialog.Show(Scripter, "WES ASNItem_Add", "", "", eventInject);
}
```

```csharp
/// <summary>
/// 自定义对话框。网格-单元格值更新事件
/// </summary>
/// <param name="TabIndex">Tab索引:1、2</param>
/// <param name="Grid">网格</param>
/// <param name="e"> 参数</param>
/// <param name="GridName">网格名：A、B</param>
/// <param name="PanelApi">面板API接口</param>
private void UltraGrid_AfterCellUpdate(int TabIndex, Infragistics.Win.UltraWinGrid.UltraGrid Grid, Infragistics.Win.UltraWinGrid.CellEventArgs e, string GridName, OrBitUserDialog.API.PanelApi PanelApi)
{
    //to do..
}
/// <summary>
/// 自定义对话框。窗体加载事件
/// </summary>
/// <param name="TabIndex">Tab索引:1、2</param>
/// <param name="AGrid">A网格</param>
/// <param name="BGrid">B网格，可能为null</param>
/// <param name="PanelApi">面板API接口</param>
private void Form_Load(int TabIndex, Infragistics.Win.UltraWinGrid.UltraGrid AGrid, Infragistics.Win.UltraWinGrid.UltraGrid BGrid, OrBitUserDialog.API.PanelApi PanelApi)
{
    //to do..
}
/// <summary>
/// 自定义对话框。窗体关闭事件
/// </summary>
/// <param name="TabIndex">Tab索引:1、2</param>
/// <param name="AGrid">A网格</param>
/// <param name="BGrid">B网格，可能为null</param>
/// <param name="PanelApi">面板API接口</param>
private void Form_Closed(int TabIndex, Infragistics.Win.UltraWinGrid.UltraGrid AGrid, Infragistics.Win.UltraWinGrid.UltraGrid BGrid, OrBitUserDialog.API.PanelApi PanelApi)
{
    //to do..
}
/// <summary>
/// 自定义对话框。提交按钮 触发时检查前置事件
/// </summary>
/// <param name="TabIndex">Tab索引:1、2</param>
/// <param name="AGrid">A网格</param>
/// <param name="BGrid">B网格，可能为null</param>
/// <param name="PanelApi">面板API接口</param>
/// <returns>True表示继续,False表示退回</returns>
private bool BtnSubmit_ClickBefore(int TabIndex, Infragistics.Win.UltraWinGrid.UltraGrid AGrid, Infragistics.Win.UltraWinGrid.UltraGrid BGrid, OrBitUserDialog.API.PanelApi PanelApi)
{
    //to do..
    return true;
}

```