C#開發(fā)ActiveX控件操作指南
C#開發(fā)ActiveX控件在開發(fā)Web頁面中是十分有用的，下面提供了C#開發(fā)ActiveX控件操作指南，供大家學(xué)習(xí)參考。
0. 前言
ActiveX控件以前也叫做OLE控件或OCX控件，它是一些軟件組件或?qū)ο?，可以將其插入到WEB網(wǎng)頁或其它應(yīng)用程序中。使用ActiveX插件，可以輕松方便的在 Web頁中插入多媒體效果、交互式對象以及復(fù)雜程序等等。
通常使用C++或VB開發(fā)ActiveX控件，本文探討一下在Visual Studio 2005環(huán)境中使用C#開發(fā)ActiveX控件的技術(shù)實(shí)現(xiàn)。
1. 問題場景
在C/S架構(gòu)的系統(tǒng)中，客戶端要實(shí)現(xiàn)某些業(yè)務(wù)功能，可以通過安裝相關(guān)的應(yīng)用程序集來方便的實(shí)現(xiàn)。同樣的需求，在B/S架構(gòu)的系統(tǒng)里實(shí)現(xiàn)起來卻比較困難。因?yàn)樗械某绦蚨挤旁诜?wù)器端，客戶端只是采用瀏覽器，通過HTTP協(xié)議來訪問服務(wù)器端。比較成熟的解決辦法是開發(fā)ActiveX控件安裝到客戶端，這樣客戶端的瀏覽器就可以訪問本地的ActiveX控件來執(zhí)行相關(guān)的本地操作。本文將要談?wù)摰?，就是使用C#開發(fā)一個ActiveX控件實(shí)現(xiàn)讀取并顯示客戶端的系統(tǒng)時間。
2. 開發(fā)環(huán)境
- Windows XP
- Visual Studio 2005
- .NET Framework 2.0（C#）
3. 實(shí)現(xiàn)過程
3.1.ActiveX控件開發(fā)
在Visual Studio 2005開發(fā)環(huán)境中，可以使用Windows控件庫項(xiàng)目實(shí)現(xiàn)ActiveX控件的開發(fā)，但是需要對項(xiàng)目做一些必要的設(shè)置。下面就來看看如何使用Windows控件庫項(xiàng)目開發(fā)一個ActiveX控件。首先創(chuàng)建一個應(yīng)用程序解決方案，并添加一個Windows控件庫項(xiàng)目：
更改“項(xiàng)目屬性-應(yīng)用程序-程序集信息”設(shè)置，勾選“使程序集 COM 可見”：
更改“項(xiàng)目屬性-生成”設(shè)置，勾選“為 COM Interop 注冊”（注意，此處如果實(shí)在debug狀態(tài)下修改的，那在調(diào)到release狀態(tài)下還需要再設(shè)置一次）：
修改AssemblyInfo.cs文件，添加[assembly: AllowPartiallyTrustedCallers()]項(xiàng)（需要引用System.Security名稱空間）：
- using System.Reflection;
- using System.Runtime.CompilerServices;
- using System.Runtime.InteropServices;
- using System.Security;
- [assembly: AssemblyTitle("Yilin.Preresearch.CSharpActiveX")]
- [assembly: AssemblyDescription("")]
- [assembly: AssemblyConfiguration("")]
- [assembly: AssemblyCompany("10BAR")]
- [assembly: AssemblyProduct("Yilin.Preresearch.CSharpActiveX")]
- [assembly: AssemblyCopyright("Copyright ? 10BAR 2009")]
- [assembly: AssemblyTrademark("")]
- [assembly: AssemblyCulture("")]
- [assembly: AllowPartiallyTrustedCallers()]
- [assembly: ComVisible(true)]
- [assembly: Guid("114d1f0c-43b8-40ac-ae7c-5adccc19aef3")]
- [assembly: AssemblyVersion("1.0.0.0")]
- [assembly: AssemblyFileVersion("1.0.0.0")]
添加一個Windows用戶控件：
按照開發(fā)Windows用戶控件一樣的思路完成該控件的開發(fā)，本例中主要實(shí)現(xiàn)了兩個業(yè)務(wù)功能，一個是提供一個公共方法，用于讀取USBKey中保存的簽名證書，保存到本地C盤根目錄下，并返回操作信息；另一個業(yè)務(wù)功能提供UI界面，包括一個Button控件和一個Label控件，Button控件的Click事件調(diào)用前面提供的那個方法，并將返回信息顯示到Label控件上。這樣做可以達(dá)到兩個目的，其一，ActiveX控件提供公共方法供B/S程序直接調(diào)用，從后實(shí)現(xiàn)業(yè)務(wù)功能；其二，ActiveX控件可以提供B/S程序UI界面，通過響應(yīng)B/S程序中對UI的操作事件實(shí)現(xiàn)業(yè)務(wù)功能。
完成控件開發(fā)后，為了使該用戶控件作為一個ActiveX控件進(jìn)行使用，還需要做以下修改：
首先，為控件類添加GUID，這個編號將用于B/S系統(tǒng)的客戶端調(diào)用時使用（可以使用 工具-創(chuàng)建GUID 菜單創(chuàng)建一個GUID）：
- Guid("4A44CF4E-F859-4328-AA22-3E9D7AFFF1AB")]
- public partial class Hello : UserControl
- {
其次，為了讓ActiveX控件獲得客戶端的信任，控件類還需要實(shí)現(xiàn)一個名為“IObjectSafety”的接口。先創(chuàng)建該接口（注意，不能修改該接口的GUID值）：
- using System;
- using System.Collections.Generic;
- using System.Text;
- using System.Runtime.InteropServices;
- namespace Preresearch.CSharpActiveX
- {
- [ComImport, GuidAttribute("CB5BDC81-93C1-11CF-8F20-00805F2CD064")]
- [InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)]
- public interface IObjectSafety
- {
- [PreserveSig]
- int GetInterfaceSafetyOptions(ref Guid riid, [MarshalAs(UnmanagedType.U4)] ref int pdwSupportedOptions, [MarshalAs(UnmanagedType.U4)] ref int pdwEnabledOptions);
- [PreserveSig()]
- int SetInterfaceSafetyOptions(ref Guid riid, [MarshalAs(UnmanagedType.U4)] int dwOptionSetMask, [MarshalAs(UnmanagedType.U4)] int dwEnabledOptions);
- }
- }
然后在控件類中繼承并實(shí)現(xiàn)該接口：
- #region IObjectSafety 成員
- private const string _IID_IDispatch = "{00020400-0000-0000-C000-000000000046}";
- private const string _IID_IDispatchEx = "{a6ef9860-c720-11d0-9337-00a0c90dcaa9}";
- private const string _IID_IPersistStorage = "{0000010A-0000-0000-C000-000000000046}";
- private const string _IID_IPersistStream = "{00000109-0000-0000-C000-000000000046}";
- private const string _IID_IPersistPropertyBag = "{37D84F60-42CB-11CE-8135-00AA004BB851}";
- private const int INTERFACESAFE_FOR_UNTRUSTED_CALLER = 0x00000001;
- private const int INTERFACESAFE_FOR_UNTRUSTED_DATA = 0x00000002;
- private const int S_OK = 0;
- private const int E_FAIL = unchecked((int)0x80004005);
- private const int E_NOINTERFACE = unchecked((int)0x80004002);
- private bool _fSafeForScripting = true;
- private bool _fSafeForInitializing = true;
- public int GetInterfaceSafetyOptions(ref Guid riid, ref int pdwSupportedOptions, ref int pdwEnabledOptions)
- {
- int Rslt = E_FAIL;
- string strGUID = riid.ToString("B");
- pdwSupportedOptions = INTERFACESAFE_FOR_UNTRUSTED_CALLER | INTERFACESAFE_FOR_UNTRUSTED_DATA;
- switch (strGUID)
- {
- case _IID_IDispatch:
- case _IID_IDispatchEx:
- Rslt = S_OK;
- pdwEnabledOptions = 0;
- if (_fSafeForScripting == true)
- pdwEnabledOptions = INTERFACESAFE_FOR_UNTRUSTED_CALLER;
- break;
- case _IID_IPersistStorage:
- case _IID_IPersistStream:
- case _IID_IPersistPropertyBag:
- Rslt = S_OK;
- pdwEnabledOptions = 0;
- if (_fSafeForInitializing == true)
- pdwEnabledOptions = INTERFACESAFE_FOR_UNTRUSTED_DATA;
- break;
- default:
- Rslt = E_NOINTERFACE;
- break;
- }
- return Rslt;
- }
- public int SetInterfaceSafetyOptions(ref Guid riid, int dwOptionSetMask, int dwEnabledOptions)
- {
- int Rslt = E_FAIL;
- string strGUID = riid.ToString("B");
- switch (strGUID)
- {
- case _IID_IDispatch:
- case _IID_IDispatchEx:
- if (((dwEnabledOptions & dwOptionSetMask) == INTERFACESAFE_FOR_UNTRUSTED_CALLER) && (_fSafeForScripting == true))
- Rslt = S_OK;
- break;
- case _IID_IPersistStorage:
- case _IID_IPersistStream:
- case _IID_IPersistPropertyBag:
- if (((dwEnabledOptions & dwOptionSetMask) == INTERFACESAFE_FOR_UNTRUSTED_DATA) && (_fSafeForInitializing == true))
- Rslt = S_OK;
- break;
- default:
- Rslt = E_NOINTERFACE;
- break;
- }
- return Rslt;
- }
- #endregion
這樣，一個ActiveX控件就開發(fā)完成了。
3.2.ActiveX控件部署
ActiveX控件可以使用Visual Studio 2005的安裝項(xiàng)目進(jìn)行部署。這與普通的Windows Form應(yīng)用程序的部署幾乎一樣，只有一個地方需要注意，將前面創(chuàng)建的用戶控件項(xiàng)目作為主輸出項(xiàng)目，并設(shè)置其Register屬性為vsdrpCOM，如下圖所示：
3.3.測試
建立一個Web應(yīng)用程序項(xiàng)目，在測試頁面的HTML代碼中添加對ActiveX控件的引用，并且可以通過Javascript調(diào)用控件的公共成員（注意這里clsid后面的值即為前面為用戶控件類設(shè)置的GUID）：
- <object id="csharpActiveX" classid="clsid:E5E0446C-8680-4444-9FC2-F837BC617ED9"></object>
- <input type="button" onclick="alert(csharpActiveX.SayHello());" value="顯示當(dāng)前時間" />
將該Web應(yīng)用程序項(xiàng)目發(fā)布到IIS。另外找一臺電腦作為客戶端測試環(huán)境，確保它與服務(wù)器端網(wǎng)絡(luò)連通，安裝.NET Framework 2.0和該ActiveX控件。安裝完成后，就可以用瀏覽器訪問服務(wù)器，進(jìn)行測試了（你也可以在開發(fā)環(huán)境的系統(tǒng)中安裝該ActiveX控件，并直接在VS 2005中運(yùn)行WebApp項(xiàng)目查看結(jié)果）：
4. 總結(jié)
綜上所述，在Visual Studio 2005環(huán)境中使用C#開發(fā)ActiveX控件，技術(shù)實(shí)現(xiàn)上沒有什么難度，唯一的問題就是客戶端需要安裝.NET Framework。鑒于ActiveX控件一般都是實(shí)現(xiàn)一些簡單單一的功能，.NET Framework 2.0已經(jīng)完全可以應(yīng)付，所以建議在.NET Framework 2.0下開發(fā)。因?yàn)橄鄬τ?NET Framework 3.5兩百多兆的安裝包，.NET Framework 2.0安裝包只有20多兆，用戶相對容易接受一些。
5. FAQ
5.1.出現(xiàn)如下錯誤怎么解決？
經(jīng)在網(wǎng)上查閱，該問題是Visual Studio 2005的一個Bug，并不是每次都發(fā)生。我的解決辦法是從Visual Studio 2008的安裝目錄里拷貝regcap.exe覆蓋Visual Studio 2005的對應(yīng)文件，文件目錄一般為“~\Microsoft Visual Studio 8\Common7\Tools\Deployment\regcap.exe”。壓縮包中提供了該文件的Visual Studio 2008版本。
讀了本文，應(yīng)該對C#開發(fā)ActiveX控件的流程有個大致的了解了。本文來自博客園藝林吧：《使用C#開發(fā)ActiveX控件》
【編輯推薦】
