Vcl.WinHelpViewer.IWinHelpTester.CanShowALink
Delphi
function CanShowALink(const ALink, FileName: String): Boolean;
C++
virtual bool __fastcall CanShowALink(const System::UnicodeString ALink, const System::UnicodeString FileName) = 0 ;
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | public | Vcl.WinHelpViewer.pas Vcl.WinHelpViewer.hpp |
Vcl.WinHelpViewer | IWinHelpTester |
Description
Queries whether the Help System can show the help topic, which is specified by the ALink
name and which is located in the specified help file.
CanShowALink returns True if the Help System can show the help topic, which is specified by the Associative link ALink
name and which is located in the specified FileName help file. Otherwise, CanShowALink returns False.
VCL does not provide an implementation of the IWinHelpTester interface. Therefore, if you need to use this function, you must implement IWinHelpTester in your application.
The TWinHelpViewer class, implemented in the implementation section of the Vcl.WinHelpViewer unit, uses CanShowALink in the TWinHelpViewer.UnderstandsKeyword function. TWinHelpViewer.UnderstandsKeyword implements the System.HelpIntfs.ICustomHelpViewer.UnderstandsKeyword function when you specify the Vcl.WinHelpViewer unit in the uses section of your program.
The WinHelpViewer unit is deprecated. Use Vcl.HtmlHelpViewer instead.
The WinHelpViewer unit implements the wrapper for the Windows WinHelp function API. Microsoft has deprecated WinHelp.