Help file for a DLL - Visual Basic .NET

Steve

I have written a help file (chm) for a DLL and referenced it using Help.ShowHelp

My expectation is that a developer using my DLL would be able to access this help file during his development time using "F1" help within the VB IDE. Is this expectation achievable

In trying to test my help file in the IDE, I have a solution with 2 projects: the DLL and a tester. VB does not look for my help file; instead, it looks for path to my source code within my namespace. I haven't yet compiled my DLL. Do I need to do that first

What's the process to make my help file accessible to the developer within the IDE

Nov 20 '05 #1

Subscribe Reply

3273

Bernie Yaeger

Hi Steve,

You can access your .chm by making it a part of the ide's tools menu.
Here's how:

Go to tools/external tools; select 'add'; give it a title; in the command
box enter c:\windows\hh.e xe; in the arguments box enter the name of your
chm: eg, c1truedbgridnet .chm; set the initial directory (full path without
the \filename)

It will then appear in your tools menu and will be available at the click of
a mouse.

I don't know a better way nor do I know if it's possible to do it in any
other manner, but your readme.txt to the developer can instruct him on
installing it in his ide as I do above.

HTH,

Bernie Yaeger

"Steve" <St****@nospam. nospam> wrote in message
news:C4******** *************** ***********@mic rosoft.com...

I have written a help file (chm) for a DLL and referenced it using Help.ShowHelp.
My expectation is that a developer using my DLL would be able to access this help file during his development time using "F1" help within the VB
IDE. Is this expectation achievable?
In trying to test my help file in the IDE, I have a solution with 2 projects: the DLL and a tester. VB does not look for my help file; instead,
it looks for path to my source code within my namespace. I haven't yet
compiled my DLL. Do I need to do that first?
What's the process to make my help file accessible to the developer within the IDE?

Nov 20 '05 #2

Peter Huang

Hi Steve,

Based on my research, I can not find a official method which will help us
to integrate our personal help file into the VS.NET IDE.

Just an idea, I think you may try to write an VS.NET Addin, after you load
the addin, the addin will hook the keyboard, so that we can intercept the
F1 press. In the meantime, we can easily know if the current active project
is the dll project which we want to invoke the customized help file from in
the Addin.

Here is an article about hook keyboard.
Managing Low-Level Keyboard Hooks in VB .NET
http://www.developer.com/net/net/art...1087_2193301_3

Also here is an article about write VS.NET Addin for your reference.
http://msdn.microsoft.com/library/de...us/dv_vstechar
t/html/tchVSAddinEnabl ingHTMLTidy.asp

NOTE: This is an hack method, you will use it at your own risk.

Best regards,

Peter Huang
Microsoft Online Partner Support

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.

Nov 20 '05 #3

Peter Huang

Hi Steve,

Thank you for your quick response.
Now I am researching the issue, and I will update you with new information
ASAP.

Thank you for your understanding.

Best regards,

Peter Huang
Microsoft Online Partner Support

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.

Nov 20 '05 #4

Peter Huang

Hi Steve,

After I further research, I think you may try to use the Visual Studio .NET
Help Integration Kit to Integrate the help file into Visual Studio
development environment.

We may get the Visual Studio .NET Help Integration Kit at link below.
http://msdn.microsoft.com/library/de...us/htmlhelp/ht
ml/hwmscExtendingN ETHelp.asp

You may look into the section below in the Visual Studio .NET Help
Integration Kit 2003 document.
Implementing Dynamic Help

Best regards,

Peter Huang
Microsoft Online Partner Support

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.

Nov 20 '05 #5

Peter Huang

Hi,

As we state in the EULA of the VSHIK in the installation directory.
SUPPORT SERVICES. No technical support will be provided for the Software.

And the whitepaper did not provide any more comment about the sample
shipped with VSHIK.

Based on my researching, the sample is listed as the below hierarchy.
CityPowerAndLig ht -------Control
TestCPandL-CS -------CS code using the control
TestCPandL-VB -------VB code using the control
XML -------implement the Dynamical Help XML Data Island
Help2 -------Help project

