AllLangHelp_sbasic.mk | 2 +
source/auxiliary/sbasic.tree | 1
source/text/sbasic/shared/03132200.xhp | 24 ++++++++++++-
source/text/sbasic/shared/thisdbdoc.xhp | 52 ++++++++++++++++++++++++++++++
source/text/sbasic/shared/uno_objects.xhp | 21 ++++++++----
5 files changed, 91 insertions(+), 9 deletions(-)
New commits:
commit 9fffc3e09d2cddfc614e5520d8d33942572dd5a5
Author: Alain Romedenne <alain.romede...@libreoffice.org>
AuthorDate: Wed Jun 2 13:58:29 2021 +0200
Commit: Rafael Lima <rafael.palma.l...@gmail.com>
CommitDate: Wed Jun 9 16:49:57 2021 +0200
ThisDatabaseDocument new help page
Change-Id: I9ad35913bbc5fef9208b3a9ea5eb9be01f882131
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/116463
Tested-by: Jenkins
Reviewed-by: Rafael Lima <rafael.palma.l...@gmail.com>
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk
index f40dd2d0f..c2d750049 100644
--- a/AllLangHelp_sbasic.mk
+++ b/AllLangHelp_sbasic.mk
@@ -396,6 +396,8 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\
helpcontent2/source/text/sbasic/shared/replace \
helpcontent2/source/text/sbasic/shared/uno_objects \
helpcontent2/source/text/sbasic/shared/stardesktop \
+ helpcontent2/source/text/sbasic/shared/stardesktop \
+ helpcontent2/source/text/sbasic/shared/thisdbdoc \
helpcontent2/source/text/sbasic/shared/GetPathSeparator \
helpcontent2/source/text/sbasic/shared/keys \
helpcontent2/source/text/sbasic/shared/main0211 \
diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree
index b52b277ee..9d981d88c 100644
--- a/source/auxiliary/sbasic.tree
+++ b/source/auxiliary/sbasic.tree
@@ -294,6 +294,7 @@
<topic id="sbasic/text/sbasic/shared/03140012.xhp">SYD
Function [VBA]</topic>
<topic id="sbasic/text/sbasic/shared/03080104.xhp">Tan
Function</topic>
<topic
id="sbasic/text/sbasic/shared/03132200.xhp">ThisComponent object</topic>
+ <topic
id="sbasic/text/sbasic/shared/thisdbdoc.xhp">ThisDatabaseDocument object</topic>
<topic
id="sbasic/text/sbasic/shared/03030205.xhp">TimeSerial Function</topic>
<topic
id="sbasic/text/sbasic/shared/03030206.xhp">TimeValue Function</topic>
<topic id="sbasic/text/sbasic/shared/03030302.xhp">Time
Function</topic>
diff --git a/source/text/sbasic/shared/03132200.xhp
b/source/text/sbasic/shared/03132200.xhp
index eb96a9964..b89a5d3cb 100644
--- a/source/text/sbasic/shared/03132200.xhp
+++ b/source/text/sbasic/shared/03132200.xhp
@@ -29,11 +29,18 @@
<bookmark_value>ThisComponent object</bookmark_value>
<bookmark_value>components;addressing</bookmark_value>
</bookmark>
-<paragraph id="hd_id3155342" role="heading" level="1" xml-lang="en-US"><link
href="text/sbasic/shared/03132200.xhp" name="ThisComponent
Object">ThisComponent Object</link></paragraph>
-<paragraph id="par_id3154923" role="paragraph" xml-lang="en-US">Addresses the
active component whose properties can be read and set, and whose methods can be
called. <literal>ThisComponent</literal> is used in Basic, where it represents
the current document. Properties and methods available through
<literal>ThisComponent</literal> depend on the document type.<comment>see
i60932</comment></paragraph>
+
+<h1 id="hd_id3155342"><link href="text/sbasic/shared/03132200.xhp"
name="ThisComponent Object">ThisComponent Object</link></h1>
+<paragraph id="par_id3154923" role="paragraph"
xml-lang="en-US"><literal>ThisComponent</literal> represents the current
document in Basic macros. It addresses the active component whose properties
can be read and set, and whose methods can be called. Properties and methods
available through <literal>ThisComponent</literal> depend on the document
type.<comment>see i60932</comment></paragraph>
</section>
+
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
-<paragraph id="par_id3151056" role="code" localize="false"
xml-lang="en-US">ThisComponent</paragraph>
+<bascode>
+ <paragraph role="bascode" id="bas_id191622796421820"
localize="false">ThisComponent</paragraph>
+</bascode>
+<paragraph role="paragraph" id="par_id241622797081182">When the active window
is a Base form, query, report, table or view, <literal>ThisComponent</literal>
returns the current <literal>Form</literal> information.</paragraph>
+<tip id="par_id871622796485123">When active window is the Basic IDE,
<literal>ThisComponent</literal> object returns the component owning the
current script.</tip>
+
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph id="par_idm1341584928" role="bascode" localize="false"
xml-lang="en-US">Sub Main</paragraph>
@@ -45,5 +52,16 @@
<paragraph id="par_idm1341575840" role="bascode" localize="false"
xml-lang="en-US"> index.update()</paragraph>
<paragraph id="par_idm1341574608" role="bascode" localize="false"
xml-lang="en-US">End Sub</paragraph>
</bascode>
+
+ <section id="relatedtopics">
+ <paragraph role="paragraph" id="par_id101622646874083"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1text_1_1TextDocument.html";
name="TextDocument API service">com.sun.star.text.TextDocument</link> API
service</paragraph>
+ <paragraph role="paragraph" id="par_id102622646874083"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sheet_1_1SpreadsheetDocument.html";
name="SpreadsheetDocument API
service">com.sun.star.sheet.SpreadsheetDocument</link> API service</paragraph>
+ <paragraph role="paragraph" id="par_id103622646874083"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1presentation_1_1PresentationDocument.html";
name="PresentationDocument API
service">com.sun.star.presentation.PresentationDocument</link> API
service</paragraph>
+ <paragraph role="paragraph" id="par_id104622646874083"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1drawing_1_1DrawingDocument.html";
name="DrawingDocument API service">com.sun.star.drawing.DrawingDocument</link>
API service</paragraph>
+ <paragraph role="paragraph" id="par_id105622646874083"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1formula_1_1FormulaProperties.html";
name="FormulaProperties API
service">com.sun.star.formula.FormulaProperties</link> API service</paragraph>
+ <paragraph role="paragraph" id="par_id106622646874083"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sdb_1_1OfficeDatabaseDocument.html";
name="OfficeDatabaseDocument API
service">com.sun.star.sdb.OfficeDatabaseDocument</link> API service</paragraph>
+ <paragraph role="paragraph" id="par_id581622646875379"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1document_1_1OfficeDocument.html";
name="OfficeDocument API service">com.sun.star.document.OfficeDocument</link>
API service</paragraph>
+ </section>
+
</body>
</helpdocument>
\ No newline at end of file
diff --git a/source/text/sbasic/shared/thisdbdoc.xhp
b/source/text/sbasic/shared/thisdbdoc.xhp
new file mode 100644
index 000000000..8f4a1c61c
--- /dev/null
+++ b/source/text/sbasic/shared/thisdbdoc.xhp
@@ -0,0 +1,52 @@
+<?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="org.LibreOffice.Help.ThisDatabaseDocument"
indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">ThisDatabaseDocument
object</title>
+ <filename>/text/sbasic/shared/thisdbdoc.xhp</filename>
+ </topic>
+ </meta>
+ <body>
+
+ <section id="thisdatabasedocument">
+ <bookmark branch="index" xml-lang="en-US" id="N0089">
+ <bookmark_value>ThisDatabaseDocument</bookmark_value>
+ <bookmark_value>API; Database document</bookmark_value>
+ </bookmark>
+ <h1 id="hd_id401544551916353"><link
href="text/sbasic/shared/thisdbdoc.xhp"
name="ThisDatabaseDocument">ThisDatabaseDocument object</link></h1>
+ <paragraph role="paragraph"
id="N0091"><literal>ThisDatabaseDocument</literal> addresses the active
<literal>Base</literal> document whose properties can be read and set, and
whose methods can be called.</paragraph>
+ <paragraph role="paragraph"
id="par_id241622646033201"><literal>ThisDatabaseDocument</literal> returns an
object of type <link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sdb_1_1OfficeDatabaseDocument.html";
name="XOfficeDatabaseDocument
interface">com.sun.star.sdb.XOfficeDatabaseDocument</link>.</paragraph>
+ </section>
+
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
+ <bascode>
+ <paragraph role="bascode" id="bas_id191622796421820"
localize="false">ThisDatabaseDocument</paragraph>
+ </bascode>
+ <paragraph role="paragraph" id="par_id241622797081182">When the active
window does not relate to a Base document,
<literal>ThisDatabaseDocument</literal> returns
<literal>Nothing</literal>.</paragraph>
+ <tip id="par_id871622796485123">When the active window is the Basic IDE,
<literal>ThisDatabaseDocument</literal> object returns the database owning the
current script.</tip>
+
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
+ <paragraph role="paragraph" id="par_id631622806529469">Opening current
database "formName" and maximizing it can be achieved as shown:</paragraph>
+ <bascode>
+ <paragraph role="bascode" id="N0094" localize="false">Dim form As
Object</paragraph>
+ <paragraph role="bascode" id="N0093"
localize="false">ThisDatabaseDocument.CurrentController.connect("","")</paragraph>
+ <paragraph role="bascode" id="N0095" localize="false">form =
ThisDatabaseDocument.FormDocuments.getByName("formName").open )</paragraph>
+ <paragraph role="bascode" id="N0096"
localize="false">form.currentController.frame.ContainerWindow.IsMaximized =
True</paragraph>
+ </bascode>
+
+ <section id="relatedtopics">
+ <paragraph role="paragraph" id="par_id251622800540402"><link
href="text/sbasic/shared/03132200.xhp" name="ThisComponent
object">ThisComponent</link> object</paragraph>
+ <paragraph role="paragraph" id="par_id101622646874083"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sdb_1_1OfficeDatabaseDocument.html";
name="OfficeDatabaseDocument API
service">com.sun.star.sdb.OfficeDatabaseDocument</link> API service</paragraph>
+ <paragraph role="paragraph" id="par_id581622646875379"><link
href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1document_1_1OfficeDocument.html";
name="OfficeDocument API service">com.sun.star.document.OfficeDocument</link>
API service</paragraph>
+ </section>
+
+</body>
+</helpdocument>
diff --git a/source/text/sbasic/shared/uno_objects.xhp
b/source/text/sbasic/shared/uno_objects.xhp
index 6d8ae8d6a..99ba126dd 100644
--- a/source/text/sbasic/shared/uno_objects.xhp
+++ b/source/text/sbasic/shared/uno_objects.xhp
@@ -24,7 +24,22 @@
<h1 id="hd_id3156027">UNO Objects, Functions and Services</h1>
<paragraph role="paragraph" id="par_id3153312"
xml-lang="en-US">Functions, objects and services of Unified Network Objects
(UNO).</paragraph>
</section>
+
+ <h2 id="hd_id121622648046670">%PRODUCTNAME Global Objects</h2>
+ <embed href="text/sbasic/shared/stardesktop.xhp#stardesktop"/>
+ <embed href="text/sbasic/shared/03132500.xhp#getdefaultcontext"/>
+ <embed href="text/sbasic/shared/03131700.xhp#getprocessservicemanager"/>
+ <embed href="text/sbasic/shared/03131900.xhp#globalscope"/>
+
+ <h2 id="hd_id121622648046680">Active document Objects</h2>
+ <paragraph role="paragraph" id="par_id481622648684689">The following
objects can be used from the active document.</paragraph>
<h2 id="hd_id91572461246639"><link
href="text/sbasic/shared/03131900.xhp#basicdialogs"
name="basicanddialog">BasicLibraries Object</link></h2>
+ <h2 id="hd_id91572461246640"><link
href="text/sbasic/shared/03131900.xhp#basicdialogs"
name="basicanddialog">DialogLibraries Object</link></h2>
+ <embed href="text/sbasic/shared/03132200.xhp#thiscomponent"/>
+ <embed href="text/sbasic/shared/thisdbdoc.xhp#thisdatabasedocument"/>
+
+ <h2 id="hd_id151622648087678">UNO Methods</h2>
+ <paragraph role="paragraph" id="par_id481622648684690">Use the following
methods to manage or query Unified Network Objects (UNO).</paragraph>
<embed href="text/sbasic/shared/03131500.xhp#createunostruct"/>
<embed href="text/sbasic/shared/03131600.xhp#createunoservice"/>
<embed href="text/sbasic/shared/03131800.xhp#createunodialog"/>
@@ -33,14 +48,8 @@
<embed href="text/sbasic/shared/03132400.xhp#createobject"/>
<embed href="text/sbasic/shared/03104600.xhp#equalunoobjects"/>
<embed href="text/sbasic/shared/03131600.xhp#createunoservice"/>
- <h2 id="hd_id91572461246640"><link
href="text/sbasic/shared/03131900.xhp#basicdialogs"
name="basicanddialog">DialogLibraries Object</link></h2>
- <embed href="text/sbasic/shared/03132500.xhp#getdefaultcontext"/>
- <embed href="text/sbasic/shared/03131700.xhp#getprocessservicemanager"/>
- <embed href="text/sbasic/shared/03131900.xhp#globalscope"/>
<embed href="text/sbasic/shared/03104400.xhp#hasunointerfaces"/>
<embed href="text/sbasic/shared/03104500.xhp#isunostruct"/>
- <embed href="text/sbasic/shared/stardesktop.xhp#stardesktop"/>
- <embed href="text/sbasic/shared/03132200.xhp#thiscomponent"/>
<note id="par_id81572615048011">%PRODUCTNAME provides an Application
Programming Interface (API) that allows controlling the $[officename]
components with different programming languages by using the $[officename]
Software Development Kit (SDK). For more information about the $[officename]
API and the Software Development Kit, visit <link
href="https://api.libreoffice.org/";
name="api.libreoffice.org">https://api.libreoffice.org</link></note>
</body>
</helpdocument>
_______________________________________________
Libreoffice-commits mailing list
libreoffice-comm...@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/libreoffice-commits
