VB.NET Code Package: Email And Web LinkLabels

• Double Text Users: download code package - 2.51 Kb
• Non-Double Text Users: download demo project - 7.58 Kb

Demo project

Message displayed when the web link is broken

Contents

• Introduction
• Background
• Double Text Users
  • Library Overview
  • Unwrapping The Library
  • Using The Library
    • Repeating The Email Sub
    • Adding The Email Sub To Your Project
    • Repeating The Web Sub
    • Adding The Web Sub To Your Project
    • Repeating The WebSiteIsAvailable Function
    • Adding The WebSiteIsAvailable Function To Your Project
• Non-Double Text Users
  • Demo Project Summary
  • lnkEmail_LinkClicked Sub Code
  • lnkWeb_LinkClicked Sub Code
  • WebSiteIsAvailable Function Code
• Points Of Interest
• Conclusion
• Licensing And Limitation Of Liability

Introduction

Use this code to make a VB.NET LinkLabel control work for either email or web links. The email link starts the user's default email program. The web link code checks if the target web site can be reached before starting the user's default browser. If the web site does not respond for any reason, a message is displayed and no attempt is made to display the web site.

The code is available in a package file for Double Text users, as well as in a demo project for non-Double Text users.

Background

Being a long time VB 6 developer, I admit to being excited about VB.NET because of the functionality that the new language makes available. LinkLabel controls are part of that new functionality. When starting my first VB.NET project, I wanted to use LinkLabels in my About window for both email addresses and a link to my web site. Knowing that I would be using LinkLabels in just about every new VB.NET project, I set up the needed code in this Double Text library. With the Email And Web LinkLabels Library in place, I can now add LinkLabels wherever I need them, very quickly.

Double Text Users

Library Overview

The Email And Web LinkLabels (EWL) library consists of three source files (.DbC), and an overview (.DbO). The source file, "Email sub", is the only one needed for email LinkLabels. For web LinkLabels, both the "Web sub" and "WebSiteIsAvailable function" are needed. The source files are set up with the default LinkLabel control names of lnkEmail and lnkWeb.

The EWL source files generate fully commented code that is ready to compile.

• The code is written with Option Strict On.
• The repeated code has been tested multiple times.
• The code is fully commented.
• Region statements can be included or not included, each time each source file is repeated.

Unwrapping The Library

1. Download and unzip the package file. The package file is named Link Labels.DbP.
2. Unwrap the package in Double Text (File | Library Exchange | Unwrap). Save the library in an empty folder.

The library is ready to go. Repeat the code per the following instructions whenever you need a ready to compile copy. (If you don't like the way I've set up the source files, change them in the edit window.)

Using The Library

Before repeating more than one of the source files in this library, turn on the Rollover Responses command on the Options menu in the Double Text main window. With Rollover Responses turned on, you will only have to enter a developer's name once instead for each source file.

The steps in the instructions below apply as written only if you do not change how the source files are set up.

Repeating The Email Sub

Each time you need a copy of this code for an email LinkLabel, follow these steps in Double Text:

1. In the main window, press F12 and browse to the EWL library.
2. Click on the "Email sub" title.
3. In the Region window, click the All button to select both items if you want the region statements included in your code and then click OK. To exclude the region statements, just click OK.
4. For the "Name of email LinkLabel control" prompt, enter the name of the email LinkLabel control and click OK (or press Enter). You can also just press Enter to accept the default name (lnkEmail).
5. For the "Developer's name" prompt, enter your name and click OK (or press Enter). You can also just press Enter to accept the default name (mine). (This prompt may not be displayed if you have Rollover Responses turned on.)

The source code is now on the clipboard. If you would like to review the code, press F4.

Adding The Email Sub To Your Project

After the email code has been repeated, add it to your project.

1. In Visual Studio, open the code view for the form containing the email LinkLabel control.
2. Place the insertion cursor where you want to add the control's LinkClicked sub.
3. Press Ctrl^V.

Repeating The Web Sub

Each time you need a copy of this code for a web LinkLabel, follow these steps in Double Text. (You must also repeat the WebSiteIsAvailable function.)

