ExcelマクロVBA技術解説 | Excelアドインの作成と登録について | ExcelマクロVBAの問題点と解決策、エクセルVBAの技術的解説



最終更新日:2019-02-03

Excelアドインの作成と登録について


Excelアドインの作成方法と登録方法についての手順と注意点、
そして対応するマクロVBAコードについて紹介します。

具体的にどんなアドインを作成するかではなく、
一般的なアドインの作成と登録についての概要の解説とVBAコードのサンプルになります。


以下の項目に分けて解説しています。
・Excelアドインについて
・アドインファイルのフォルダ
・アドインの作り方
・アドインの登録と有効化
・リボンへの登録
・アドインで保存するVBA
・アドインを登録するVBA
・アドインを有効化するVBA
・アドインマネージャーを表示するVBA
・アドイン配布時に自動登録するVBA


Excelアドインについて
アドインは、一般的にはプログラムに拡張した機能を追加するものを指します。
エクセルに独自の機能追加するものがエクセルアドインになります。

Excelのアドインファイルは、拡張子が.xlam(2003までは.xla)のファイルです。
このアドインファイルをエクセルに登録することでアドインの機能が使えるようになります。



アドインファイルのフォルダ

Excelアドインの既定のフォルダは、
C:\Users\ユーザー\AppData\Roaming\Microsoft\AddIns
になります。

通常は、上記フォルダにアドインファイルを入れて使うものですが、他のフォルダでも構いません。
Excelからアクセス可能なフォルダであれば、どこに置いても登録可能です。



アドインの作り方

