NO IMAGE

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控制元件庫專案:

clip_image002

 

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

clip_image004

 

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

clip_image006

 

      修改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使用者控制元件:

clip_image008

       按照開發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
{

      其次,為了讓ActiveX控制元件獲得客戶端的信任,控制元件類還需要實現一個名為“IObjectSafety”的介面。先建立該介面(注意,不能修改該介面的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);
    }
}

複製程式碼

      然後在控制元件類中繼承並實現該介面: 

複製程式碼

#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控制元件就開發完成了。

3.2.ActiveX控制元件部署

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

clip_image009

 

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專案檢視結果):

clip_image011

 

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

clip_image012

 

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