Schlüsselwort-basierte Hilfe anzeigen
Nach oben zu Hilfesystem-Interfaces
Hilfe wird in der Hilfeanzeige normalerweise auf Schlüsselwörtern basierend angezeigt, wobei die Anzeige aufgefordert wird, Hilfe abhängig von einem bestimmten String anzuzeigen, oder als kontextabhängige Hilfe, wobei die Anzeige aufgefordert wird, Hilfe abhängig von einem bestimmten numerischen Bezeichner bereitzustellen.
Hinweis: In Anwendungen unter Windows, die die Anzeige HTMLHelp verwenden, ist die Standardform einer Hilfeanforderung ein numerischer Hilfekontext.
Um auf Schlüsselwörtern basierende Hilfe-Anforderungen zu unterstützen, muss das ICustomHelpViewer-Interface implementiert sein, während für die kontextbasierte Hilfeanforderungen das IExtendedHelpViewer-Interface implementiert sein muss.
ICustomHelpViewer unterstützt drei Methoden für die Verarbeitung der auf Schlüsselwörtern basierenden Hilfe:
UnderstandsKeyword(const HelpString: String): Integer
int UnderstandsKeyword(const UnicodeString HelpString)
- UnderstandsKeyword ist die erste von drei vom Hilfe-Manager aufgerufenen Methoden. UnderstandsKeyword ruft jede registrierte Hilfeanzeige mit demselben HelpString-String auf, um festzustellen, ob die Anzeige Hilfe zu diesem HelpString bereitstellen kann. UnderstandsKeyword übergibt als Antwort eine ganze Zahl, die angibt, wie viele Hilfeseiten die Hilfeanzeigen zu dieser Hilfeanforderung bereitstellen können.
ICustomHelpViewer.GetHelpStrings(const HelpString: String): TStringList
Classes::TStringList*__fastcall ICustomHelpViewer::GetHelpStrings(const UnicodeString HelpString)
- GetHelpStrings wird vom Hilfe-Manager aufgerufen, wenn mehrere Hilfeanzeigen Hilfe zu dem angegebenen HelpString-Schlüsselwort anbieten können. Von der Anzeige wird als Rückgabewert eine TStringList erwartet, die vom Hilfe-Manager freigegeben wird. Die Strings in der zurückgegebenen Liste entsprechen den Hilfethemen, die für das HelpString-Schlüsselwort bereitgestellt werden können, aber die Eigenschaften dieser Zuordnung können von der Hilfeanzeige festgelegt werden. Im Falle der Anzeige HTMLHelp unter Windows enthält die Stringliste immer genau einen Eintrag.
ShowHelp(const HelpString: String)
void__fastcall ShowHelp(const UnicodeString HelpString)
- ShowHelp wird vom Hilfe-Manager aufgerufen, wenn er die Hilfeanzeige benötigt, um Hilfe zu einem bestimmten HelpString-Schlüsselwort anzuzeigen. Dies ist der letzte Methodenaufruf in der Operation; diese Methode wird garantiert nie aufgerufen, wenn nicht zuvor UnderstandsKeyword aufgerufen wurde.