VLPropertyList Reference

Read/Write PropertyHelpFile

See Also See Also Applies To Applies To

Returns or sets help file for a property. This file is displayed, when user presses F1 key on this property in VLPropertyList control.

 

Syntax

object.HelpFile [= string ]

 

The HelpFile property syntax has these parts:

PartDescription
object An object expression that evaluates to CProperty
string A help file name for the property.

 

Remark

VLPropertyList control supports WinHelp (.hlp format help) as well as HtmlHelp (new .chm format help) files. It will automatically launch and show the appropriate help page when HelpFile and HelpContext are specified for a property.

When COM object's properties are loaded using LoadobjectProperties , the HelpFile and HelpContext attributes are also loaded from the typeinfo of the COM object.

Before launching the help file, the control fires HelpRequested event. You can suppress auto launching of help by setting bProcessDefault to false in the HelpRequested event.