🪅

動的に XAML コントロールを生成する(WinUI 3)

に公開
2026/01/05

はじめに

WinUI 3 において文字列から動的に XAML コントロールを生成(作成)する方法のまとめです。

  • アドオンから UI 要素を受け取る
  • 外部(ファイルなど)から UI 要素を受け取る

などの際に使えるかと思います。

サンプルプログラムは GitHub に上げてあります。主要コードは MainPageViewModel.cs にあります。

動的生成の基本

文字列から XAML コントロールを生成するのは簡単です。以下のコードで楕円コントロールを生成できます。

String xaml = """
	<Ellipse Width="300" Height="30" Fill="Red" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"/>
	""";
FrameworkElement element = (FrameworkElement)XamlReader.Load(xaml);
_stackPanel.Children.Add(element);

基本的には普段書いている XAML を XamlReader に渡すだけですが、公式説明にある通り、xmlns を指定する必要があることに注意してください。忘れると実行時に例外になります。

生成後、既にウィンドウ内に存在している StackPanel などの子コントロールとして追加します。

複数コントロールの生成

XamlReader は 1 つのコントロールしか生成できません。複数コントロールを生成したい場合は、StackPanel や UserControl などのコンテナコントロールにくるみます。

String xaml = """
	<StackPanel Orientation="Horizontal" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
		<Rectangle Width="150" Height="30" Fill="Blue"/>
		<Ellipse Width="150" Height="30" Fill="Purple"/>
	</StackPanel>
	""";
FrameworkElement element = (FrameworkElement)XamlReader.Load(xaml);
_stackPanel.Children.Add(element);

要素の検索

FindName() による要素検索は、動的生成した要素内に限り使えます。

動的生成した要素を既存の親要素に追加したとして、親要素で FindName() しても検索できません。以下の例で、_stackPanel は元からウィンドウ内にあるスタックパネルですが、_stackPanel で FindName() しても動的生成した要素は検索できません。

FrameworkElement element = (FrameworkElement)XamlReader.Load(xaml);
_stackPanel.Children.Add(element);

// 生成した要素内では FindName() で検索可能
Object? result1 = element.FindName("DynamicEllipse");

// 親要素からは FindName() で検索できない(null が返る)
Object? result2 = _stackPanel.FindName("DynamicEllipse");

MVVM バインド

プロパティーの MVVM バインドは動的バインド {Binding} が使えます。

String xaml = """
	<StackPanel Orientation="Horizontal" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
		<TextBlock Text="バインド出力用:"/>
		<TextBlock Text="{Binding TextVal}"/>
	</StackPanel>
	""";
FrameworkElement element = (FrameworkElement)XamlReader.Load(xaml);
_stackPanel.Children.Add(element);
element.DataContext = this;

DataContext を忘れずに指定してください。

静的バインド {x:Bind} は使えません。

イベントハンドラー

2 つやり方があります。

コード指定方式

動的生成後にコードでイベントハンドラーを += します。

String xaml = """
	<Button Content="動的生成ボタン" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"/>
	""";
Button element = (Button)XamlReader.Load(xaml);
_stackPanel.Children.Add(element);
element.Click += async (s, e) => await ButtonDynamicClicked();

公式説明で例示されている方法なので安心です。

Binding 方式

プロパティーの {Binding} と同様にしてコマンドも {Binding} できます。

String xaml = """
	<Button Content="動的生成ボタン" Command="{Binding ButtonDynamicClickedCommand}" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"/>
	""";
Button element = (Button)XamlReader.Load(xaml);
_stackPanel.Children.Add(element);
element.DataContext = this;

ただし公式説明で言及されていないので、もしかしたら何か不都合があるのかもしれません。

リソースから生成

プロジェクト内部のリソースからコントロールを動的生成することも可能です。

XAML 側

例えば UserControl であれば、まずは通常通りプロジェクトに XAML を追加します。そのうえで、

  • x:Class を削除。
  • MyUserControl.xaml に付属している MyUserControl.xaml.cs を削除。
  • ファイルのプロパティーで「ビルドアクション」を「埋め込みリソース」に変更。

を行います。

先述の通り {x:Bind} は使えないので注意してください。

C# 側

リソースを読み込んで XAML 文字列を取得します。その後はこれまでと同様です。

using Stream stream = Assembly.GetExecutingAssembly().GetManifestResourceStream("namespace(プロジェクト名.フォルダー名).MyUserControl.xaml")
	?? throw new Exception("コントロールリソースが見つかりません。");
Byte[] data = new Byte[stream.Length];
stream.ReadExactly(data);
String xaml = Encoding.UTF8.GetString(data);
FrameworkElement element = (FrameworkElement)XamlReader.Load(xaml);
_stackPanel.Children.Add(element);

まとめ

文字列から XAML コントロールを生成すること自体は簡単ですが、いくつか制限事項があります。

  • x:Class の指定ができない。
  • FindName() の範囲が限られる。
  • {x:Bind} が使えない。

Native AOT に適用するのは非現実的かなと思います。

代替手段

動的 XAML には先述の制限事項もあり、また、通常より複雑性も増してしまうため、やりたいことが他の手段で実現できる場合は他の手段を採用するほうが良いかと思います。

要素数が変動する(配列やリストなど)という程度であれば、ItemsView などのコレクションコントロールを使用し、表示方法をテンプレートでカスタマイズするほうが簡単です。テンプレートの書き方についてはこちらの記事もどうぞ。

時と場合によって RadioButtons と ComboBox を切り替えたいというように、予め使用する可能性のあるコントロールが分かっている場合は、Visibility の切り替え(使用しないコントロールの非表示化)で対応するほうが簡単かもしれません。

単に動的生成したいだけであれば、コードで new するほうが簡単かもしれません。x:Class があっても問題ないなど、動的 XAML より制限も少ないです。

サンプルプログラム

サンプルプログラム(GitHub に上げてあります)を実行すると、動的 XAML コントロール生成の動作を確認できます。

確認環境

項目 環境
OS Windows 11 Pro 25H2
Visual Studio 2026 18.1.1
.NET 10.0
Template Studio for WinUI 5.5
WinUIEx 2.9.0
Windows App SDK 1.8.251106002 (1.8.3)

参考リンク

主な改訂履歴

  • 2026/01/03 初版。
  • 2026/01/05 「代替手段」に new を記載。

Discussion