【WPF】一瞬で実装できるドラッグ アンド ドロップのコード紹介

Windowsでお馴染みのドラッグ＆ドロップは超便利なので、自作プログラムに組み込みたくなるものですが、イベント処理を記述しなければならないため、結構面倒です。

他のサイトではドラッグ＆ドロップの原理とか、イベント処理をゴリゴリ記述するようなサンプルが多いので、本サイトでは瞬殺で実装できるよう関数化しました。

いちいちイベントハンドラを記述しなくても簡単に実装できますので、是非ご活用ください。

尚、WindowsForm版については、こちらの記事で紹介しています。

ドラッグ & ドロップの動作

次の動画を見て頂いた通り、「テキストファイル.txt」というファイルを、目的とするコントロールにドラッグ＆ドロップすると、マウスのアイコンが「ドラッグ＆ドロップ」用のアイコンに変わっていますね。

つまり、ドロップ先のコントロールは、ドラッグされたファイルを受け付ける状態になっているという事です。

ドロップ後の処理は特に書いていないので画面上何も起こりませんが、「アイコンが変わった＝受付状態にある」という所がポイントです。

ドラッグ & ドロップ機能をコントロールに付与するコード

冒頭で説明した通り、ドラッグ＆ドロップの機能を任意のコントロールに付与する関数を作りました。

詳細の説明は後回しにして、ここでは使い方と付与するコードの中身を紹介しておきます。

使い方

使い方は簡単で、EnableDragDropという関数の引数にコントロールを渡すだけです。

この関数を呼び出すと、引数で渡したコントロールがドラッグ＆ドロップを受け付けるようになるので、コンストラクタか フォームのLoadedイベントハンドラに記述するのが良いかと思います。

ソースコード

ソースコードは次の通りです。

Visual Studio でイベントハンドラを作成し、必要な処理をイベントハンドラ内に記述していく必要があるのですが、それを全て関数内で行っています。

ドラッグ＆ドロップ後に行いたい処理は「ここに、ドラッグ＆ドロップ受付時の処理を記述する」と書いてある部分に記述して下さい。

解説

処理を出来るだけ簡単に済ませるために、PreviewDragOver と PreviewDrop のイベントハンドラを記述しています。

　PreviewDragOver　は、ファイルやフォルダをコントロール上にドラッグした時に発生するイベントで、e.Effects にDragDropEffects.Copy を設定することで、アイコンの形を変えています。

PreviewDrop はドロップ時に発生するイベントで、GetData(DataFormats.FileDrop) メソッドによりファイル又はフォルダを取得しています。

尚、一度のドラッグ＆ドロップで、複数のファイルやフォルダが渡される可能性があるため、GetDataの戻り値は文字列配列になっています。

どのコントロールに対応しているか

次のような画面を作って試してみたところ、

TextBox、ComboBox、DataGrid、ListBox、TabContorl、TabItem、ListView、TreeViewで動作することを確認しています。

他のコントロールにも使えるとは思いますが、実際によく使うのが上記なので、これだけを確認しました。

サンプルソース一式

次のリンクからプロジェクト一式がダウンロードできます。

まとめ

今回はWPFのWindowアプリに、ドラッグ＆ドロップを組み込む関数を紹介しました。

関数をコピー＆ペーストし、コンストラクタか フォームのLoaded イベントで EnableDragDrop を呼び出すだけという手軽さです。

コントロール毎にドラッグ＆ドロップのイベントハンドラを書くのは手間なので、関数化しておけば非常に楽になります。

是非ご活用下さい。