WPF ComboBox の ItemsSource バインドパターンと選択値の取得方法

概要

WPF の ComboBox は ItemsSource に渡すデータ構造に応じて、表示内容の制御方法と選択値の取得方法が変わる。具体的には DisplayMemberPath、ItemTemplate、SelectedItem、SelectedValue、SelectedValuePath の組み合わせが、バインドするコレクションの型によって異なる。本記事では代表的な実装パターンを整理し、それぞれの選択に関するプロパティの使い分けを示す。

前提・対象環境

• フレームワーク／言語: .NET 8 / C# 12
• 対象コントロール: WPF ComboBox
• アーキテクチャ: MVVM（DataContext 経由のバインド）
• 前提知識: WPF バインド基礎、INotifyPropertyChanged

問題

ComboBox の ItemsSource に渡すコレクションの要素型が変わると、選択値の取得方法も変わる。たとえば文字列リストを渡す場合と、ID と名称を持つオブジェクトのリストを渡す場合では、ViewModel にバインドするプロパティの型と設定が異なる。この違いを把握していないと、選択しても値が反映されない、または初期値が表示されないといった問題が発生する。

原因・背景

ComboBox の選択関連プロパティは以下の 3 種類がある。

文字列リストの場合、要素そのものが文字列であるため SelectedItem は string を返す。オブジェクトのリストを使い SelectedValuePath を指定すると、SelectedValue には指定プロパティの値が返る。どのプロパティをバインドするかはデータ構造に依存するため、構造ごとに設定を合わせる必要がある。

解決方法

実装に入る前に、ItemsSource の要素型に応じて選択関連プロパティを使い分ける。

• 要素が string や enum のような単純値なら、要素そのものを受け取る SelectedItem を使う。
• 要素がオブジェクトで、選択されたオブジェクト全体を扱いたいなら SelectedItem を使う。
• 要素がオブジェクトで、ID など特定の値だけを ViewModel に持たせたいなら SelectedValue と SelectedValuePath を使う。
• 表示用の名称と保持したい値を分けたい場合は、DisplayMemberPath と SelectedValuePath を組み合わせる。
• SelectedIndex は表示順そのものに意味がある場合に限って使い、通常は値やオブジェクトを直接扱う設定を優先する。

この方針で選べば、ViewModel 側のプロパティ型と ComboBox の設定を対応させやすくなり、初期選択や選択変更の反映漏れを防ぎやすい。

実装例

パターン A：文字列リスト

ItemsSource が ObservableCollection<string> のとき、DisplayMemberPath は不要であり、SelectedItem に string 型のプロパティをバインドするだけで機能する。

<ComboBox ItemsSource="{Binding Regions}"
          SelectedItem="{Binding SelectedRegion}" />

対応する ViewModel 側の実装は次のとおりである。

public ObservableCollection<string> Regions { get; } = new()
{
    "東北", "関東", "中部", "近畿", "九州"
};

private string? _selectedRegion;
public string? SelectedRegion
{
    get => _selectedRegion;
    set { _selectedRegion = value; OnPropertyChanged(); }
}

SelectedItem に string 以外の型（例: int）をバインドすると型の不一致でバインドエラーとなる。

パターン B：オブジェクトリスト ＋ DisplayMemberPath ＋ SelectedItem

ItemsSource が ObservableCollection<T> で、表示する文字列と選択して取得するオブジェクトが同じ型の場合、DisplayMemberPath で表示プロパティを指定し、SelectedItem にオブジェクト全体をバインドする。

<ComboBox ItemsSource="{Binding Departments}"
          DisplayMemberPath="Name"
          SelectedItem="{Binding SelectedDepartment}" />

上記の XAML では Department オブジェクトの Name を表示しつつ、選択結果として Department オブジェクト全体を SelectedDepartment にバインドしている。対応するモデルと ViewModel の定義例は次のとおり。

public class Department
{
    public int Id { get; set; }
    public string Name { get; set; } = string.Empty;
}

public ObservableCollection<Department> Departments { get; } = new()
{
    new Department { Id = 1, Name = "営業部" },
    new Department { Id = 2, Name = "開発部" },
    new Department { Id = 3, Name = "総務部" },
};

private Department? _selectedDepartment;
public Department? SelectedDepartment
{
    get => _selectedDepartment;
    set { _selectedDepartment = value; OnPropertyChanged(); }
}

選択後は SelectedDepartment.Id や SelectedDepartment.Name で任意のフィールドにアクセスできる。ViewModel にオブジェクト全体を保持するため、後から複数フィールドを参照しやすい。

パターン C：オブジェクトリスト ＋ DisplayMemberPath ＋ SelectedValuePath

表示は Name で行い、選択値として Id（数値や文字列のキー）だけを取得したい場合に使う。SelectedValuePath に取得したいプロパティ名を指定し、SelectedValue にそのプロパティの型でバインドする。

<ComboBox ItemsSource="{Binding Departments}"
          DisplayMemberPath="Name"
          SelectedValuePath="Id"
          SelectedValue="{Binding SelectedDepartmentId}" />

対応する ViewModel 側では、選択された Id を保持するプロパティを次のように定義する。

