エクセル VBA ListViewにドラッグ&ドロップでファイルパスを取得(Excel VBA)

【本日のミッション】

エクセル VBAのListViewにドラッグ&ドロップで、ファイルパスを取得せよ。

ミッションの概要

エクセル VBA の ListViewにドラッグ&ドロップで、ファイルパスを取得せよ、というのが今回のミッションです。

ツールボックスに ListViewコントロールボタンを表示させる

ListViewオブジェクトを使用するためには、ツールボックスにListViewコントロールを追加しなくてはいけません。その方法は、下記ページをご参照ください。

エクセル VBA フォーム ツールボックスにListViewコントロールを追加(Excel VBA)

ユーザーフォームに ListViewを作る

ユーザーフォームを開く

画面左のプロジェクトエクスプローラーから、ユーザーフォームをダブルクリックして開きます。

ツールボックスを表示させる

ListViewを作るためのツールボックスを、下記方法で表示させます。

ツールボックスにListViewボタンが表示されない場合は、エクセル VBA フォーム ツールボックスにListViewコントロールを追加(Excel VBA)を参考に追加してください。

ツールボックスを表示する方法1

[表示]-[ツールボックス]

ツールボックスを表示する方法2

標準ツールバーの[ツールボックス]ボタンをクリックします。

標準ツールバーが表示されていない場合は、[表示]-[ツールバー]-[標準]で表示されます。

ListViewの作成

ツールボックスから「ListView」ボタンをクリックします。
ツールボックスにListViewボタンが表示されない場合は、エクセル VBA フォーム ツールボックスにListViewコントロールを追加(Excel VBA)を参考に追加してください。

ユーザーフォームのListViewを配置したい位置に、左上からクリックのまま右下までドラッグします。

ユーザーフォームにListViewが作成されます。

左のプロパティウインドウを確認すると、このListViewのオブジェクト名が「ListView1」ということが確認できます。

今回はファイルパスを表示させたいので、ユーザーフォーム・リストビューの幅を広げておきます。

ユーザーフォームの Initialize 処理で、ListViewの初期設定を行う

UserForm_Initialize に記述した処理は、ユーザーフォームが画面表示される時に行われます。ユーザーフォームに設置したオブジェクト(リストビュー・リストビュー・コンボボックス・テキストボックス等)で、

  • リストビューの列見出し
  • プルダウンを開いた時に出てきて欲しい値リスト
  • 初めから表示されていて欲しい選択リスト
  • テキストの初期値

等は、ユーザーフォームが開くと同時に設定されるようにしておきます。
今回は、ユーザーフォーム「UserForm1」が画面表示される時に、リストビュー「ListView1」に

  • 行全体の選択
  • 行列グリッド線の表示
  • ラベル編集不可
  • ファイルドロップの処理
  • 表示形式
  • 列見出しの名前・列幅の設定

ユーザーフォームのコードウィンドウを表示

プロジェクトエクスプローラーから、ListViewを設置しているユーザーフォームを右クリックします。

[コードの表示]をクリックし、コードウィンドウを表示させます。([F7]キーでもコード表示できます。)

UserFormの選択

コードウィンドウ上部の「(General)」と表示されているプルダウンを開き、「UserForm」を選択します。

自動的に下記コードが挿入されますが、削除するとUserFormの選択が解除されるため、そのままにしておきます。

Initializeの選択

右側のプルダウン(「Click」と表示されています。)を開き、「Initialize」を選択します。

下記コードが表示されます。

ここで先ほどの「Private Sub UserForm_Click() ~ End Sub」は不要になりますので、削除しておきましょう。

UserForm_Initialize にコードの追加

Private Sub UserForm_Initialize ~ End Sub 内に下記の通り、コードを追加します。

Private Sub UserForm_Initialize()
    With ListView1
        '■プロパティ設定
        .FullRowSelect = True           '行全体の選択
        .Gridlines = True               '行列グリッド線の表示
        .LabelEdit = lvwManual          'ラベル編集不可
        .OLEDropMode = ccOLEDropManual  'ファイルドロップ処理
        .View = lvwReport               '表示形式

        '■列見出しの名前・列幅の設定
        .ColumnHeaders.Add , "key1", "ファイルパス", 350, lvwColumnLeft
    End With
End Sub

ユーザーフォームの実行

このコード内にカーソルを置いたまま、[F5]キーをクリック(ユーザーフォームの実行)するとユーザーフォームが表示されます。

ファイルをドラッグ&ドロップした時の動作を設定

UserForm_Initializeに初期設定を施しただけでは、ListViewは希望している動作をしません。ファイルをドラッグ&ドロップした時の動作を設定する必要があります。

ユーザーフォームのコードウィンドウを表示

プロジェクトエクスプローラーから、ListViewを設置しているユーザーフォームを右クリックします。

[コードの表示]をクリックし、コードウィンドウを表示させます。([F7]キーでもコード表示できます。)

ListView1の選択

コードウィンドウ上部左のプルダウンを開き、「ListView1」を選択します。

自動的に下記コードが挿入されますが、このコードは使用しません。削除するとListView1の選択が解除されるため、そのままにしておきます。

OLEDragDropの選択

上部右側のプルダウンを開き、「OLEDragDrop」を選択します。

下記コードが表示されます。

ここで先ほどの「Private Sub ListView1_BeforeLabelEdit(Cancel As Integer)~ End Sub」は不要になりますので、削除しておきましょう。

