System.Actions.TContainedAction.HelpKeyword

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

property HelpKeyword: string read FHelpKeyword write SetHelpKeyword;

C++

__property System::UnicodeString HelpKeyword = {read=FHelpKeyword, write=SetHelpKeyword};

Properties

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

Description

Contains the keyword string that identifies the Help topic for the action.

This HelpKeyword value is propagated to all clients of the action.

HelpKeyword is only used when htKeyword 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 HelpKeyword property's value to invoke the online Help showing the topic with this keyword.

See Also