FileDialog.Filter プロパティ

定義

名前空間:

System.Windows.Forms

アセンブリ:

System.Windows.Forms.dll

ダイアログ ボックスの [保存先ファイルの種類] または [ファイルの種類] ボックスに表示される選択肢を決定する、現在のファイル名のフィルター文字列を取得または設定します。

public:
 property System::String ^ Filter { System::String ^ get(); void set(System::String ^ value); };

public string Filter { get; set; }

member this.Filter : string with get, set

Public Property Filter As String

プロパティ値

String

ダイアログ ボックスで使用できるファイル フィルター処理オプション。

例外

ArgumentException

Filter の形式が無効です。

例

次のコード例では、 OpenFileDialog プロパティの FileDialog 作成、設定、ダイアログ ボックスの表示の実装と説明を使用します。 この例では、プロパティとFilterIndexプロパティをFilter使用して、ユーザーのフィルターの一覧を提供します。 この例では、フォーム Button に配置され、名前空間が System.IO 追加されている必要があります。

private:
   void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      Stream^ myStream;
      OpenFileDialog^ openFileDialog1 = gcnew OpenFileDialog;

      openFileDialog1->InitialDirectory = "c:\\";
      openFileDialog1->Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*";
      openFileDialog1->FilterIndex = 2;
      openFileDialog1->RestoreDirectory = true;

      if ( openFileDialog1->ShowDialog() == System::Windows::Forms::DialogResult::OK )
      {
         if ( (myStream = openFileDialog1->OpenFile()) != nullptr )
         {
            // Insert code to read the stream here.
            myStream->Close();
         }
      }
   }

var fileContent = string.Empty;
var filePath = string.Empty;

using (OpenFileDialog openFileDialog = new OpenFileDialog())
{
    openFileDialog.InitialDirectory = "c:\\";
    openFileDialog.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*";
    openFileDialog.FilterIndex = 2;
    openFileDialog.RestoreDirectory = true;

    if (openFileDialog.ShowDialog() == DialogResult.OK)
    {
        //Get the path of specified file
        filePath = openFileDialog.FileName;

        //Read the contents of the file into a stream
        var fileStream = openFileDialog.OpenFile();

        using (StreamReader reader = new StreamReader(fileStream))
        {
            fileContent = reader.ReadToEnd();
        }
    }
}

MessageBox.Show(fileContent, "File Content at path: " + filePath, MessageBoxButtons.OK);

Private Sub button1_Click(ByVal sender As Object, ByVal e As System.EventArgs)
    Dim myStream As Stream = Nothing
    Dim openFileDialog1 As New OpenFileDialog()

    openFileDialog1.InitialDirectory = "c:\"
    openFileDialog1.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*"
    openFileDialog1.FilterIndex = 2
    openFileDialog1.RestoreDirectory = True

    If openFileDialog1.ShowDialog() = System.Windows.Forms.DialogResult.OK Then
        Try
            myStream = openFileDialog1.OpenFile()
            If (myStream IsNot Nothing) Then
                ' Insert code to read the stream here.
            End If
        Catch Ex As Exception
            MessageBox.Show("Cannot read file from disk. Original error: " & Ex.Message)
        Finally
            ' Check this again, since we need to make sure we didn't throw an exception on open.
            If (myStream IsNot Nothing) Then
                myStream.Close()
            End If
        End Try
    End If
End Sub

注釈

フィルターオプションごとに、フィルター文字列にはフィルターの説明が含まれており、その後に垂直バー (|) とフィルター パターンが続きます。 異なるフィルター オプションの文字列は、縦棒で区切ります。

フィルター文字列の例を次に示します。

Text files (*.txt)|*.txt|All files (*.*)|*.*

ファイルの種類をセミコロンで区切ることで、フィルターにいくつかのフィルター パターンを追加できます。

Image Files(*.BMP;*.JPG;*.GIF)|*.BMP;*.JPG;*.GIF|All files (*.*)|*.*

このプロパティを FilterIndex 使用して、ユーザーに最初に表示されるフィルター オプションを設定します。

こちらもご覧ください

• CheckFileExists
• FilterIndex