デザイン実行かどうかを判定する

(2017/04/26 8:04:29 created.)

(2017/05/24 16:58:05 modified.)

デザイン実行とは、XAML デザイナーがバックグラウンドでコードを解析・実行することです。このおかげで XAML デザイナー上の表示がリアルタイムに変化しています。

ユーザーコントロールやカスタムコントロールを配置するとき、そのコンテンツに動的なデータがある場合、デザイン実行ではまだアプリケーションは動いていないため、デザイン実行中に予期せぬエラーや例外が発生してしまい、XAML デザイナー上で画面の確認ができなくなってしまいます。このようなことが起きないようにするために、デザイン実行かどうかをコードで判断することができます。

Signals.xaml

<UserControl x:Class="Tips_XamlDesigner.Views.Signals"

             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"

             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"

             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"

             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"

```
             mc:Ignorable="d" 
```

             d:DesignHeight="300" d:DesignWidth="300">

    <StackPanel Orientation="Horizontal">

        <Ellipse Width="20" Height="20" Margin="5" Fill="Green" />

        <Ellipse Width="20" Height="20" Margin="5" Fill="Yellow" />

        <Ellipse Width="20" Height="20" Margin="5" Fill="Red" />

        <TextBlock x:Name="textblock1" Text="Signals" VerticalAlignment="Center" />

```
    </StackPanel>
```
```
</UserControl>
```

Signals.xaml.cs

```
namespace Tips_XamlDesigner.Views
```
```
{
```
```
    using System.Windows.Controls;
```
```
 
```
```
    /// <summary>
```

    /// Signals.xaml の相互作用ロジック

```
    /// </summary>
```

    public partial class Signals : UserControl

```
    {
```
```
        public Signals()
```
```
        {
```
```
            InitializeComponent();
```
```
 
```

            if (System.ComponentModel.DesignerProperties.GetIsInDesignMode(this))

```
            {
```

                this.textblock1.Text = "デザインモード";

```
            }
```
```
        }
```
```
    }
```
```
}
```

XAML 上で "Signals" というテキストを持つ TextBlock コントロールに対し、コードビハインドでは、ある条件によって "デザインモード" というテキストに変更するコードが組み込まれています。

System.ComponentModel.DesignerProperties クラスは、デザイナーとの通信に使用される添付プロパティを提供しています。そして、IsDesignMode という添付プロパティで、対象とするオブジェクトのインスタンスがデザイナーのコンテキストで実行されているかどうかを確認することができます。

IsDesignMode は添付プロパティなので、プロパティ名の頭に "Get" を付けた GetIsDesignMode() メソッドでプロパティ値を取得することができます。したがって、14 行目のように、引数にユーザーコントロール自身を示す this を指定して IsDesignMode 添付プロパティの値を取得することで、デザインモードかどうかを判定することができます。

このユーザーコントロールをウィンドウに配置してみましょう。XAML コードは次のようになります。

MainView.xaml

<Window x:Class="Tips_XamlDesigner.Views.MainView"

        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"

        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"

        xmlns:vw="clr-namespace:Tips_XamlDesigner.Views"

        Title="MainView" Height="300" Width="300">

```
    <StackPanel>
```
```
        <vw:Signals />
```
```
        <vw:Signals />
```
```
    </StackPanel>
```
```
</Window>
```

実行するとユーザーコントロールの XAML で定義したように、"Signals" というテキストが表示されていますが、

XAML デザイナー上ではコードビハインドで変更された文字列になっていることがわかります。

このサンプルでは静的なデータを書き換えるのみでしたが、実行しないと取得できない動的なデータなどに対して、デザインモードの場合には仮の値を入れておくようにしておくなどしておけば、XAML デザイナーがエラーを出力することなく画面が確認できるようになります。

また、Window や UserControl など View に関するインスタンスが取得できない場合、GetIsDesignMode() メソッドの引数に DependencyObject を渡すことができません。この場合は次のような方法でデザイン実行かどうかを判定します。

Sample.cs

if ((bool)(System.ComponentModel.DesignerProperties.IsInDesignModeProperty.GetMetadata(typeof(System.Windows.DependencyObject)).DefaultValue))

```
{
```

    // デザイン実行時は処理しない

```
    return;
```
```
} 
```