Here is the workthrough that works.
1. Copy the xml file under the XML directory to the directory.
<VS install path>\Common7\I DE\HTML\XMLLink s\<LCID>.
The value of <LCID> depends upon your language, such as English or French.
For example, the English LCID is 1033.

The XML Help Provider and Dynamic Help
http://msdn.microsoft.com/library/de...us/vsintro7/ht
ml/vxgrfhowdynamic helpworks.asp

2. Compile the Help2 Project under the Help2 directory.

3 Use the Help Integration Wizard Beta to install the compiled help file.

Creating a Help Collection Using the Help Integration Wizard Beta
http://msdn.microsoft.com/library/de...us/dv_vstechar
t/html/integration_wiz ard.asp

We can download it at the link below.
Help Integration Wizard Beta
http://download.microsoft.com/downlo...c-8810-acd798c
e99d5/HelpIntWizardBe ta.EXE

4. Restart the VS.NET IDE and load the TestCPandL-CS or TestCPandL-VB
project, move the mouse onto the LightSwitch in the line below.
private CityPowerAndLig ht.Controls.Lig htSwitch lightSwitch1;
We will find the Dynamical Help has changed.

5. Press F1 will invoke the predefined page in the xml file under the XML
directory, and now we have copy it under the directory below.
<VS install path>\Common7\I DE\HTML\XMLLink s\<LCID>

