Home

Online Help

 

Introduction

Online help is the system of providing help files with an application. Online help is usually available from the main menu through a menu group created under a Help category.

In the past, the techniques to provide or program online help were not always easy. The early implementations of help were created in a system called WinHelp. This required using a Rich Text Format (rtf) file and appropriately formatting it. It is possible that, when folks at Microsoft developed WinHelp, they had only Microsoft Word in mind. It was difficult to get the required file ready if you were using another application such as WordPad or WordPerfect...

Creating the help file was not enough. Once the file was ready, it had to be added to the application, and appropriately. This back and forth gymnastic was a great motivation for neglect. As if these difficulties were not enough, or because of these difficulties, Microsoft created another system called HTML Help. This neither solved most problems nor created an easier solution. At this time, this HTML Help is widely used and many companies, such as AutoDesk (AutoCAD) and Macromedia to name just two, have adopted it . Many companies such as Borland, Jasc, just to name two, are still using WinHelp. This indicates that HTML Help didn't solve all problems and was not anonymously adopted.

Because HTML Help is the most supported help system by Microsoft, we will use it. Also, it is easier to use HTML Help in a Microsoft Visual Studio 2005 application than to use WinHelp.

Practical LearningPractical Learning: Introducing Online Help

  1. To create a new form, on the main menu, click Project -> Add Windows Form...
  2. In the Add New Item dialog box, set the name of the form to Calculation, and click Add
  3. Design the new form as follows:
     
    Clarksville Ice Scream - Difference Calculation
    Control Name Text Additional Properties
    Label   Order Total:  
    TextBox txtOrderTotal 0.00 TextAlign: Right
    Modifier: Public
    Label   Amount Tended:  
    TextBox txtAmountTended 0.00 TextAlign: Right
    Button btnCalculate Calculate  
    Label   Difference:  
    TextBox txtDifference 0.00 TextAlign: Right
    Button btnClose Close  
  4. Double-click both buttons and implement their Click events as follows:
     
    private void btnCalculate_Click(object sender, EventArgs e)
    {
                double TotalOrder,
        AmountTended = 0.00,
        Difference;
    
        // Get the value of the total order. Actually, this value 
        // will be provided by the main form
        TotalOrder = double.Parse(this.txtOrderTotal.Text);
    	
        try 
        {
    	// The amount tended will be entered by the user
    	AmountTended = double.Parse(this.txtAmountTended.Text);
        }
        catch(FormatException)
        {
    	MessageBox.Show("The amount you entered is not " +
    			 "valid - Please try again!");
        }
    
        // Calculate the difference of both values, assuming 
        // that the amount tended is higher
        Difference = AmountTended - TotalOrder;
    
        // Display the result in the Difference text box
        this.txtDifference.Text = Difference.ToString();
    }
    
    private void btnClose_Click(object sender, EventArgs e)
    {
                Close();
    }
  5. Display the first form (Form1.cs [Design])
  6. Add a new button to the bottom side of the form between the other buttons
  7. Change its values in the Properties window as follows:
    Name:    btnDifference
    Text:     Difference
    Enabled: False
    ToolTip on ToolTip1: Click to calculate the amount owed to the customer
  8. Double-click the Difference button and implement its Click event as follows:
     
    private void btnDifference_Click(object sender, EventArgs e)
    {
                // Declare a variable for the Calculation form
        Calculation dlgCalculation = new Calculation();
    
        // Transfer the current value of the Order Total text 
        // box from the main form to the other form
        dlgCalculation.txtOrderTotal.Text = this.txtOrderTotal.Text;
        // Display the other form
        dlgCalculation.ShowDialog();
    }
  9. Change the Click events of the Calculate Total  and the New Order buttons as follows:
     
    private void btnNewOrder_Click(object sender, EventArgs e)
    {
        // If the user clicks New Order, we reset
        // the form with the default values
        this.dtpOrderDate.Value = DateTime.Today;
        this.dtpOrderTime.Value = DateTime.Now;
        this.cboFlavors.Text = "Vanilla";
        this.cboContainers.Text = "Cone";
        this.cboIngredients.Text  = "None";
        this.txtScoops.Text = "1";
        this.txtOrderTotal.Text = "0.00";
        this.btnDifference.Enabled = false;
    }
    
    private void btnCalcTotal_Click(object sender, EventArgs e)
    {
        double PriceContainer = 0.00,
               PriceIngredient = 0.00,
               PriceScoops = 0.00,
               OrderTotal = 0.00;
        int NumberOfScoops = 1;
    
        // Find out what container the customer requested
        // The price of a container depends on which
        // one the customer selected
        if (cboContainers.Text == "Cone")
            PriceContainer = 0.55;
        else if (cboContainers.Text == "Cup")
            PriceContainer = 0.75;
        else
            PriceContainer = 1.15;
    
        // If the customer selected an ingredient,
        // which is not "None", add $.95
        if (cboIngredients.Text != "None")
            PriceIngredient = 0.95;
    
        try
        {
            // Get the number of scoops
            NumberOfScoops = int.Parse(this.txtScoops.Text);
    
            if (NumberOfScoops == 2)
                PriceScoops = 2.55;
            else if (NumberOfScoops == 3)
                PriceScoops = 3.25;
            else
                PriceScoops = 1.85;
        }
        catch (FormatException)
        {
            MessageBox.Show("The value you entered for the scoops is not valid" +
                        "\nOnly natural numbers such as 1, 2, or 3 are allowed" +
                            "\nPlease try again");
        }
    
        // Make sure the user selected a flavor, 
        // otherwise, there is no reason to process an order
        if (cboFlavors.Text != "")
            OrderTotal = PriceScoops + PriceContainer + PriceIngredient;
    
        this.txtOrderTotal.Text = OrderTotal.ToString();
        this.btnDifference.Enabled = true;
    }
  10. Test the application. Here is an example:
     
    Clarksville Ice Scream
  11. After using it, close it and return to Visual Studio

