FileDialog.FilterIndex FileDialog.FilterIndex FileDialog.FilterIndex FileDialog.FilterIndex Property

定義

ファイル ダイアログ ボックスで現在選択されているフィルターのインデックスを取得または設定します。Gets or sets the index of the filter currently selected in the file dialog box.

public:
 property int FilterIndex { int get(); void set(int value); };
public int FilterIndex { get; set; }
member this.FilterIndex : int with get, set
Public Property FilterIndex As Integer

プロパティ値

ファイル ダイアログ ボックスで現在選択されているフィルターのインデックスを含む値。A value containing the index of the filter currently selected in the file dialog box. 既定値は 1 です。The default value is 1.

次のコード例ではOpenFileDialog 、のFileDialog実装を使用して、プロパティの作成、設定、およびダイアログボックスの表示について説明します。The following code example uses the OpenFileDialog implementation of FileDialog and illustrates creating, setting of properties, and showing the dialog box. この例ではFilterFilterIndexプロパティとプロパティを使用して、ユーザーのフィルターの一覧を指定します。The example uses the Filter and FilterIndex properties to provide a list of filters for the user. この例では、がButton配置されたフォームSystem.IOと、それに追加された名前空間が必要です。The example requires a form with a Button placed on it and the System.IO namespace added to it.

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

注釈

FilterIndexプロパティを使用して、ユーザーに対して最初に表示されるフィルター処理オプションを設定します。Use the FilterIndex property to set which filtering option is shown first to the user. また、[ファイル] ダイアログをFilterIndex表示した後にの値を使用して、選択したフィルターに応じて特別なファイル操作を実行することもできます。You can also use the value of FilterIndex after showing the file dialog to perform special file operations depending upon the filter chosen.

注意

最初のフィルターエントリのインデックス値は1です。The index value of the first filter entry is 1.

適用対象

こちらもご覧ください