IHelpSelector implementieren

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Hilfesystem-Interfaces


Warnung! RAD Studio stellt keine Implementierung des Interface IHelpSelector bereit. Um Methoden dieses Interface zu verwenden, müssen Sie Ihre eigene Implementierung bereitstellen.

System.HelpIntfs.IHelpSelector ist eine Ergänzung von System.HelpIntfs.ICustomHelpViewer. Wenn mehr als eine registrierte Anzeige Unterstützung für ein bestimmtes Schlüsselwort, eine Kontext-ID oder einen Themennamen zurückmelden oder ein Inhaltsverzeichnis bereitstellen, muss der Hilfe-Manager eine davon auswählen. Für Kontexte-IDs oder Themennamen wählt der Hilfe-Manager immer die erste Hilfeanzeige aus, die eine Unterstützung zurückmeldet. Im Fall von Schlüsselwörtern oder Inhaltsverzeichnissen wählt der Hilfe-Manager standardmäßig die erste Hilfeanzeige aus. Diese Verhaltensweise kann von einer Anwendung jedoch überschrieben werden.

Um die Entscheidung des Hilfe-Managers für solche Fälle zu überschreiben, muss eine Anwendung eine Klasse registrieren, die eine Implementierung der Schnittstelle IHelpSelector bereitstellt. IHelpSelector exportiert zwei Funktionen: SelectKeyword und TableOfContents. Beide nehmen als Argument ein TStrings-Objekt entgegen, das entweder die möglichen Übereinstimmungen mit dem Schlüsselwörtern enthält, oder die Namen der Anzeigen, die ein Inhaltsverzeichnis bereitstellen können. Der Implementierer muss den Index zurückgeben (in TStringsList), der den ausgewählten String repräsentiert. Dann wird TStringsList vom Hilfe-Manager freigegeben.

Hinweis: Der Hilfe-Manager gerät möglicherweise durcheinander, wenn die Strings neu angeordnet werden. Es wird empfohlen, dass Anwendungen, die IHelpSelector implementieren, dies möglichst vermeiden. Das Hilfesystem unterstützt nur einen Hilfe-Selektor; werden neue Selektoren registriert, wird der zuvor existierende Selektor deaktiviert.

Siehe auch