[NOTE: we may need to change the <LItem URL> tag in the xml file because
when we build into the vs.net help collection the path may changed.
But we can input the LightSwitch in the index to get the correct page and
retrieve the url something like
ms-help://MS.VSCC.2003/ms.wizard.names pace/CityPowerHelp2/LightSwitch.htm
And now we can change the <LItem URL> based on the
ms-help://MS.VSCC.2003/ms.wizard.names pace/CityPowerHelp2/ url base.
e.g.
<LItem
URL="ms-help://MS.VSCC.2003/ms.wizard.names pace/CityPowerHelp2/WinProjectsCS
..htm" LinkGroup="Help ">Creating a CP&L Windows Project (C#)</LItem>
<LItem
URL="ms-help://MS.VSCC.2003/ms.wizard.names pace/CityPowerHelp2/StartWinProje
cts.htm" LinkGroup="Gett ingStarted">CP& amp;L Windows Projects</LItem>
Here are some additional resource about Dynamic Help for your reference.

MS Help 2 - Dynamic Help
http://www.helpware.net/mshelp2/demo/DynamicHelp.htm

MS H2 Collection Tutorial
http://www.helpware.net/mshelp2/h2tutorial.htm
Best regards,

Peter Huang
Microsoft Online Partner Support

Get Secure! - www.microsoft.com/security
This posting is provided "AS IS" with no warranties, and confers no rights.

Nov 20 '05 #6

Similar topics

6552

Saved .rtf Help File corrupt after reformatting system

by: Dave | last post by:

After following Microsofts admonition to reformat my system before doing a final compilation of my app I got many warnings/errors upon compiling an rtf file created in word. I used the Help Workshop program: hcw.exe that's included with Visual Basic. This exact same file compiled perfectly with no notes, warnings or errors prior to reformatting my system. Prior to the reformatting, I copied the help.rtf file onto a CD and checked the box to...

Visual Basic 4 / 5 / 6

3553

gtk/qt scintilla help !

by: fabien | last post by:

Hi, I am writing a POV-RAY editor with Python using either QT or GTK as GUI 'wrapper'. ( I am still trying both ) * * * * PYGTK * * * * I have downloaded PygtkScintilla-1.99.5. There is a lexPOV.cxx file in the package, but I can not find any POV keywords in any file ( there are about 150 POV keywords). Did i miss it, and if not, how do I create one and include it for the library building ?

Python

4344

help me? About "include files"

by: wukexin | last post by:

Help me, good men. I find mang books that introduce bit "mang header files",they talk too bit,in fact it is my too fool, I don't learn it, I have do a test program, but I have no correct doing result in any way. Who can help me, I thank you very very much. list.cpp(main program) //-------------------------------------------------------------------------- - #pragma hdrstop #pragma argsused

C / C++

2630

HTML Help file

by: dixie | last post by:

Help, I'm really out of my depth here (not unusual I hear you say :-). I have just installed HTML Help in an application. I told it in the Project Properties the path to the help file. I then type in a command line that runs the help in the correct Context from a button on each form. It all worked fine - HERE. The problem is that when I sent it out to a site, the help file was not able to be accessed because it was my path in the...

Microsoft Access / VBA

2392

Help File: Empty Screen Or Menu Item

by: Tim Marshall | last post by:

I'm putting together my first help file (using Easy Help, http://www.easyhelp.com/). So far, so good. I'm able to use the Help File and Help Context ID to have things from my help file pop up when F1 is pressed. But how do I do this when my Access App screen is empty? A hidden form? Also, how do I have a menu item that pulls up the help file? When I open the help file on its own, there is a contents item tht appears, I'd like to...

Microsoft Access / VBA

3715

anybody help me

by: Rahul | last post by:

Hi Everybody I have some problem in my script. please help me. This is script file. I have one *.inq file. I want run this script in XML files. But this script errors shows . If u want i am attach this script files and inq files. I cant understand this error. Please suggest me. You can talk with my yahoo id b_sahoo1@yahoo.com. Now i am online. Plz....Plz..Plz...

Python

2188

DEADLINE! Please help!

by: KitKat | last post by:

I need to get this to go to each folders: Cam 1, Cam 2, Cam 4, Cam 6, Cam 7, and Cam 8. Well it does that but it also needs to change the file name to the same folder where the file is being grabbed, BUT it doesn't. I have tried and tried.....please help example: C:\Projects\Darryl\Queue Review Files\2-24\Cam 7\Cam7-20060224170000-01.jpg Cam7 but all I keep getting is Cam1, as the beginning of the jpg name,...:( HELP!

Visual Basic .NET

2029

Trigger a Help event.

by: lord.zoltar | last post by:

I've managed to get a nice little chm help system written. Now I need to display it! I added a HelpProvider to my MDIParent form and set the namespace of the HelpProvider to be the help file. So far so good - when I press F1, I get HTML Help popping up with my Help file. This is good but I've been requested to make Help pop up when the user clicks on "Help" in the menu, or on a specific Help Button. I'm trying to trigger the HelpRequested...

Visual Basic .NET

3266

Please help me to catch this error

by: Amali | last post by:

I'm newdie in c programming. this is my first project in programming. I have to write a program for a airline reservation. this is what i have done yet. but when it runs it shows the number of seats as 0 and the flight no. is also repeating. If any can tell why is this please help me. #include<stdio.h> #include<ctype.h> #include<conio.h>

C / C++

2874

please help me correct the errors in this program.have to submit theproject tomorrow!!

by: priyajohal | last post by:

#include<fstream.h> #include<process.h> #include<stdlib.h> #include<conio.h> #include<string.h> #include<dos.h> #include<ctype.h> #include<stdio.h> void setup() void help();

C / C++

8739

Changing the language in Windows 10

by: Hystou | last post by:

Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...

Windows Server

9384

Problem With Comparison Operator <=> in G++

by: Oralloy | last post by:

Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...

C / C++

9157

The easy way to turn off automatic updates for Windows 10/11

by: Hystou | last post by:

Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...

Windows Server

9088

Discussion: How does Zigbee compare with other wireless protocols in smart home applications?

by: tracyyun | last post by:

Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...

General

8052

AI Job Threat for Devs

by: agi2029 | last post by:

Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...

Career Advice

5995

Couldn’t get equations in html when convert word .docx file to html file in C#.

by: conductexam | last post by:

I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...

C# / C Sharp

4762

Windows Forms - .Net 8.0

by: adsilva | last post by:

A Windows Forms form does not have the event Unload, like VB6. What one acts like?

Visual Basic .NET

3207

transfer the data from one system to another through ip address

by: 6302768590 | last post by:

Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system

C# / C Sharp

2147

Comprehensive Guide to Website Development in Toronto: Expert Insights from BSMN Consultancy

by: bsmnconsultancy | last post by:

In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

General