WPFのDataGridでマウスクリックしたグリッド位置を取得する

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

目次

1. はじめに
2. WPFのDataGridでマウスクリックしたグリッド位置を取得する
3. おわりに

リンク

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回は業務で使用しているWPFのDataGridでマウスクリックしたグリッド位置を取得する方法についてです。

目次へ

2. WPFのDataGridでマウスクリックしたグリッド位置を取得する

WPFのDataGridでマウスクリックしたグリッド位置を取得するには、以下のような実装にします。

実装例

MainWindow.xaml

<Window x:Class="WPFDataGridPos.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:WPFDataGridPos"
        mc:Ignorable="d"
        Title="MainWindow" Height="250" Width="300" ContentRendered="Window_ContentRendered">
    <Grid>
        <DataGrid x:Name="dataGrid" ItemsSource="{Binding}" MouseDown="dataGrid_MouseDown"/>
    </Grid>
</Window>

MainWindow.xaml.cs

using System;
using System.Data;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Input;
using System.Windows.Media;

namespace WPFDataGridPos
{
    /// <summary>
    /// MainWindow.xaml の相互作用ロジック
    /// </summary>
    public partial class MainWindow : Window
    {
        /**
         * @brief コンストラクタ
         */
        public MainWindow()
        {
            // コンポーネントの初期化を行います。
            InitializeComponent();
        }

        /**
         * @brief 描画が終わった後に呼び出されます。
         * 
         * @param [in] sender ウィンドウ
         * @param [in] e イベント
         */
        private void Window_ContentRendered(object sender, EventArgs e)
        {
            // データグリッドにテストデータを設定します。
            var dataTable = new DataTable();
            for (var columnIndex = 0; columnIndex < 3; ++columnIndex)
            {
                dataTable.Columns.Add($"列{columnIndex + 1}");
            }

            for (var rowIndex = 0; rowIndex < 5; ++rowIndex)
            {
                var row = dataTable.NewRow();
                for (var columnIdex = 0; columnIdex < 3; ++columnIdex)
                {
                    row[columnIdex] = $"{rowIndex}-{columnIdex}";
                }
                dataTable.Rows.Add(row);
            }
            dataGrid.DataContext = dataTable;
        }

        /**
         * @brief データグリッドでマウスがクリックされた時に呼び出されます。
         * 
         * @param [in] sender データグリッド
         * @param [in] e イベント
         */
        private void dataGrid_MouseDown(object sender, MouseButtonEventArgs e)
        {
            // データグリッドでマウスがクリックされた位置を取得します。
            var dataGrid = sender as DataGrid;
            var point = e.GetPosition(dataGrid);

            // データグリッドでマウスがクリックされた位置の行オブジェクトを取得します。
            var row = GetDataGridObject<DataGridRow>(dataGrid, point);
            if (row == null)
            {
                return;
            }
            // 行オブジェクトから行インデックス(0起算)を取得します。
            var rowIndex = row.GetIndex();

            // データグリッドでマウスがクリックされた位置のセルオブジェクトを取得します。
            var cell = GetDataGridObject<DataGridCell>(dataGrid, point);
            if (cell == null)
            {
                return;
            }
            // セルオブジェクトから列インデックス(0起算)を取得します。
            var columnIndex = cell.Column.DisplayIndex;

            MessageBox.Show($"行={rowIndex} 列={columnIndex}");
        }

        /**
         * @brief 引数の位置のDataGridのオブジェクトを取得します。
         * 
         * @param [in] dataGrid データグリッド
         * @param [in] point 位置
         * @return DataGridのオブジェクト
         */
        private T GetDataGridObject<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;
        }
    }
}

実行結果

行2、列1のセルをマウスクリックした結果

API Reference

DataGridクラス

目次へ

3. おわりに

DataGridでマウスクリックしたグリッド位置を取得したいことはよくあると思います。
そのため簡単に取得できるかと思ったのですが、簡単にはできないようです。

リンク

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

目次へ

---

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

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

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

目次へ