source/text/sbasic/shared/03/sf_calc.xhp | 11 ++++++++++-
source/text/sbasic/shared/03/sf_document.xhp | 11 ++++++++++-
2 files changed, 20 insertions(+), 2 deletions(-)
New commits:
commit fbbbb4dedd4e42ed16056ba9c98a829601f61833
Author: Rafael Lima <rafael.palma.l...@gmail.com>
AuthorDate: Mon Jul 25 21:33:42 2022 +0200
Commit: Rafael Lima <rafael.palma.l...@gmail.com>
CommitDate: Thu Jul 28 21:03:38 2022 +0200
Improve description of how to invoke Documents and Calc SF services
Change-Id: Id9b9cc379bd838bdbae882554c8320f30595453e
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/137416
Tested-by: Jenkins
Tested-by: Jean-Pierre Ledure <j...@ledure.be>
Reviewed-by: Rafael Lima <rafael.palma.l...@gmail.com>
diff --git a/source/text/sbasic/shared/03/sf_calc.xhp
b/source/text/sbasic/shared/03/sf_calc.xhp
index 2da2d254f..8b143da7f 100644
--- a/source/text/sbasic/shared/03/sf_calc.xhp
+++ b/source/text/sbasic/shared/03/sf_calc.xhp
@@ -62,12 +62,17 @@
<bascode>
<paragraph role="bascode" localize="false" id="bas_id671621467660766">Set
oDoc = ui.OpenDocument("C:\Documents\MyFile.ods")</paragraph>
</bascode>
- <paragraph role="paragraph" id="par_id741621467697967">It is also possible
to instantiate the <literal>Calc</literal> service using the
<literal>CreateScriptService</literal> method:</paragraph>
+ <paragraph role="paragraph" id="par_id741621467697967">It is also possible
to instantiate the <literal>Calc</literal> service specifying a window name for
the <literal>CreateScriptService</literal> method:</paragraph>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id371589191782045">Dim
oDoc As Object</paragraph>
<paragraph role="bascode" localize="false" id="bas_id711589191788959">Set
oDoc = CreateScriptService("SFDocuments.Calc", "MyFile.ods")</paragraph>
</bascode>
<paragraph role="paragraph" id="par_id271621467810774">In the example above,
"MyFile.ods" is the name of an open document window. If this argument is not
provided, the active window is considered.</paragraph>
+ <paragraph role="paragraph" id="par_id551658777771853">It is also possible
to invoke the <literal>Calc</literal> service using the document referenced by
<literal>ThisComponent</literal>. This is specially useful when running a macro
from within the Basic IDE.</paragraph>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id861658777838994">Dim
oDoc As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id541658777839238">Set
oDoc = CreateScriptService("Calc", ThisComponent)</paragraph>
+ </bascode>
<paragraph role="paragraph" id="par_id71158288562139" xml-lang="en-US">It is
recommended to free resources after use:</paragraph>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id61582733781413">Set
oDoc = oDoc.Dispose()</paragraph>
@@ -88,6 +93,10 @@
<paragraph role="pycode" localize="false" id="pyc_id701621532481401">myDoc
= CreateScriptService("SFDocuments.Calc", "MyFile.ods")</paragraph>
<paragraph role="pycode" localize="false"
id="pyc_id951621532568918">myDoc.Dispose()</paragraph>
</pycode>
+ <pycode>
+ <paragraph role="pycode" localize="false" id="pyc_id711658778703006">bas =
CreateScriptService("Basic")</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id811658778703326">myDoc
= CreateScriptService("Calc", bas.ThisComponent)</paragraph>
+ </pycode>
<tip id="par_id71611090922315">The use of the prefix
"<literal>SFDocuments.</literal>" while calling the service is optional.</tip>
<h2 id="hd_id991591016893982" xml-lang="en-US">Definitions</h2>
diff --git a/source/text/sbasic/shared/03/sf_document.xhp
b/source/text/sbasic/shared/03/sf_document.xhp
index f0c0ee7c5..6a2e0129d 100644
--- a/source/text/sbasic/shared/03/sf_document.xhp
+++ b/source/text/sbasic/shared/03/sf_document.xhp
@@ -58,11 +58,16 @@
<paragraph role="bascode" localize="false" id="bas_id511589191758563">Set
oDocA = ui.CreateDocument("Calc")</paragraph>
<paragraph role="bascode" localize="false" id="bas_id331589191766531">Set
oDocB = ui.OpenDocument("C:\Documents\MyFile.odt")</paragraph>
</bascode>
- <paragraph role="paragraph" id="par_id691622816765571">Directly if the
document is already open.</paragraph>
+ <paragraph role="paragraph" id="par_id691622816765571">Using a window name
if the document is already open.</paragraph>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id371589191782045">Dim
oDoc As Object</paragraph>
<paragraph role="bascode" localize="false" id="bas_id711589191788959">Set
oDoc = CreateScriptService("SFDocuments.Document", "Untitled 1") 'Default =
ActiveWindow</paragraph>
</bascode>
+ <paragraph role="paragraph" id="par_id551658777771853">Using the document
referenced by <literal>ThisComponent</literal>. This is specially useful when
running a macro from within the Basic IDE.</paragraph>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id861658777838994">Dim
oDoc As Object</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id541658777839238">Set
oDoc = CreateScriptService("Document", ThisComponent)</paragraph>
+ </bascode>
<paragraph role="paragraph" id="par_id821622816825012">From a macro
triggered by a document event.</paragraph>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id61598109336361">Sub
RunEvent(ByRef poEvent As Object)</paragraph>
@@ -90,6 +95,10 @@
</pycode>
<pycode>
<paragraph role="pycode" localize="false" id="pyc_id931622818866918">doc =
CreateScriptService("SFDocuments.Document", "Untitled 1")</paragraph>
+ </pycode>
+ <pycode>
+ <paragraph role="pycode" localize="false" id="pyc_id711658778703006">bas =
CreateScriptService("Basic")</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id811658778703326">doc =
CreateScriptService("Document", bas.ThisComponent)</paragraph>
</pycode>
<pycode>
<paragraph role="pycode" localize="false" id="pyc_id551622819064247">def
RunEvent(event)</paragraph>
