Home > Articles

  • Print
  • + Share This
This chapter is from the book

Creating and Using Custom Exceptions

Implement error handling in the user interface.

  • Create and implement custom error messages.

  • Create and implement custom error handlers.

  • Raise and handle errors.

The exception classes provided by the .NET Framework, combined with the custom messages created when you create a new Exception object to throw or rethrow exceptions, should suffice for most of your exception handling requirements. In some cases, however, you might need exception types that are specific to the problem you are solving.

TIP

Using ApplicationException as a Base Class for Custom Exceptions Although you can derive custom exception classes directly from the Exception class, Microsoft recommends that you derive custom exception classes from the ApplicationException class.

The .NET Framework allows you to define custom exception classes. To keep your custom-defined Exception class homogeneous with the .NET exception framework, Microsoft recommends that you consider the following when you design a custom exception class:

  • Create an exception class only if there is no existing exception class that satisfies your requirement.

  • Derive all programmer-defined exception classes from the System.ApplicationException class.

  • End the name of your custom exception class with the word Exception (for example, MyOwnCustomException).

  • Implement three constructors with the signatures shown in the following code:

    public class MyOwnCustomException :
      ApplicationException
    {
      // Default constructor
      public MyOwnCustomException ()
      {
      }
      // Constructor accepting a single string message
      public MyOwnCustomException (string message) :
        base(message)
      {
      }
      // Constructor accepting a string message and an
      // inner exception that will be wrapped
      // by this custom exception class
      public MyOwnCustomException(string message,
       Exception inner) : base(message, inner)
      {
      }
    }

Step by Step 3.4 shows you how to create a custom exception.

STEP BY STEP 3.4 - Creating and Using a Custom Exception

  1. Add a new Windows form to the project. Name it StepByStep3_4.

  2. Place and arrange controls on the form as shown in Figure 3.6. Name the TextBox control txtDate, the Button control btnIsLeap, and the Label control inside the Results panel lblResult.

Figure 3.6Figure 3.6 The leap year finder implements a custom exception for an invalid date format.

  1. Switch to the code view and add the following definition for the MyOwnInvalidDateFormatException class to the end of the class definition for project StepByStep3_4:

    // You can create your own exception classes by
    // deriving from the ApplicationException class.
    // It is good coding practice to end the class name
    // of the custom exception with the word "Exception"
    public class MyOwnInvalidDateFormatException :
      ApplicationException
    {
      // It is a good practice to implement the three
      // recommended common constructors as shown here.
      public MyOwnInvalidDateFormatException()
      {
      }
      public MyOwnInvalidDateFormatException(
        string message): base(message)
      {
        this.HelpLink =
       "file://MyOwnInvalidDateFormatExceptionHelp.htm";
      }
      public MyOwnInvalidDateFormatException(
       string message, Exception inner) :
       base(message, inner)
      {
      }

    }

  2. Add the following definition for the Date class:

    //This class does elementary date handling required
    //for this program
    public class Date
    {
      private int day, month, year;
    
      public Date(string strDate)
      {
        if (strDate.Trim().Length == 10)
        {
          //Input data might be in an invalid format
          //In which case, Convert.ToDateTime()
          // method will fail
          try
          {
            DateTime dt =
              Convert.ToDateTime(strDate);
            day = dt.Day;
            month = dt.Month;
            year = dt.Year;
          }
          //Catch the exception, attach that to the
          //custom exception and
          //throw the custom exception
          catch(Exception e)
          {
            throw new
             MyOwnInvalidDateFormatException(
             "Custom Exception Says: " +
             "Invalid Date Format", e);
          }
        }
        else
          //Throw the custom exception
          throw new MyOwnInvalidDateFormatException(
            "The input does not match the " +
            "required format: MM/DD/YYYY");
      }
    
      //Find if the given date belongs to a leap year
      public bool IsLeapYear()
      {
        return (year%4==0) && ((year %100 !=0) ||
          (year %400 ==0));
      }

    }

  3. Add the following event handler for the Click event of btnIsLeap:

    private void btnIsLeap_Click(
       object sender, System.EventArgs e)
    {
      try
      {
        Date dt = new Date(txtDate.Text);
        if (dt.IsLeapYear())
          lblResult.Text =
            "This date is in a leap year";
        else
          lblResult.Text =
            "This date is NOT in a leap year";
      }
      //Catch the custom exception and
      //display an appropriate message
      catch (MyOwnInvalidDateFormatException dte)
      {
        string msg;
        //If some other exception was also
        //attached with this exception
        if (dte.InnerException != null)
         msg = String.Format(
         "Message:\n {0}\n\n Inner Exception:\n {1}",
         dte.Message, dte.InnerException.Message);
        else
          msg = String.Format(
            "Message:\n {0}\n\n Help Link:\n {1}",
            dte.Message, dte.HelpLink);
    
        MessageBox.Show(msg, dte.GetType().ToString());
      }

    }

  4. Insert a Main() method to launch the form. Set the form as the startup object for the project.

  5. Run the project. Enter a date and click the button. If the date you enter is in the required format, you see a result displayed in the Results group box; otherwise, you get a message box showing the custom error message thrown by the custom exception, as in Figure 3.7.

