Windows Ribbon Framework ガイド

IronHSP の iron_ribbon_native.hsp + hspribbon.dll を使用して、 Office 風のネイティブリボン UI を HSP アプリケーションに組み込む方法を解説します。

1. 概要

Windows Ribbon Framework は Windows 7 以降に標準搭載されている UI コンポーネントです。 Office 2007 以降のリボンインターフェースと同じネイティブ品質で表示されます。

必要なもの

• hspribbon.dll / hspribbon_64.dll — IronHSP プラグイン (同梱済み)
• iron_ribbon_native.hsp — HSP ラッパーモジュール (同梱済み)
• uicc.exe — リボンマークアップコンパイラ (Windows SDK に含まれる)

2. uicc.exe の入手方法

uicc.exe は Windows SDK に含まれています。

インストール方法

1. Visual Studio Installer を開く
2. 「個別のコンポーネント」タブを選択
3. 「Windows 10 SDK」または「Windows 11 SDK」にチェック
4. インストール

または Microsoft 公式サイトから単体でダウンロードできます。

パスの確認

C:\Program Files (x86)\Windows Kits\10\bin\10.0.XXXXX.0\x86\uicc.exe

複数バージョンがインストールされている場合は最新版を使用してください。

3. ワークフロー

┌──────────┐     uicc.exe      ┌──────────┐
│ ribbon.xml │ ──────────────→ │ ribbon.bml │  (バイナリマークアップ)
│ (XML定義)  │                  │ ribbon.rc  │  (リソーススクリプト)
│            │                  │ ribbon.h   │  (C/C++ ヘッダ)
└──────────┘                  └──────────┘
                                       │
                              hspribbon.dll が
                              自動的にリソース DLL を
                              生成してロード
                                       │
                                       ▼
                              ┌──────────────┐
                              │ リボン表示！     │
                              └──────────────┘

4. リボンマークアップ XML の書き方

4.1 基本構造

<?xml version="1.0" encoding="utf-8"?>
<Application xmlns="http://schemas.microsoft.com/windows/2009/Ribbon">

  <!-- コマンド定義 -->
  <Application.Commands>
    <Command Name="cmdNew" Id="101" LabelTitle="New" />
  </Application.Commands>

  <!-- ビュー定義 -->
  <Application.Views>
    <Ribbon>
      <Ribbon.Tabs>
        <Tab CommandName="cmdTabHome">
          <Group CommandName="cmdGrpFile">
            <Button CommandName="cmdNew" />
          </Group>
        </Tab>
      </Ribbon.Tabs>
    </Ribbon>
  </Application.Views>

</Application>

4.2 Command 要素の属性

4.3 画像の指定

<Command Name="cmdNew" Id="101" LabelTitle="New">
  <Command.LargeImages>
    <Image Source="res\new32.bmp" />      <!-- 32x32 BMP -->
  </Command.LargeImages>
  <Command.SmallImages>
    <Image Source="res\new16.bmp" />      <!-- 16x16 BMP -->
  </Command.SmallImages>
</Command>

4.4 コントロール種別

4.5 SizeDefinition (グループ内レイアウト)

4.6 ApplicationMenu (ファイルメニュー)

<Ribbon.ApplicationMenu>
  <ApplicationMenu>
    <MenuGroup>
      <Button CommandName="cmdNew" />
      <Button CommandName="cmdOpen" />
      <Button CommandName="cmdSave" />
    </MenuGroup>
    <MenuGroup>
      <Button CommandName="cmdExit" />
    </MenuGroup>
  </ApplicationMenu>
</Ribbon.ApplicationMenu>

4.7 Quick Access Toolbar

<Ribbon.QuickAccessToolbar>
  <QuickAccessToolbar>
    <QuickAccessToolbar.ApplicationDefaults>
      <Button CommandName="cmdSave" />
      <Button CommandName="cmdUndo" />
      <Button CommandName="cmdRedo" />
    </QuickAccessToolbar.ApplicationDefaults>
  </QuickAccessToolbar>
</Ribbon.QuickAccessToolbar>

4.8 ColorTemplate (カラーピッカー)

<DropDownColorPicker CommandName="cmdFontColor" ColorTemplate="ThemeColors" />

ColorTemplate: ThemeColors / StandardColors / HighlightColors

5. コンパイル手順

uicc.exe ribbon.xml ribbon.bml /header:ribbon.h /res:ribbon.rc

6. HSP からの使い方

6.1 基本

#include "iron_ribbon_native.hsp"

screen 0, 1024, 600

; 初期化
ribbon_native_init

; BML ロード (.rc + .h + res/*.bmp も同じフォルダに必要)
ribbon_native_load_bml dir_cur + "\\ribbon.bml"

; イベントモード ON (メッセージ ID はユーザーが自由に設定可能)
ribbon_native_set_event_mode 1, 0x80C8

; oncmd でコマンドを受信
oncmd gosub *on_ribbon, 0x80C8
stop

*on_ribbon
    cmd_id = wparam    ; コマンド ID (ribbon.xml の Id 属性)
    cmd_verb = lparam  ; 0=Execute, 1=Preview, 2=CancelPreview
    mes "CMD=" + cmd_id
    return

6.2 API リファレンス

7. トラブルシューティング

8. 参考リンク

• Windows Ribbon Framework XML Schema (Microsoft Docs)
• UIRibbonDemos (fafalone) - VB6/twinBASIC サンプル
• UIRibbon-Reversing - BML フォーマット解析