Home > Articles

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

Custom Exceptions

Implement error handling in the UI: Create and implement custom error messages.

Implement error handling in the UI: Create and implement custom error handlers.

TIP

Use ApplicationException As Base Class for Custom Exceptions Although you can derive directly from the Exception class, Microsoft recommends that you derive any custom exception class you create for your Windows application from the ApplicationException class.

In most cases, .NET's built-in exception classes, combined with custom messages that you create when instantiating a new exception, will suffice your exception handling requirements. However, in some cases you need exception types specific to the problem you are solving.

The .NET Framework allows you to define custom exception classes. To make your custom Exception class work well with the .NET exception handling framework, Microsoft recommends that you consider the following when you're designing a custom exception class:

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

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

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

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

    Public Class MyOwnCustomException
      Inherits ApplicationException
    
      ' Default constructor
      Public Sub New()
    
      End Sub
    
      ' Constructor accepting a single string message
      Public Sub New(ByVal message As String)
        MyBase.New(message)
      End Sub
    
      ' Constructor accepting a string message 
      ' and an inner exception 
      ' that will be wrapped by this custom exception class
      Public Sub New(ByVal message As String, _
       ByVal inner As Exception)
        MyBase.new(message, inner)
      End Sub
    
    End Class

Step By Step 3.4 shows how to create a custom exception.

STEP BY STEP 3.4 Creating a Custom Exception

  1. Add a new Windows Form to your Visual Basic .NET project.

  2. Place two Label controls, a TextBox control named txtDate, and a Button control named btnIsLeap on the form. Figure 3.6 shows a design for this form. Name the empty Label control lblResults.

Figure 3.6 Leap Year Finder.

  1. Add a new class to your project. Add code to create a custom exception class:

    Public Class MyOwnInvalidDateFormatException
      Inherits ApplicationException
    
      ' Default constructor
      Public Sub New()
    
      End Sub
    
      ' Constructor accepting a single string message
      Public Sub New(ByVal message As String)
        MyBase.New(message)
        Me.HelpLink = _
         "file://MyOwnInvalidDateFormatExceptionHelp.htm"
      End Sub
    
      ' Constructor accepting a string 
      ' message and an inner exception 
      ' that will be wrapped by this custom exception class
      Public Sub New(ByVal message As String, _
       ByVal inner As Exception)
        MyBase.new(message, inner)
        Me.HelpLink = _
         "file://MyOwnInvalidDateFormatExceptionHelp.htm"
      End Sub
    

    End Class

  2. Add a second new class to your project. Add code to create a class named LeapDate:

    Public Class LeapDate
      ' This class does elementary date handling for the
      ' leap year form
      Private day, month, year As Integer
    
      Public Sub New(ByVal strDate As String)
        If strDate.Trim().Length = 10 Then
          ' Input data might be in invalid 
          ' format; in that case
          ' the Convert.ToDateTime method will fail
          Try
            Dim dt As DateTime = _
             Convert.ToDateTime(strDate)
            day = dt.Day
            month = dt.Month
            year = dt.Year
            ' Catch any exception, attach 
            ' it to the custom exception and
            ' throw the custom exception
          Catch e As Exception
            Throw New MyOwnInvalidDateFormatException( _
             "Custom Exception: Invalid Date Format", e)
          End Try
        Else
          ' bad input, throw a custom exception
          Throw New MyOwnInvalidDateFormatException( _
           "The input does not match the required " & _
           "format: MM/DD/YYYY")
        End If
      End Sub
    
      ' Find if the given date belongs to a leap year
      Public Function IsLeapYear() As Boolean
        IsLeapYear = (year Mod 4 = 0) And _
         ((year Mod 100 <> 0) Or (year Mod 400 = 0))
      End Function
    End Class
  3. Add the following event handler for the Click event of btnIsLeap:

    Private Sub btnIsLeap_Click(ByVal sender As System.Object, _
     ByVal e As System.EventArgs) Handles btnIsLeap.Click
      Try
        Dim dt As LeapDate = New LeapDate(txtDate.Text)
        If dt.IsLeapYear() Then
          lblResult.Text = "This date is in a leap year"
        Else
          lblResult.Text = _
           "This date is NOT in a leap year"
        End If
        ' Catch the custom exception and 
        ' display an appropriate message
      Catch dte As MyOwnInvalidDateFormatException
        Dim msg As String
        ' If some other exception was also 
        ' attached with this exception
        If Not dte.InnerException Is Nothing Then
          msg = String.Format( _
           "Message:" & vbCrLf & "{0}" & _
           vbCrLf & vbCrLf & "Inner Exception:" & _
           vbCrLf & "{1}", _
           dte.Message, dte.InnerException.Message)
        Else
          msg = String.Format("Message:" & _
           vbCrLf & "{0}" & _
           vbCrLf & vbCrLf & _
           "Help Link:" & vbCrLf & "{1}", _
           dte.Message, dte.HelpLink)
        End If
        MessageBox.Show(msg, dte.GetType().ToString())
      End Try
    End Sub
  4. Set the form as the startup object for the project.

  5. Run the project. Enter a date and click the button. If the date was in the correct format, you'll see a result displayed in the Results label. Otherwise, you'll get a message box showing the custom error message thrown by the custom exception, as shown in Figure 3.7.

