System.HelpIntfs.IHelpSystem3.ShowIndex
Delphi
procedure ShowIndex(const Topic, HelpFileName: string);
C++
virtual void __fastcall ShowIndex(const System::UnicodeString Topic, const System::UnicodeString HelpFileName) = 0 ;
Propriétés
| Type | Visibilité | Source | Unité | Parent |
|---|---|---|---|---|
procedure function |
public | System.HelpIntfs.pas System.HelpIntfs.hpp |
System.HelpIntfs | IHelpSystem3 |
Description
Ouvre le volet Index du visualiseur d'aide.
Le système d'aide RTL appelle ShowIndex pour que'un visualiseur ouvre son volet Index. Si le visualiseur d'aide peut chercher le paramètre de rubrique donné, il effectue la recherche dans l'Index ; sinon, il est ignoré. Le paramètre HelpFileName est utilisé seulement dans quelques systèmes d'aide (par exemple, l'aide Microsoft HTML) et seulement s'il n'existe pas de fichier d'aide familier au système d'aide.
Le système d'aide interroge tous les visualiseurs d'aide recensés. S'il n'y a qu'un visualiseur qui puisse afficher un volet Index, donc cela est montré ; sinon, l'utilisateur est invité à décider quel visualiseur doit être affiché.