The Help Provider

Context-sensitive help allows the user to get local help on a particular control. This works by the user who can first click a control and then press Shift+F1. This displays a yellow box with a word or a group of words:

Microsoft Access - Context-Sensitive Help

This help is easier to provide in a dialog box because a dialog has a feature not available on a form. It consists of adding a button with a question mark and then creating the words that would display eventually. When you create this type of dialog box, the user can click the question marked button and click a control. The user can also press Shift+F1. This causes the mouse pointer to be equipped with a question mark. The user can then click a control and a yellow box would appear for that control, providing help.

Help

To make it easy to provide online help in a Visual Studio 2005application, the .NET Framework provides the HelpProvider control. After adding this control to the application, the form and all controls on it receive a new property labeled HelpString On HelpProvider1. You can then type the desired string in the field of the Properties window for each control that would display context-sensitive help.

Practical LearningPractical Learning: Using Context-Sensitive Help

  1. Display the Calculation form and click an area to select the form
  2. Change the following values of the form in the Properties window:
    FormBorderStyle: FixedDialog
    HelpButton: True
    MaximizeBox: False
    MinimizeBox: False
    ShowInTaskbar: False
  3. In the Components section of the Toolbox, click HelpProvider and click the form
     
  4. Using the Properties window, change the following values for the indicated controls:
     
    Control HelpString On HelpProvider1
    txtOrderTotal This is the total amount of the current order
    txtAmountTended This is the amount the customer tended
    btnCalculate Click here to calculate the difference between the amount tended and the total price of the order
    txtDifference This displays the difference between the amount tended and the total of the order
    btnClose Click here to close the dialog box
  5. Execute the application
  6. When it displays, process an order and click the Calculate Difference button
  7. In the Calculation dialog box, click the question mark button in the title bar and click on the text boxes or buttons
     
  8. After using the application, close the forms and return to Visual Studio
  9. Display the main form (Form1.cs [Design])
  10. To add a menu to the application, on the Toolbox, click MenuStrip and click the form
  11. On the form, click Type Here. Type &File and press the down arrow key
  12. Type E&xit and press Enter
  13. On the right side of File (on the form), click Type Here
  14. Type &Help and press the down arrow key
  15. Type &Contents... and press the down arrow key
  16. Type &Index... and press the down arrow key
  17. Type &Search... and press Enter
     
  18. On the form, click File and double-click Exit
  19. Implement its event as follows:
     
    private void exitToolStripMenuItem_Click(object sender, EventArgs e)
    {
        Close();
    }
  20. Test the application then close it and return to Visual Studio

Introduction to HTML Help

The online help we described above provides only small yellow boxes. It is called context-sensitive because it provides its assistance on only a control of the form. Another technique, in fact highly supported with any commercial program, consists of providing an external application that resembles a book. This allows the user to get more detailed information about almost any aspect of the application.