1. In the main window, press F12 and browse to the EWL library.
2. Click on the "Web sub" title.
3. In the Region window, click the All button to select both items if you want the region statements included in your code and then click OK. To exclude the region statements, just click OK.
4. For the "Name of web site LinkLabel control" prompt, enter the name of the web LinkLabel control and click OK (or press Enter). You can also just press Enter to accept the default name (lnkWeb).
5. For the "Developer's name" prompt, enter your name and click OK (or press Enter). You can also just press Enter to accept the default name (mine). (This prompt may not be displayed if you have Rollover Responses turned on.)

The source code is now on the clipboard. If you would like to review the code, press F4.

Adding The Web Sub To Your Project

After the web code has been repeated, add it to your project.

1. In Visual Studio, open the code view for the form containing the web site LinkLabel control.
2. Place the insertion cursor where you want to add the control's LinkClicked sub.
3. Press Ctrl^V.

Note: When adding the Web sub code to a project, you must also add the supporting WebSiteIsAvailable function.

Repeating The WebSiteIsAvailable Function

Each time you need a copy of this code for a web LinkLabel, follow these steps in Double Text. (Do not repeat the code for this function unless you also repeat the "Web sub.")

1. In the main window, press F12 and browse to the EWL library.
2. Click on the "WebSiteIsAvailable function" title.
3. In the Region window, click the All button to select both items if you want the region statements included in your code and then click OK. To exclude the region statements, just click OK.
4. For the "Developer's name" prompt, enter your name and click OK (or press Enter). You can also just press Enter to accept the default name (mine). (This prompt may not be displayed if you have Rollover Responses turned on.)

The source code is now on the clipboard. If you would like to review the code, press F4.

Adding The WebSiteIsAvailable Function To Your Project

After the function code has been repeated, add it to your project.

1. In Visual Studio, open the code view for the form containing the web site LinkLabel control.
2. Place the insertion cursor where you want to add the WebSiteIsAvailable private function.
3. Press Ctrl^V.

