|
RAD Studio VCL Reference
|
  |
   |
ICustomHelpViewer.GetHelpStrings Method
|
RAD Studio VCL Reference
|
|
|
Return Help Strings that match a keyword.
function GetHelpStrings(const HelpString: string): TStringList;
__fastcall TStringList GetHelpStrings(const AnsiString HelpString);
The Help System calls GetHelpStrings to obtain a list of Help Strings for topics that match a keyword-based Help request. GetHelpStrings should expect the keyword in the parameter and return the Help Strings in a TStringList object.
A Help String is an identifying string associated with a specific topic. The Help System requires that each of the topics provided by a given Viewer have a different Help String. The Help System does not require that two Viewers never use the same Help String, but an application should still avoid doing this. One strategy is to include the Viewer Name in the Help String.
The Help System uses Help Strings to provide the Help Selector with a merged list of Help topics that match a request. Typically, Help Strings are human-readable topic descriptions, and the Help Selector simply displays them to the user so the user can choose which topic will be displayed.
|
Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
|
|
What do you think about this topic? Send feedback!
|
Description