技術資料/カスタムリボン

前提条件 †

カスタムリボンは、Microsoft Office 2007以降のアプリであれば可能だが、ここではExcel2007を対象に記述する。

参考サイト †

• チュートリアル
• XMLリファレンス
• http://www.ka-net.org/blog/?cat=1

用意するもの †

• Microsoft Excel 2007
• Office Custom UI Editor
• UTF-8 を編集可能なテキストエディタ

※Office Custom UI Editorに替わる、Office Ribbon Editorというツールもあるみたい。

手順 †

Excelアドインファイルの準備 †

カスタムリボンは、Officeのアドインファイルとして用意することになる。

1. Excelを起動する。
2. 何も編集せずに、Excelアドインファイル(*.xlam)として保存する。（例：custom.xlam）

customUI.xmlの埋め込み †

カスタムリボンの外観は、XMLファイルで記述される。その雛型を埋め込む。

1. Office Custom UI Editorを起動する。
2. 先ほど保存した「custom.xlam」を開く。
3. メニューの「Insert」-「Office 2007 Custom UI Part」を選択。
4. 画面左側のツリービューに「customUI.xml」が追加されるので、選択する。
5. メニューの「Insert」-「Sample XML」-「Excel - A Custom Tab」を選択する。
6. 上書き保存する。

customUI.xmlの編集 †

ここからテキストエディタでXMLファイルを編集していくが、全角文字を使うつもりがなければ引き続きOffice Custom UI Editorを使用することもできる。
(Office Custom UI Editorを使う場合は、以下のZIP解凍/再圧縮の手順は必要なくなる)

1. 「custom.xlam」をZIP解凍する。
2. 先ほど埋め込んだXMLファイル「\customUI\customUI.xml」をテキストエディタで開く。
3. 【重要】1行目を以下のように変更する。

   <customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui">

   ↓

   <customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui">

   ※「2009/07」はOffice2010用。Office2007の場合は「2006/01」とする必要がある。
4. 先頭に以下の行を追加する。

   <?xml version="1.0" encoding="utf-8"?>

5. あとは好みにカスタマイズしていく。（タグの説明等は後述） XMLファイルの内容は、以下のようになっているはず。
   このままアドインとして登録すると、埋め込まれたサンプルを動作させることができる。

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

   <?xml version="1.0" encoding="utf-8"?> <customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui"> <ribbon> <tabs> <tab id="customTab" label="Contoso" insertAfterMso="TabHome"> <group idMso="GroupClipboard" /> <group idMso="GroupFont" /> <group id="customGroup" label="Contoso Tools"> <button id="customButton1" label="ConBold" size="large" onAction="conBoldSub" imageMso="Bold" /> <button id="customButton2" label="ConItalic" size="large" onAction="conItalicSub" imageMso="Italic" /> <button id="customButton3" label="ConUnderline" size="large" onAction="conUnderlineSub" imageMso="Underline" /> </group> <group idMso="GroupEnterDataAlignment" /> <group idMso="GroupEnterDataNumber" /> <group idMso="GroupQuickFormatting" /> </tab> </tabs> </ribbon> </customUI>

6. 文字エンコードを「UTF-8」として上書き保存する。
7. 解凍したファイル群を、再圧縮する。 解凍したファイル群のトップは、以下のような構造になっているはず。
   　・_rels
   　・customUI
   　・docProps
   　・xl
   　・[Content_Types].xml
   これらのファイルを全選択した状態でZIP圧縮する。
   ※新しくフォルダを作ってこれらのファイルを入れてから圧縮したりしないこと。Excelファイルの内部構造が変わってしまい、正常に動作しなくなる。
8. 圧縮したファイルをリネームする。 圧縮したファイルは、「*.zip」となっているはずなので、最初の「custom.xlam」という名前に戻しておく。

CallBack関数の作成 †

XMLで指定したコントロールの動作の定義は、CallBack関数で行う。

1. 「custom.xlam」を開く。
2. VBEを開き、標準モジュールを挿入する。
3. XMLに定義したCallBack関数をPublicで作成する。
   ※XMLに全角文字を使用していない状態であれば、Office Custom UI Editorの「Generate Callbacks」ボタンを押すことで関数定義の雛型を表示してくれる。
4. 上書き保存する。

Excelにアドインとして登録 †

1. 「custom.xlam」を以下の場所に置く。

   C:\Documents and Settings\[ユーザ名]\Application Data\Microsoft\AddIns

2. Excelを起動し、「Officeボタン」-「Excelのオプション」-「アドイン」の画面を開き、下の方の「設定」ボタンを押す。
3. 有効なアドイン一覧に「Custom」があるはずなのでチェックを付け「OK」を押す。
4. 以上で完了。アドインをアンインストールするときは、チェックを外してからアドインファイルを削除すればよい。

XMLファイルのタグ †

Word2007の場合 †

以下の点に気をつければ、Excelと同じ手順でOK。

• Wordにはアドインファイルという種類のファイルは無いので「*.dotm」として作成する。
• 作成したdotmファイルを以下に置くと、自動的にロードされる。

  C:\Program Files\Microsoft Office\Office12\STARTUP

• マクロを修正する場合、上記フォルダにdotmファイルを置いた状態だとVBEでコードの編集等ができないので、一度別のフォルダに移動してから開いて編集すること。