To provide online help in a Visual Studio 2005 application, you can use an external system. This consists of creating a complete application whose only purpose is to describe another application. This means that, in the beginning, both applications are not related in any way. With HTML Help, you must first create HTML files. You create these files anyway you like but, in this case, they are meant to provide support for a specific application. Therefore, when creating the files, try to divide them by issues. For example, you can create a file for each form of your application and use that file to describe what the form or dialog box is used for. You still can use any approach to create the files you would need. Experience will guide you eventually into knowing what to put in those files.

After creating the HTML files, you can open HTML Help Workshop which is a complete but separate application. This application is freely available from Microsoft and you can download it from the MSDN web site.

Practical LearningPractical Learning: Creating an HTML Help File

  1. Using Windows Explorer or My Computer, create a folder named cic
  2. Inside of the cic folder, create a folder named images
  3. Save the following pictures in the cic\images folder:
     
    Main Form
    Customer Processing Order Form
    Order Form
    Difference Calculation
  4. Start Notepad and create a Cascading Style Sheet file to format the body tag and the main title of the pages. Here is an example:
     
    body
    {
    	font-size: 10pt;
    	color: black;
    	margin-top: 0pt;
    	margin-left: 0pt;
    	font-family: Verdana, Tahoma, Arial, Sans-Serif;
    }
    
    .maintitle
    {
    	font-weight: bold;
    	font-size: 24pt;
    	color: blue;
    	font-family: Garamond, Georgia, 'Times New Roman' , Serif;
    }
  5. Save the file as cic.css in the cic folder
  6. Start another file with the following contents
     
    <html>
    
    <head>
    
    <link rel="stylesheet" type="text/css" href="cic.css">
    
    <title>Overview of Clarksville Ice Cream</title>
    </head>
    
    <body>
    
    <table border="0" width="100%" cellspacing="0" cellpadding="0">
      <tr>
        <td width="100%" align="center">
          <p class="maintitle">Overview of Clarksville Ice Cream</p></td>
      </tr>
      <tr>
        <td width="100%" bgcolor="#0000FF" height="2"></td>
      </tr>
    </table>
    
    <p>&nbsp;</p>
    <center><img border="0" src="images/main1.gif"
             alt="The main window of the application"
    	 width="416" height="284"></center>
    <p>Clarksville Ice Cream is a computer application used to process customers
    orders. It allows an employee to receive requests from a customer, based on what
    is available in the menu. When the order is complete, an ice cream is
    &quot;prepared&quot; and handed to the customer. As a commercial business, the
    application calculates the total amount. The amount is read to the customer who
    hands money to the clerk to complete the transaction</p>
    
    </body>
    
    </html>
  7. Save it as introduction.htm
  8. Start another file with the following contents
     
    <html>
    
    <head>
    
    <link rel="stylesheet" type="text/css" href="cic.css">
    
    <title>Customer Order Form</title>
    </head>
    
    <body>
    
    <table border="0" width="100%" cellspacing="0" cellpadding="0">
      <tr>
        <td width="100%" align="center">
          <p class="maintitle">Customer Order Form</p>
        </td>
      </tr>
      <tr>
        <td width="100%" bgcolor="#0000FF" height="2"></td>
      </tr>
    </table>
    
    <p>&nbsp;</p>
    <p>The main or opening window of this application displays a form used to
    process customers orders. The top section of the form, also called the title
    bar, is equipped with a menu called the main menu. this menu allows the user to
    start a new order or to close the application. To use this main menu, you can
    click one of the top-level words such as File. This causes the menu category of
    your choice to expand:</p>
    <center>
      <img border="0" src="images/main2.gif"
       alt="The main menu" width="416" height="284"></center>
    <p>After using a menu item, you can click it or click somewhere else to collapse
    it.</p>
    
    <p>The other objects on the main form allow the user to process an order by
    selecting items from the Windows controls. Once an order is ready, the user can
    click the Calculate Total button. This evaluates the total price of the order
    and displays it in the text box on the right side of Order Total.</p>
    
    <p>To start a new customer order, the user can click the New Order button. This
    resets all controls on the form:</p>
    
    <center>
       <img border="0" src="images/main3.gif" 
        alt="Customer Form Reset" width="416" height="284"></center>
    
    <p>When an order has been calculated, the user can click the Calculate
    Difference button to evaluate the diffence.</p>
    
    </body>
    
    </html>
  9. Save it as mainform.htm
  10. Start another file with the following contents
     
    <html>
    
    <head>
    
    <link rel="stylesheet" type="text/css" href="cic.css">
    
    <title>Difference Calculation</title>
    </head>
    
    <body>
    
    <table border="0" width="100%" cellspacing="0" cellpadding="0">
      <tr>
        <td width="100%" align="center">
          <p class="maintitle">Difference Calculation</p>
        </td>
      </tr>
      <tr>
        <td width="100%" bgcolor="#0000FF" height="2"></td>
      </tr>
    </table>
    
    <p>&nbsp;</p>
    <p>The Calculation dialog box allows a user to easily calculate the amount of
    money owed to a customer. After a customer has placed an order and given money
    to the clerk, the user can display this dialog box. When it comes up, the top
    text box of this window already displays the amount of the customer's order. The
    user can then simply enter the amount the customer gave in the Amount Tended
    text box. Then the user can click Calculate</p>
    <center>
      <img border="0" src="images/calculation1.gif"
       width="304" height="152"></center>
    <p>When the user has clicked the Calculate button, it calculates the difference
    and displays it in the Difference text box. After using this dialog box, the
    user can close it by clicking Close.</p>
    <p>&nbsp;</p>
    
    </body>
    
    </html>
  11. Save it as calculation.htm
  12. Start another file with the following contents
     
    <html>
    
    <head>
    
    <title>Clarksville Ice Cream - Home</title></head>
    
    <body>
    <h1>Clarksville Ice Cream</h1>
    <p><a href="introduction.htm">Introduction</a></p>
    <p><a href="mainform.htm">The Main Form</a></p>
    <p><a href="calculation.htm">The Difference Calculation Dialog Box</a></p>
    </body>
    
    </html>
  13. Save it as index.htm
  14. Start HTML Help Workshop
  15. On the main menu of HTML Help Workshop, click File -> New
     
    HTML Help Workshop - New
  16. In the New dialog box, make sure Project is selected and click OK
     
    New Project Wizard - First Page
  17. In the first page of the New Project wizard, click Next
     
    New Project - Destination
  18. In the second page of the wizard, click Browse
  19. Locate the cic folder you created and display it in the Save In combo box
  20. Set the File Name to cicoh
     
    The Open Dialog Box
  21. Click Open
     
    New Project - Destination
  22. In the second page, click Next
     
    New Project - Existing Files
  23. In the third page, read the text. Click the HTML files (.htm) check box and click Next
  24. In the fourth page, click Add
  25. In the Open dialog box, press and hold Ctrl. Then click each htm file to select them all
     
    The Open Dialog Box - Selecting the HTML files
  26. Click Open
     
  27. In the fourth page, click Next
  28. In the last page of the wizard, click Finish
  29. In HTML Help Workshop, click the Contents tab
    In the dialog box that displays, make sure the first radio button is selected
     
  30. Click OK
  31. In the Save As dialog box, accept the suggested name
     
    Save As
  32. Click Save
  33. Click the Insert a Heading button Insert a Heading
  34. In the Table Of Contents Entry dialog box, in the Entry Title text box, type Clarksville Ice Cream and click Add
  35. In the Path Or URL dialog box, select the Clarksville Ice Cream - Home and click OK
     
    Table of Contents Entry
  36. Click OK
  37. Click the Insert A Page button Insert A Page
  38. In the message box that displays, click No
  39. In the Entry Title text box, type Introduction and click Add
  40. In the Path Or URL dialog box, select the Overview of Clarksville Ice Cream and click OK
     
    Table Of Contents Entry - New File
  41. In the Table Of Contents Entry dialog box, click OK
  42. In the same way, create new pages under the Introduction heading using the following table
     
    New Page Title Page or URL
    Customer Order Form Customer Order Form
    Difference Calculation Difference Calculation
  43. In HTML Help Workshop, click the Index tab. In the dialog box that comes up, make sure the top radio button is selected
     
  44. Click OK
  45. Accept the suggested name of the file and press Enter
  46. Click Insert A Keyword Insert A Keyword
  47. In the Keyword text box, type Calculation and click Add
  48. In the Path Or URL dialog box, click Difference Calculation and click OK twice
  49. In the same way, create new keywords using the following table (sometimes you may receive a message box asking whether you want to create the keyword above the other; it doesn't matter, for this exercise, whether you click Yes or No):
     
    New Keyword Page or URL
    amount Difference Calculation
    money Difference Calculation
    customer Difference Calculation
    order Difference Calculation
    clerk Difference Calculation
    window Difference Calculation
    Amount Tended Difference Calculation
    Calculate Difference Calculation
    Close Difference Calculation
    computer Overview of Clarksville Ice Cream
    Application Overview of Clarksville Ice Cream
    employee Overview of Clarksville Ice Cream
    menu Overview of Clarksville Ice Cream
    commercial Overview of Clarksville Ice Cream
    business Overview of Clarksville Ice Cream
    transaction Overview of Clarksville Ice Cream
    Main Menu Customer Order Form
    category Customer Order Form
    choice Customer Order Form
  50. Click the Sort Keywords Alphabetically button
     
  51. Click the Project tab
  52. Click the Add/Modify Window Definitions button Add/Modify Window Definitions
  53. Set the name to MainWnd and press Enter
  54. Set the Title Bar Text to Clarksville Ice Cream
  55. Click the Buttons tab then click the Home and the Locate check boxes

    Window Types - Buttons
  56. Click the Position tab
  57. Set the Width to 800 and the Height to 600
     
  58. Click the Files tab
  59. Set the Default and the Home choices to index.htm
     
  60. Click the Navigation Pane tab
  61. Click the Search Tab and the Advanced check boxes
     
  62. Click OK
     
  63. When the Resolve Window Definition wizard comes up, in the first page, make sure the window defined previously is selected in the Window Type combo box and click Next
  64. Click the Compile Full-Text Information check box
     
    Resolve Window Definition - Finish
  65. Click Next
  66. In the second page, accept the defaults and click Next
  67. In the third page, accept the default and click Finish
  68. To create the help file, click the Save All Files And Compile button
     
  69. While the compilation is over, close the HTML Help Workshop window

HTML Help and Visual Studio 2005Applications

After creating the HTML Help application, you can use a HelpProvider control to connect it to your application. The HelpProvider control is equipped wit the HelpNamespace provider. This property allows you to specify the application that contains the help application. Besides the HelpNamespace property, the HelpProvider control provides various methods to manage help.

HTML Help can be provided to a Visual Studio 2005 application through the Help class. The overloaded ShowHelp() method is used to specify the help file to display and possibly additional information. Notice that all versions take a first argument as a Control type. This is the parent control from where the online help will be provided.

The first version allows you specify the help file. It can be the help file specified in the HelpProvider.HelpNamespace property mentioned above.

The second and the fourth versions allow you to specify the tab of the HTML Help window to display when the method is called. This is done through the HelpNavigator enumerator that has a value for each tab of the HTML Help window. the fourth version can be used to open the HTML Help window from its Find tab and specify a keyword to search for.

The third version can be used to open a help file based on a keyword.

The ShowHelpIndex() method can be used to open the Index tab of the HTML Help window.

Practical LearningPractical Learning: Providing Online Help to an Application

  1. Open Windows Explorer or My Computer
  2. In the cic folder, copy the cicoh.chm file to the clipboard and paste it in the folder of the current project (ClarckvilleIceCream1)
  3. Display the main form
  4. In the Components section of the Toolbox, click HelpProvider Help Provider and click the form
  5. In the Properties window, change its Name to hpvIceCream and click HelpNamespace
  6. Click the ellipsis button of the HelpNamespace property
  7. From the CIC1 folder of the current project, select the cicoh.chm file
     
    Open Help File
  8. Click Open
  9. On the main menu of the form, click Help and double-click Contents
  10. Implement the event as follows:
     
    private void contentsToolStripMenuItem_Click(object sender, EventArgs e)
    {
                Help.ShowHelp(this, hpvIceCream.HelpNamespace);
    }
  11. Display the main form. On the main menu of the form, double-click Index
  12. Implement the event as follows:
     
    private void indexToolStripMenuItem_Click(object sender, EventArgs e)
    {
        Help.ShowHelpIndex(this, hpvIceCream.HelpNamespace);
    }
  13. Display the main form. On the main menu of the form, double-click Search
  14. Implement the event as follows:
     
    private void searchToolStripMenuItem_Click(object sender, EventArgs e)
    {
        Help.ShowHelp(this, hpvIceCream.HelpNamespace, HelpNavigator.Find, "");
    }
  15. Test the application. When it displays, click the Help menu of the form and click one of the menu items
     
    HTML Help
  16. After using it, close the online help window, close the form, and return to Visual Studio
 

Previous Copyright © 2007 FunctionX, Inc. Home