Unit 'Controls' Package
[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] [#lcl]

TControl.HelpKeyword

The context-sensitive Help keyword for the control.

Declaration

Source position: controls.pp line 1781

published property TControl.HelpKeyword : string
  read FHelpKeyword
  write SetHelpKeyword
  stored IsHelpKeyWordStored;

Description

HelpKeyword is a String type with the context-sensitive keyword used to locate and display a help topic for the control. When an value is assigned to the property, the HelpType property is set to htKeyword.

HelpKeyword is used in the ShowHelp method, and passed as an argument to the HelpKeyword method in the Application singleton.

Use HelpContext to specify a numeric context identifier for the help topic displayed for the control.

Use the HelpFile property, found on the parent form or in a TApplicationProperties instance, to set the help file with the content for the help topic.

See also

TControl.HelpContext

  

The numeric context-sensitive Help identifier for the control.

TControl.HelpType

  

Indicates whether context-sensitive Help is selected by numeric ID or keyword.

TControl.ShowHelp

  

Displays the help associated with the control.

TApplication.HelpKeyword

  

Shows help for the specified keyword.

TApplicationProperties.HelpFile

  

Contains the name for the help file in an application.

TCustomForm.HelpFile

  

The name of the help file for the form.



CT Web help

CodeTyphon Studio