Vcl.WinHelpViewer.IWinHelpTester.CanShowContext

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function CanShowContext(const Context: THelpContext;  const FileName: String): Boolean;

C++

virtual bool __fastcall CanShowContext(const System::Classes::THelpContext Context, 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 context identifier and which is located in the specified help file.

CanShowContext returns True if the Help System can show the help topic, which is specified by the Context context identifier and which is located in the specified FileName help file. Otherwise, CanShowContext 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 CanShowContext in the TWinHelpViewer.UnderstandsContext function. TWinHelpViewer.UnderstandsContext implements the System.HelpIntfs.IExtendedHelpViewer.UnderstandsContext 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.

See Also