ListView1_OLEDragDrop にコードの追加

Private Sub ListView1_OLEDragDrop ~ End Sub 内に下記の通り、コードを追加します。
これが、ファイルをドラッグ&ドロップした時の動作指定になります。

Private Sub ListView1_OLEDragDrop(Data As MSComctlLib.DataObject, Effect As Long, Button As Integer, Shift As Integer, x As Single, y As Single)
    '【変数】
    Dim i As Long           'カウンター
    Dim fileCount As Long   'ファイル数
    
    With ListView1
    
        '■既存ファイル名のクリア
        If .ListItems.Count > 0 Then
            .ListItems.Clear
        End If
        
        '■ファイル数の取得
        fileCount = Data.Files.Count
        
        '■ドラッグ&ドロップしたファイル名を順にリスト化
        For i = 1 To fileCount
            .ListItems.Add = Data.Files(i)
        Next i
    End With
End Sub

ファイルをドラッグ&ドロップした時の動作確認

このコード内にカーソルを置いたまま、[F5]キーをクリック(ユーザーフォームの実行)するとユーザーフォームが表示されます。

ユーザーフォームに、ファイルをドラッグ&ドロップすると、ファイルパスが表示されます。

■■■スポンサーリンク■■■

FullRowSelectプロパティ

True:行全体を選択します。

False:項目だけを選択します。

Gridlinesプロパティ

True:行列グリッド線を表示します。

False:行列グリッド線を表示しません。

LabelEditプロパティ

lvwManual:ラベル編集不可

lvwAutomatic:ラベル編集可

OLEDropModeプロパティ

ccOLEDropManual:ファイルをドロップするとListViewオブジェクトの「ListView1_OLEDragDrop」で設定した処理を行います。

今回「ListView1_OLEDragDrop」では、既存ファイル名のクリアとファイル名のリスト化の処理を行っています。

ccOLEDropNone:ファイルをドロップしても「ListView1_OLEDragDrop」で設定した処理は行われず、ファイルが開きます。

Viewプロパティ

lvwReport:詳細表示

lvwList:一覧表示

lvwSmallIcon:小アイコン表示

lvwIcon:アイコン表示

ColumnHeaders.Add

ListViewオブジェクトの列見出しを追加・設定します。

ListViewオブジェクト.ColumnHeaders.Add Index, Key, Text, Width, Alignment, Icon
引数内容
Index追加する列の位置を指定します。省略すると左から追加されます。
Key列見出しを特定するユニークな名前を指定します。
2つの異なる列に、同じ名前を指定すると「実行時エラー ‘35602’: Key is not unique in collection」というエラーが表示されますので、列ごとに重複しない名前を指定するようにします。
Text列見出しに表示する文字列を指定します。
Width列見出しの幅を指定します。省略すると均等幅になります。
Alignment見出し文字列の位置を指定します。

lvwColumnLeft(規定値)左寄せ
lvwColumnRight右寄せ
lvwColumnCenter中央

ListItemsコレクション

今回のListViewの列は「ファイルパス」の1列だけですが、複数列で表示形式 「View = lvwReport」 としている時は、一番左の列のみがListItemsコレクションになります。

2列目以降は、1列目のListItemsコレクションSubItemsコレクションになるので注意が必要です。この話はまた後日に・・・。

ListItems.Count

ListViewに表示されている項目数を取得します。
下記の場合は「3」になります。

ListItems.Clear

ListViewに表示されている項目をクリアします。
項目をクリアせずに、ファイルをドラッグ&ドロップすると、前に表示されていた項目を残したまま、下に項目が追加されます。
↓前にドラッグ&ドロップしたファイルパスが残った状態。

Data.Files.Count

ドラッグ&ドロップしているファイル数です。

Data」はどこから来たの?と、思ってしまいますね。
「ListView1_OLEDragDrop」を設定したときに、自動的に組み込まれているんですね。

Private Sub ListView1_OLEDragDrop(Data As MSComctlLib.DataObject, Effect As Long, Button As Integer, Shift As Integer, x As Single, y As Single)
・
・
End if

ListItems.Add

ListViewのListItemsコレクションにデータを追加します。
今回の場合は、ファイルパスの一列だけなので問題はないのですが、複数列存在する場合は、一番左の列「ListItemsコレクション」のみにデータが追加されます。

【参考】

VBA(マクロ)作成の前、リボンに開発タブを表示させる(Excel VBA)
ユーザーフォームの作成方法 準備(Excel VBA)
ユーザーフォームのオブジェクトの名前を「UserForm1」から変更する方法(Excel VBA)
ユーザーフォームの上のバー(タイトルバー)の名前を「UserForm1」から変更する(Excel VBA)
ユーザーフォームのオブジェクトウィンドウとコードウィンドウを表示切替させる方法(Excel VBA)
「オブジェクト名が不正です」を出さないようにユーザーフォームオブジェクト名を命名規則に従って変更(Excel VBA)
エクセルファイルが開いた時にユーザーフォームを表示させる方法(Excel VBA)
エクセル フォームのラベルのテキストを縦書きにする方法(Excel VBA)
エクセル VBA フォーム ツールボックスにListViewコントロールを追加(Excel VBA)
エクセル VBA フォーム「Microsoft ListView Control」が出てこない原因 (Excel VBA)
エクセル VBA ListViewにドラッグ&ドロップでファイルパスを取得(Excel VBA)

■■■スポンサーリンク■■■