private int _selectedDepartmentId;
public int SelectedDepartmentId
{
    get => _selectedDepartmentId;
    set { _selectedDepartmentId = value; OnPropertyChanged(); }
}

SelectedValue の型と SelectedValuePath で指定するプロパティの型が一致していないと、選択値が反映されない。また SelectedItem と SelectedValue は同時に利用できるが、一方を変更するともう一方も自動で更新される。

パターン D：ItemTemplate を使ったカスタム表示

1 行の表示に複数フィールドを含めたい場合や、アイコン付きの選択肢を実装したい場合は ItemTemplate を使う。DisplayMemberPath と ItemTemplate は両方を設定できるが、表示には ItemTemplate が優先されて DisplayMemberPath は無視される。そのため、カスタム表示が必要なときは ItemTemplate を使用し、通常は DisplayMemberPath を併用しない。

<ComboBox ItemsSource="{Binding Employees}"
          SelectedItem="{Binding SelectedEmployee}">
    <ComboBox.ItemTemplate>
        <DataTemplate>
            <StackPanel Orientation="Horizontal">
                <TextBlock Text="{Binding Id}" Width="40" Foreground="Gray"/>
                <TextBlock Text="{Binding Name}" />
            </StackPanel>
        </DataTemplate>
    </ComboBox.ItemTemplate>
</ComboBox>

この XAML で参照する Employee モデルの定義例は次のとおりである。

public class Employee
{
    public int Id { get; set; }
    public string Name { get; set; } = string.Empty;
}

ItemTemplate を使う場合、ドロップダウンを閉じた状態（選択済み表示）と展開した一覧で異なるレイアウトを出したいときは ItemTemplate の代わりに ItemContainerStyle と ContentTemplate を組み合わせる。

パターン E：Enum リスト

選択肢が固定の列挙体の場合、ObjectDataProvider を使って XAML から Enum 値を列挙する方法と、ViewModel でコレクションを用意する方法がある。保守性を考えると ViewModel でコレクションを生成する方法が安全である。

ViewModel 側で Enum.GetValues を使って選択肢を生成する。

public enum Priority { 低, 中, 高 }

public IEnumerable<Priority> Priorities { get; }
    = (Priority[])Enum.GetValues(typeof(Priority));

private Priority _selectedPriority = Priority.中;
public Priority SelectedPriority
{
    get => _selectedPriority;
    set { _selectedPriority = value; OnPropertyChanged(); }
}

この ViewModel に対して、XAML 側では ItemsSource と SelectedItem を次のようにバインドする。

<ComboBox ItemsSource="{Binding Priorities}"
          SelectedItem="{Binding SelectedPriority}" />

SelectedItem の型は Priority（Enum 型）になる。SelectedValue と SelectedValuePath を使って Enum の数値（基底値）だけを取得することも可能だが、明示的に (int)SelectedPriority でキャストした方が意図が明確である。

注意点

• DisplayMemberPath と ItemTemplate を同時に設定した場合の挙動
  両方を設定すると ItemTemplate が優先されて DisplayMemberPath は無視される。意図しない挙動を防ぐため、カスタム表示が必要な場合は ItemTemplate を使用し、DisplayMemberPath を併用しない。

• SelectedValue の初期値を正しく設定する
  SelectedValuePath を使う場合、ViewModel 側の初期値が ItemsSource 内に存在しない値だと選択状態が空になる。ItemsSource がセットされる前に SelectedValue が設定されるとバインドが空振りすることがある。ItemsSource を先に設定してから選択値を設定する順序を守る。

• SelectedItem の一致判定は Equals を考慮する
  SelectedItem は「常に参照比較」とは限らず、Equals による一致判定が関わる。既定の実装では別インスタンス同士は一致しないことが多いため、同じ内容のオブジェクトを初期値として設定しても選択されない場合がある。値同値で一致させたい場合は、対象型で Equals と GetHashCode をオーバーライドし、必要に応じて IEquatable<T> も実装する。識別子やコード値のような特定プロパティで選択を管理したい場合は、SelectedValuePath と SelectedValue を使う。

• null の扱い
  選択肢として「未選択」を表す null を含める場合、ComboBox は空欄として表示する。ViewModel 側で null を許容する型（例: string?, int?）を使う。

代替案・比較

まとめ

ComboBox の実装パターンは ItemsSource に渡す型によって決まる。

• 文字列リストのみの場合は SelectedItem に string 型をバインドするだけで十分である。
• オブジェクトリストでオブジェクト全体が必要な場合は DisplayMemberPath ＋ SelectedItem を使う。
• オブジェクトリストで特定フィールド（ID など）だけ必要な場合は SelectedValuePath ＋ SelectedValue を使う。
• カスタムレイアウトが必要な場合は ItemTemplate を使い、DisplayMemberPath との同時指定は避ける。
• Enum は ViewModel でコレクション化し、SelectedItem に Enum 型をバインドする。

初期値が反映されない問題の多くは、参照比較の不一致か ItemsSource のセット順序に起因する。SelectedValuePath を使うか、同一インスタンスを参照するよう設計することで回避できる。