Property "Help File" <helpfile>

Top  Previous  Next

If we have a help file belonging to the library element, we can introduce it with this property.

Help files can be anything that can be called with Windows Explorer; Help Files with .hlp or .chm extension or html files or even documents in richtext format.

If help file is the case then with helpbm attribute, properties can be linked to bookmarks in help file.

The name of the help file should be given relative to the element file. If it is located in the same directory as the element file it is sufficient to give only the name of the file.

Example:

 <panel name="myelement">

    <helpfile helpbm="default-bookmark">myelement.hlp</helfile> 

    <prop name="propa" helpbm="bm_propa" type="string"/>

 </panel>

 

In this example, if the user focuses on "propa" property of "myelement" element in property editor and presses F1 key, he will be displayed the section marked with bookmark "bm_prop" in "myelement.hlp" file.

See Properties Exclusive to Library Elements.