Vcl.HtmlHelpViewer.IHtmlHelpTester.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.HtmlHelpViewer.pas Vcl.HtmlHelpViewer.hpp |
Vcl.HtmlHelpViewer | IHtmlHelpTester |
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 IHtmlHelpTester interface. Therefore, if you need to use this function, you must implement IHtmlHelpTester in your application.
The Vcl.THtmlHelpViewer class, implemented in the implementation section of the Vcl.HtmlHelpViewer unit, uses CanShowALink in the Vcl.THtmlHelpViewer.UnderstandsKeyword function. Vcl.THtmlHelpViewer.UnderstandsKeyword implements the System.HelpIntfs.ICustomHelpViewer.UnderstandsKeyword function when you specify the Vcl.HtmlHelpViewer unit in the uses section of your program.