プロシージャーでのVBAの記述について
最初は通常の「Excel マクロ有効ブック(*.xlsm」で作成します。
アドインとして呼び出すプロシージャーは、外部で使える必要がありますので、
Sub
Public Sub
Function
Public Function
このように、スコープがPublicになるようにします。

アドインの機能を呼び出す方法は何通りもあります。

・リボン「開発」→「マクロ」→「実行」
・リボンのアイコンをクリック
・ユーザー定義関数
 ユーザー定義関数の作り方
 ユーザー定義関数でフリガナを取得する(GetPhonetic)
 ユーザー定義関数でハイパーリンクのURLを取得(Hyperlink)
・ショートカットキー
 マクロをショートカットで起動(OnKeyメソッド)
 「値の貼り付け」をショートカットに登録(OnKey)
・マウスの右クリックメニユー
 右クリックメニューの変更(CommandBars)
・セル各種イベント
 WithEventsを使用
※参考ページはアドインとして作っているものではなく、呼び出し方法と実装の参考です。

一番使い勝手が良く機能拡張しやすいのは、右クリックメニューを使う方法だと思っています。
メニューの階層化もできますし、使えるアイコンも結構あります。

アドインのプロシージャーで自身(アドインを書いたブック)のシートも使えますが、
自身のシートを表示することはできません。
したがって、ユーザーの操作で自身のシートに記入してもらうような事はできません。
他のブックに記入してもらい、その内容を自身のシートに転記して自身を保存(Save)することは可能です。

.xlamの保存方法
マクロ有効ブック.xlsmで作成したブックをアドイン.xlamで保存するには、
名前を付けて保存します。



「Excel アドイン(*.xlam)」を選択します。
アドイン.xlamで保存後は、元のマクロ有効ブック.xlsmの画面に戻ります。



アドインの登録と有効化

エクセルを起動して、
リボンの「フアイル」 ・・・一番左

「オプション」 ・・・下から2番目

「アドイン」 ・・・下から2番目



一番下の、「設定(G)」をクリック



「参照(B)」をクリック



Excelアドインの既定のフォルダである、
C:\Users\ユーザー\AppData\Roaming\Microsoft\AddIns
が表示されます。
他のフォルダにアドインファイルを置いた場合は、そのフォルダに移動します。

登録するアドインファイルを選択して、「OK」



アドインの一覧に登録したアドインが表示されます。
チェックを付けて、「OK」

これで登録したアドインが使用可能になります。
※Excelのバージョンによっては、エクセルを再起動しないとアドインが有効にならない場合があります。
確認の意味でも、エクセルを再起動して機能しているか確認してください。



リボンへの登録

アドインを起動する方法はいろいろあるので、特にリボンに登録する必要性はありませんが、
リボンを使いたい場合は、以下のようにします。

リボンの「フアイル」 →「オプション」 →「リボンのユーザー設定」



「新しいタブ(W)」をクリックして、ユーザー設定のタブを作成します。
すでにある時は、そこに追加しても良い。



アドイン内のプロシージャーが一覧表示されるので、
プロシージャーを選択して追加ます。



「名前の変更(M)」で、それぞれ分かり易い名前に変更してください。

アイコンの変更や、既存リボンのカスタマイズは通常の方法ではできません。
これらをやる場合はXMLで可能ではあますが、本サイトでは紹介していません。



アドインで保存するVBA

マクロ有効ブック.xlsmで作成したブックをアドイン.xlamとして保存するVBAです。

Sub AddinSaveas()
  Dim strFile As String
  strFile = Replace(ThisWorkbook.FullName, ".xlsm", ".xlam")
  If Dir(strFile) <> "" Then Kill strFile
  ThisWorkbook.SaveAs Filename:=strFile, FileFormat:=xlOpenXMLAddIn
End Sub

SaveAsメソッドで、引数FileFormatにxlOpenXMLAddInを指定します。

上の例では、マクロ有効ブック.xlsmと同じフォルダに保存していますが、
アドインの規定フォルダに保存するには、そのフォルダをまず取得します。

Sub AddinFolder()
  Dim wsh As Object
  Set wsh = CreateObject("WScript.Shell")
  MsgBox wsh.SpecialFolders("Appdata") & "\Microsoft\Addins\"
End Sub

取得したアドインの規定フォルダに保存してください。
ただし、自分だけで使うアドインならともかく、
配布用に作成する場合を考慮すると、一旦は別フォルダに保存したほうが良いのではないかと思います。
アドインの動作確認は、アドイン登録しなくてもアドイン.xlamを直接開くことで確認できます。



アドインを登録するVBA

アドインファイル.xlamをアドインの一覧に登録するVBAです。

Sub AddinAdd()
  AddIns.Add ThisWorkbook.Path & "\AddinTest.xlam"
End Sub

アドインの一覧に入れるだけでは有効化さないので、
この時点では、まだアドインは使える状態になっていません。

既にアドインに登録されている場合は、このVBAは無視されます。



アドインを有効化するVBA

アドインの一覧でチェックを付けて有効化するVBAです。

Sub AddinInstall()
  AddIns("AddinTest").Installed = True
End Sub

無効化する場合は、Falseを指定します。

有効化されている状態でExcelが起動している場合は、アドインファイルが開かれています。
アドインファイルを入れ替える場合は、一旦無効化してから入れ替えます。



アドインマネージャーを表示するVBA

リボンの「フアイル」→「オプション」→「アドイン」→「設定(G)」で表示されるダイアログを表示するVBAです。

Sub AddinManeger()
  Dim rtn
  rtn = Application.Dialogs(xlDialogAddinManager).Show
  If rtn = True Then
    MsgBox "OK"
  Else
    MsgBox "キャンセル"
  End If
End Sub

「OK」が選択されたとしても、何が変更されたかは判別できません。

これを判別するには、ダイアログの表示前後でアドインの一覧の変化を判定すれば可能です。
以下では、アドインに登録されているファイルの一覧をイミディエイトウインドウに出力しています。

Sub GetAddins()
  Dim objAddin As AddIn
  For Each objAddin In AddIns
    Debug.Print objAddin.FullName
  Next
End Sub

上ではフルパスを出力していますが、
名前だけなら、.Name
パスだけなら、.Path



アドイン配布時に自動登録するVBA

アドインを配布時に、ユーザーの手間を省くために自動でアドイン登録できれば便利です。

同一フォルダにあるアドイン.xlamを、アドインフォルダにコピーしてからアドイン登録&有効化するVBAです。

Sub AdinAutoInstall()
  Dim InstallPath
  Dim AddinPath
  Dim AddinFile
  Dim AddinName
  Dim xlApp
  Dim fso
  Dim wsh
  
  AddinName = "AddinTest" 'アドインのファイル名、アドイン名
  AddinFile = AddinName & ".xlam"
  
  On Error Resume Next
  
  'Excelのインスタンス
  Set xlApp = Application 'VBA
  'Set xlApp = CreateObject("Excel.Application") 'VbScript
  
  '登録済対策
  xlApp.AddIns(AddinName).Installed = False
  
  '使用するオブジェクトのインスタンス
  Set wsh = CreateObject("WScript.Shell")
  Set fso = CreateObject("Scripting.FileSystemObject")
  
  'アドインのファイル名、ここでは同一フォルダ
  AddinPath = ThisWorkbook.Path & "\" 'VBA
  'AddinPath = fso.GetFolder(".") & "\" 'VbScript
  
  'Addinsフォルダ、任意のフォルダを指定可能
  InstallPath = wsh.SpecialFolders("Appdata") & "\Microsoft\Addins\"
  'アドインファイルをコピー
  fso.CopyFile AddinPath & AddinFile, InstallPath & AddinFile, True
  
  'アドイン登録
  'xlApp.Workbooks.Add 'VbScript
  xlApp.AddIns.Add InstallPath & AddinFile
  xlApp.AddIns(AddinName).Installed = True
  'xlApp.Quit 'VbScript
  
  '終了時の解放
  Set wsh = Nothing
  Set fso = Nothing
  Set xlApp = Nothing
  
  MsgBox "インストール終了"
End Sub

VBScriptとある程度共通で使えるようにしています。
・参照設定を使わない
・オブジェクトの型を指定しない
これにより、ほとんどの部分はそのままコピペしてVBScriptで使えるようにVBAコードを書いています。
コメントで、
'VBA
'VbScript
これは、
VBAとして使う場合は、 'VBAの行を生かし、'VbScriptの行をコメントアウトする
VScriptとして使う場合は、 'VBAの行をコメントアウトし、'VbScriptの行を生かす

VBScriptはテキストファイルで、拡張子を.vbsとするだけです。
起動もダブルクリック等で起動できますし、アプリが立ち上がらないので高速で処理完了します。
一応VBScriptで動作確認もしてはありますが、
本サイトではVBScriptの解説をしていませんので、あくまで補足としての記載になります。

アドインを配布して使ってもらう場合は、VBScriptの方が起動は手軽で簡単かもしれません。
処理速度も上記コードならほぼ一瞬で終わります。
ただし、VBScriptでは細かいエラー処理を入れるのが面倒です。
面倒なだけで入れられないことはありませんが、
そのような必要性がある場合は、
VBAの方がコードが書きやすくテストしやすいと思います。



Excelに独自機能を組み込む場合、
単にExcel起動と同時に機能追加するだけなら、個人用マクロブックでも良いことになります。
そのような場合は、アドインと個人用マクロブックのどちらが良いということもないと思います。
しかし、
個人用マクロブックは名前が示す通り、基本的には個人で使うものです。
したがって、配布する場合はアドインにしたほうが後々の保守性は良くなります。
機能ごとにxlamを分けて配布すれば、ユーザーが個別にいつでも有効化・無効化できますので融通も効きます。




同じテーマ「マクロVBA技術解説」の記事

文字列としてのプロシージャー名を起動する方法(Run,OnTime)
ドキュメントの作成者を取得(GetObject,BuiltinDocumentProperties)
画像サイズ(横x縦)の取得について
文字種(ひらがな、全半角カタカナ、半角英大文字等々)の判定
オブジェクトとプロパティの真実
オブジェクト式について
オブジェクトの探索方法
条件付きコンパイル(32ビット64ビットの互換性)
ドキュメントプロパティ(BuiltinDocumentProperties,CustomDocumentProperties)
VBAでファイルを規定のアプリで開く方法
Excelアドインの作成と登録について

新着記事 ・・・新着記事一覧を見る

Excelシートの複雑な計算式を解析するVBA|VBAサンプル集(2月18日)
VBAクラスの作り方:独自Rangeっぽいものを作ってみた|VBA技術解説(2月16日)
VBAクラスの作り方:列名のプロパティを自動作成する|VBA技術解説(2月14日)
VBAクラスの作り方:列名の入力支援と列移動対応|VBA技術解説(2月11日)
クラスを使って他ブックのイベントを補足する|VBA技術解説(2月6日)
Excelアドインの作成と登録について|VBA技術解説(2月3日)
参照設定、CreateObject、オブジェクト式の一覧|VBA技術解説(1月20日)
VBAでファイルを規定のアプリで開く方法|VBA技術解説(1月20日)
ドキュメントプロパティ(BuiltinDocumentProperties,CustomDocumentProperties)|VBA技術解説(1月19日)
他ブックへのリンクエラーを探し解除|VBAサンプル集(1月15日)

アクセスランキング ・・・ ランキング一覧を見る

1.最終行の取得(End,Rows.Count)|VBA入門
2.セルのコピー&値の貼り付け(PasteSpecial)|VBA入門
3.変数とデータ型(Dim)|ExcelマクロVBA入門
4.Range以外の指定方法(Cells,Rows,Columns)|VBA入門
5.RangeとCellsの使い方|ExcelマクロVBA入門
6.マクロって何?VBAって何?|ExcelマクロVBA入門
7.繰り返し処理(For Next)|ExcelマクロVBA入門
8.とにかく書いて見よう(Sub,End Sub)|VBA入門
9.定数と型宣言文字(Const)|ExcelマクロVBA入門
10.ひらがな⇔カタカナの変換|エクセル基本操作



  • >
  • >
  • >
  • Excelアドインの作成と登録について

  • このサイトがお役に立ちましたら「シェア」「Bookmark」をお願いいたします。


    記述には細心の注意をしたつもりですが、
    間違いやご指摘がありましたら、「お問い合わせ」からお知らせいただけると幸いです。
    なお、掲載のVBAコードは自己責任で使ってください。万一データ破損等の損害が発生しても責任は負いません。





    このサイトがお役に立ちましたら「シェア」「Bookmark」をお願いいたします。

    本文下部へ

    ↑ PAGE TOP