System.HelpIntfs.IHelpSystemFlags

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

IHelpSystemFlags = interface(IExtendedHelpViewer)

C++

__interface  INTERFACE_UUID("{69418F09-5E49-4899-9E13-9FE3C1497566}") IHelpSystemFlags  : public IExtendedHelpViewer

Properties

Type Visibility Source Unit Parent
interface
class
public
System.HelpIntfs.pas
System.HelpIntfs.hpp
System.HelpIntfs System.HelpIntfs

Description

Interface for setting a default topic.

The IHelpSystemFlags interface can be optionally implemented in order to alter the default system behavior. IHelpSystemFlags exposes methods that are used for determining whether the help system should fall back to a default topic or raise an exception if the search for a topic is not successful.

If GetUseDefaultTopic is True, then if a topic being searched for is not found, the default topic is shown instead.

See Also