 |
This document is archived and information here might be outdated. Recommended version. |
ICommand.HelpContextID Property (ArcObjects .NET 10.6 SDK)
|
This document is archived and information here might be outdated. Recommended version. |
The help context ID associated with this command.
[Visual Basic .NET] Public ReadOnly Property HelpContextID As Integer
[C#] public int HelpContextID {get;}
[C++]
HRESULT get_HelpContextID(
System.Int32* helpID
);
[C++]
Parameters helpID [out, retval]
helpID is a parameter of type long*
The HelpContextID property is used to specify the mapped numeric value of the topic ID of the context sensitive help topic for your custom command. Specify the name of your help file in the HelpFile property.
Implement this function to provide contextual (F1) help for your custom command. Two types of help are supported: chm file help and web help.
To associate a help topic in a chm file, use the HelpFile property to specify the the name of the chm file and the HelpContextID property to specify the mapped numeric value for the specific topic you want to link to. As part of your deployment strategy, register the .chm file as a new string value in:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\HTMLHelp.
To link to a website, simply return the url.
In both cases, end-users of your command can access the help by pressing the F1 key when hovering over the command. Commands with help display a special footnote in their tooltip indicating so.