WPFのDataGridで選択したセルを識別する。

この記事は2019年05月19日に投稿しました。

f:id:paveway:20190914064630j:plain

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回は業務で使用しているWPFのDataGridで選択したセルを識別する方法についてです。

WPFのDataGridで選択したセルを識別する方法ですが、PreviewMouseLeftButtonDownイベントとPreviewMouseLeftButtonUpイベントを利用します。
WPFのDataGridでマウスの左ボタン押下でセルを選択すると、PreviewMouseLeftButtonDownイベントが発生します。
そしてマウスの左ボタンを放すとPreviewMouseLeftButtonUpイベントが発生します。
これを利用して選択したセルを識別します。

実装例

MainWindow.xaml

<Window x:Class="WPFDataGridDrag.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:WPFDataGridDrag"
        mc:Ignorable="d"
        Title="MainWindow" Height="450" Width="800" ContentRendered="Window_ContentRendered">
    <Grid>
        <DataGrid
            Name="dataGrid"
            SelectionUnit="Cell"
            PreviewMouseLeftButtonDown="DataGrid_PreviewMouseLeftButtonDown"
            PreviewMouseLeftButtonUp="DataGrid_PreviewMouseLeftButtonUp"/>
    </Grid>
</Window>

MainWindow.xaml.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Controls.Primitives;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;

namespace WPFDataGridDrag
{
    /**
     * @brief パーソンクラス
     *        データグリッドに表示するクラス
     */
    class Person
    {
        public string Name { get; set; }
        public string Address { get; set; }
        public int Age { get; set; }
    }

    /// <summary>
    /// MainWindow.xaml の相互作用ロジック
    /// </summary>
    public partial class MainWindow : Window
    {
        /**
         * @brief コンストラクタ
         */
        public MainWindow()
        {
            InitializeComponent();

            // データグリッドにサンプルデータを設定します。
            var list = new List<Person>();
            list.Add(new Person() { Name = "佐藤", Address = "東京", Age = 20 });
            list.Add(new Person() { Name = "鈴木", Address = "千葉", Age = 31 });
            list.Add(new Person() { Name = "高橋", Address = "埼玉", Age = 42 });
            list.Add(new Person() { Name = "田中", Address = "神奈川", Age = 53 });
            list.Add(new Person() { Name = "伊藤", Address = "群馬", Age = 64 });
            dataGrid.ItemsSource = list;
        }

        /**
         * @brief ウィンドウが描画された後に呼び出されます。
         * 
         * @param [in] sender ウィンドウ
         * @param [in] e イベント
         */
        private void Window_ContentRendered(object sender, EventArgs e)
        {
            // データグリッドに識別用のタグを設定します。
            var rowNum = dataGrid.Items.Count;
            var columnNum = dataGrid.Columns.Count;
            for (int i = 0; i < rowNum; ++i)
            {
                for (int j = 0; j < columnNum; ++j)
                {
                    var cell = GetDataGridCell(dataGrid, i, j);
                    if (cell == null)
                    {
                        continue;
                    }
                    var tag = string.Format("{0:00}{1:00}", i, j);
                    cell.Tag = tag;
                }
            }
        }

        /**
         * データグリッドでマウスの左ボタンが押下された時に呼び出されます。
         * 
         * @param [in] sender データグリッド
         * @param [in] e マウスボタンイベント
         */
        private void DataGrid_PreviewMouseLeftButtonDown(object sender, MouseButtonEventArgs e)
        {
            // ボタンが押下されたセルのタグを表示します。
            var dataGrid = sender as DataGrid;
            if (dataGrid == null)
            {
                return;
            }
            var point = e.GetPosition(dataGrid);
            var cell = GetDataGridCell<DataGridCell>(dataGrid, point);
            Console.WriteLine($"down={cell.Tag}");
        }

