System.Actions.TContainedAction.HelpContext

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

property HelpContext: THelpContext read FHelpContext write SetHelpContext default 0;

C++

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

Properties

Type Visibility Source Unit Parent
property public
System.Actions.pas
System.Actions.hpp
System.Actions TContainedAction

Description

Keeps the integer context ID that identifies the Help topic for the action.

HelpContext specifies the integer context ID to identify the Help topic to show when invoking Help for the action. This HelpContext value is propagated to all clients of the action.

HelpContext is only used when htContext is selected in the HelpType property.

Note: To use Help, you need to enable Help in your application. When your application supports usage of the appropriate Help system, then it can show Help topics from the associated Help file. When a client control has focus and the user presses the F1 key, the control uses the HelpContext property's value to invoke the online Help that shows the topic with this context ID. The target topic is uniquely identified by a HelpContext context ID value.

See Also