THTMLBrowserHelpViewer.BrowserParams property

Declaration

property BrowserParams: string read FBrowserParams write SetBrowserParams;

Description

BrowserParams is a String property used to specify arguments passed on the command line to the browser application. The arguments identify the URL and any optional command line switches needed for the executable in BrowserPath. BrowserParams uses the ' %s' notation to represent a macro that is substituted with the URL for the Help topic when it is displayed. The value in BrowserParams can be overridden, but should always include '%s' to allow insertion of the URL for the help topic.

BrowserParams is updated/used when the HTML help topic is displayed in the ShowNode method. When BrowserParams contains an empty string (''), the value in DefaultBrowserParams is used.

Use BrowserPath to access the browser application used to view HTML help topics. Use the OnFindDefaultBrowser event handler to perform conditional browser path and parameter assignment based on user-defined criteria.

See also

• BrowserPath
• BrowserParams
• OnFindDefaultBrowser
• ShowNode