VLPropertyList Reference

MethodHelpRequested

See Also See Also Applies To Applies To

This event is triggered when user presses F1 button on a selected property.

 

Syntax

Private Sub object_HelpRequested (ByVal aProperty As CProperty,ByRef bProcessDefault As Boolean)

 

The HelpRequested event syntax has these parts:

PartDescription
object An object expression that evaluates to a VLPropertyList.

aProperty

An object which evaluates to the CProperty, specifies the property which was selected when F1 was pressed.

bProcessDefault

A boolean expression that enables/disables the automatic launching of help file specified by the HelpFile attribute of a Property.

 

Settings

Setting for bProcessDefault are:

Value Description
False Disables automatic display of help for property.
True (default) Enables automatic display of help for 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.