Ribbon界面的Office插件開發

      此乃開博第一篇也。Office插件開發是一項古老的技術,彷佛從office2000開始,Office的插件體系就已經固定下來,後續版本也只是在不斷完善和加入新功能。Office插件是在COM模型的基礎上,實現了特定的接口,進而經過COM技術進行相互操做的一個dll文件。經過在相應的註冊表位置進行註冊,就能夠被Office程序調用。html

在繼續本篇教程以前,先來介紹一下本次開發的基本環境:編輯器

開發工具:Delphi 7 企業版ide

系統環境:Win7 64位系統 安裝WPS Office 2013SP3(9.1.0.4953)函數

      基於WPS V9版的API,這個版本基本兼容 MS Office 2007,你也能夠基於MS OfficeAPI接口,效果是同樣的。本教程同時可用於MS Office 和 WPS Office工具

Office插件是一個實現了IDTExtensibility2接口的COM組件,在導入相應的類型庫後就能夠引用AddInDesignerObjects_TLB.pas的相關接口,它的聲明以下:開發工具

  _IDTExtensibility2 = interface(IDispatch)
    ['{B65AD801-ABAF-11D0-BB8B-00A0C90F2744}']
    procedure OnConnection(const Application: IDispatch; ConnectMode: ext_ConnectMode; 
                           const AddInInst: IDispatch; var custom: PSafeArray); safecall;
    procedure OnDisconnection(RemoveMode: ext_DisconnectMode; var custom: PSafeArray); safecall;
    procedure OnAddInsUpdate(var custom: PSafeArray); safecall;
    procedure OnStartupComplete(var custom: PSafeArray); safecall;
    procedure OnBeginShutdown(var custom: PSafeArray); safecall;
  end;

 

在此很少作介紹,具體可參考MSDN,裏面有詳細的介紹。測試

Ribbon界面是Office2007新增的界面,這個界面的插件開發,將界面設計與功能實現進行了分離,界面以XML文件進行定義,功能實現以回調函數的形式調用,與傳統的工具欄和菜單形式的插件相比,開發效率要高的多,本教程要介紹的就是這一技術。ui

在實現Ribbon界面,在插件中除了要實現IDTExtensibility2接口外,還要實現Ribbon界面的專用接口IRibbonExtensibility,這個接口定義在Office的類型庫中,聲明以下:spa

 

  IRibbonExtensibility = interface(IDispatch)
    ['{000C0396-0000-0000-C000-000000000046}']
    function GetCustomUI(const RibbonID: WideString): WideString; safecall;
  end;

 

這個接口只有一個方法GetCustomUI,返回值爲界面設計的XML文件內容。咱們本次要實現的界面XML內容以下:.net

 

<customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui">
    <ribbon startFromScratch="false">
        <tabs>
            <tab id="DemoTab" label="育林軟件">
                <group id="loadFormsGroup" label="測試分組">
                    <button id="btn1" label="測試功能" onAction="OnAction" getImage="GetImage"/>
                    <button id="btn2" label="關於咱們" onAction="OnAction" getImage="GetImage"/>
                </group>
            </tab>
        </tabs>
    </ribbon>
</customUI>

 

關於XML的定義規則請參考MSDN,上面有詳細介紹。OnAction是回調函數,用於響應按鈕點擊,GetImage用於返回按鈕的圖片。

咱們的COM對象定義以下:

 

type
  TTestRibbon = class(TAutoObject, IDTExtensibility2, IRibbonExtensibility, ITestRibbon)
  private

  protected
    {實現IRibbonExtensibility接口}
    function GetCustomUI(const RibbonID: WideString): WideString; safecall;
    {實現IDTExtensibility2接口}
    procedure OnConnection(const Application: IDispatch; ConnectMode: ext_ConnectMode;
      const AddInInst: IDispatch; var custom: PSafeArray); safecall;
    procedure OnDisconnection(RemoveMode: ext_DisconnectMode; var custom: PSafeArray); safecall;
    procedure OnAddInsUpdate(var custom: PSafeArray); safecall;
    procedure OnStartupComplete(var custom: PSafeArray); safecall;
    procedure OnBeginShutdown(var custom: PSafeArray); safecall;
    {實現ITestRibbon接口,這兩個方法就是咱們要用的回調函數}
    procedure OnAction(const ctrl: IDispatch); safecall;
    function GetImage(const ctrl: IDispatch): IDispatch; safecall;
  public

  end;

 

