【Excel VBA】VBAの処理状況をPowerShell経由でタスクトレイにトースト通知する

VBAの処理状況をPowerShell経由でタスクトレイにトースト通知する

この記事では、Microsoft Office 上の全てのVBA環境で利用可能な「MakeToastNotification」というユーザー定義関数を紹介します。

この関数を標準モジュール等に追加すると、Windowsオペレーティングシステムで一般的に利用されている以下のようなトースト通知をタスクトレイに簡単に表示できます。

このトースト通知は、Windowsオペレーティングシステムで用いられる以下のような特徴を持った通知形式の一つで、ユーザーに重要な情報やアクションを伝えるため、画面右下で焼きあがったトーストのようにせり上がって表示される小さな通知メッセージです。

このトースト通知はデスクトップ上で他の作業をしている最中でも表示されるため、ユーザーに注意を促すことができ、アプリケーションやシステムからの重要なイベントや更新情報、新着メッセージ、アラームなどの通知によく使用されています。

このトースト通知についての公式情報は必要に応じて「トースト通知」から確認できます｡

この情報が読者の皆様のお役に立てることを願っています。

この関数は、2023年5月22日午前11:54 の
りゅうりゅう@VBAer×ココナラPRO認定(@blacklist_ryu)
さんの以下の投稿を元に、これを一般化、関数化して作成したものです。

VBAでMSGBOX代わりにトースト通知を出すメリットと注意点

MSGBOXで表示する程ではない、ちょっとしたお知らせをしたいときに便利。
MSGBOXと違って処理が中断されない。

ただし、Widowsの設定で通知をOFF設定にしていると表示されない。 https://t.co/SZgtCm8SGR

— りゅうりゅう@VBAer × ココナラPRO認定 (@blacklist_ryu) May 22, 2023

この記事の投降後、2023年5月25日午後02:01に
根元 亮治@ルートアシスト(@rootassist)
さんから @relu さんによる､以下のスニペット(プログラムコードの断片や部分です。通常、再利用可能なコード片として使用され、特定の機能や処理を実行するために他のコードに組み込まれます)記事を紹介頂きましたので併せてご紹介しておきます。
この記事中で直接反映できませんがトースト通知恐るべしです。

横からですが、PowerShellを使った通知ではいろいろな表示ができます。このページにサンプルがあります。ここまでやれるとは知りませんでした。https://t.co/4qfTU6RD92

— 根元 亮治@ルートアシスト (@rootassist) May 25, 2023

解決できること

この関数を標準モジュール等に追加すると、VBAツールの実行状況を１行のステートメントでタスクトレイに簡単にトースト通知できます。

読んでほしい方

VBAでツールの開発をしている方、ツール開発にスマートなユーザーインターフェースを取り入れたい方には必見の内容です。

MakeToastNotification関数 の紹介

説明

この「MakeToastNotification」関数は、Windowsのタスクトレイにトースト通知するための関数です。

但し Windows の設定で通知がOFF設定になっているとトースト通知が表示されないので

Windowsの「スタート」メニューから、歯車アイコンを選択し

設定 > システム > 通知とアクション

を順に選び、通知とアクション セクションの中で、通知の設定が オン になっていることを確認してください。

参照オブジェクト

このユーザー定義関数を利用するための参照オブジェクトはありません。

利用例

例えば VBAコードの中で以下のように

Sub Test_MakeToastNotification()
    
    Call MakeToastNotification("状況連絡", "処理1が終了しました。")
    
    Call MakeToastNotification("状況連絡", "処理2が終了しました。")
    
End Sub

記述すると、画面右下のWindowsのタスクトレイにそれぞれ

といったトースト通知が表示されます。

引数

戻り値

VBAコード

MakeToastNotification

このVBA関数は、Windowsのタスクトレイにトースト通知を送信するための関数で、最後にこの関数の戻り値として成功コード0を返します。

Function MakeToastNotification(ByVal msg_title As String, ByVal msg_text As String) As Integer
    
    ' 成功コードと失敗コードを定数として設定する
    Const C_SUCCESS As Integer = 0
    Const C_FAILURE As Integer = 1
    
    Dim cmd As String
    
    ' PowerShellコマンドの一部を定数として設定する
    Const C_CMD1 = "powershell -Command ""Add-Type -AssemblyName System.Windows.Forms;" & _
                   "$toast = New-Object System.Windows.Forms.NotifyIcon;" & _
                   "$toast.Icon = [System.Drawing.Icon]::ExtractAssociatedIcon('C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe'); " & _
                   "$toast.BalloonTipTitle = '"
    
    Const C_CMD2 = "'; " & _
                   "$toast.BalloonTipText = '"
    
    Const C_CMD3 = "'; " & _
                   "$toast.Visible = $True; " & _
                   "$toast.ShowBalloonTip(0)"""
    
    ' PowerShellコマンドを構築する
    cmd = C_CMD1 & msg_title & C_CMD2 & msg_text & C_CMD3
    
    ' PowerShellスクリプトを実行する
    Call VBA.Shell(cmd, vbHide)
    
    ' 成功コードを返す
    MakeToastNotification = C_SUCCESS
    
End Function

MakeToastNotificationの簡単な説明

Powershell 部分の詳細説明

ユーザーとしてこのMakeToastNotificationを使う際にはブラックボックスとして知る必要はないのですが、ご参考に23行目で組み上がったPowerShellに渡すコマンド文字列 cmd の中身にも触れておきましょう。

まとめ

この記事では、Microsoft Office 上の全てのVBA環境で利用可能な「MakeToastNotification」というユーザー定義関数を紹介しました。

この関数を標準モジュール等に追加すると、Windowsオペレーティングシステムで一般的に利用されているトースト通知を簡単に表示できます。

この情報が読者の皆様のお役に立てることを願っています。

ライブラリ一覧