Figure 3.7Figure 3.7 You can associate a customized error message and a help link with a custom exception.

Guided Practice Exercise 3.1

You are a Windows developer for a data analysis company. For one of your applications you need to create a keyword searching form that asks for a filename and a keyword from the user (as shown in Figure 3.8). The form should search for the keyword in the file and display the number of lines that contain the keyword in the results group box. Your form assumes that the entered keyword is a single word. If it is not a single word, you need to create and throw a custom exception for that case.

Figure 3.8Figure 3.8 The keyword searching form throws a custom exception if the input is not in the required format.

How would you throw a custom exception to implement custom error messages and custom error handling in your program?

You should try working through this problem on your own first. If you get stuck, or if you'd like to see one possible solution, follow these steps:

  1. Add a new form to your Visual C# .NET project. Name the form GuidedPracticeExercise3_1.cs.

  2. Place and arrange controls on the form as shown in Figure 3.8. Name the TextBox control for accepting the filename txtFileName and the Browse control btnBrowse. Set the ReadOnly property of txtFileName to true. Name the TextBox control for accepting the keyword txtKeyword and the Button control btnSearch. Set the tab order of the form in the correct order, to ensure that the user's cursor is not placed in the read-only text box when the application starts.

  3. Add an OpenFileDialog control to the form and change its name to dlgOpenFile.

  4. Create a new class named BadKeywordFormatException that derives from ApplicationException and place the following code in it:

    public class BadKeywordFormatException :
      ApplicationException
    {
      public BadKeywordFormatException()
      {
      }
      public BadKeywordFormatException(string message):
        base(message)
      {
      }
      public BadKeywordFormatException(string message,
        Exception inner): base(message, inner)
      {
      }
    }
  5. Create a method named GetKeywordFrequency() in the GuidedPracticeExercise3_1 class. This method should accept a string and return the number of lines that contain the string. Add the following code to the method:

    private int GetKeywordFrequency(string path)
    {
      if(this.txtKeyword.Text.Trim().IndexOf(' ') >= 0)
        throw new BadKeywordFormatException(
         "The keyword must only have a single word");
    
      int count = 0;
      if (File.Exists(path))
      {
        StreamReader sr =
          new StreamReader(txtFileName.Text);
        while (sr.Peek() > -1)
         if (sr.ReadLine().IndexOf(txtKeyword.Text)
          >= 0)
            count++;
      }
      return count;
    }
  6. Add the following code to the Click event handler of btnBrowse:

    private void btnBrowse_Click(
      object sender, System.EventArgs e)
    {
      if (dlgOpenFile.ShowDialog() == DialogResult.OK)
        txtFileName.Text = dlgOpenFile.FileName;
    }
  7. Add the following code to the Click event handler of btnSearch:

    private void btnSearch_Click(
      object sender, System.EventArgs e)
    {
      if (txtKeyword.Text.Trim().Length == 0)
      {
        MessageBox.Show(
          "Please enter a keyword to search for",
          "Missing Keyword");
        return;
      }
      try
      {
        lblResult.Text = String.Format(
         "The keyword: '{0}', was found in {1} lines",
         txtKeyword.Text,
         GetKeywordFrequency(txtFileName.Text));
      }
      catch(BadKeywordFormatException bkfe)
      {
        string msg = String.Format(
          "Message:\n {0}\n\n StackTrace:\n{1}",
          bkfe.Message, bkfe.StackTrace);
        MessageBox.Show(msg, bkfe.GetType().ToString());
      }
    }
  8. Insert the Main() method to launch the form GuidedPracticeExercise3_1.cs. Set the form as the startup object for the project.

  9. Run the project. Click the Browse button and select an existing file. Enter the keyword to search for in the file and click the Search button. If the keyword entered is in the wrong format (for example, if it contains two words), the custom exception is raised.

If you have difficulty following this exercise, review the sections "Handling Exceptions" and "Creating and Using Custom Exceptions" earlier in this chapter. After reviewing, try this exercise again.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020