ITestRibbon是咱們com對象定義的接口,它有兩個方法OnActionGetImage,若是XML中定義的控件較多,咱們須要添加的回調函數就越多,每種控件的回調函數都是大同小異,咱們實現的就是針對普通按鈕的回調函數,須要在delphi的類型庫編輯器中添加,以下圖。

 

     OnAction你也能夠定義爲其它名稱,只要參數類型相同,什麼名字均可以,但要注意名稱必定要跟XML中定義的同樣,也就是說你這裏定義的什麼名字,XML文件中onActon後面也要用什麼名字。類型庫導入完成,接口定義完成就開始實現部分了,這纔是重點。說實話,在接口定義部分我也走了很多彎路,研究了幾個晚上才搞明白,網上基於.net的相關內容很多,但參考性不強,.netcom的實現進行了封裝,開發者不用關心定義,只要寫代碼就能夠了,但delphi要作的工做還有不少。雖然麻煩,但好處仍是有的,.net開發的插件要附帶不少文件,delphi開發的插件只要發佈一個dll就能夠了。

下面咱們來看實現部分,先看GetCustomUI

 

function TTestRibbon.GetCustomUI(const RibbonID: WideString): WideString;
var Str:TStrings;
begin
  Str:=TStringList.Create;
  Str.LoadFromFile('C:\CustomUI.xml');
  Result := Str.Text;
  Str.Free;
end;

     這裏咱們選擇從文件載入XML數據,主要是爲了後期修改與調試方便,等到發佈的時候,徹底能夠將XML文件加入進資源文件,從資源中載入。

到這裏,若是咱們編譯後安裝插件,就能夠在Office中顯示咱們的按鈕了,但因爲沒有實現OnAction,因此點擊按鈕是沒有任何反應的,下面咱們來實現OnAction回調函數。它的定義以下:

procedure OnAction(const ctrl: IDispatch); safecall;

根據微軟的定義,ctrl是一個IRibbonControl接口的參數,這個接口定義在Office的通用類型庫中,這個參數是咱們判斷究竟是哪一個按鈕調用了這個函數的基礎,就是依據IRibbonControlID屬性,這個ID就是XML中定義的Id,咱們的實現以下:

 

procedure TTestRibbon.OnAction(const ctrl: IDispatch);
begin
  if (ctrl as IRibbonControl).Id = 'btn1' then
    MessageBox(0, '您點擊了按「測試功能」!', '提示', MB_OK + MB_ICONINFORMATION)
  else
    MessageBox(0, '您點擊了按鈕「關於咱們」!', '提示', MB_OK + MB_ICONINFORMATION);
end;

到此一個簡單的插件就已經完成了,下面說一下插件安裝。

將如下內容保存爲註冊表文件.reg,並雙擊導入註冊表。

 

Windows Registry Editor Version 5.00

[HKEY_CURRENT_USER\Software\Microsoft\Office\Word\Addins\Yulinsoft.TestRibbon]
"FriendlyName"="測試Ribbon插件"
"Description"="測試插件"
"LoadBehavior"=dword:00000003
"CommandLineSafe"=dword:00000001

[HKEY_CURRENT_USER\Software\Kingsoft\Office\WPS\AddinsWL]
"Yulinsoft.TestRibbon"=""

 

而後再用命令行regsvr32註冊咱們的dll,注意文件路徑正確,註冊成功後打開Word2007WPS,就能夠看到咱們的按鈕了,以下圖:

【原創文章,轉載請註明出處】 

本教程所有代碼與資源文件下載:

http://pan.baidu.com/s/1eQrSOSE

本文參考內容以下:

http://gregmaxey.mvps.org/word_tip_pages/customize_ribbon_main.html

Customizing the 2007 Office Fluent Ribbon for Developers (Part 1 of 3)

Customizing the 2007 Office Fluent Ribbon for Developers (Part 2 of 3)

Customizing the 2007 Office Fluent Ribbon for Developers (Part 3 of 3)

初來貴地交流技術,若有不對之處,歡迎你們批評指證。下節咱們將講解如何給按鈕添加圖像!

相關文章
相關標籤/搜索