2016/12/01

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

    WPFではコントロールをカスタマイズしたり、見た目を変えたりを容易に行う事ができます。

    それらをシステム全体を通して統一して使いたい場合、定義自体は１か所で管理し、それを参照する形にするのが望ましいと考えるでしょう。

     

    XAMLでもそれは可能です。

    ResourceDictionaryを使う事で、何度も使う定義をひとまとめにして管理する事が出来ます。

     

    以下の例では、DataGridコントロールのStyle部分を別ファイルに定義しています。

    リソースディクショナリ (ResourceDictionary)

    VisualStudioの場合は「新しい項目の追加」から「リソースディクショナリ（WPF）」を選択するとリソースディクショナリ用のXAMLファイルを作成する事ができます。

     

    この例では「SampleDictionary.xaml」というファイル名で作成しました。

    このファイルにDataGrid用のStyle定義を記述していきます。 

    <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定義を指定します。

    カテゴリ： C#, C#WPF