Export (0) Print
Expand All

FileDialog.FilterIndex Property

Gets or sets the index of the filter currently selected in the file dialog box.

[Visual Basic]
Public Property FilterIndex As Integer
[C#]
public int FilterIndex {get; set;}
[C++]
public: __property int get_FilterIndex();
public: __property void set_FilterIndex(int);
[JScript]
public function get FilterIndex() : int;
public function set FilterIndex(int);

Property Value

A value containing the index of the filter currently selected in the file dialog box. The default value is 1.

Remarks

Use the FilterIndex property to set which filtering option is shown first to the user. You can also use the value of FilterIndex after showing the file dialog to perform special file operations depending upon the filter chosen.

Note   The index value of the first filter entry is 1.

Example

[Visual Basic, C#, C++] The following example uses the OpenFileDialog implementation of FileDialog and illustrates creating, setting of properties, and showing the dialog box. The example uses the Filter and FilterIndex properties to provide a list of filters for the user. The example assumes a form with a Button placed on it and the System.IO namespace added to it.

[Visual Basic] 
Protected Sub button1_Click(sender As Object, e As System.EventArgs)
    Dim myStream As Stream
    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() = DialogResult.OK Then
        myStream = openFileDialog1.OpenFile()
        If Not (myStream Is Nothing) Then
            ' Insert code to read the stream here.
            myStream.Close()
        End If
    End If
End Sub


[C#] 
protected void button1_Click(object sender, System.EventArgs e)
{
    Stream myStream;
    OpenFileDialog openFileDialog1 = new OpenFileDialog();

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

    if(openFileDialog1.ShowDialog() == DialogResult.OK)
    {
        if((myStream = openFileDialog1.OpenFile())!= null)
        {
            // Insert code to read the stream here.
            myStream.Close();
        }
    }
}


[C++] 
protected:
 void button1_Click(Object* /*sender*/, System::EventArgs* /*e*/)
 {
     Stream* myStream;
     OpenFileDialog* openFileDialog1 = new OpenFileDialog();
 
     openFileDialog1->InitialDirectory = S"c:\\" ;
     openFileDialog1->Filter = S"txt files (*.txt)|*.txt|All files (*.*)|*.*" ;
     openFileDialog1->FilterIndex = 2 ;
     openFileDialog1->RestoreDirectory = true ;
 
     if(openFileDialog1->ShowDialog() == DialogResult::OK)
     {
         if((myStream = openFileDialog1->OpenFile())!= 0)
         {
             // Insert code to read the stream here.
             myStream->Close();
         }
     }
 }
 

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

FileDialog Class | FileDialog Members | System.Windows.Forms Namespace | CheckFileExists | Filter

Show:
© 2014 Microsoft