More than 1 year has passed since last update.

[C#/WPF] コンバーターの書き方

Last updated at 2022-02-06Posted at 2020-12-23

やりたいこと

WPFで画面を作るときにコンバーターをよく使うが、都度既存のコードからコピペしていて身についた感がなかったので、テンプレートとして持っておくために下記にメモしておく。

コンバーターの作り方

今回は、MSの公式サンプルをもとに、

DateTime型の値を、画面表示の際に日付の文字列に変換する
日付の文字列を、プロパティget時にDateTime型の値に変換する

というコンバーターを作ってみる。

コンバーターのクラスを作る

クラス名はDateTimeConverterのように、〇〇Conveterというようにするのが慣例っぽい。
その名前で、IValueConverterインターフェースを実装した下記のようなクラスを作る。

Convertメソッドが「プロパティ→画面表示に反映時」の変換を記述するところ。
ConvertBackメソッドが「画面表示→プロパティに反映時」の変換記述するところ。

DateTimeConverter.cs

public class DateTimeConverter : IValueConverter
{
    // DateTimeを「yyyy/MM/dd HH:mm:ss.fff」形式の文字列に変換
    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
    {
        DateTime date = (DateTime)value;
        return date.ToString("yyyy/MM/dd HH:mm:ss.fff");
    }
    // 文字列をDateTimeに変換
    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
    {
        string strValue = value as string;
        DateTime resultDateTime;
        if (DateTime.TryParse(strValue, out resultDateTime))
        {
            return resultDateTime;
        }
        return DependencyProperty.UnsetValue;
    }
}

※個人的経験では、ほとんどの場合「プロパティ→画面表示に反映時」に変換することしかしないので、Converterメソッドだけ使ってConvertBackメソッドはほとんど使ったことがない。

そういう場合は、ConvertBackの中身は下記のようにしておけばいい。

public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
{
    throw new NotImplementedException();
}

画面にリソースとして登録し、それを変換したいところで使う

一番の親(今回はWindow)のリソースとして、下記のようにして登録する。

MainWIndowの一部.xaml

<Window.Resources>
    <converter:DateTimeConverter x:Key="DateTimeConverter"/>
</Window.Resources>

そいつのKeyを使って、変換を行いたいコントロールにバインドしたプロパティのコンバーターとして使用する。
(今回は、ConverterParameterは別に不要だが、パラメータ渡せるということを示すために渡すだけ渡す)

MainWIndowの一部.xaml

<TextBox Grid.Row="1" Grid.Column="2" Text="{Binding Dt, ElementName=root, Converter={StaticResource DateTimeConverter}, ConverterParameter=123}"/>

ViewModel等に、バインドするプロパティを作成して、get/setしてみる

下記のように、画面にバインドしたプロパティに

set(今回はDtに現在の日付をセットした)
get(今回はDtの値をゲットしてyyyyねんMMがつddにち形式で表示した)

MainWindow.xaml.cs

public DateTime Dt
{
    get { return _dt; }
    set { _dt = value; OnPropertyChanged(nameof(Dt)); }
}
// テキストボックス ← プロパティ
private void Button_Click(object sender, RoutedEventArgs e)
{
    // set
    Dt = DateTime.Now;
}
// テキストボックス → プロパティ
private void Button_Click_1(object sender, RoutedEventArgs e)
{
    // get
    AddLog(Dt.ToString("入力した日付は、yyyyねんMMがつddにち です"));
}

そうすると、コンバータを通って、下記のように画面に表示される。

以上で、一通りコンバーターが使えるようになった。

コード全部