「ファイル」ダイアログボックスを表示・設定（FileDialog オブジェクト）

2016/03/09

FileDialog オブジェクト

FileDialog オブジェクト のメソッド・プロパティを使用して、「ファイル」のダイアログボックスを表示・設定します。
なお、ダイアログボックスの種類を指定するには、FileDialog プロパティを使用します。

FileDialog オブジェクトの主なメソッド

Show メソッド

Showメソッドは、指定したダイアログボックスを表示します。

【書式】

object.Show

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。
戻り値・・・ダイアログボックスを表示後、ユーザーが有効なボタンをクリックすると -1 を返し、「キャンセル」ボタンをクリックすると 0 を返します。

Execute メソッド

表示されるダイアログボックスの種類に応じたアクション（「ファイルを開く」「ファイルの保存」）を実行します。

【書式】

object.Execute

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。

Show メソッドで、ダイアログボックスを表示し、ユーザーが有効なボタンをクリックした場合、表示したダイアログボックスに応じたアクションが実行されます。この時、「ファイルを開く」ダイアログボックスを表示（FileDialog プロパティ の引数に、msoFileDialogOpen を指定）した場合、指定したファイルが開かれます。「名前を付けて保存」ダイアログボックスを表示（FileDialog プロパティ の引数に、msoFileDialogSaveAs を指定）した場合、指定したパス・ファイル名で保存されます。

FileDialog オブジェクトの主なプロパティ

AllowMultiSelect プロパティ

ダイアログボックスで、複数のファイルを選択できるかどうかを設定します。

【書式】

＜取得＞
object.AllowMultiSelect

＜設定＞
object.AllowMultiSelect = boolean

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。
boolean ・・・ True を指定すると複数のファイルを選択することができます。False を指定しすると 1 つのファイルしか選択することができません。

ButtonName プロパティ

ダイアログボックスのボタンに表示する文字列を設定します。

【書式】

＜取得＞
object.ButtonName

＜設定＞
object.ButtonName = string

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。
string ・・・ダイアログボックスのボタンに表示する文字列（ 51 文字）を指定します。省略すると既定値が指定されます（既定では、ファイルのダイアログボックスの種類に応じた標準テキストが設定されています）。

DialogType プロパティ

FileDialog オブジェクト が表示するダイアログボックスの種類を表す定数（MsoFileDialogType 列挙型）を取得します。読み取り専用です。

【書式】

＜取得＞
object.DialogType

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。

戻り値・・・ダイアログボックスの種類を表す MsoFileDialogType 列挙型 の値。

定数	値	内容
msoFileDialogOpen	1	「ファイルを開く」ダイアログボックス
msoFileDialogSaveAs	2	「名前を付けて保存」ダイアログボックス
msoFileDialogFilePicker	3	「参照」ダイアログボックス（ファイルを選択）
msoFileDialogFolderPicker	4	「参照」ダイアログボックス（フォルダを選択）

FilterIndex プロパティ

ダイアログボックスで表示する既定のファイルの種類を設定します。

【書式】

＜取得＞
object.FilterIndex

＜設定＞
object.FilterIndex = long

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。
long ・・・既定で表示するファイルの種類を表す数値を指定します。数値は、ファイルリストの上から順に、1, 2, 3, …… となります。省略すると 1 を指定したものとされます。

Filters プロパティ

FileDialogFilters コレクション を取得します。値の取得のみ可能です。

【書式】

＜取得＞
object.Filters

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。
戻り値・・・ FileDialogFilters コレクション

FileDialogFilters コレクションは、ダイアログボックスに表示されるファイルフィルタを設定します。詳細は、FileDialogFilters コレクション・FileDialogFilter オブジェクトを参照して下さい。

InitialFileName プロパティ

ダイアログボックスに最初に表示されるパスまたはファイル名を指定します。

【書式】

＜取得＞
object.InitialFileName

＜設定＞
object.InitialFileName = string

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。
string ・・・既定のパス・ファイル名を指定します。

