AppHelpOptions

AppHelpOptions sets or returns help setting options.

svOpt = AppHelpOptions()

bool = AppHelpOptions(ssType)

bool = AppHelpOptions(ssType, ssURI)

Return Value

If the function is invoked without parameters it returns the current values for ssType and ssURI as an array with two strings (svOpt), otherwise the functions returns bool.

bool is TRUE (1), if the function was successful and otherwise FALSE (0).

Parameters

ssType

ssType is one of the following strings:

"chm"	HtmlHelp system is used.
"chm-local"	The local installed HtmlHelp chm file is used.
"html-local"	The standard web browser is used to display the local installed HTML help files.
"html-web"	The standard web browser is used to display HTML from the Internet or Intranet.

ssURI

ssURI sets the location of the help files.

Is ssType is "chm", ssURI is not used.

If ssType is "html-web", the default value is http://www.uniplot.de/documents/de/ (German) or http://www.uniplot.de/documents/en/ (English).

If ssType is "html-local", the default value is "file:///" + GetRootDirectory() + "help/{LANG}/", where {LANG} is de (German) or en (English).

Comment

If you would like to use the html help with your Web-Browser, please download the help files here http://www.uniplot.de/documents/en/download.html.

Example

Using the Internet help http://www.uniplot.de/documents/en/ with you web browser (for example Microsoft Internet Explorer or Mozilla Firefox):

AppHelpOptions("html-web")

Using the standard help system:

AppHelpOptions("chm")

Intranet example:

AppHelpOptions("html-local", "http://uniplot.my-company.com/documents/{LANG}/");

Local disk example:

AppHelpOptions("html-local", "file:///D:/uniplot-documents/{LANG}/");

History

Version	Description
5.20	New.

See also

Overview Application Object, AppHelp

_id-8055