C#のWPFでよく使うXAMLの定義を別ファイルにする

WPFではコントロールをカスタマイズしたり、見た目を変えたりを容易に行う事ができるが、それらをシステム全体を通して統一して使いたい場合、定義自体は1か所で管理し、それを参照する形にするのが望ましい。

 

ResourceDictionaryを使う事で、複数回使うオブジェクトを分けて管理する事が出来る。

 

 以下の例では、DataGridコントロールのStyleを別ファイルに定義しておき、それを参照している。

リソースディクショナリ (SampleDictionary.xaml)

VisualStudioの場合「新しい項目の追加」から「リソースディクショナリ(WPF)」を選択して、

Style定義を記述する為のXAMLファイルを作成する。

<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                    xmlns:local="clr-namespace:WpfApplication1">
    <Style x:Key="SampleDataGridStyle" TargetType="DataGrid">
        <Setter Property="RowHeaderWidth" Value="20"/>
        <Setter Property="HorizontalGridLinesBrush" Value="LightYellow"/>
        <Setter Property="VerticalGridLinesBrush"   Value="#FFE4E4BD"/>
        <Setter Property="AlternatingRowBackground" Value="LightYellow"/>
        <Setter Property="BorderBrush" Value="#FFD7E4F2"/>
        <Setter Property="CellStyle">
            <Setter.Value>
                <Style TargetType="DataGridCell">
                    <Style.Triggers>
                        <Trigger Property="IsSelected" Value="True">
                            <Setter Property="Background" Value="#FF3399FF" />
                            <Setter Property="Foreground" Value="White" />
                        </Trigger>
                    </Style.Triggers>
                </Style>
            </Setter.Value>
        </Setter>
    </Style>
</ResourceDictionary>

ResourceDictionary要素 (1行目)

一番親の要素を<ResourceDictionary>にして、その中にオブジェクトを定義する。

 

 

オブジェクトに名前を付ける (4行目) 

x:Key属性を使ってオブジェクトに名前を付ける。

この名前を使ってオブジェクトの定義を参照する。

 

 

 

 

 

 

参照する側

<Window x:Class="WpfApplication1.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WpfApplication1"
        mc:Ignorable="d"
        Title="MainWindow" Height="180" Width="250">
    <Window.Resources>
        <ResourceDictionary>
            <ResourceDictionary.MergedDictionaries>
                <ResourceDictionary Source="/SampleDictionary.xaml"/>
            </ResourceDictionary.MergedDictionaries>
        </ResourceDictionary>
    </Window.Resources>
    <DataGrid Margin="20" Style="{StaticResource SampleDataGridStyle}">
    </DataGrid>
</Window>

リソースディクショナリをマージする (9~15行目)

<Windows.Resource>内に<ResourceDictionary>要素を追加。

<ResourceDictionary.MergedDictionaries>へ参照するファイル名を指定する。

 

 

 

Styleへリソースをセットする (16行目)

{StaticResource}マークアップ拡張を使い、x:Keyに指定した名前で参照するStyle定義を指定する。