Home

File Information

 

Introduction

In its high level of support for file processing, the .NET Framework provides the FileInfo class. This class is equipped to handle all types of file-related operations including creating, copying, moving, renaming, or deleting a file. FileInfo is based on the FileSystemInfo class that provides information on characteristics of a file.

 

Practical LearningPractical Learning: Introducing File Information

  1. Start a new Windows Application
  2. Set the name to WattsALoan1
  3. In the Properties window, change the form's Text to Watts A Loan
  4. To be able to use the Visual Basic library, in the Solution Explorer, right-click WattsALoan1 and click Add Reference...
  5. In the .NET property page, click Microsoft.VisualBasic
     
  6. Click OK
  7. Design the form as follows:
     
    Control Name Text
    Label   Acnt #:
    Label   Customer Name:
    Label   Customer:
    TextBox txtAccountNumber  
    TextBox txtCustomerName  
    Label   Empl #:
    Label   Employee Name:
    Label   Prepared By:
    TextBox txtEmployeeNumber  
    TextBox txtEmployeeName  
    Button btnNewEmployee  
    Label   Loan Amount:
    TextBox txtLoanAmount  
    Label   Interest Rate:
    TextBox txtInterestRate  
    Label   %
    Label   Periods
    TextBox   txtPeriods
    Button btnCalculate Calculate
    Label   Monthly Payment:
    TextBox txtMonthlyPayment  
    Button btnClose Close
  8. Double-click the Calculate button and implement its event as follows:
     
    private void btnCalculate_Click(object sender, EventArgs e)
    {
        double LoanAmount = 0.00D,
               InterestRate = 0.00D,
               Periods = 0.00D,
               MonthlyPayment = 0.00D;
    
        try
        {
            LoanAmount = double.Parse(txtLoanAmount.Text);
        }
        catch (FormatException)
        {
            MessageBox.Show("Invalid Loan Amount");
        }
    
        try
        {
            InterestRate = double.Parse(txtInterestRate.Text);
        }
        catch (FormatException)
        {
            MessageBox.Show("Invalid Interest Rate");
        }
    
        try
        {
            Periods = double.Parse(txtPeriods.Text);
        }
        catch (FormatException)
        {
            MessageBox.Show("Invalid Periods Value");
        }
    
        try
        {
            MonthlyPayment =
                  Microsoft.VisualBasic.Financial.Pmt(InterestRate/12/100,
                                                       Periods,
                                       -LoanAmount,
                                       0,
                           Microsoft.VisualBasic.DueDate.BegOfPeriod);
            txtMonthlyPayment.Text = MonthlyPayment.ToString("F");
        }
        catch (FormatException)
        {
            MessageBox.Show("Invalid Periods Value");
        }
    }   
  9. Return to the form and double-click the Close button to implement its event as follows:
     
    private void btnClose_Click(object sender, EventArgs e)
    {
        Close();
    }
  10. Return to the form

File Initialization

The FileInfo class is equipped with one constructor whose syntax is:

public FileInfo(String fileName);

This constructor takes as argument the name of a file or its complete path. If you provide only the name of the file, the compiler would consider the same directory of its project. Here is an example:

public partial class Exercise : Form
{
    private void btnSave_Click(object sender, EventArgs e)
    {
        FileInfo flePeople = new FileInfo("People.txt");
    }
}

Alternatively, if you want, you can provide any valid directory you have access to. In this case, you should provide the complete path.

Practical LearningPractical Learning: Initializing a File

  1. Double-click an unoccupied area on the body form
  2. Scroll up completely and, under the other using lines, type using System.IO;
  3. Scroll down complement and change the Load event of the form as follows:
     
    private void Form1_Load(object sender, EventArgs e)
    {
                string  strFilename = "Employees.wal";
    	 FileInfo  fiEmployees = new FileInfo(strFilename);
    }
  4. Save the file

File Creation

The FileInfo constructor is mostly meant only to indicate that you want to use a file, whether it exists already or it would be created. Based on this, if you execute an application that has only a FileInfo object created using the constructor as done above, nothing would happen.

To create a file, you have various alternatives. If you want to create one without writing anything in it, which implies creating an empty file, you can call the FileInfo.Create() method. Its syntax is:

public FileStream Create();

This method simply creates an empty file. Here is an example of calling it:

private void btnSave_Click(object sender, EventArgs e)
{
    FileInfo flePeople = new FileInfo("People.txt");
    flePeople.Create();
}

