FileDialogFilters コレクション・FileDialogFilter オブジェクト

2016/03/03 2016/05/21

FileDialogFilters コレクション

FileDialog オブジェクトを使用して表示される「ファイル」のダイアログボックスで選択できるファイルの種類を表す FileDialogFilter オブジェクトのコレクションです。FileDialogFilters コレクションを取得するには、 FileDialog オブジェクトの Filters プロパティを使用します。

FileDialogFilters コレクションの主なプロパティ

Count プロパティ

FileDialogFilters コレクション内の項目の数を取得します。読み取り専用。

【書式】

＜取得＞
object.Count

引数・戻り値

object ・・・対象となる FileDialogFilters オブジェクトを指定します。
戻り値・・・ FileDialogFilters コレクション内の項目の数を示す長整数型（Long）の値。

FileDialogFilters コレクションの主なメソッド

Add メソッド

「ファイル」ダイアログボックスのファイルの一覧に、新しいファイルの種類を追加します。

【書式】

object.Add ( description, extensions, position )

引数・戻り値

object ・・・対象となる FileDialogFilters オブジェクトを指定します。
description ・・・ダイアログボックスのフィルタの一覧に追加するファイル名拡張子を説明するテキストを指定します。
　　（例）description:=”テキストファイル”
extensios ・・・ダイアログボックスのフィルタの一覧に追加するファイル名の拡張子を表すテキストを指定します。複数の拡張子を指定する場合は、セミコロンで区切ります。
　　（例）extensions:=”*.txt;*.csv”
position ・・・ダイアログボックスのフィルタの一覧に挿入する位置を表す数値を指定します。新しいフィルタは、この位置にあるフィルタの直前に挿入されます。省略すると、フィルタの一覧の末尾に追加されます。
戻り値・・・新しく追加されたファイルフィルタを表す FileDialogFilter オブジェクト。

Clear メソッド

「ファイル」ダイアログボックスに現在適用されているすべてのファイルフィルタを削除します。

【書式】

object.Clear

引数・戻り値

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

Item メソッド

指定した FileDialogFilters コレクションのメンバーである FileDialogFilter オブジェクトを取得します。

【書式】

＜取得＞
object.Item ( index )

引数・戻り値

object ・・・対象となる FileDialogFilters オブジェクトを指定します。
index ・・・ダイアログボックスのファイルフィルタの一覧の位置を表す数値を指定します。
戻り値・・・ダイアログボックスに表示される、引数 index で指定した位置にあるファイルフィルタ（FileDialogFilter オブジェクト）。

FileDialogFilter オブジェクト

ファイル（「ファイルの参照」「フォルダの参照」「ファイルを開く」「名前を付けて保存」）のダイアログボックスに表示されるファイルフィルタを表します。FileDialogFilter オブジェクトを取得するには、FileDialogFilters コレクションに Item メソッドを使用します。

【書式】

＜取得＞
object.Item ( index )

引数・戻り値

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

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

Description プロパティ

ファイルダイアログボックスに表示されるファイルフィルタの説明を取得します。読み取り専用です。

【書式】

＜取得＞
object.Description

引数・戻り値

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

Extensions プロパティ

ファイルダイアログボックスに表示されるファイルフィルタの拡張子を取得します。読み取り専用です。

【書式】

＜取得＞
object.Extensions

引数・戻り値

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

FileDialogFilter オブジェクト・FileDialogFilters コレクション使用例

サンプルVBAソース

　
Sub Sample_FileDialogFilters()

    Dim i As Long
    
    'ファイルを開くダイアログボックス
    With Application.FileDialog(msoFileDialogOpen)
    
        'ダイアログボックスを表示
        .Show
        
        For i = 1 To .Filters.Count
            
            'ダイアログボックスに表示されるファイルフィルタ一覧を表示
            With .Filters.Item(i)
            
                Cells(i, 1) = .Description
                Cells(i, 2) = .Extensions
            
            End With
        
        Next i
    
        Columns("A:B").AutoFit
    
    End With
    
End Sub