source/text/sbasic/shared/03/sf_services.xhp | 264 +++++++++++++++++++++++++++
source/text/sbasic/shared/03/sf_session.xhp | 50 ++---
source/text/sbasic/shared/03103700.xhp | 34 +--
source/text/sbasic/shared/03104200.xhp | 8
source/text/sbasic/shared/03131900.xhp | 2
5 files changed, 312 insertions(+), 46 deletions(-)
New commits:
commit ec6e0c930fd8a7ca5dc6a84a686602acff69234e
Author: Alain Romedenne <alain.romede...@libreoffice.org>
AuthorDate: Tue Feb 16 10:45:07 2021 +0100
Commit: Alain Romedenne <alain.romede...@libreoffice.org>
CommitDate: Wed Feb 17 13:29:42 2021 +0100
sf_services new help page
+ sf_session adjustments and links
- Addition of Array formulae and Array function information
Change-Id: I03d64d863db90124cad75d13a66ade8d6abba126
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/110921
Tested-by: Jenkins
Tested-by: Jean-Pierre Ledure <j...@ledure.be>
Reviewed-by: Rafael Lima <rafael.palma.l...@gmail.com>
Reviewed-by: Alain Romedenne <alain.romede...@libreoffice.org>
diff --git a/source/text/sbasic/shared/03/sf_services.xhp
b/source/text/sbasic/shared/03/sf_services.xhp
new file mode 100644
index 000000000..3dc040187
--- /dev/null
+++ b/source/text/sbasic/shared/03/sf_services.xhp
@@ -0,0 +1,264 @@
+<?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="SF_Services" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">ScriptForge.Services service</title>
+ <filename>/text/sbasic/shared/03/sf_services.xhp</filename>
+ </topic>
+</meta>
+<body>
+<section id="abstract">
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id751582710853363">
+ <bookmark_value>Services service</bookmark_value>
+ </bookmark>
+
+<h1 id="hd_id471582710868716" xml-lang="en-US"><variable
id="ScriptForgeServices"><link href="text/sbasic/shared/03/sf_services.xhp"
name="Services
service"><literal>ScriptForge</literal>.<literal>Services</literal>
service</link></variable></h1>
+
+<paragraph role="paragraph" xml-lang="en-US" id="par_id351582710868545">
+ The ScriptForge library is built upon an extensible collection of
so-called "Services".
+ <br />This collection is implemented as categories of Basic libraries or
Python modules:
+</paragraph>
+<list type="ordered" format="a">
+ <listitem>
+ <paragraph id="par_id751582711417284" role="listitem"
xml-lang="en-US">the standard <literal>ScriptForge</literal> library shipped
with %PRODUCTNAME</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id711582711434921" role="listitem"
xml-lang="en-US">a number of "associated" libraries shipped with %PRODUCTNAME
as well</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id11582711444725" role="listitem"
xml-lang="en-US">any user/contributor LibreOffice extension wanting to fit into
the same framework</paragraph>
+ </listitem>
+</list>
+</section>
+
+<paragraph role="paragraph" id="par_id211596296017810" xml-lang="en-US">A
<emph>service</emph> is a collection of properties or methods which implement
the service.</paragraph>
+<tip id="par_id301596296901387" xml-lang="en-US">For the author of a user
script, a service may be either a <emph>module</emph> within a library, or an
<emph>instance</emph> of a class module.</tip>
+<paragraph role="paragraph" id="par_id411596296395830" xml-lang="en-US">An
<emph>event manager</emph> is a script contained in a library which binds an
event triggering a macro - usually defined by the <menuitem>Tools -
Customize</menuitem> menu - to the concerned service instance.</paragraph>
+<tip id="par_id771596296933669" xml-lang="en-US">As an example, if several
documents trigger the same macro when they are loaded, it might be useful to
know which document triggered the macro this time. That's where an event
manager plays its role.</tip>
+
+<paragraph role="paragraph" id="par_id191582711902530" xml-lang="en-US">The
following methods make up the kernel of the <literal>ScriptForge</literal>
framework:</paragraph>
+<list type="unordered">
+ <listitem>
+ <paragraph id="par_id641582712034899" role="listitem" xml-lang="en-US"
localize="false"><emph>RegisterScriptServices</emph></paragraph>
+ <paragraph role="paragraph" id="par_id351582712098824"
xml-lang="en-US">Called internally by <literal>ScriptForge</literal> to
register for a library the list of services it implements.
+ <br />Each library associated to <literal>Scriptforge</literal> or
extending it must implement its own <literal>RegisterScriptServices</literal>
method.</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id961595847982832" role="listitem" xml-lang="en-US"
localize="false"><emph>RegisterService</emph></paragraph>
+ <paragraph role="paragraph" id="par_id671595847982308"
xml-lang="en-US">Called - as many times as there are services to register in
the library - by <literal>RegisterScriptServices</literal>.</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id201596294275926" role="listitem" xml-lang="en-US"
localize="false"><emph>RegisterEventManager</emph></paragraph>
+ <paragraph role="paragraph" id="par_id241596294275434"
xml-lang="en-US">Called to register a library event manager by
<literal>RegisterScriptServices</literal>.</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id281582712132230" role="listitem" xml-lang="en-US"
localize="false"><emph>CreateScriptService</emph></paragraph>
+ <paragraph role="paragraph" id="par_id741582712156448"
xml-lang="en-US">Called by user scripts to get an object giving access to the
service given as argument.
+ <br />All services should be invoked thru the
<literal>CreateScriptService</literal> method.</paragraph>
+ </listitem>
+</list>
+<tip id="par_id651582712806415" xml-lang="en-US">Conventionally, the
<literal>String</literal>, <literal>Array</literal> and
<literal>Exception</literal> services may be invoked directly respectively as
<literal>SF_String</literal>, <literal>SF_Array</literal> and
<literal>SF_Exception</literal>.</tip>
+
+<table id="tab_id501611613601554">
+ <tablerow>
+ <tablecell colspan="3"><paragraph id="par_id891611613601554"
role="tablehead" xml-lang="en-US">List of Methods in the Services
Service</paragraph></tablecell>
+ </tablerow>
+ <tablerow>
+ <tablecell>
+ <paragraph id="par_id891611613601556" role="tablecontent"
localize="false">
+ <link
href="text/sbasic/shared/03/sf_services.xhp#CreateScriptService"
name="CreateScriptService method">CreateScriptService</link>
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id541611613601554" role="tablecontent"
localize="false">
+ <link
href="text/sbasic/shared/03/sf_services.xhp#RegisterScriptServices"
name="RegisterScriptServices method">RegisterScriptServices</link><br/>
+ <link
href="text/sbasic/shared/03/sf_services.xhp#RegisterService"
name="RegisterService method">RegisterService</link>
+ </paragraph>
+ </tablecell>
+ <tablecell>
+ <paragraph id="par_id701611613601554" role="tablecontent"
localize="false">
+ <link
href="text/sbasic/shared/03/sf_services.xhp#RegisterEventManager"
name="RegisterEventManager method">RegisterEventManager</link>
+ </paragraph>
+ </tablecell>
+ </tablerow>
+</table>
+
+ <section id="CreateScriptService">
+ <comment> CreateScriptService
--------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id861582714020042">
+ <bookmark_value>Services service;CreateScriptService</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id751582714020043" localize="false">CreateScriptService</h2>
+ <paragraph role="paragraph" id="par_id871582714020043">
+ Gain access to one of the services of a library for the benefit of a
user script.
+ <br /> The returned value is a Basic object or
<literal>Nothing</literal> if an error occurred.
+ </paragraph>
+ <paragraph role="paragraph" id="par_id101582714266656" xml-lang="en-US">
+ A service can be understood as either:
+ </paragraph>
+ <list type="unordered">
+ <listitem>
+ <paragraph id="par_id531582714337820" role="listitem"
xml-lang="en-US">as a set of methods gathered in a Basic standard
module</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id291582714347134" role="listitem"
xml-lang="en-US">or a set of methods and properties gathered in a Basic class
module.</paragraph>
+ </listitem>
+ </list>
+ <h3 id="hd_id431582714020044"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id901582714020044">CreateScriptService(Service As String, [arg0, ...]
As Variant) As Variant</paragraph>
+ </bascode>
+ <h3 id="hd_id251582714020044"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id971582714020045"><emph>Service</emph>: The name of the service
identified as "library.service".
+ <br />The library is a Basic library that must exist in the <link
href="text/sbasic/shared/03131900.xhp" name="GlobalScope">GlobalScope</link>.
The default value is "ScriptForge".
+ <br />The service is one of the services registered by the library via
the <literal>RegisterScriptServices()</literal> method.</paragraph>
+ <paragraph role="paragraph" id="par_id391582714020045"><emph>arg0,
...</emph>: A list of arguments required by the invoked service.
+ <br />If the first argument refers to an event manager, then arg0 is
mandatory and must be the UNO object representing the event provided as
argument to the user macro.</paragraph>
+ <h3 id="hd_id91582714020046"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id581582898149266">GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph>
+ <paragraph role="bascode" id="bas_id981582898174133">' To be done
once</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id281582898567582">Dim svc As Object</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id571582714020046">Set svc = CreateScriptService("Array")</paragraph>
+ <paragraph role="bascode" id="bas_id311582715700844">' Refers to the
"ScriptForge.Array" service or SF_Array</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id671582715735064">Set svc =
CreateScriptService("ScriptForge.Dictionary")</paragraph>
+ <paragraph role="bascode" id="bas_id61582715759468">' Returns a new
empty dictionary class instance; "ScriptForge." is optional</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id231582715781789">Set svc =
CreateScriptService("SFDocuments.Calc")</paragraph>
+ <paragraph role="bascode" id="bas_id901582715797722">' Refers to the
Calc service, implemented in the associated SFDocuments library</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id841582715829454">Set svc = CreateScriptService("Timer",
True)</paragraph>
+ <paragraph role="bascode" id="bas_id361582715845747">' Returns a Timer
class instance starting immediately</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id11596298688112">Set svc =
CreateScriptService("SFDocuments.DocumentEvent", oEvent)</paragraph>
+ <paragraph role="bascode" id="bas_id571596298708062">' Refers to the
DocumentEvent service implemented in the associated SFDocuments
library</paragraph>
+ <paragraph role="bascode" id="bas_id121613492254532">' Returns the
instance of the Document class that fired the event</paragraph>
+ </bascode>
+ </section>
+
+ <section id="RegisterScriptServices">
+ <comment> RegisterScriptServices
------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id221582722979917">
+ <bookmark_value>Services service;RegisterScriptServices</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id11582722979426" localize="false">RegisterScriptServices</h2>
+ <paragraph role="paragraph" id="par_id1315827229793">
+ By executing a series of invocations of
<literal>RegisterService()</literal> and
<literal>RegisterEventManager()</literal>, the
<literal>RegisterScriptServices()</literal> method incorporates a library into
the <literal>ScriptForge</literal> framework.
+ <br/>Each library pertaining to the framework must implement its own
version of this method.
+ </paragraph>
+ <warning id="par_id411582723190195" xml-lang="en-US">The method has to be
stored in a <emph>standard</emph> Basic module as opposed to a class
module.</warning>
+ <paragraph role="paragraph" id="par_id351582724127926">A service is
either:</paragraph>
+ <section id="ServiceIdentifier">
+ <list type="unordered">
+ <listitem>
+ <paragraph id="par_id171582722979820" role="listitem"
xml-lang="en-US">a Basic standard module passed as a Basic object.</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id121582722979649" role="listitem"
xml-lang="en-US">or a string designating the function to execute to get an
instance of the service. It is in fact the function containing the
<literal>New</literal> keyword of a <link
href="text/sbasic/shared/03103700.xhp" name="Set statement">Set</link>
statement creating the instance.</paragraph>
+ </listitem>
+ </list>
+ <bascode>
+ <paragraph role="bascode" xml-lang="en-US" id="par_id771582725815107">
GlobalScope.LibraryName.ModuleName ' Object</paragraph>
+ <paragraph role="bascode" xml-lang="en-US" id="bas_id721582724496873">
"LibraryName.ModuleName.FunctionName" ' String</paragraph>
+ </bascode>
+ </section>
+ <h3 id="hd_id351582722979618"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id761582722979924">Public Sub RegisterScriptServices()</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id771582727350871">'
To be stored in library = myLibrary</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id541582722979219">
With GlobalScope.ScriptForge.SF_Services</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id731582725340888">
.RegisterService("myService1", GlobalScope.myLibrary.myModule)</paragraph>
+ <paragraph role="bascode" id="bas_id11582725353585"> ' Refer to a
Basic standard module implementing the service as a set of methods</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id451582725361588">
.RegisterService("myService2",
"myLibrary.someModule.someFunction")</paragraph>
+ <paragraph role="bascode" id="bas_id341582725374064"> ' The
function should return an instance of a Basic object class implementing the
service</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id881582725383456">
' ...</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id851582725392009">
End With</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id371582725476589">End Sub</paragraph>
+ </bascode>
+ <paragraph role="paragraph" id="par_id741582727674249"
xml-lang="en-US">When a user script contains a statement such as:</paragraph>
+ <bascode><paragraph role="bascode" localize="false"
id="bas_id301582727687068">Set myServ =
CreateScriptService("myLibrary.myService1")</paragraph></bascode>
+ <paragraph role="paragraph" id="par_id611582727701061" xml-lang="en-US"><br
/><literal>ScriptForge</literal> performs these tasks:</paragraph>
+ <list type="ordered" format="i">
+ <listitem>
+ <paragraph id="par_id511582728914523" role="listitem"
xml-lang="en-US">load the library <literal>myLibrary</literal> when
necessary</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id441582728492537" role="listitem"
xml-lang="en-US">invoke the <literal>RegisterScriptServices</literal> method to
load the list of services of <literal>myLibrary</literal> in memory</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id531582728511341" role="listitem"
xml-lang="en-US">initialize the variable <literal>myServ</literal> with the
given service</paragraph>
+ </listitem>
+ </list>
+ </section>
+
+ <section id="RegisterService">
+ <comment> RegisterService
------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id231595857355626">
+ <bookmark_value>Services service;RegisterService</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id501595857355859" localize="false">RegisterService</h2>
+ <paragraph role="paragraph" id="par_id331595857355789" xml-lang="en-US">
+ The method returns <literal>True</literal> if the name-value pair given
as argument could be registered successfully.
+ </paragraph>
+ <h3 id="hd_id701595857355894"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id441595857355915">GlobalScope.ScriptForge.SF_Services.RegisterService(ServiceName
As String, ServiceReference As Variant) As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id1159585735573"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id721595857355929"><emph>ServiceName</emph>: The name of the service as
a case-insensitive string. The name must be unique.</paragraph>
+ <paragraph role="paragraph" id="par_id271595857355756"
xml-lang="en-US"><emph>ServiceReference</emph>: A service reference is
either:</paragraph>
+ <embed href="text/shared/03/sf_services.xhp#ServiceIdentifier"/>
+ <h3 id="hd_id481595857355966"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id11595857355578">
With GlobalScope.ScriptForge.SF_Services</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id571595857355831">
.RegisterService("myService1", GlobalScope.myLibrary.myModule)</paragraph>
+ <paragraph role="bascode" xml-lang="en-US" id="bas_id101595857355820">
' Refer to a Basic standard module implementing the service as a set of
methods</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id771595857355646">
.RegisterService("myService2",
"myLibrary.someModule.someFunction")</paragraph>
+ <paragraph role="bascode" xml-lang="en-US" id="bas_id951595857355198">
' The function should return an instance of a Basic object class
implementing the service</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id56159585735558">
' ...</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id461595857355534">
End With</paragraph>
+ </bascode>
+ </section>
+
+ <section id="RegisterEventManager">
+ <comment> RegisterEventManager
------------------------------------------------------------------------------------------------------------------------
</comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id241596299279341">
+ <bookmark_value>Services service;RegisterEventManager</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id981596299279692" localize="false">RegisterEventManager</h2>
+ <paragraph role="paragraph" id="par_id701596299279876" xml-lang="en-US">
+ The method returns <literal>True</literal> if the name-value pair given
as argument could be registered successfully.
+ </paragraph>
+ <h3 id="hd_id151596299279417"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false"
id="bas_id201596299279643">GlobalScope.ScriptForge.SF_Services.RegisterEventManager(ServiceName
As String, ServiceReference As String) As Boolean</paragraph>
+ </bascode>
+ <h3 id="hd_id421596299279275"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <paragraph role="paragraph"
id="par_id331596299279165"><emph>ServiceName</emph>: The name of the service as
a case-insensitive string. The name must be unique.</paragraph>
+ <paragraph role="paragraph" id="par_id92159629927929"
xml-lang="en-US"><emph>ServiceReference</emph>: A string designating the
function to execute to get an instance of the service. It is in fact the
function containing the <literal>New</literal> keyword of a <link
href="text/sbasic/shared/03103700.xhp" name="Set statement">Set</link>
statement creating the instance.:</paragraph>
+ <bascode><paragraph role="bascode" localize="false"
id="bas_id661596299279598"> "LibraryName.ModuleName.FunctionName" '
String</paragraph></bascode>
+ <h3 id="hd_id631596299279349"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id89159629927920">
With GlobalScope.ScriptForge.SF_Services</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id531596299279547">
.RegisterEventManager("myEventMgr",
"myLibrary.someModule.someFunction")</paragraph>
+ <paragraph role="bascode" id="bas_id521596299279373"> ' The
function should return an instance of a Basic object class implementing the
service</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id641596299279251">
' ...</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id801596299279792">
End With</paragraph>
+ </bascode>
+ </section>
+
+ <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/>
+
+ <section id="relatedtopics">
+ <embed href="text/sbasic/shared/03103700.xhp#Set_h1"/>
+ <embed href="text/sbasic/shared/03131900.xhp#GlobalScope_h1"/>
+ </section>
+
+</body>
+</helpdocument>
\ No newline at end of file
diff --git a/source/text/sbasic/shared/03/sf_session.xhp
b/source/text/sbasic/shared/03/sf_session.xhp
index 8c9aae2f0..e9a32de58 100644
--- a/source/text/sbasic/shared/03/sf_session.xhp
+++ b/source/text/sbasic/shared/03/sf_session.xhp
@@ -227,7 +227,7 @@
<paragraph role="bascode" id="bas_id61582815407231" xml-lang="en-US">'
Xray returns no value</paragraph>
</bascode>
</section>
-
+
<section id="ExecuteCalcFunction">
<comment> ExecuteCalcFunction
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id571582816585180">
@@ -235,13 +235,13 @@
</bookmark>
<h2 id="hd_id551582816585181" localize="false">ExecuteCalcFunction</h2>
<paragraph role="paragraph" id="par_id111582816585181">Execute a Calc
function using its English name and based on the given arguments.
- <br />If the arguments are arrays, the function is executed as an array
function.</paragraph>
+ <br />If the arguments are arrays, the function is executed as an <link
href="text/scalc/01/04060107.xhp" name="array formula">array
formula</link>.</paragraph>
<h3 id="hd_id391582816585182"><embedvar
href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
<bascode>
<paragraph role="bascode" localize="false"
id="bas_id391582816585182">session.ExecuteCalcFunction(CalcFunction As String,
arg0, ...) As Variant</paragraph>
</bascode>
<h3 id="hd_id711582816585182"><embedvar
href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph"
id="par_id771582816585183"><emph>CalcFunction</emph>: The english name of the
function to execute.</paragraph>
+ <paragraph role="paragraph"
id="par_id771582816585183"><emph>CalcFunction</emph>: The English name of the
function to execute.</paragraph>
<paragraph role="paragraph" id="par_id371582816585183"><emph>arg0,
...</emph>: The arguments to provide to the called Calc function. Each argument
must be either a string, a numeric value or an array of arrays combining those
types.</paragraph>
<h3 id="hd_id891582816585184"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
<bascode>
@@ -251,7 +251,7 @@
<paragraph role="bascode" id="bas_id881582816585185" xml-lang="en-US">'
Generates an error.</paragraph>
</bascode>
</section>
-
+
<section id="ExecutePythonScript">
<comment> ExecutePythonScript
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id671582818023244">
@@ -280,7 +280,7 @@
<paragraph role="bascode" localize="false"
id="bas_id101582818023248">session.ExecutePythonScript(session.SCRIPTISSHARED,
"Capitalise.py$getNewString", "Abc") ' "abc"</paragraph>
</bascode>
</section>
-
+
<section id="HasUnoMethod">
<comment> HasUnoMethod
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id901587477335292">
@@ -302,7 +302,7 @@
<paragraph role="bascode" localize="false"
id="bas_id671587477335639">MsgBox session.HasUnoMethod(a,
"callFunction")</paragraph>
</bascode>
</section>
-
+
<section id="HasUnoProperty">
<comment> HasUnoProperty
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id511587477832348">
@@ -319,12 +319,12 @@
<paragraph role="paragraph" id="par_id701587477832750"
xml-lang="en-US"><emph>PropertyName</emph>: the property as a case-sensitive
string</paragraph>
<h3 id="hd_id511587477832273"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
<bascode>
- <paragraph role="bascode" localize="false" id="bas_id61587477832241">Dim
a As Variant</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id281587477832114">a
= CreateUnoService("com.sun.star.sheet.FunctionAccess")</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id90158747783219">MsgBox session.HasUnoProperty(a,
"Wildcards")</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id61587477832241">Dim
svc As Variant</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id281587477832114">svc =
CreateUnoService("com.sun.star.sheet.FunctionAccess")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id90158747783219">MsgBox session.HasUnoProperty(svc,
"Wildcards")</paragraph>
</bascode>
</section>
-
+
<section id="OpenURLInBrowser">
<comment> OpenURLInBrowser
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id321601129640799">
@@ -343,7 +343,7 @@
<paragraph role="bascode" localize="false"
id="bas_id781601129640527">session.OpenURLInBrowser("https://docs.python.org/3/library/webbrowser.html";)</paragraph>
</bascode>
</section>
-
+
<section id="RunApplication">
<comment> RunApplication
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id121582819697896">
@@ -365,7 +365,7 @@
<paragraph role="bascode" localize="false"
id="bas_id641582819697901">session.RunApplication("kate",
"/home/me/install.txt") ' GNU/Linux</paragraph>
</bascode>
</section>
-
+
<section id="SendMail">
<comment> SendMail
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id601601030349204">
@@ -393,7 +393,7 @@
<paragraph role="bascode" localize="false" id="bas_id971601033015034">
)</paragraph>
</bascode>
</section>
-
+
<section id="UnoMethods">
<comment> UnoMethods
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id701587478024358">
@@ -414,7 +414,7 @@
<paragraph role="bascode" localize="false"
id="bas_id211587478024770">MsgBox SF_Array.Contains(session.UnoMethods(a),
"callFunction")</paragraph>
</bascode>
</section>
-
+
<section id="UnoProperties">
<comment> UnoProperties
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id57158747834361">
@@ -430,12 +430,12 @@
<paragraph role="paragraph"
id="par_id241587478343323"><emph>UnoObject</emph>: The object to
inspect.</paragraph>
<h3 id="hd_id42158747834340"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
<bascode>
- <paragraph role="bascode" localize="false"
id="bas_id281587478343944">Dim a As Variant</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id581587478343738">a
= CreateUnoService("com.sun.star.sheet.FunctionAccess")</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id101587478343422">MsgBox SF_Array.Contains(session.UnoProperties(a),
"Wildcards")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id281587478343944">Dim svc As Variant</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id581587478343738">svc =
CreateUnoService("com.sun.star.sheet.FunctionAccess")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id101587478343422">MsgBox SF_Array.Contains(session.UnoProperties(svc),
"Wildcards")</paragraph>
</bascode>
</section>
-
+
<section id="UnoObjectType">
<comment> UnoObjectType
--------------------------------------------------------------------------------------------------------------------------
</comment>
<bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id221582820251346">
@@ -451,11 +451,11 @@
<paragraph role="paragraph"
id="par_id921582820251349"><emph>UnoObject</emph>: The object to
identify.</paragraph>
<h3 id="hd_id51582820251350"><embedvar
href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
<bascode>
- <paragraph role="bascode" localize="false"
id="bas_id771582820251350">Dim a As Variant, s As String</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id721582820680948">a
= CreateUnoService("com.sun.star.system.SystemShellExecute")</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id571582820689968">s
= session.UnoObjectType(a) '
"com.sun.star.comp.system.SystemShellExecute"</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id821582820696697">a
= CreateUnoStruct("com.sun.star.beans.Property")</paragraph>
- <paragraph role="bascode" localize="false" id="bas_id315828202513519">s
= session.UnoObjectType(a) ' "com.sun.star.beans.Property"</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id771582820251350">Dim svc As Variant, txt As String</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id721582820680948">svc =
CreateUnoService("com.sun.star.system.SystemShellExecute")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id571582820689968">txt = session.UnoObjectType(svc) '
"com.sun.star.comp.system.SystemShellExecute"</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id821582820696697">svc =
CreateUnoStruct("com.sun.star.beans.Property")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id315828202513519">txt = session.UnoObjectType(svc) '
"com.sun.star.beans.Property"</paragraph>
</bascode>
</section>
@@ -482,8 +482,10 @@
<embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/>
<section id="relatedtopics">
- <embed href="text/sbasic/guide/basic_2_python.xhp#basic2python"/>
+ <embed href="text/sbasic/shared/03104200.xhp#Array_h1"/>
<embed
href="text/sbasic/shared/calc_functions.xhp#CallingCalcFunctionsh1"/>
+ <embed href="text/sbasic/guide/basic_2_python.xhp#basic2python"/>
+ <embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/>
</section>
</body>
diff --git a/source/text/sbasic/shared/03103700.xhp
b/source/text/sbasic/shared/03103700.xhp
index dbbfa1cb3..8203a58d5 100644
--- a/source/text/sbasic/shared/03103700.xhp
+++ b/source/text/sbasic/shared/03103700.xhp
@@ -35,39 +35,39 @@
</bookmark>
-<paragraph id="hd_id3154422" role="heading" level="1" xml-lang="en-US"><link
href="text/sbasic/shared/03103700.xhp" name="Set Statement">Set
Statement</link></paragraph>
+<h1 id="hd_id3154422" xml-lang="en-US"><variable id="Set_h1"><link
href="text/sbasic/shared/03103700.xhp" name="Set Statement">Set
Statement</link></variable></h1>
<paragraph id="par_id3159149" role="paragraph" xml-lang="en-US">Sets an object
reference on a variable.</paragraph>
</section>
-<paragraph id="hd_id3153105" role="heading" level="2"
xml-lang="en-US">Syntax:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id491585753339474">
<image src="media/helpimg/sbasic/LetSet_statement.svg"
id="img_id4156306484514"><alt xml-lang="en-US" id="alt_id15152796484514">Set
Statement diagram</alt></image>
</paragraph>
<bascode>
-<paragraph id="par_id3154217" role="bascode" xml-lang="en-US">[Set] variable =
[New] object</paragraph>
+ <paragraph id="par_id3154217" role="bascode" xml-lang="en-US">[Set]
variable = [New] object</paragraph>
</bascode>
-<paragraph id="hd_id3154685" role="heading" level="2"
xml-lang="en-US">Parameters:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">
<emph>variable:</emph> a variable or a property that requires an object
reference.</paragraph>
<paragraph role="paragraph" id="par_id211588241663649"> <emph>expression:
</emph> A computable combination of terms such as a formula or an object
property or method.</paragraph>
<paragraph id="par_id3159252" role="paragraph" xml-lang="en-US">
<emph>object:</emph> Object that the variable refers to.</paragraph>
<paragraph id="par_idN10623" role="paragraph" xml-lang="en-US">
<literal>Nothing</literal> - Assign <literal>Nothing</literal> to a variable to
remove a previous assignment.</paragraph>
<note id="par_id101586014505785" xml-lang="en-US"><literal>Set</literal>
keyword is optional. <literal>Nothing</literal> is the default value for
objects.</note>
-<paragraph id="hd_id3159153" role="heading" level="2"
xml-lang="en-US">Example:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
-<paragraph id="par_idm1340836336" role="bascode" localize="false"
xml-lang="en-US">Sub ExampleSet</paragraph>
-<paragraph id="par_idm1340835104" role="bascode" localize="false"
xml-lang="en-US"> Dim obj As Object</paragraph>
-<paragraph id="par_idm1340833872" role="bascode" localize="false"
xml-lang="en-US"> Set obj = ThisComponent</paragraph>
-<paragraph id="par_idm1340832624" role="bascode" localize="false"
xml-lang="en-US"> Print obj.Title</paragraph>
-<paragraph id="par_idm1341832624" role="bascode" localize="false"
xml-lang="en-US"> </paragraph>
-<paragraph id="par_idm1340832625" role="bascode" localize="false"
xml-lang="en-US"> obj = New com.sun.star.beans.PropertyValue</paragraph>
-<paragraph id="par_idm1340832626" role="bascode" localize="false"
xml-lang="en-US"> With obj</paragraph>
-<paragraph id="par_idm1340832627" role="bascode" localize="false"
xml-lang="en-US"> .Name = "key" : .Value = 594.34</paragraph>
-<paragraph id="par_idm1340832628" role="bascode" localize="false"
xml-lang="en-US"> Print .Name, .Value</paragraph>
-<paragraph id="par_idm1340931399" role="bascode" localize="false"
xml-lang="en-US"> End With</paragraph>
-<paragraph id="par_idm1340831399" role="bascode" localize="false"
xml-lang="en-US">End Sub</paragraph>
+<paragraph id="par_idm1340836336" role="bascode" localize="false">Sub
ExampleSet</paragraph>
+<paragraph id="par_idm1340835104" role="bascode" localize="false"> Dim obj
As Object</paragraph>
+<paragraph id="par_idm1340833872" role="bascode" localize="false"> Set obj
= ThisComponent</paragraph>
+<paragraph id="par_idm1340832624" role="bascode" localize="false"> Print
obj.Title</paragraph>
+<paragraph id="par_idm1341832624" role="bascode" localize="false"> </paragraph>
+<paragraph id="par_idm1340832625" role="bascode" localize="false"> obj =
New com.sun.star.beans.PropertyValue</paragraph>
+<paragraph id="par_idm1340832626" role="bascode" localize="false"> With
obj</paragraph>
+<paragraph id="par_idm1340832627" role="bascode" localize="false">
.Name = "key" : .Value = 594.34</paragraph>
+<paragraph id="par_idm1340832628" role="bascode" localize="false">
Print .Name, .Value</paragraph>
+<paragraph id="par_idm1340931399" role="bascode" localize="false"> End
With</paragraph>
+<paragraph id="par_idm1340831399" role="bascode" localize="false">End
Sub</paragraph>
</bascode>
<tip id="par_id841586014507226" xml-lang="en-US"><literal>New</literal>
creates UNO objects or <link href="text/sbasic/shared/classmodule"
name="ClassModule">class module</link> objects, before assigning it to a
variable.</tip>
-</body>
+</body>
</helpdocument>
\ No newline at end of file
diff --git a/source/text/sbasic/shared/03104200.xhp
b/source/text/sbasic/shared/03104200.xhp
index 4657343f2..056478400 100644
--- a/source/text/sbasic/shared/03104200.xhp
+++ b/source/text/sbasic/shared/03104200.xhp
@@ -32,18 +32,18 @@
<section id="array">
<bookmark xml-lang="en-US" branch="index"
id="bm_id3150499"><bookmark_value>Array function</bookmark_value>
</bookmark>
-<paragraph role="heading" id="hd_id3150499" xml-lang="en-US" level="1"><link
href="text/sbasic/shared/03104200.xhp" name="Array Function">Array
Function</link></paragraph>
+<h1 id="hd_id3150499" xml-lang="en-US"><variable id="Array_h1"><link
href="text/sbasic/shared/03104200.xhp" name="Array Function">Array
Function</link></variable></h1>
<paragraph role="paragraph" id="par_id3155555" xml-lang="en-US">Returns the
type Variant with a data field.</paragraph>
</section>
-<paragraph role="heading" id="hd_id3148538" xml-lang="en-US"
level="2">Syntax:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
<paragraph role="bascode" id="par_id3153126" xml-lang="en-US">Array ( Argument
list)</paragraph>
</bascode>
<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US">See also <link
href="text/sbasic/shared/03104300.xhp"
name="DimArray">DimArray</link></paragraph>
-<paragraph role="heading" id="hd_id3150669" xml-lang="en-US"
level="2">Parameters:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph role="paragraph" id="par_id3145609" xml-lang="en-US">
<emph>Argument list:</emph> A list of any number of arguments that are
separated by commas.</paragraph>
-<paragraph role="heading" id="hd_id3156343" xml-lang="en-US"
level="2">Example:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="par_id3153897"
xml-lang="en-US">Dim A As Variant</paragraph>
<paragraph role="bascode" id="par_id3153525" xml-lang="en-US">A =
Array("Fred","Tom","Bill")</paragraph>
diff --git a/source/text/sbasic/shared/03131900.xhp
b/source/text/sbasic/shared/03131900.xhp
index a91107a43..faf6abd27 100644
--- a/source/text/sbasic/shared/03131900.xhp
+++ b/source/text/sbasic/shared/03131900.xhp
@@ -39,7 +39,7 @@
<bookmark_value>BasicLibraries; library container</bookmark_value>
<bookmark_value>DialogLibraries; library container</bookmark_value>
</bookmark>
-<h1 id="hd_id3150682"><link href="text/sbasic/shared/03131900.xhp"
name="GlobalScope">GlobalScope specifier</link></h1>
+<h1 id="hd_id3150682"><variable id="GlobalScope_h1"><link
href="text/sbasic/shared/03131900.xhp" name="GlobalScope">GlobalScope
specifier</link></variable></h1>
<paragraph role="paragraph" id="par_id991572457387308">To manage personal or
shared library containers (<emph>%PRODUCTNAME Macros</emph> or <emph>My
Macros</emph>) from within a document, use the <literal>GlobalScope</literal>
specifier.</paragraph>
</section>
<section id="basicdialogs">
_______________________________________________
Libreoffice-commits mailing list
libreoffice-comm...@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/libreoffice-commits