The FileInfo.Create() method returns a FileStream object. You can use this returned value to write any type of value into the file, including text. If you want to create a file that contains text, an alternative is to call the FileInfo.CreateText() method. Its syntax is:

public StreamWriter CreateText();

This method returns a StreamWriter object. You can use this returned object to write text to the file.

File Existence

When you call the FileInfo.Create() or the FileInfo.CreateText() method, if the file passed as argument, or as the file in the path of the argument, exists already, it would be deleted and a new one would be created with the same name. This can cause the right file to be deleted. Therefore, before creating a file, you may need to check whether it exists already. To do this, you can check the value of the Boolean FileInfo.Exists property. This property holds a true value if the file exists already and it holds a false value if the file doesn't exist or it doesn't exist in the path.

Practical LearningPractical Learning: Creating a Text File

  1. Change the Load event of the form as follows:
     
    private void Form1_Load(object sender, EventArgs e)
    {
        string  strFilename = "Employees.wal";
        FileInfo fiEmployees = new FileInfo(strFilename);
    
        // If the employees file was not created already,
        // then create it
        if (!fiEmployees.Exists)
        {
            StreamWriter stwEmployees = fiEmployees.CreateText();
        }
    }  
  2. Save the file

Writing to a File

As mentioned earlier, the FileInfo.Create() method returns a FileStream object. You can use this to specify the type of operation that would be allowed on the file.

To write normal text to a file, you can first call the FileInfo.CreateText() method. This method returns a StreamWriter object. The StreamWriter class is based on the TextWriter class that is equipped with the Write() and the WriteLine() methods used to write values to a file. The Write() method writes text on a line and keeps the caret on the same line. The WriteLine() method writes a line of text and moves the caret to the next line.

After writing to a file, you should close the StreamWriter object to free the resources it was using during its operation(s). Here is an example:

private void btnSave_Click(object sender, EventArgs e)
{
    FileInfo flePeople = new FileInfo("People.txt");
    StreamWriter stwPeople = flePeople.CreateText();

    try
    {
        stwPeople.WriteLine(txtPerson1.Text);
        stwPeople.WriteLine(txtPerson2.Text);
        stwPeople.WriteLine(txtPerson3.Text);
        stwPeople.WriteLine(txtPerson4.Text);
    }
    finally
    {
        stwPeople.Close();

        txtPerson1.Text = "";
        txtPerson2.Text = "";
        txtPerson3.Text = "";
        txtPerson4.Text = "";
    }
}

Practical LearningPractical Learning: Writing to a Text File

  1. Change the Load event of the form as follows:
     
    private void Form1_Load(object sender, EventArgs e)
    {
        string  strFilename = "Employees.wal";
        FileInfo fiEmployees = new FileInfo(strFilename);
    
        // If the employees file was not created already,
        // then create it
        if (!fiEmployees.Exists)
        {
            StreamWriter stwEmployees = fiEmployees.CreateText();
    
            // And create a John Doe employee
    	try {
    	    stwEmployees.WriteLine("00-000");
    	    stwEmployees.WriteLine("John Doe");
    	}
    	finally
    	{
    	    stwEmployees.Close();
    	}
        }
    }   
  2. Save the file

Appending to a File

You may have created a text-based file and written to it. If you open such a file and find out that a piece of information is missing, you can add that information to the end of the file. To do this, you can call the FileInfo.AppenText() method. Its syntax is:

public StreamWriter AppendText();

When calling this method, you can retrieve the StreamWriter object that it returns, then use that object to add new information to the file.

