Show: Delphi C++
Display Preferences

Vcl.Controls.TControl.HelpContext

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property HelpContext: THelpContext read FHelpContext write SetHelpContext stored IsHelpContextStored default 0;

C++

__property System::Classes::THelpContext HelpContext = {read=FHelpContext, write=SetHelpContext, stored=IsHelpContextStored, default=0};

Properties

Type Visibility Source Unit Parent
property published
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls TControl

Description

The HelpContext property contains the numeric context ID that identifies the Help topic for the control.

In case of a .chm help file, you must map symbolic Context IDs of Help topics to numeric topic ID values in the [MAP] section of your project (.hhp) file.

To enable Context ID-based context-sensitive Help for a control, set Vcl.Controls.TControl.HelpType to htContext and set HelpContext to a numeric topic ID.

A topic ID of 0 (default) means that no Help topic is provided for the control.

To use the Help, insert in the uses clause of your application the Vcl.HtmlHelpViewer or another unit that provides an interface to the external Help viewer to use. For C++, you need to include the HTMLHelpViewer.hpp header file.

See Also

Personal tools
In Other Languages
Previous Versions
Assistance