More than 1 year has passed since last update.

C# その2Advent Calendar 2020

[C#/WPF] WPF＋.NetFrameworkでアクションセンター内のトーストを押したときにアプリを起動する

Last updated at 2023-05-25Posted at 2020-12-08

やりたいこと

**デスクトップアプリ(WPF)**にトースト(toast)でユーザーに通知を行う機能を実装したい。
ざっくり動きとしては、こういうのが「ピローン」と画面右下に出てきて、

そいつを押すと、アプリが起動する。
押さずにほおっておくとWindowsの「アクションセンター」に入る。

アクションセンター内にあるトーストを押すと、押したトーストは消えて、アプリが起動する。
というようなイメージ。

トーストを実装すること自体初めてなのでよくしらなかったのだが、

トーストはもともとUWPの機能である。
デスクトップアプリ(WPFやWinForm)でトーストをするにはちょっと特殊なことをしないといけない。

っぽい。

で、その特殊なことをMicrosoftの公式ドキュメントやネットで調べながら実装したところ、トーストの仕組みを知らないせいでものすごく苦労してしまったので、その時に調べたことやノウハウをメモして残そうと思った次第。

成果物

まず下記に、作ったコード一式を置いている。

トースト実験プログラム本体
https://github.com/tera1707/WPF-/tree/master/040_ToastJikken

AUMID,CLSIDの入ったshortcutを作成するツール
https://github.com/tera1707/WPF-/tree/master/040_MakeShortcut

トーストのためのCLSIDをレジストリに登録するツール
https://github.com/tera1707/WPF-/tree/master/040_RegisterCLSIDtoRegistry

使った環境は下記の通り。

項目	値
Windows	Windows 10 Pro 1909
.NETのバージョン	.NET Framework 4.7.2 / WPF
プラットフォーム	x64

やり方概要

下記のページに、デスクトップアプリでトーストを実装するためのMicrosoft公式のやり方が書いてあるので、基本的にはこちらをもとに進める。
https://docs.microsoft.com/ja-jp/windows/uwp/design/shell/tiles-and-notifications/send-local-toast-desktop?tabs=msix-sparse

やること大項目	MSdocsの該当項目
①コードを書く	Step 1: Install the Notifications library Step 2: Implement the activator Step 3.2: Register AUMID and COM server Step 4: Register COM activator Step 5: Send a notification
②AUMID,CLSIDの入ったshortcutを作成	Step 3.1: WiX Installer
③トーストのためのCLSIDをレジストリに登録	Step 3.1: WiX Installer

基本はMS公式ドキュメントをベースに進めるのだが、
この表で「①コードを書く」に該当する公式のStep 3.1: WiX Installerが、何をするための手順なのかが全然わからなかった。（というより、こちらの都合で、Wixインストーラーではなく別のインストーラー作成ソフトを使わないといけなかったので、そのソフトを使った場合ではこの項目に対して何をしたらよいのか？が全然読み取れなかった。）

そのわからなかった部分については、後ほど

の項目で対応策に触れる。

実際にトーストを作る

ここから、実際にトーストの機能を作っていく。
基本はMS公式の通りに進めるが、一部進める順番が違うので注意。

①コードを書く

`Microsoft.Toolkit.Uwp.Notifications`パッケージをインストール

→公式：Step 1: Install the Notifications library

UWPのSDKをええように参照して、デスクトップアプリからもトーストを使えるようにしてくれるMicrosoft.Toolkit.Uwp.Notifications のNuGetパッケージをインストールする。

CLSIDを持つNotificationActivatorを継承したクラスを作成

→公式：Step 2: Implement the activator

MyNotificationActivator.csというファイルを追加して、そこにNotificationActivatorクラスを継承したクラスを作成し、そいつにCLSIDを振る。（中身は後でつくる）

下記のGuid("・・・・・")の部分がCLSID。

MyNotificationActivator.cs

[ClassInterface(ClassInterfaceType.None)]
[ComSourceInterfaces(typeof(INotificationActivationCallback))]
[Guid("EF608355-E10B-487C-BA55-AE7E400E4EC7"), ComVisible(true)]
class MyNotificationActivator : NotificationActivator
{
    // 中身は後でつくる
}

CLSIDは、いわゆる「GUID」なので、VisualStudioのGUIDの作成ツールを使ってGUIDを取得し、そいつを振ればOK。

下記で「コピー」を押すとクリップボードにコピーされるので、[Guid("replaced-with-your-guid-C173E6ADF0C3"), ComVisible(true)]のところに張り付ける。
(そのまま張り付けるとカッコとかついてるので、必要なGUIDの数字以外の余計なものは消す)

DesktopNotificationManagerCompat.RegisterAumidAndComServer でAUMIDを登録

→公式：Step 3.2: Register AUMID and COM server

アプリ起動後一回、下記を実行してAUMIDを登録する。
今回は、メインのウインドウのコンストラクタで実施。

MainWindow.xaml.cs

DesktopNotificationManagerCompat.RegisterAumidAndComServer<MyNotificationActivator>("MyCompany.ToastJikken");

DesktopNotificationManagerCompat.RegisterActivator でCOMサーバーを登録する

→Step 4: Register COM activator

アプリ起動後一回、下記を実行してCOMサーバーを登録する。
RegisterAumidAndComServerと同様に、メインのウインドウのコンストラクタで実施。

MainWindow.xaml.cs

DesktopNotificationManagerCompat.RegisterActivator<MyNotificationActivator>();

トーストを表示

トーストを表示させる部分をつくる。
(下記のコード。MSのサンプルそのまま)

→Step 5: Send a notification

MainWIndow.xaml.cs

// トーストを組み立てる
ToastContent toastContent = new ToastContentBuilder()
    .AddToastActivationInfo("action=viewConversation&conversationId=5", ToastActivationType.Foreground)
    .AddText("Hello world!")
    .GetToastContent();

// 組み立てたやつをもとにToastNotificationを作成
var toast = new ToastNotification(toastContent.GetXml());

// トーストを表示
DesktopNotificationManagerCompat.CreateToastNotifier().Show(toast);

~~ここまでで、とりあえずトーストは出てくる。が、出てきたトーストを押してもなにも起きない。~~
DesktopNotificationManagerCompat.CreateToastNotifier().Show(toast);を実行しても、まだトーストはでない。(後に行うショートカット作成とCLSID登録が必要。)

次は、トーストが押されたときに実行される部分を作る。

押されたときの処理(OnActivated())を実装する

→Step 6: Handling activation

下記のようなコードを書いて、トーストを押されたら、メイン画面上のリストboxに押された旨を表示させてみる。
※MainWindow.mw.AddLog("ABC")が、その旨表示させるコードビハインドが持っているメソッド。

MyNotificationActivator.cs

[ClassInterface(ClassInterfaceType.None)]
[ComSourceInterfaces(typeof(INotificationActivationCallback))]
[Guid("EF608355-E10B-487C-BA55-AE7E400E4EC7"), ComVisible(true)]
class MyNotificationActivator : NotificationActivator
{
    public override void OnActivated(string invokedArgs, NotificationUserInput userInput, string appUserModelId)
    {
        Application.Current.Dispatcher.Invoke(delegate
        {
            OpenWindowIfNeeded();

            // ログ表示
            MainWindow.mw.AddLog("OnActivated()実行しました");
            MainWindow.mw.AddLog(invokedArgs);
        });
    }

    private void OpenWindowIfNeeded()
    {
        MainWindow.mw.AddLog("OpenWindowIfNeeded()");

        // ウインドウを開く (アプリが閉じている間にトーストが押されたとき(≒アクションセンターで押された時)等)
        if (App.Current.Windows.Count == 0)
        {
            MainWindow.mw.AddLog("メインウインドウ表示");
            new MainWindow().Show();
        }

        // ウインドウをActivateして、フォーカスをあてる
        MainWindow.mw.AddLog("メインウインドウにフォーカス当てました");
        App.Current.Windows[0].Activate();

        // 最小化してたら通常の大きさに戻す
        App.Current.Windows[0].WindowState = WindowState.Normal;
    }
}

これで、トーストが押されたときに、上の処理をしてくれるようになる。

【注意】
OnActivated()は、UIスレッドとは異なるスレッドで実行されている。
そのため上記サンプルでも画面を操作するようなコードはApplication.Current.Dispatcher.Invoke(()を使ってUIスレッドで実行するようにしている。

★次の「②AUMID,CLSIDの入ったshortcutを作成」と「③トーストのためのCLSIDをレジストリに登録」について

→公式：Step 3.1: WiX Installer

この部分が、公式では「WiX」というMSおすすめ？のインストーラー作成ツールを使った手順説明になっているのだが、ここが、WiXを使った結果、何がoutputされるのか？何をしようとしている手順なのか？がわからなかった。

というより、私の場合、作るアプリをインストールするときに使うインストーラーが、WiXではなくほかのインストーラー作成ソフトを使うことに決まっていたため、WiXを使えない、どうしたらいい？となってしまった。(調べ始めた時点で「WiX」というツールの存在を知らなかったので輪をかけて？？？になった)

調べるうえで、先人が作成してくれているデスクトップアプリでのトーストを扱うOSSを利用する中で、やっていることを理解していこうという調査方法を取ったのだが、その時、調べを進めるうえでものすごく下記のページ/OSSにお世話になった。

〇デスクトップアプリからインタラクティブなトースト通知
https://8thway.blogspot.com/2016/05/desktop-interactive-toast.html

〇emoacht/DesktopToast
https://github.com/emoacht/DesktopToast

こちらのOSSを利用すると、簡単にデスクトップアプリでトーストを実装することができる。
そのコードを拝見する中で、そのよくわからないstep3で実際にやらないといけないのが、

NotificationActivatorを継承したクラスのCLSIDをレジストリに登録すること
アプリのAUMIDとNotificationActivatorを継承したクラスのCLSIDを持ったショートカットをスタートメニューに置くこと

だということが分かった。
(大変勉強になりました、ありがとうございます。)

で、上記を行う場合、使っていたインストーラー作成ソフトでそういうことができるので、インストーラーにやってもらうことになった。（インストーラでインストールをする時に、ショートカットとCOMのCLSIDを登録してくれるようにした。）

ただ、仕事ではそういう風に対応したが、自分で勉強＆趣味で作ってみるうえではそのようなインストーラー作成ソフト(有料)は使えないので、自前でその2つができるようなツールを作って対応した。(そのツールについても下に置き場所を書いておく)

②AUMID,CLSIDの入ったshortcutを作成

→公式：Step 3.1: WiX Installer

以下の情報を持つショートカットを作成し、ユーザーのスタートメニューに配置する。
スタートメニューのパスは、Win+Rで出てくる「ファイル名を指定して実行」に「shell:start menu」と入力して出てくるC:\Users\ユーザー名\AppData\Roaming\Microsoft\Windows\Start Menuにする。

※「shell:common start menu」と入力して出てくるC:\ProgramData\Microsoft\Windows\Start Menu\Programsでも試した限りトーストはうまく動く。
複数ユーザーに共通のショートカットを作りたい時などはこちらにすればよいっぽい。

それぞれ、今回は実験用として、下記のような値にした。

※配置場所：C:\Users\ユーザー名\AppData\Roaming\Microsoft\Windows\Start Menu

使うもの	値	備考
AUMID	MyCompany.ToastJikken	通常`会社名.アプリ名`の形式にする(参照)
CLSID	EF608355-E10B-487C-BA55-AE7E400E4EC7	NotificationActivatorを継承したクラスに振ったGUID

※上記CLSIDは今回実験するときに作ったサンプル値なので、上にあげた手順で各自自分のGUIDを作って入れること。

ショートカット作成用のツールはこちら
https://github.com/tera1707/WPF-/tree/master/040_MakeShortcut

AUMIDの形式は公式ページに記載がある。
※ただ試した限りでは、別にこの形式でなくてもトーストは動くっぽい。

③トーストのためのCLSIDをレジストリに登録

→公式：Step 3.1: WiX Installer

NotificationActivatorを継承したクラスに振ったCLSIDをレジストリに登録する。
アクションセンターに入ったトーストから、アプリを起動させるのに必要な手順。

登録先は、

`コンピューター\HKEY_CURRENT_USER\Software\Classes\CLSID\{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}\LocalServer32`

※xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxは、今回使うCLSID。

regeditで手打ちで登録してもOK。
ただ面倒なので、レジストリ登録のためにツールを作った。
https://github.com/tera1707/WPF-/tree/master/040_RegisterCLSIDtoRegistry

実際に登録してregeditでみると、下記のような感じ。

動かしてみる

ここまで行えば、以下ができるようになる。

アプリからトーストを表示する。
右下に出ている間にトーストを押したときに、OnActiateに書いた処理を実行する。
(アプリ実行中に)アクションセンターに入ったトーストを押したときに、アプリを起動してOnActiateに書いた処理を実行する。
(アプリ終了状態で)アクションセンターに入ったトーストを押したときに、アプリを起動してOnActiateに書いた処理を実行する。

これで、基本のトーストのライフサイクル一周分はできたかと思う。

トーストをカスタムする

基本はここまででできたが、ただテキストを表示して、押したらアプリ起動する、というだけでは味気ないので、画像を出したりユーザーにテキストを入力させたりもできる様子。

その辺は、下記をみればできそう。(今回はやらない)
https://docs.microsoft.com/ja-jp/windows/uwp/design/shell/tiles-and-notifications/adaptive-interactive-toasts?tabs=builder-syntax

ポイント/ハマったところ

はじめ、トーストがどういう仕組みで動いているのかを全然わかっていなかったので、MSの公式手順のそれぞれ(特にstep3)が、何をしたいがための作業なのかがよくわかってなかった。

で、ハマったポイントというか、あ、たぶんそういうことなんだな、となったポイントは下記だった。

AUMIDとCLSIDを含んだショートカットがスタートメニューの中に置かれてないと、アクションセンターの中のトーストからアプリ起動できない

右下にトーストが「ピローン」といって表示されている間はアプリ本体(もしくはトーストを表示するためのexe)が起動している状態

そのトーストは、一定時間経過するとアクションセンターに入る。
アクションセンターに入った後のトーストを押したときは、アプリ本体が終了している状態であってもアプリを起動しないといけない。

トーストを押したときにどのアプリを起動しに行くか、の紐づけをしているのが、上で作成したショートカットとレジストリに登録したCLSIDだった。(たぶん)

下の図は、公式にこういう流れで処理している、というドキュメントを見つけて書いたわけではなく、動かしてみてそういう動きをしてるんじゃないか、という私の理解を書いたもの。(なので、参考程度に...)

多分、UWPで作ったアプリのトースト機能では、こういうことを自前でショートカットとか作らずに、UWPの元々の仕組みでできるのだと思う。
(それを、元々の仕組みを使わずに、無理やり実現させようというのがデスクトップアプリのトースト、という理解。)

デバッグ中は動くのに、本番環境に入れたとたんにわけのわからない動きをする

NotificationActivatorを継承したクラスのCLSIDをレジストリに登録したのだが、実装中にCLSID(GUID)をいろいろ変えて動きを見てみたりしていたせいで、変な動きに悩まされた。

具体的には、

ここのLocalServer32の中の、トーストを押したときに起動したいexeのパスを変えてしまったり、VisualStudioのプロジェクトを別の場所に置いてしまったりすると、トーストを押したときに何も起動してくれなかったり、今は使ってない昔使っていたVSのプロジェクトの中のexeが起動してしまったりする。

私の場合は、デバッグ時はこの絵にあるようなVSのプロジェクトのフォルダ内のexeで動かしているが、本来のexeの場所はC:\Program Files\・・・の中だったので、本番環境にもっていくと、「デバッグしてるときはうまく動くのに、本番環境に入れるとトーストを押してもアプリ起動してくれない」といったことに陥ってしまった。

今振り返ると、別のパスを見に行ってしまっているのだからそうなるのは当たり前に思えるが、実験し始めた当初はトーストの仕組みもよくわかってない状態だったのでそれはそれはハマった。

トーストからアプリ起動時、作業ディレクトリが変わる

トーストを押したタイミングによって、作業ディレクトリが変わる。

試したところ、アプリが起動していないときにトーストを押してアプリが起動した場合は、C:\windows\system32になる様子。

アプリ内で、相対パスでなにかを行っているような場合は要注意。

やってみて感じたこと

一応Microsoftの公式のやり方があるのだから「デスクトップアプリでもトーストは実装できる」と考えてよいものだと思うが、やっぱりUWPの機能はUWPで使った方がよいかもしれない、と今回感じた。
(appxなどにパッケージする形で出すのも良いかもしれない)

上で何度も書いていた「MSの資料のstep3がわからない」のように「デスクトップアプリで使えるようにするための部分」はあまり公式ドキュメントで優しく解説してくれないっぽいので、そのあたりでなにか問題があって説明を求められたときに、調査が難航しそうな気がする。

とはいえ、トーストの機能は今は一般的になってるので、仕様を決める側は「当然そういうことができる」ものだと思っている様子。

私の周りでは「トーストはデスクトップアプリではナシ」という選択肢は無さそうなので、開発しながら実験して触りまくって、開発終了までに枯らすしかないな、と思う。

.NET5ではもっと簡単にできるようになった！(21/04/18時点)

本記事は、2020/12月の時点で、.NET Framework4.7.2を使ってトーストを試したものです。

21/04/18時点で、.NET5を使ったWPFでは、さらにやり方が簡単になっているようです。
※MS公式ページの、この記事で書いている「step3 Wix Installerを使う部分」も無くなって、わかりやすくてWixInstallerを使わなくても済む内容になっていました。(つまり、自前でショートカットにAUMIDとか埋め込んで配置、とかしなくてよくなった！素晴らしい...)

.NET5を使う方は、上記記事を参照された方がよいと思います。
ざっくり手順はMS公式に従って、下記のようなもの。

手順
- nugetでMicrosoft.Toolkit.Uwp.Notificationsをインストールする。
- csprojで、対象OSを10.0.17763.0以降にするために、<TargetFramework>net5.0-windows10.0.17763.0</TargetFramework>を書く。
- コードにトースト出す処理を書く。(MSのサンプル通りに書くと、下記の感じ)

new ToastContentBuilder()
    .AddArgument("action", "viewConversation")
    .AddArgument("conversationId", 9813)
    .AddText("Andrew sent you a picture")
    .AddText("Check this out, The Enchantments in Washington!")
    .Show();

※.NETFramework では？
現時点で、.NETFrameworkで同じことできるか試してみましたが、今のところはできないっぽかった(.NET Frameworkで上の記事に挙げて頂いているTargetFrameworkにWin10.0.17763.0を指定する方法がわからなかった)ので、この記事の手順も一応残しておきます。

さらに追記...
下の方に書いたレジストリにCOMのCLSIDを登録したり、AUMIDをショートカットに組み込んだりするやり方はこちらに(新たに)書かれたっぽい。

このやり方で動くのか試してないが、この記事に書いたショートカットを置いたりする手順は、実際はここに書かれていることをするための手順だったのだ、と推測。
もうないとは思うが、今度また.netFrameworkでトーストをやることになったら、ここを見てみればよいかもしれない...