Practical LearningPractical Learning: Writing to a Text File

  1. To create a new form, on the main menu, click Project -> Add Windows Form...
  2. In the Templates list, make sure Windows Form is selected. Set the Name to NewEmployee and click Add
  3. Design the form as follows:
     
    Control Text Name
    Label Employee #:
    TextBox txtEmployeeNumber
    Label Employee Name:
    TextBox txtEmployeeName
    Button Create btnCreate
    Button Close btnClose
  4. Right-click the form and click View Code
  5. In the top section of the file, under the using using lines, type
    using System.IO;
  6. Return to the New Employee form and double-click the Create button
  7. Implement its event as follows:
     
    private void btnCreate_Click(object sender, EventArgs e)
    {
        string  strFilename = "Employees.wal";
        FileInfo  fiEmployees = new FileInfo(strFilename);
        StreamWriter  stwEmployees = null;
    
        // Normally, we should have the file already but just in case...
        if( !fiEmployees.Exists )
    	 stwEmployees = fiEmployees.CreateText();
        else // If the file exists already, then we will only add to it
    	 stwEmployees= fiEmployees.AppendText();
    				 
        try {
    	 stwEmployees.WriteLine(txtEmployeeNumber.Text);
    	 stwEmployees.WriteLine(txtEmployeeName.Text);
        }
        finally
        {
    	 stwEmployees.Close();
        }
    
        txtEmployeeNumber.Text = "";
        txtEmployeeName.Text = "";
        txtEmployeeNumber.Focus();
    }
  8. Return to the New Employee form and double-click the Close button
  9. Implement its event as follows:
     
    private void btnClose_Click(object sender, EventArgs e)
    {
        Close();
    }
  10. Access the Form1 form
  11. Double-click the top New button and implement the event as follows:
     
    private void btnNewEmployee_Click(object sender, EventArgs e)
    {
        NewEmployee  frmNewEmployee = new NewEmployee();
    
        frmNewEmployee.ShowDialog();
    }
  12. Return to the form
  13. In the combo box on top of the Properties window, select txtEmployeeNumber
  14. On the Properties window, click the Events button and double-click Leave
  15. Implement the event as follows:
     
    private void txtEmployeeNumber_Leave(object sender, EventArgs e)
    {
        string strFilename = "Employees.wal";
        FileInfo fiEmployees = new FileInfo(strFilename);
    
        if (fiEmployees.Exists)
        {
            if (txtEmployeeNumber.Text == "")
            {
                txtEmployeeName.Text = "";
                return;
            }
            else
            {
                StreamReader strEmployees = fiEmployees.OpenText();
                string strEmployeeNumber, strEmployeeName;
                bool found = false;
    
                try
                {
                    using (strEmployees = new StreamReader(strFilename))
                    {
                        while (strEmployees.Peek() >= 0)
                        {
                            strEmployeeNumber = strEmployees.ReadLine();
    
                            if (strEmployeeNumber == txtEmployeeNumber.Text)
                            {
                                strEmployeeName = strEmployees.ReadLine();
                                txtEmployeeName.Text = strEmployeeName;
                                found = true;
                            }
                        }
                    }
    
                    // When the application has finished checking the file
                    // if there was no employee with that number,
    		// let the user know
                    if (found == false)
                    {
                    MessageBox.Show("No employee with that number was found");
                        txtEmployeeName.Text = "";
                        txtEmployeeNumber.Focus();
                    }
                }
                finally
                {
                    strEmployees.Close();
                }
            }
        }
    }
  16. Execute the application to test it
  17. First create a few employees as follows:
     
    Employee # Employee Name
    42-806 Patricia Katts
    75-148 Helene Mukoko
    36-222 Frank Leandro
    42-808 Gertrude Monay
  18. Process a loan
     
    Watts A Loan
  19. Close the application

Reading from a File

As opposed to writing to a file, you can read from it. To support this, the FileInfo class is equipped with a method named OpenText(). Its syntax is:

public StreamREader OpenText();

This method returns a StreamReader object. You can then use this object to read the lines of a text file. Here is an example:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using System.IO;

namespace FileProcessing2
{
    public partial class Exercise : Form
    {
        public Exercise()
        {
            InitializeComponent();
        }

        private void btnSave_Click(object sender, EventArgs e)
        {
            FileInfo flePeople = new FileInfo("People.txt");
            StreamWriter stwPeople = flePeople.CreateText();

            try
            {
                stwPeople.WriteLine(txtPerson1.Text);
                stwPeople.WriteLine(txtPerson2.Text);
                stwPeople.WriteLine(txtPerson3.Text);
                stwPeople.WriteLine(txtPerson4.Text);
            }
            finally
            {
                stwPeople.Close();

                txtPerson1.Text = "";
                txtPerson2.Text = "";
                txtPerson3.Text = "";
                txtPerson4.Text = "";
            }
        }

        private void btnOpen_Click(object sender, EventArgs e)
        {
            string Filename = "People.txt";
            FileInfo flePeople = new FileInfo(Filename);
            StreamReader strPeople = flePeople.OpenText();

            if (flePeople.Exists == true)
            {
                try
                {
                    txtPerson1.Text = strPeople.ReadLine();
                    txtPerson2.Text = strPeople.ReadLine();
                    txtPerson3.Text = strPeople.ReadLine();
                    txtPerson4.Text = strPeople.ReadLine();
                }
                finally
                {
                    strPeople.Close();
                }
            }
            else
                MessageBox.Show("There is no file named People.txt " +
                                "in the indicated location");
        }
    }
}
 

Home Copyright © 2007 FunctionX, Inc.