Figure 3.7 Custom error message thrown by the custom exception.

In Guided Practice Exercise 3.1 you'll create a custom defined Exception class that helps implement custom error messages and custom error handling in your programs.

GUIDED PRACTICE EXERCISE 3.1

Your goal is to create a keyword-searching application. The application should ask for a filename and a keyword and search for the keyword in the file. The application should then display the number of lines that contain the keyword. The application assumes that the entered keyword will be a single word. If not, you must create and throw a custom exception for that case.

Try this on your own first. If you get stuck or would like to see one possible solution, follow these steps:

  1. Add a new form to your Visual Basic .NET Project.

  2. Place three Label controls, two TextBox controls, and two Button controls on the form, arranged as shown in Figure 3.8. Name the TextBox for accepting filenames txtFileName and the Browse button btnBrowse. Name the TextBox for accepting keywords txtKeyword and the search button btnSearch. Name the results label lblResult.

Figure 3.8 Form allowing a keyword search in a file.

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

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

    Public Class BadKeywordFormatException
      Inherits ApplicationException
    
      ' Default constructor
      Public Sub New()
    
      End Sub
    
      ' Constructor accepting a single string message
      Public Sub New(ByVal message As String)
        MyBase.New(message)
      End Sub
    
      ' Constructor accepting a string 
      ' message and an inner exception 
      ' that will be wrapped by this custom exception class
      Public Sub New(ByVal message As String, _
       ByVal inner As Exception)
        MyBase.new(message, inner)
      End Sub
    
    End Class
  3. Create a method named GetKeywordFrequency in the form's module. This class accepts a filename and returns the number of lines containing the keyword. Add the following code to the method:

    Private Function GetKeywordFrequency( _
     ByVal strPath As String) As Integer
      If Me.txtKeyword.Text.Trim().IndexOf(" ") >= 0 Then
        Throw New BadKeywordFormatException( _
         "The keyword must only have a single word")
      End If
    
      Dim count As Integer = 0
      If File.Exists(strPath) Then
        Dim sr As StreamReader = _
         New StreamReader(txtFileName.Text)
        Do While (sr.Peek() > -1)
          If sr.ReadLine().IndexOf(txtKeyword. _
           Text) >= 0 Then
            count += 1
          End If
        Loop
      End If
      GetKeywordFrequency = count
    End Function
  4. Add the following code to the Click event handler of the btnBrowse button:

    Private Sub btnBrowse_Click(ByVal sender As System.Object, _
     ByVal e As System.EventArgs) Handles btnBrowse.Click
      If dlgOpenFile.ShowDialog() = DialogResult.OK Then
        txtFileName.Text = dlgOpenFile.FileName
      End If
    End Sub
  5. Add the following code to the Click event handler of the btnSearch Button:

    Private Sub btnSearch_Click(ByVal sender As System.Object, _
     ByVal e As System.EventArgs) Handles btnSearch.Click
      If txtKeyword.Text.Trim().Length = 0 Then
        MessageBox.Show( _
         "Please enter a keyword to search", _
         "Missing Keyword")
        Exit Sub
      End If
      Try
      lblResult.Text = String.Format("The keyword: '{0}'" & _
       "was found in {1} lines", _
         txtKeyword.Text, _
         GetKeywordFrequency(txtFileName.Text))
      Catch bkfe As BadKeywordFormatException
        Dim msg As String = _
         String.Format("Message:" & vbCrLf & _
         "{0}" & vbCrLf & vbCrLf & "StackTrace:" & _
         vbCrLf & "{1}", _
         bkfe.Message, bkfe.StackTrace)
        MessageBox.Show(msg, bkfe.GetType().ToString())
      End Try
    End Sub
  6. Set the form as the startup object for the project.

  7. Run the project. Click the Browse button and select an existing file. Enter a keyword to search for in the file and press the Search button. If the keyword entered is in wrong format (contains a space) then the custom exception will be raised.

  • + 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