自己完結 + 単一ファイル生成 を指定して発行した .NET 5 Windows Forms アプリに、ビジュアルスタイルが適用されない

配置先に .NET のインストールが不要の「自己完結」配置モード

Windows OS 上で Visual Studio を使っての、Windows Forms アプリの開発における話。

ついに .NET 5 が公式リリースとなったことを踏まえ、手持ちの .NET Framework ベースで作成されている Windows Forms アプリを .NET 5 に移植を開始した。

そして、.NET Core 3.1 以降、さらに改善された単一ファイルへの発行を試すことにした。

さらについでに、配置先での事前の .NET ランタイムのインストールが不要である、「自己完結」の配置モードでの発行とすることにした。

Visual Studio 上で発行プロファイルを設定している様子は下図のとおり。

見た目がなんだか古くさいぞ

これで発行を実行してみると、すんなり終了。

では発行された実行ファイル (.exe) を実行してみると...

あれ?

なんか、見た目がいつもと違わないですか? (下図)

20年くらい前にはこんな外観をよく見てた気もするが... Windows 9x とか...!?

あらためて、さっきまでデバッグ実行していた実行ファイルで実行してみると、こちらはちゃんと "今風" の外観となっている! (下図)

1枚目のスクショ、すなわち自己完結+単一ファイル生成で発行してから実行したときの外観は、普通にデバッグ実行したときの外観 (2枚目のスクショ) と違って、そう、Windows Forms アプリの Main 関数の冒頭で「Application.EnableVisualStyles()」を呼び出さなかった場合と同じ、ビジュアルスタイルが適用されなかったときの外観である。

しかしこれは一体どういうこと?

Windows Forms のソースコードを追ってみた

一体どうしてこんなことになるのか、Windows Forms のソースコードを追ってみた。

それでわかったのは、「Application.EnableVisualStyles()」が行なっているのは、System.Windows.Forms.dll に Win32 リソース形式で埋め込まれているアプリケーションマニフェストファイル (.manifest) のコンテンツを取得し、Win32 API 呼び出しを実施して、ビジュアルスタイルを適用している、ということだった。

ところが、自己完結と単一ファイル生成を組み合わせて出来上がった .NET 5 Windows Forms アプリケーションでは、System.Windows.Forms.dll も .exe ファイルに埋め込まれてしまっている関係で、目的のアプリケーションマニフェストファイルの Win32 リソースにたどり着けないらしい。

それでビジュアルスタイルの有効化に失敗する模様だ。

このような仕掛けなので、

• 単一ファイル生成であっても、配置モードが「フレームワーク依存」、つまり、System.Windows.Forms.dll が実行ファイル (.exe) に埋没していない場合
  ("C:\Porogram Files\..." のどこかに配置されているハズ)
  
  
• あるいはまた、配置モードが「自己完結」であっても、単一ファイル生成が OFF、つまり、System.Windows.Forms.dll が発行先フォルダに独立して存在する場合

 は、ちゃんとビジュアルスタイルが適用された。

暫定回避策

それではということで、ビジュアルスタイルを有効化するアプリケーションマニフェストファイルを自分で作成して、これを明示的に自分のアプリに埋め込むよう設定することにした。

まず、プロジェクトのフォルダに、「App.manifest」ファイル (※拡張子は .manifest がいいだろうけど、ファイル名は何でも良いはず) を作成し、中に以下の XML を記載する。

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">

  <description>Windows Forms Common Control manifest</description>

  <dependency>

    <dependentAssembly>

      <assemblyIdentity type="win32"

        name="Microsoft.Windows.Common-Controls" version="6.0.0.0"

        processorArchitecture="*"

        publicKeyToken="6595b64144ccf1df"

        language="*" />

    </dependentAssembly>

  </dependency>

</assembly>

次に、Visual Studio で開発中なら、プロジェクトのプロパティ画面から [アプリケーション] カテゴリの [アイコンとマニフェスト] の [マニフェスト] のドロップダウンを開き、そこに、今作成した「App.manifest」が選択肢にあがっているはずなので、これを選択する。

あるいはまた、Visual Studio のプロジェクトプロパティ画面を経由せずとも、.csproj を直接編集して、自作の「App.manifest」ファイルの使用を指定しても良い。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>

    <OutputType>WinExe</OutputType>

    <TargetFramework>net5.0-windows</TargetFramework>

    <UseWindowsForms>true</UseWindowsForms>

    <!-- 👇 この行を追加 -->

    <ApplicationManifest>App.manifest</ApplicationManifest>

  </PropertyGroup>

</Project>

以上でビルド・発行すると、無事、自己完結 + 単一ファイル生成を指定して生成された実行ファイルでも、ちゃんとビジュアルスタイルが適用されて実行されるようになった。

次の修正リリースで直るっぽい?

...というように、とりあえず暫定回避できて良かった、としたその翌日。

さてこれは Issue でも挙げなきゃだめだろうか、あるいはもうすでに Issue あがっているのでは、と思いながら、Windows Forms の GitHub リポジトリを漁ってみたところ、案の定、既にこの問題で Issue があがっていた。

当該 Issue を見ると、既に、.NET 5 のリリース候補第2版の時点で、この問題が認識されていた模様。

残念ながら 2020年 11 月の、.NET 5 初回公式リリースには修正を盛り込むのが間に合わなかったのだろうか。

もしこの先、.NET 5 の修正リリースが出ることがあれば、そのときにはきっと直っていることを期待して良さそうだ。