天天看點

使用C#開發ActiveX控件

前言

      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控件庫項目:

使用C#開發ActiveX控件

      更改“項目屬性-應用程式-程式集資訊”設定,勾選“使程式集 COM 可見”:

使用C#開發ActiveX控件

      更改“項目屬性-生成”設定,勾選“為 COM Interop 注冊”(注意,此處如果實在debug狀态下修改的,那在調到release狀态下還需要再設定一次):

使用C#開發ActiveX控件

      修改AssemblyInfo.cs檔案,添加[assembly: AllowPartiallyTrustedCallers()]項(需要引用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使用者控件:

使用C#開發ActiveX控件

       按照開發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")]

public partial class Hello : UserControl

{

使用C#開發ActiveX控件

      其次,為了讓ActiveX控件獲得用戶端的信任,控件類還需要實作一個名為“IObjectSafety”的接口。先建立該接口(注意,不能修改該接口的GUID值): 

using System;

using System.Collections.Generic;

using System.Text;

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);

    }

}

      然後在控件類中繼承并實作該接口: 

#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:

            if (_fSafeForInitializing == true)

                pdwEnabledOptions = INTERFACESAFE_FOR_UNTRUSTED_DATA;

        default:

            Rslt = E_NOINTERFACE;

    return Rslt;

public int SetInterfaceSafetyOptions(ref Guid riid, int dwOptionSetMask, int dwEnabledOptions)

            if (((dwEnabledOptions & dwOptionSetMask) == INTERFACESAFE_FOR_UNTRUSTED_CALLER) && (_fSafeForScripting == true))

                Rslt = S_OK;

            if (((dwEnabledOptions & dwOptionSetMask) == INTERFACESAFE_FOR_UNTRUSTED_DATA) && (_fSafeForInitializing == true))

#endregion

      這樣,一個ActiveX控件就開發完成了。

3.2.ActiveX控件部署

      ActiveX控件可以使用Visual Studio 2005的安裝項目進行部署。這與普通的Windows Form應用程式的部署幾乎一樣,隻有一個地方需要注意,将前面建立的使用者控件項目作為主輸出項目,并設定其Register屬性為vsdrpCOM,如下圖所示:

使用C#開發ActiveX控件

3.3.測試

      建立一個Web應用程式項目,在測試頁面的HTML代碼中添加對ActiveX控件的引用,并且可以通過Javascript調用控件的公共成員(注意這裡clsid後面的值即為前面為使用者控件類設定的GUID): 

<object id="csharpActiveX" classid="clsid:E5E0446C-8680-4444-9FC2-F837BC617ED9"></object>

<input type="button" onclick="alert(csharpActiveX.SayHello());" value="顯示目前時間" />

      将該Web應用程式項目釋出到IIS。另外找一台電腦作為用戶端測試環境,確定它與伺服器端網絡連通,安裝.NET Framework 2.0和該ActiveX控件。安裝完成後,就可以用浏覽器通路伺服器,進行測試了(你也可以在開發環境的系統中安裝該ActiveX控件,并直接在VS 2005中運作WebApp項目檢視結果):

使用C#開發ActiveX控件

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.出現如下錯誤怎麼解決?

使用C#開發ActiveX控件

      經在網上查閱,該問題是Visual Studio 2005的一個Bug,并不是每次都發生。我的解決辦法是從Visual Studio 2008的安裝目錄裡拷貝regcap.exe覆寫Visual Studio 2005的對應檔案,檔案目錄一般為“~\Microsoft Visual Studio 8\Common7\Tools\Deployment\regcap.exe”。壓縮包中提供了該檔案的Visual Studio 2008版本。