System.HelpIntfs.IHelpSelector

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

IHelpSelector = interface(IInterface)

C++

__interface  INTERFACE_UUID("{B0FC9358-5F0E-11D3-A3B9-00C04F79AD3A}") IHelpSelector  : public System::IInterface

Properties

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

Description

Interface for Help Selector object.

When an application uses more than one Help Viewer, there may be multiple responses to a Help request. By default, the Help System polls the Viewers in the order they were registered, and gives the request to the first viewer that claims to be able to handle it.

An application can optionally provide a Help Selector, which determines the Viewer for keyword-based Help requests and for requests to display a Table of Contents. To define a Help Selector, create an object that implements IHelpSelector and pass it to the Help System, using AssignHelpSelector.

The Help Selector cannot affect context-based or topic-based Help requests, which always go to the first Viewer that claims to be able to handle the request.

See Also