Files
help/source/text/sbasic/shared/03/lib_ScriptForge.xhp
Alain Romedenne e4bc24515c ScriptForge library help - WiP
main page

Change-Id: I27f9fc5d1731fd23a0130c52f372711a920a02d7
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/106433
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
2020-11-23 22:50:50 +01:00

52 lines
3.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
-->
<meta>
<topic id="toolsbasiclibrary" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">ScriptForge Library</title>
<filename>/text/sbasic/shared/03/lib_ScriptForge.xhp</filename>
</topic>
</meta>
<body>
<h1 id="hd_id31529004750471" xml-lang="en-US"><variable id="ScriptForge_lib"><link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="ScriptForge library">The <item type="literal">ScriptForge</item> Library</link></variable></h1>
<bookmark xml-lang="en-US" branch="index" id="bm_id491529070339774">
<bookmark_value>BASIC ScriptForge library</bookmark_value>
</bookmark>
<section id="howtoget">
<embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/>
</section>
<note id="par_id901528999850603"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/>
<item type="literal">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</item></note>
<paragraph role="paragraph" id="par_id781606153472028">The described modules and classes are invoked from user scripts as "Services". A generic constructor of those services has been designed for that purpose:</paragraph>
<bascode>
<paragraph role="bascode" id="bas_id201606153529501">[ScriptForge.][Services.]CreateScriptService("servicename"[, arg0, Arg1, ...])</paragraph>
</bascode>
<paragraph role="paragraph" id="par_id891606153700196">Services from external libraries can registered with the <literal>RegisterScriptServices(...)</literal> method in order to extend the set of available services.</paragraph>
<paragraph role="paragraph" id="par_id491606151060454">Array Service</paragraph>
<paragraph role="paragraph" id="par_id51606151111406">Dictionary class Service</paragraph>
<paragraph role="paragraph" id="par_id341606151137912">Exception class Service</paragraph>
<paragraph role="paragraph" id="par_id1001606151139039">FileSystem Service</paragraph>
<paragraph role="paragraph" id="par_id511606151140972">L10n class Service</paragraph>
<paragraph role="paragraph" id="par_id781606151141190">Platform Service</paragraph>
<paragraph role="paragraph" id="par_id821606151141382">Root class Service</paragraph>
<paragraph role="paragraph" id="par_id771606151141575">Services class Service</paragraph>
<paragraph role="paragraph" id="par_id671606151231848">Session Service</paragraph>
<paragraph role="paragraph" id="par_id861606151242391">String Service</paragraph>
<paragraph role="paragraph" id="par_id791606151259895">TestStream class Service</paragraph>
<paragraph role="paragraph" id="par_id951606151273072">Timer class Service</paragraph>
<paragraph role="paragraph" id="par_id951606151282712">UI Service</paragraph>
<paragraph role="paragraph" id="par_id161606151295297">Utils Service</paragraph>
</body>
</helpdocument>