creatte help file on user defined function

hoit

unread,

Nov 12, 2001, 12:55:53 PM11/12/01

to

Hi everybody,

Can anyone tell me how to create a help file on a user defined function?

I would like to explain on every required parameter what kind of variable is
required (as in the standard functions in excel)
and also give the user a helpfile with examples (as in the standard
functions in excel) when clicked on the holp button.

in what format does one write these helpfiles, where are they stored etc.

any help is greatly appreciated.

greetings

Sybolt

Tom Ogilvy

unread,

Nov 12, 2001, 1:14:22 PM11/12/01

to

You need to create the function as an XLL. Not supported in VBA although
Laurent Longre has found an approach that works with two arguments - I have
seen someone post that it didn't work with 3, but I haven't tested it, so I
don't want to be the source of rumors or legends.

http://longre.free.fr/english/func_cats.htm

To see Laurent's approach.

If you speak/read french, most of his site is in French and you might get
more details on the french side.

Regards,
Tom Ogilvy

"hoit" <s.hoi...@chello.nl> wrote in message
news:J2UH7.153364$jH5.2...@amsnews03.chello.com...

Charles Williams

unread,

Nov 12, 2001, 2:21:37 PM11/12/01

to

You can build a help file for a VBA function that will be accessed when the
user presses F1. To make this work requires a help compiler to build a help
file, and then you need to associate the help file and a particular context
id within the help file with the function.

You can use the MacroOptions method to specify the description for the
function, help file and context id.

As Tom says, descriptive text for the function arguments is more difficult!
hth
Charles Williams
______________________
Decision Models
The Excel Calculation Site
www.DecisionModels.com

"Tom Ogilvy" <twog...@msn.com> wrote in message
news:#1PWdX6aBHA.1412@tkmsftngp05...

hoit

unread,

Nov 13, 2001, 12:38:07 PM11/13/01

to

Thanks for your reply,

But I'm still a bit puzzled.
how does it really work.

In what format do I write the help file and what does the context ID mean
and how do I operate on it.

for instsance...
I created a user defined function (hypotenusa) on a mudule and saved it as
an add-in.

then I tried to write the helpfile using notepad and saving the file as
hypotenusa.hlp.
then I tried to connect this helpfile to the function in the options.

however, when I now click on button Help in the hypotenusa entry window I
receive the message
"No help file available".
In what format do you write the helpfile, and what does the context id mean.

Greets,

Sybolt

Charles Williams

unread,

Nov 13, 2001, 4:58:17 PM11/13/01

to

There are two types of Help files : HTML help and WinHelp.
I use WinHelp. To make this you need to be able to create RTF files (Msoft
Word can do this), and use Msoft Help Workshop which you can download from
the Msoft site. This includes the Help Compiler, which converts RTF to HLP.
You also need a help compiler for HTML help, which is also downloadable from
the Msoft site.

The context ID gets created by the help compiler, its just a numeric label
for a section of Help.

There are a lot of tools available, some free, some chargeable, that
simplify this process.
The two main chargeable ones are probably RoboHelp and Doc-to-Help.
(I use Doc-to-Help).

hth
Charles

______________________
Decision Models
The Excel Calculation Site
www.DecisionModels.com

"hoit" <s.hoi...@chello.nl> wrote in message

news:3UcI7.202577$jH5.3...@amsnews03.chello.com...

hoit

unread,

Nov 14, 2001, 1:11:27 AM11/14/01

to

This certainly helps!!

Thanks a lot.

greets,

Sybolt