        /**
         * データグリッドでマウスの左ボタンが放された時に呼び出されます。
         * 
         * @param [in] sender データグリッド
         * @param [in] e マウスボタンイベント
         */
        private void DataGrid_PreviewMouseLeftButtonUp(object sender, MouseButtonEventArgs e)
        {
            // ボタンが放されたセルのタグを表示します。
            var dataGrid = sender as DataGrid;
            if (dataGrid == null)
            {
                return;
            }
            var point = e.GetPosition(dataGrid);
            var cell = GetDataGridCell<DataGridCell>(dataGrid, point);
            Console.WriteLine($"up={cell.Tag}");
        }

        // 内部メソッド(詳細は省略します)

        private DataGridCell GetDataGridCell(DataGrid dataGrid, int rowIndex, int columnIndex)
        {
            if (dataGrid.Items == null || dataGrid.Items.IsEmpty)
            {
                return null;
            }

            var row = GetDataGridRow(dataGrid, rowIndex);
            if (row == null)
            {
                return null;
            }

            var presenter = GetVisualChild<DataGridCellsPresenter>(row);
            if (presenter == null)
            {
                return null;
            }

            var generator = presenter.ItemContainerGenerator;
            var cell = generator.ContainerFromIndex(columnIndex) as DataGridCell;
            if (cell == null)
            {
                dataGrid.UpdateLayout();
                var column = dataGrid.Columns[columnIndex];
                dataGrid.ScrollIntoView(row, column);
                cell = generator.ContainerFromIndex(columnIndex) as DataGridCell;
            }
            return cell;
        }

        private DataGridRow GetDataGridRow(DataGrid dataGrid, int index)
        {
            if (dataGrid.Items == null || dataGrid.Items.IsEmpty)
            {
                return null;
            }

            var generator = dataGrid.ItemContainerGenerator;
            var row = generator.ContainerFromIndex(index) as DataGridRow;
            if (row == null)
            {
                dataGrid.UpdateLayout();
                var item = dataGrid.Items[index];
                dataGrid.ScrollIntoView(item);
                row = generator.ContainerFromIndex(index) as DataGridRow;
            }
            return row;
        }

        private T GetVisualChild<T>(Visual parent) where T : Visual
        {
            T result = default(T);
            var count = VisualTreeHelper.GetChildrenCount(parent);
            for (int i = 0; i < count; ++i)
            {
                var child = VisualTreeHelper.GetChild(parent, i) as Visual;
                result = child as T;
                if (result != null)
                {
                    break;
                }

                result = GetVisualChild<T>(child);
            }
            return result;
        }

        private T GetDataGridCell<T>(DataGrid dataGrid, Point point)
        {
            T result = default(T);
            var hitResultTest = VisualTreeHelper.HitTest(dataGrid, point);
            if (hitResultTest != null)
            {
                var visualHit = hitResultTest.VisualHit;
                while (visualHit != null)
                {
                    if (visualHit is T)
                    {
                        result = (T)(object)visualHit;
                        break;
                    }
                    visualHit = VisualTreeHelper.GetParent(visualHit);
                }
            }
            return result;
        }
    }
}

目次へ

3. おわりに

DataGridでマウスの左ボタン押下で選択したセルを識別しようとしましたが、MouseLeftButtonDownイベント、MouseLeftButtonUpイベントでは要望の動作になりませんでした。
PreviewMouseLeftButtonDownイベント、PreviewMouseLeftButtonUpイベントを利用する必要がありました。

IT・Web・ゲーム業界のエンジニア転職なら【Tech Stars Agent】

実戦で役立つ C#プログラミングのイディオム/定石&パターン

作者: 出井秀行
出版社/メーカー: 技術評論社
発売日: 2017/02/18
メディア: 大型本
この商品を含むブログ (1件) を見る

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ

プログラムを書こう！

実務や自作アプリ開発で習得した役に立つソフトウェア技術情報を発信するブログ

WPFのDataGridで選択したセルを識別する。

目次

1. はじめに

2. WPFのDataGridで選択したセルを識別する

実装例

MainWindow.xaml

MainWindow.xaml.cs

3. おわりに