006_Introduction to Help

8/7/2019 006_Introduction to Help

1/79

006 Help Provider in C#.Net

Prepared by: Rogelio V. del Cano

Estimated Duration: 6 Hours


2/79

006 Help Provider in C#.Net 2

Objectives

At the end of this module, studentsshould be able to:

Create help files with table of contents andfull search text feature

Use the HelpProvider and Help objects

Add an About Box


3/79


How do you ask for help?


4/79


Free Help Compiler

Download from Microsoft the free helpcompiler.

Search for htmlhelp.exe

Install after download.


5/79


Take a Screen shot of your Form


6/79


Edit it in Paint


7/79


Save the Image as JPG File


8/79


Create an HTML File

Customer Form

Customer Form

The Customer Form is part of the File Maintenance pull down menu, which allows the user to add, modify, and search for a customer. The form displays a record one at a time by using the navigation button. It has seven buttons

that are positioned at the right side of the form. These buttons are Add, Edit, Save, Cancel,Search, Delete, and Close (See Buttons Description below.)


9/79


10/79

Create a New Document

Insert a 4 x 10 table



11/79

Increase the Height of the 1st

Row:


Note: The height of the first row must be equivalent to the size of at least two rows.


12/79


13/79

Improve the Table Shading

Click Borders and Shading



14/79


15/79


16/79

Select the Alternating Rows

Select the second row

Hold down the Control key

Continue selecting the other rows



17/79

Select Alternating Rows

Right-click insideof any one of theselected rows

Click TableProperties



18/79


19/79

Click the Shading Tab

Click the ShadingTab

Select Dark Blue,Text 2, Lighter80%



20/79


21/79


Type the Following:

Input Control Description Required Data Type

Customer No. Automatically generated by

the system.

Yes Number

Surname The last name of the

customer.

Yes String

First Name The given name of the

customer.

Yes String

Middle Initial The middle initial of thecustomer

Yes String

Address The complete home location

of the customer

Yes String

Telephone No. The landline or the mobile

phone number of the

customer.

Yes String

Birth Date The month, day, and year

the customer was born.

Yes Date / Time

Customer Status The description of the

customers business activity.

Yes String

Registration Date The month, day, and year

the customer was enlisted

into the database.

Yes Date / Time


22/79


Type the Following:

Input Control Description Required DataType

Customer No. Automatically generated by the system. Yes Number

Surname The last name of the customer. Yes String

First Name The given name of the customer. Yes String

Middle Initial The middle initial of the customer Yes String

Address The complete home location of the customer Yes String

Telephone

No.The landline or the mobile phone number of the customer. Yes String

Birth Date The month, day, and year the customer was born. YesDate /

Time

CustomerStatus

The description of the customers business activity. Yes String

Registration

DateThe month, day, and year the customer was enlisted into the database. Yes

Date /

Time


23/79


Edit the HTML File

Insert these lines.


24/79

Result



25/79


Buttons Descriptions (3 cols & 8rows)

D l h hi hli h d i


26/79

Delete the highlighted portion

from image001 up to image007:



27/79

Insert the following:


Insert these lines.


28/79

Result:



29/79


Summary of Files

1.CustomerIntro.htm2.CustomerIntro.JPG

3.CInputControls.htm4.CInputControls.JPG

5.ButtonsDescriptions.htm6.ButtonsDescriptions.JPG


30/79


Desired Output


31/79


Desired Output


32/79


Desired Output


33/79


Launch HTML Help Workshop


34/79


35/79


Help Development Cycle


36/79


Create a New Help Project

Click the New button from the toolbar

Click Project, then OK

Wizard appears, click the Next button

Click the Browse button to locate where you want to

save your project Type CustomerHelp in the File Name

Click Open

It goes back to the Wizard

Click the last option, HTML Files (*.htm) Click the Add button, select your 3 .htm files

Click Next, then Finish


37/79


Check the Output


38/79


Change Project Options

Click the Change ProjectOptions

From the General Tab,

type Customer Help inthe Title

Select CustomerIntro.htmfrom the Default File


39/79


Change Project Options (cont.)

Click the CompilerTab

Check Compile full-text

Click OK


40/79


Table of Contents

Click the Contents Tab

Ensure that Create a newcontents file is selected

Click OK Edit the default file name

to: Customer Table ofContents

Click Save


41/79


Contents Tab Tools


42/79


Table of Contents (cont.)

Click Insert a Page

In the entry title, type,Introduction

Click the Add button Select CustomerForm, click

OK

Click OK again


43/79


Table of Contents (cont.)

Click Insert a Heading

Answer No for the question, Do youwant to insert

In the Entry Title, type, Input

Click OK

Click Insert Page

In the Entry Title, type, Input Controls

Click Add, Select Input Controls, thenOK


44/79


DIY for Buttons

Use Buttons for heading

Use Description for the page


45/79


46/79



47/79


How to Integrate the *.chm to C#?

1. Add a HelpProvider object to yourfrmCustomer


48/79



1. Add a HelpProvider object to yourfrmCustomer

2. Rename it to helpProviderCustomer


49/79


50/79



How to Integrate the * chm to C#?


51/79


How to Integrate the .chm to C#?(cont.)

1. Go the Load event of the frmCustomer2. Put your cursor after the last line

3. Type the following:

helpProviderCustomer.HelpNamespace =

Application.StartupPath + @"\CustomerHelp.chm";4. In the meantime, copy your CustomerHelp.chm to the

\bin\debug and \bin\release folders

5. Run your program, load frmCustomer, press F1

6. Note: Copy the help provider line code to the Activated event

of the Customer form


52/79


53/79


Warning!

If the location of thefolder is too deep,the help file may not

display correctly. To correct this

limitation, transferyour folder close to

the root.


54/79


mdiMain Complete Menu Items


55/79


56/79

On Click of the Disclaimer Menu


57/79


On Click of the Disclaimer MenuItem

Help.ShowHelp(this, Application.StartupPath + @"\disclaimer.chm");


58/79


59/79


Add AboutBox.frm


60/79

Add Ab B f


61/79


Add AboutBox.frm

Add Ab B f


62/79


Add AboutBox.frm

Add Ab B f (S )


63/79


Add AboutBox.frm (Summary)

Ab t B


64/79


About Box

Note: Change the logo


65/79


Ch th A bl P ti


66/79


Change the Assembly Properties


67/79

Ch th A bl P ti


68/79



Ch th A bl P ti


69/79



Ch th A bl P ti


70/79




71/79

Ho to Displa the Abo t Bo ?


72/79


How to Display the About Box?

1. Double click the About from the Helpmenu strip

2. Type the following codes: AboutBoxSalesInv nab = new AboutBoxSalesInv();

nab.MdiParent = this;

nab.Show();

3. Run, click Help >> About

Close Button


73/79

Close Button

Go to the Click event and type:

this.Close();


How to auto-close the


74/79

AboutBox?


Question & Answer


75/79


Question & Answer


76/79


77/79

Hint


78/79


Hint


79/79

Documents

006_Introduction to Help