引数 string に、パスやファイル名の設定方法について

ファイル名には、「*」（連続する任意の数の文字）や「?」（任意の 1 文字）のワイルドカードを使用できます（パスには使用できません）。
パスのみを指定した場合、ファイルフィルターにより設定されたすべての種類のファイルがダイアログボックスに表示されます。
存在しないファイルを指定した場合、ダイアログボックスにファイルは表示されません。
無効なパスを指定した場合、最後に使用したパスが使用されます。
256 文字より長い文字列を指定すると、実行時エラーになります。

InitialView プロパティ

ダイアログボックスでファイルとフォルダの表示方法を MsoFileDialogView 列挙型 の定数で、設定および取得します。

【書式】

＜取得＞
object.InitialView

＜設定＞
object.InitialView = const

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。

const ・・・ファイルダイアログボックスで表示されるビューを表す MsoFileDialogView 列挙型 の定数またはその値を指定します。

定数	値	内容
msoFileDialogViewList	1	ファイルはリスト形式で詳細なしで表示
msoFileDialogViewDetails	2	ファイルはリスト形式で詳細情報と共に表示
msoFileDialogViewProperties	3	ファイルはリスト形式で選択したファイルのプロパティを示すウィンドウと共に表示
msoFileDialogViewPreview	4	ファイルは選択したファイルを示すプレビューウィンドウと共に表示
msoFileDialogViewThumbnail	5	ファイルは縮小表示で表示
msoFileDialogViewLargeIcons	6	ファイルは大きいアイコンで表示
msoFileDialogViewSmallIcons	7	ファイルは小さいアイコンで表示
msoFileDialogViewWebView	8	ファイルは Web ビューで表示
msoFileDialogViewTiles	9	ファイルは並べられたアイコンで表示

SelectedItems プロパティ

ユーザーが選択したファイルのパスの一覧を取得します。読み取り専用です。

【書式】

＜取得＞
object.SelectedItems

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。
戻り値・・・ FileDialogSelectedItems コレクション

FileDialogSelectedItems.Count プロパティ
コレクション内の項目数を取得します。

FileDialogSelectedItems.Item( index ) メソッド
表示されたダイアログボックスからユーザーが選択したファイルのうち上から index 番目のパスに対応する文字列を取得します。

Title プロパティ

ダイアログボックスのタイトルバーに表示する文字列を設定および取得します。

【書式】

＜取得＞
object.Title

＜設定＞
object.Title = string

引数・戻り値

object ・・・対象となる FileDialog オブジェクトを指定します。
string ・・・タイトルバーに表示する文字列を指定します。

FileDialog オブジェクト使用例

サンプルVBAソース

　
Sub Sample_FileDialogObject1()

    Dim str As String
    Dim i As Long
    
    '「ファイルを開く」ダイアログボックス
    With Application.FileDialog(msoFileDialogOpen)
    
        str = .Item & vbCrLf                    'FileDialog に関連付けられたテキスト
        str = str & .ButtonName & vbCrLf        'ボタンに表示されているテキスト
        str = str & .DialogType & vbCrLf        'ダイアログボックスの種類を表す値
        str = str & .FilterIndex & vbCrLf       '既定で表示するファイルの種類（リストの位置）
        str = str & .InitialFileName & vbCrLf   '既定で表示するパス
        str = str & .InitialView & vbCrLf       'ファイル・フォルダの表示方法を表す値
        str = str & .Title & vbCrLf             'タイトル
        

        '複数ファイル選択可
        .AllowMultiSelect = True
        
        'ダイアログボックスを表示し、「開く」ボタンをクリックしたらファイルを開く
        If .Show = -1 Then .Execute
        
        '選択したファイルのパスの一覧
        For i = 1 To .SelectedItems.Count
            str = str & .SelectedItems.Item(i) & vbCrLf
        Next i
        

        MsgBox str
        
    End With

End Sub