This document is archived and information here might be outdated.  Recommended version.


IMultiItemEx.ItemHelpFile Property (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > SystemUI > ESRI.ArcGIS.SystemUI > Interfaces > IM > IMultiItemEx Interface > IMultiItemEx.ItemHelpFile Property
ArcGIS Developer Help

IMultiItemEx.ItemHelpFile Property

The name of the help file associated with the item specified by the index.

[Visual Basic .NET]
Public Function get_ItemHelpFile ( _
    ByVal index As Integer _
) As String

[C#]
public string get_ItemHelpFile (
    int index
);

[C++]
HRESULT get_ItemHelpFile(
  long index,
  System.String* HelpFile
);

[C++]
Parameters
index [in]

  index is a parameter of type long
HelpFile [out, retval]

  HelpFile is a parameter of type BSTR*

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

The ItemHelpFile property is used to specify the name of the help file that contains the context sensitive help topic for the specified item your custom MultiItem.

Index specifies the index of the current item on the multiItem.

Remarks

If you set both the ItemHelpFile (or IMultiItem.HelpFile) and ItemHelpContextID properties, then an end-user of your command can use the "What's This?" command in ArcMap or ArcCatalog to get help on your command. Note, if you want your What's This help to look and behave the same as the standard ArcGIS commands, then you should create a WinHelp file instead of a HTMLHelp file.

If you have a WinHelp file (*.hlp), set IMultiItem.HelpFile or IMultiItemEx.ItemHelpFile to the name of the help file containing the topic that describes the command and set IMultiItem.ItemHelpContextID to the topic ID's mapped numeric value. The topic ID is the so-called # footnote in the RTF file you include in your WinHelp file. You can use Help Workshop to add this numeric value by opening the HPJ file, clicking Map and then clicking Add (to add the mapping for an individual topic). See the help topic "To enable a program to display an individual Help topic" in the Help Workshop's help file.

If you have an HTMLHelp file (*.chm) the procedure is similar; specifiy the
.chm file as IMultiItem.HelpFile or IMultiItemEx.ItemHelpFile and the mapped numeric value as
IMultiItem.ItemHelpContextID. Popup topics are problematic with HTMLHelp, but the help topic will display in a default or user-defined window.

As part of your deployment strategy register the name of the WinHelp file (*.hlp) as a new string value in:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Help

Or if you're working with a HTMLHelp file (*.chm) register its name as a new string value in:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\HTMLHelp.

See Also

IMultiItemEx Interface