.. highlightlang:: us .. index:: AppHelpOptions .. _apphelpoptions: AppHelpOptions ============== .. us.tag AppHelpOptions NOTREADYENGLISH App New5200 :ref:`AppHelpOptions` sets or returns help setting options. .. function:: svOpt = AppHelpOptions() bool = AppHelpOptions(ssType) bool = AppHelpOptions(ssType, ssURI) .. us.return **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). .. us.params **Parameters** .. uparam:: ssType *ssType* is one of the following strings: .. list-table:: :header-rows: 0 * - ``"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. .. uparam:: 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). .. us.comment **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. .. us.example **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}/"); .. us.history **History** .. list-table:: :header-rows: 1 * - Version - Description * - 5.20 - New. .. seealso:: :ref:`Overview-Application-Object`, :ref:`AppHelp` :sub:`id-8055`