All of the above instructions for using the library are in the library overview. Click on the Float button in the Double Text main window whenever you need a refresher. (If you change any of the source files, don't forget to reflect those changes in the overview.)

Non-Double Text Users

Demo Project Summary

Download and unzip the demo project. Open the solution in Visual Studio. Both sub procedures and the function are in the F_LinkLabels form. The subs are in the "Link Labels" region, and the function is in the "Procedures" region.

When you need this code, use whichever tool you prefer to make a copy of the appropriate sub and function, and then make any needed modifications. You might want to find and change the following either before or after you paste the code into your project in the form containing the LinkLabel control(s).

• If you don't want the Region statements, delete them.
• Change the date the code is added to your project.
• Change the name of the developer.
• Find and replace the name of the LinkLabel control (unless you used the default control name).

lnkEmail_LinkClicked Sub Code

This code opens the user's default email program.

#Region " ... Email "
    Private Sub lnkEmail_LinkClicked(ByVal sender As System.Object, _
            ByVal e As System.Windows.Forms.LinkLabelLinkClickedEventArgs) _
            Handles lnkEmail.LinkClicked
        '------------------------------------------------


        '     Date    Developer            Comments


        '  ---------- -------------------- --------------


        '  12/11/2005 G Gilbert            Original code


        '------------------------------------------------



        '------------------------------------------------


        ' Launch default email application


        '------------------------------------------------


        Dim EmailLink As String
        EmailLink = "mailto:" & _
                    lnkEmail.Text.Substring(e.Link.Start, e.Link.Length)
        System.Diagnostics.Process.Start(EmailLink)

    End Sub
#End Region

lnkWeb_LinkClicked Sub Code

This code tries to get a response from the linked web site before opening the user's default browser. If the linked web site does not respond (for any reason), a message is displayed and no attempt is made to open the browser.

#Region " ... Web Site "
    Private Sub lnkWeb_LinkClicked(ByVal sender As System.Object, _
                ByVal e As System.Windows.Forms.LinkLabelLinkClickedEventArgs) _
                Handles lnkWeb.LinkClicked
        '-------------------------------------------------


        '     Date    Developer            Comments


        '  ---------- -------------------- ---------------


        '  12/11/2005 G Gilbert            Original code


        '-------------------------------------------------



        '-------------------------------------------------


        ' Local Constant/Variable Declarations


        '-------------------------------------------------


        Dim WebSite As String = _
            lnkWeb.Text.Substring(e.Link.Start, e.Link.Length)
        Dim WebURL As String = "http://" & WebSite

        '-------------------------------------------------


        ' Check for a response from the web site


        ' before starting the default web browser


        '-------------------------------------------------


        If WebSiteIsAvailable(WebURL) Then
            System.Diagnostics.Process.Start(WebURL)
        Else
            Dim xMsg As String = "Unable to connect to the site" & _
                                 ControlChars.CrLf & _
                                 WebSite & _
                                 ControlChars.CrLf & ControlChars.CrLf & _
                                 "(Are you connected to the Internet?!?)"
            MessageBox.Show(xMsg, _
                            "No Response", _
                            MessageBoxButtons.OK, _
                            MessageBoxIcon.Exclamation)
        End If

    End Sub
#End Region

WebSiteIsAvailable Function Code

This code attempts to get a response from the passed URL.

#Region " ... WebSiteIsAvailable Function "
    Private Function WebSiteIsAvailable(ByVal linkText As String) As Boolean
        '----------------------------------------------------


        ' Attempt to get a response from the passed URL


        ' Pass:       linkText    URL to site being checked


        ' Return:     True        The site responded


        '             False       The site did not respond


        '----------------------------------------------------


        '     Date    Developer            Code Change


        '  ---------- -------------------- ------------------


        '  12/11/2005 G Gilbert            Original code


        '----------------------------------------------------



        '----------------------------------------------------


        ' Local Constant/Variable Declarations


        '----------------------------------------------------


        Dim URL_Object As New System.Uri(linkText)
        Dim URL_WebRequest As System.Net.WebRequest
        Dim URL_WebResponse As System.Net.WebResponse
        Dim Response_Result As Boolean

        '----------------------------------------------------


        ' Attempt to get a response from the URL


        '----------------------------------------------------


        Try
            URL_WebRequest = System.Net.WebRequest.Create(URL_Object)
            URL_WebResponse = URL_WebRequest.GetResponse
            Response_Result = True
        Catch Any_Error As Exception
            Response_Result = False
        End Try
        URL_WebResponse = Nothing
        URL_WebRequest = Nothing
        URL_Object = Nothing

        '----------------------------------------------------


        ' Return the result


        '----------------------------------------------------


        Return Response_Result

    End Function
#End Region

Points Of Interest

The web link code performed as needed with all four combinations of no Internet connection, a good Internet connection, a valid web site, and a bogus web site. All four possible combinations tested successfully. The email code has only two scenarios ... a default email program and no default email program. I didn't bother to test the latter since Windows ships with IE. That might constitute an invalid assumption, but, if a person has Windows and no email program, what's up with that?

Conclusion

I expect to be using LinkLabels often in my projects. If for nothing else, the About windows will probably have at least one web site link and at least two email links. With the Email And Web LinkLabels Library, adding any number of LinkLabels to my code will be quick and practically effortless.

---

Licensing And Limitation Of Liability

You may use the Double Text library and all code offered in this article any way you choose without restriction.

Under no circumstances, and under no legal theory, tort, contract, or otherwise, will George Gilbert (hereafter referred to as "software author") or his licensors, be liable to the user of the Double Text library and all code offered in this article (hereafter referred to collectively as "article code") for any damages, including any lost profits, lost data, or other indirect, special, incidental or consequential damages, arising out of the use or inability to use the article code, and data or information supplied, even if the software author, his licensors or authorized dealer have been advised of the possibility of such damages, or for any claim by any other party.

You must Sign In to use this message board.

FAQ    Noise Tolerance Very HighHighMediumLowVery Low   Layout Expand Posts & RepliesThread ViewNo JavascriptNo JS + Preview   Per page 102550

Msgs 1 to 14 of 14 (Total in Forum: 14) (Refresh) FirstPrevNext

Thanx very much eng / Mahmoud abdel Aziz elgindy 0:59 7 Dec '08   thankes All your articles very good Sign In·View Thread·PermaLink Re: Thanx very much George B Gilbert 6:36 7 Dec '08   Your welcome! Sign In·View Thread·PermaLink thankes goldman1415 11:00 24 Jun '08   thankes All your articles very good Sign In·View Thread·PermaLink Re: thankes George B Gilbert 11:22 24 Jun '08   Thank you! Sign In·View Thread·PermaLink Great Article umertahir 2:10 16 Oct '07   That's exactly what I wanted to do which is explained quite nicely in the article. Thanks Umer Sign In·View Thread·PermaLink Re: Great Article George B Gilbert 4:52 16 Oct '07   Your welcome! Sign In·View Thread·PermaLink Awesome Article BAbrian 1:19 11 Feb '07   George, this aticle is perfect! Thank you so much for posting code for us "newbies". Now, I just need to study the code to learn how/why it works. I've searched the net for a while only to find examples with many many lines of code that don't even work. Thanks again for your help! Sign In·View Thread·PermaLink Re: Awesome Article George B Gilbert 3:49 11 Feb '07   You're welcome! Sign In·View Thread·PermaLink How to open website explicitly in new window? MehdiAnis 7:30 19 Oct '06   Hi, I am using code to open website, it is working fine. Thanks for nice information. The problem is it used existing Internet Explorer window to show the clicked web site. How can I explicitly open the website in a new browser window? I will appriciate your help. Sign In·View Thread·PermaLink Re: How to open website explicitly in new window? George B Gilbert 8:53 19 Oct '06   I don't think there is a way to force a new browser window from within VB .NET. The System.Diagnostics.Process.Start method has a second parameter you can use to pass command line arguments to the default web browser. The problem there is that you have to know what the default browser is, and the format of that browser's command line arguments. I use Firefox. Passing that browser's command line argument for a new window via the Start method didn't work. The only way I could force a new browser window was to set the Firefox "Open links from other applications" option to "a new window." Sign In·View Thread·PermaLink "Double Text user"? sabine32 21:21 18 Jan '06   Dear George, thanks for that clear well structured compact and complete information! I have to try your code later...but for now: what I did not understand is: what is a "Double Text user"? thanks for answering sabine Sign In·View Thread·PermaLink Re: "Double Text user"? MansonP 2:35 19 Jan '06   Yeah I also would like to know what you mean Sign In·View Thread·PermaLink Re: "Double Text user"? George B Gilbert 5:49 19 Jan '06   Sabine... Thank you for your kind comments about my article. To respond to your question, my answer to another person's similar question is duplicated below. If this doesn't answer your query, please let me know. George ******************************** Chris... Thank you for your question! I use Double Text because it makes me much more productive at writing applications than I would be without it. I detest having to write the same code or comments or whatever over and over. With Double Text I can put any code in any language (and anything else that I re-use) into a library from which I can replicate the text whenever I need it with one mouse click. The markers that I can put into the code enable me to customize code every time I duplicate it because Double Text reads those markers and prompts me for what I want to insert in place of the markers. I don't have to do any finding and replacing. Hope that makes sense. There is much more I can say on this topic, but, I don't want to get too long winded. If you would like to know more of the details, I wrote a history of Double Text that you are welcome to read at http://www.2goodsoftware.com/dthistory.htm.[^] You are exactly right on encapsulating re-usable code in a class library. That is definitely the way to go when appropriate. I do the same (I'm working on an article for next week that will present my passwords form library). I use Double Text for the code that I prefer not to put into a class library. In other words, I use Double Text libraries to complement classes. For example, I have a library that I use constantly for inserting comments into my code. Comments are definitely not something you can put into a class, but, as you can see from my code, I'm a firm believer in liberally commenting code. My code comments library makes generating those consistently formatted comments exceptionally easy and quick. In this article I present both a Double Text library as well as traditional code snippets so that readers have options. How you grab the code and what you do with it is entirely up to you. That's one of the fun things about programming ... we usually get to do it our way. If Double Text would work for you, that's great. If it doesn't work for you, that's great too! Hope I've answered your question fully. If not, let me know and I'll try again. George It's a poor carpenter that blames his hammer Sign In·View Thread·PermaLink Re: "Double Text user"? sabine32 8:10 19 Jan '06   Thank you, George - I found your homepage... Sign In·View Thread·PermaLink

Last Visit: 16:02 9 Jul '09     Last Update: 16:02 9 Jul '09 1