使用C#開發ActiveX控件,
0. 前言
ActiveX控件以前也叫做OLE控件或OCX控件,它是一些軟件組件或對象,可以將其插入到WEB網頁或其它應用程序中。使用ActiveX插件,可以輕松方便的在 Web頁中插入多媒體效果、交互式對象以及復雜程序等等。
通常使用C++或VB開發ActiveX控件,本文探討一下在Visual Studio 2005環境中使用C#開發ActiveX控件的技術實現。
1. 問題場景
在C/S架構的系統中,客戶端要實現某些業務功能,可以通過安裝相關的應用程序集來方便的實現。同樣的需求,在B/S架構的系統裡實現起來卻比較困難。因為所有的程序都放在服務器端,客戶端只是采用浏覽器,通過HTTP協議來訪問服務器端。比較成熟的解決辦法是開發ActiveX控件安裝到客戶端,這樣客戶端的浏覽器就可以訪問本地的ActiveX控件來執行相關的本地操作。本文將要談論的,就是使用C#開發一個ActiveX控件實現讀取並顯示客戶端的系統時間。
2. 開發環境
- Windows XP
- Visual Studio 2005
- .NET Framework 2.0(C#)
3. 實現過程
3.1.ActiveX控件開發
在Visual Studio 2005開發環境中,可以使用Windows控件庫項目實現ActiveX控件的開發,但是需要對項目做一些必要的設置。下面就來看看如何使用Windows控件庫項目開發一個ActiveX控件。首先創建一個應用程序解決方案,並添加一個Windows控件庫項目:
更改“項目屬性-應用程序-程序集信息”設置,勾選“使程序集 COM 可見”:
更改“項目屬性-生成”設置,勾選“為 COM Interop 注冊”(注意,此處如果實在debug狀態下修改的,那在調到release狀態下還需要再設置一次):
修改AssemblyInfo.cs文件,添加[assembly: AllowPartiallyTrustedCallers()]項(需要引用System.Security名稱空間):
usingSystem.Reflection;
usingSystem.Runtime.CompilerServices;
usingSystem.Runtime.InteropServices;
usingSystem.Security;
[assembly:AssemblyTitle("Yilin.Preresearch.CSharpActiveX")]
[assembly:AssemblyDescription("")]
[assembly:AssemblyConfiguration("")]
[assembly:AssemblyCompany("10BAR")]
[assembly:AssemblyProduct("Yilin.Preresearch.CSharpActiveX")]
[assembly:AssemblyCopyright("Copyright©10BAR2009")]
[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用戶控件:
按照開發Windows用戶控件一樣的思路完成該控件的開發,本例中主要實現了兩個業務功能,一個是提供一個公共方法,用於讀取USBKey中保存的簽名證書,保存到本地C盤根目錄下,並返回操作信息;另一個業務功能提供UI界面,包括一個Button控件和一個Label控件,Button控件的Click事件調用前面提供的那個方法,並將返回信息顯示到Label控件上。這樣做可以達到兩個目的,其一,ActiveX控件提供公共方法供B/S程序直接調用,從後實現業務功能;其二,ActiveX控件可以提供B/S程序UI界面,通過響應B/S程序中對UI的操作事件實現業務功能。
完成控件開發後,為了使該用戶控件作為一個ActiveX控件進行使用,還需要做以下修改:
首先,為控件類添加GUID,這個編號將用於B/S系統的客戶端調用時使用(可以使用 工具-創建GUID 菜單創建一個GUID):
Guid("4A44CF4E-F859-4328-AA22-3E9D7AFFF1AB")]
publicpartialclassHello:UserControl
{
其次,為了讓ActiveX控件獲得客戶端的信任,控件類還需要實現一個名為“IObjectSafety”的接口。先創建該接口(注意,不能修改該接口的GUID值):
usingSystem;
usingSystem.Collections.Generic;
usingSystem.Text;
usingSystem.Runtime.InteropServices;
namespacePreresearch.CSharpActiveX
{
[ComImport,GuidAttribute("CB5BDC81-93C1-11CF-8F20-00805F2CD064")]
[InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)]
publicinterfaceIObjectSafety
{
[PreserveSig]
intGetInterfaceSafetyOptions(refGuidriid,[MarshalAs(UnmanagedType.U4)]refintpdwSupportedOptions,[MarshalAs(UnmanagedType.U4)]refintpdwEnabledOptions);
[PreserveSig()]
intSetInterfaceSafetyOptions(refGuidriid,[MarshalAs(UnmanagedType.U4)]intdwOptionSetMask,[MarshalAs(UnmanagedType.U4)]intdwEnabledOptions);
}
}
然後在控件類中繼承並實現該接口:
#regionIObjectSafety成員
privateconststring_IID_IDispatch="{00020400-0000-0000-C000-000000000046}";
privateconststring_IID_IDispatchEx="{a6ef9860-c720-11d0-9337-00a0c90dcaa9}";
privateconststring_IID_IPersistStorage="{0000010A-0000-0000-C000-000000000046}";
privateconststring_IID_IPersistStream="{00000109-0000-0000-C000-000000000046}";
privateconststring_IID_IPersistPropertyBag="{37D84F60-42CB-11CE-8135-00AA004BB851}";
privateconstintINTERFACESAFE_FOR_UNTRUSTED_CALLER=0x00000001;
privateconstintINTERFACESAFE_FOR_UNTRUSTED_DATA=0x00000002;
privateconstintS_OK=0;
privateconstintE_FAIL=unchecked((int)0x80004005);
privateconstintE_NOINTERFACE=unchecked((int)0x80004002);
privatebool_fSafeForScripting=true;
privatebool_fSafeForInitializing=true;
publicintGetInterfaceSafetyOptions(refGuidriid,refintpdwSupportedOptions,refintpdwEnabledOptions)
{
intRslt=E_FAIL;
stringstrGUID=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;
}
returnRslt;
}
publicintSetInterfaceSafetyOptions(refGuidriid,intdwOptionSetMask,intdwEnabledOptions)
{
intRslt=E_FAIL;
stringstrGUID=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;
}
returnRslt;
}
#endregion
這樣,一個ActiveX控件就開發完成了。
3.2.ActiveX控件部署
ActiveX控件可以使用Visual Studio 2005的安裝項目進行部署。這與普通的Windows Form應用程序的部署幾乎一樣,只有一個地方需要注意,將前面創建的用戶控件項目作為主輸出項目,並設置其Register屬性為vsdrpCOM,如下圖所示:
3.3.測試
建立一個Web應用程序項目,在測試頁面的HTML代碼中添加對ActiveX控件的引用,並且可以通過Javascript調用控件的公共成員(注意這裡clsid後面的值即為前面為用戶控件類設置的GUID):
<objectid="csharpActiveX"classid="clsid:E5E0446C-8680-4444-9FC2-F837BC617ED9"></object>
<inputtype="button"onclick="alert(csharpActiveX.SayHello());"value="顯示當前時間"/>
將該Web應用程序項目發布到IIS。另外找一台電腦作為客戶端測試環境,確保它與服務器端網絡連通,安裝.NET Framework 2.0和該ActiveX控件。安裝完成後,就可以用浏覽器訪問服務器,進行測試了(你也可以在開發環境的系統中安裝該ActiveX控件,並直接在VS 2005中運行WebApp項目查看結果):
4. 總結
綜上所述,在Visual Studio 2005環境中使用C#開發ActiveX控件,技術實現上沒有什麼難度,唯一的問題就是客戶端需要安裝.NET Framework。鑒於ActiveX控件一般都是實現一些簡單單一的功能,.NET Framework 2.0已經完全可以應付,所以建議在.NET Framework 2.0下開發。因為相對於.NET Framework 3.5兩百多兆的安裝包,.NET Framework 2.0安裝包只有20多兆,用戶相對容易接受一些。
5. FAQ
5.1.出現如下錯誤怎麼解決?
經在網上查閱,該問題是Visual Studio 2005的一個Bug,並不是每次都發生。我的解決辦法是從Visual Studio 2008的安裝目錄裡拷貝regcap.exe覆蓋Visual Studio 2005的對應文件,文件目錄一般為“~\Microsoft Visual Studio 8\Common7\Tools\Deployment\regcap.exe”。壓縮包中提供了該文件的Visual Studio 2008版本。