summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRafael Lima <rafael.palma.lima@gmail.com>2021-06-25 18:46:58 +0200
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-06-29 10:51:50 +0200
commita65cd9e1f6b76162853428d38395a02ad6faf7cb (patch)
treebd151ab9ff74cb57dd0d7076e1f65e9fa73c5328
parentAdd note about Python support availability on some SF services (diff)
downloadhelp-a65cd9e1f6b76162853428d38395a02ad6faf7cb.tar.gz
help-a65cd9e1f6b76162853428d38395a02ad6faf7cb.zip
Fix localization in SF_Form, SF_FormControl and SF_UI help pages
Change-Id: I7306fbfdabf3df84028aadacb90d0502d48f5c56 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/117863 Tested-by: Jenkins Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com> (cherry picked from commit 8d017a90e29ece12e5a71b7e0242b5f926575cb5) Reviewed-on: https://gerrit.libreoffice.org/c/help/+/118060
-rw-r--r--source/text/sbasic/shared/03/sf_form.xhp104
-rw-r--r--source/text/sbasic/shared/03/sf_formcontrol.xhp4
-rw-r--r--source/text/sbasic/shared/03/sf_intro.xhp8
-rw-r--r--source/text/sbasic/shared/03/sf_ui.xhp46
4 files changed, 81 insertions, 81 deletions
diff --git a/source/text/sbasic/shared/03/sf_form.xhp b/source/text/sbasic/shared/03/sf_form.xhp
index efb3fb493..497b379e3 100644
--- a/source/text/sbasic/shared/03/sf_form.xhp
+++ b/source/text/sbasic/shared/03/sf_form.xhp
@@ -83,7 +83,7 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id691622014677169">my_form = doc.Forms(0)</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id691622014677169">my_form = doc.Forms(0)</paragraph>
</pycode>
<warning id="par_id181618250546617">If you try to access a <literal>FormDocument</literal> that is currently opened in <emph>Design Mode</emph> an exception will be raised.</warning>
<h3 id="hd_id921618179792926">In Calc documents</h3>
@@ -119,13 +119,13 @@
</bascode>
<paragraph role="paragraph" id="par_id681622028653480">Previous examples translate in Python as:</paragraph>
<pycode>
- <paragraph role="pycode" id="pyc_id501622028742999">db = CreateScriptService('SFDocuments.Document', XSCRIPTCONTEXT.getDocument())</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id501622028742999">db = CreateScriptService('SFDocuments.Document', XSCRIPTCONTEXT.getDocument())</paragraph>
<paragraph role="pycode" id="pyc_id811622808499801"># The statement below is necessary only if the form hasn't been opened yet</paragraph>
- <paragraph role="pycode" id="pyc_id671622028743191">form_doc = db.OpenFormDocument('thisFormDocument')</paragraph>
- <paragraph role="pycode" id="pyc_id431622028743374">form = form_doc.Forms('thisFormDocument', 'MainForm')</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id671622028743191">form_doc = db.OpenFormDocument('thisFormDocument')</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id431622028743374">form = form_doc.Forms('thisFormDocument', 'MainForm')</paragraph>
<paragraph role="pycode" id="pyc_id511622808538351"># Or, alternatively, to access the form by its index ...</paragraph>
- <paragraph role="pycode" id="pyc_id681622028743582">form = form_doc.Forms('thisFormDocument', 0)</paragraph>
- <paragraph role="pycode" id="pyc_id611622028743782">sub_form = form.SubForms('mySubForm')</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id681622028743582">form = form_doc.Forms('thisFormDocument', 0)</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id611622028743782">sub_form = form.SubForms('mySubForm')</paragraph>
</pycode>
<h3 id="hd_id211618180379064">In Form events</h3>
<paragraph role="paragraph" id="par_id421616768529754" xml-lang="en-US">To invoke the <literal>Form</literal> service when a form event takes place:</paragraph>
@@ -138,17 +138,17 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id551622022387877" localize="false">def OnEvent(event: uno):</paragraph>
- <paragraph role="pycode" id="pyc_id081622022388165" localize="false"> form = CreateScriptService('SFDocuments.FormEvent', event)</paragraph>
- <paragraph role="pycode" id="pyc_id641622022388397" localize="false"> pass</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id551622022387877">def OnEvent(event: uno):</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id081622022388165"> form = CreateScriptService('SFDocuments.FormEvent', event)</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id641622022388397"> pass</paragraph>
</pycode>
<embed href="text/sbasic/shared/03/sf_formcontrol.xhp#FormEvent_Note"/>
<paragraph role="paragraph" id="par_id721623150543016">It is recommended to free resources after use of the Form service.</paragraph>
<bascode>
- <paragraph role="bascode" localize="false" id="bas_id751681880415566">myForm.Dispose() ' using Basic</paragraph>
+ <paragraph role="bascode" localize="false" id="bas_id751681880415566">myForm.Dispose() ' Basic</paragraph>
</bascode>
<pycode>
- <paragraph role="pycode" id="pyc_id551226022387877" localize="false">form.Dispose() # using Python</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id551226022387877">form.Dispose() # Python</paragraph>
</pycode>
<paragraph role="paragraph" id="par_id221623150547406">This operation is done implicitly when a form document is closed with the <literal>CloseFormDocument()</literal> method described below.</paragraph>
</section>
@@ -589,9 +589,9 @@
<paragraph id="par_id41616859019478" role="listitem" xml-lang="en-US"><emph>In Base documents:</emph> Sets the focus on the <literal>FormDocument</literal> the <literal>Form</literal> refers to.</paragraph>
</listitem>
</list>
- <h3 id="hd _id61583933076171" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id11622536171845" localize="false"><input>svc.Activate(): bool</input></paragraph>
- <h3 id="hd _id26158393307687" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<paragraph role="paragraph" id="par_id921618228229529">The following example assumes you want to activate the form named <literal>FormA</literal> located in <literal>Sheet1</literal> of the currently open Calc file. It first gets access to the document using the <literal>Document</literal> service and <literal>ThisComponent</literal> and then activates the form.</paragraph>
<bascode>
<paragraph role="bascode" id="bas_id21618228468066">'Gets hold of the form that will be activated</paragraph>
@@ -603,9 +603,9 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id211622537233877" localize="false">doc = CreateScriptService('Document', XSCRIPTCONTEXT.getDocument())</paragraph>
- <paragraph role="pycode" id="pyc_id181622537234494" localize="false">form = doc.Forms('Sheet1', 'FormA')</paragraph>
- <paragraph role="pycode" id="pyc_id981622537234703" localize="false">form.Activate()</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id211622537233877">doc = CreateScriptService('Document', XSCRIPTCONTEXT.getDocument())</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id181622537234494">form = doc.Forms('Sheet1', 'FormA')</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id981622537234703">form.Activate()</paragraph>
</pycode>
<note id="par_id81618228720782"><literal>ThisComponent</literal> applies to Calc and Writer documents. For Base documents use <literal>ThisDataBaseDocument</literal>.</note>
</section>
@@ -616,15 +616,15 @@
</bookmark>
<h2 id="hd _id18161686043718" localize="false">CloseFormDocument</h2>
<paragraph role="paragraph" id="par_id501616860541195" xml-lang="en-US">Closes the form document containing the actual <literal>Form</literal> instance. The <literal>Form</literal> instance is disposed.</paragraph>
- <h3 id="hd _id99161686043761" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id811622538068303" localize="false"><input>svc.CloseFormDocument(): bool</input></paragraph>
- <h3 id="hd _id901616860437964" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id511616860437148">myForm.CloseFormDocument() ' Basic</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id331622538021746" localize="false">form.CloseFormDocument() # Python</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id331622538021746">form.CloseFormDocument() # Python</paragraph>
</pycode>
<note id="par_id611618229004669">This method only closes form documents located in Base documents. If the form is stored in a Writer or Calc document, calling <literal>CloseFormDocument</literal> will have no effect.</note>
</section>
@@ -643,11 +643,11 @@
<paragraph id="par_id81598185229301" role="listitem" xml-lang="en-US">If the optional <literal>ControlName</literal> argument is provided, the method returns a <literal>FormControl</literal> class instance referring to the specified control.</paragraph>
</listitem>
</list>
- <h3 id="hd _id601584541257443" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id471622538274231" localize="false"><input>svc.Controls(opt controlname: str): any</input></paragraph>
- <h3 id="hd _id291584541257237" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph role="paragraph" id="par_id1001584541257789"><emph>controlname</emph> : A valid control name as a case-sensitive string. If absent, the list of control names is returned as a zero-based array.</paragraph>
- <h3 id="hd _id32158454125769" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id151598185478904">Dim myForm As Object, myList As Variant, myControl As Object</paragraph>
<paragraph role="bascode" localize="false" id="bas_id21598185484092">Set myForm = myDoc.Forms("myForm")</paragraph>
@@ -656,9 +656,9 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id711622538462214" localize="false">form = doc.Forms('myForm')</paragraph>
- <paragraph role="pycode" id="pyc_id631622538462782" localize="false">form_names = form.Controls()</paragraph>
- <paragraph role="pycode" id="pyc_id961622538463294" localize="false">form_control = form.Controls('myTextBox') # SFDocuments.FormControl</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id711622538462214">form = doc.Forms('myForm')</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id631622538462782">form_names = form.Controls()</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id961622538463294">form_control = form.Controls('myTextBox') # SFDocuments.FormControl</paragraph>
</pycode>
</section>
<section id="GetDatabase">
@@ -669,18 +669,18 @@
<h2 id="hd _id141616861134554" localize="false">GetDatabase</h2>
<paragraph role="paragraph" id="par_id291616861407907" xml-lang="en-US">Return a <link href="text/sbasic/shared/03/sf_database.xhp" name="DBService"><literal>SFDatabases</literal>.<literal>Database</literal></link> instance giving access to the execution of SQL commands on the database the current form is connected to and/or that is stored in the current Base document.</paragraph>
<paragraph role="paragraph" id="par_id991616861417207" xml-lang="en-US">Each form has its own database connection, except in Base documents where they all share the same connection.</paragraph>
- <h3 id="hd _id431616861134316" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id221622547947693" localize="false"><input>svc.GetDatabase(opt user: str, opt password: str): svc</input></paragraph>
- <h3 id="hd _id871616861134673" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph role="paragraph" id="par_id701616861134906"><emph>user, password</emph>: The login optional parameters (Default = "").</paragraph>
- <h3 id="hd _id911616861134351" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id231616861134373">Dim myDb As Object ' SFDatabases.Database</paragraph>
<paragraph role="bascode" localize="false" id="bas_id2316168611347">Set myDb = oForm.GetDatabase()</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id871622547824003" localize="false">db = form.GetDatabase() # SFDatabases.Database</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id871622547824003">db = form.GetDatabase() # SFDatabases.Database</paragraph>
</pycode>
</section>
<section id="MoveFirst">
@@ -690,15 +690,15 @@
</bookmark>
<h2 id="hd _id591616861787279" localize="false">MoveFirst</h2>
<paragraph role="paragraph" id="par_id771616861842867" xml-lang="en-US">The form cursor is positioned on the first record. Returns <literal>True</literal> if successful.</paragraph>
- <h3 id="hd _id601616861787526" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id101622549004980" localize="false"><input>svc.MoveFirst(): bool</input></paragraph>
- <h3 id="hd _id51616861787314" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id191616861787635">myForm.MoveFirst() ' Basic</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id421622549258920" localize="false">form.MoveFirst() # Python</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id421622549258920">form.MoveFirst() # Python</paragraph>
</pycode>
</section>
<section id="MoveLast">
@@ -708,15 +708,15 @@
</bookmark>
<h2 id="hd _id831616863143434" localize="false">MoveLast</h2>
<paragraph role="paragraph" id="par_id331616863143187" xml-lang="en-US">The form cursor is positioned on the last record. Returns <literal>True</literal> if successful.</paragraph>
- <h3 id="hd _id66161686314335" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id931622549019307" localize="false"><input>svc.MoveLast(): bool</input></paragraph>
- <h3 id="hd _id501616863143323" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id691616863143688">myForm.MoveLast() ' Basic</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id831622549604397" localize="false">form.MoveLast() # Python</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id831622549604397">form.MoveLast() # Python</paragraph>
</pycode>
</section>
<section id="MoveNew">
@@ -726,15 +726,15 @@
</bookmark>
<h2 id="hd _id41161686314366" localize="false">MoveNew</h2>
<paragraph role="paragraph" id="par_id361616863143954" xml-lang="en-US">The form cursor is positioned on the new record area. Returns <literal>True</literal> if successful.</paragraph>
- <h3 id="hd _id461616863143572" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id131622549039501" localize="false"><input>svc.MoveNew(): bool</input></paragraph>
- <h3 id="hd _id311616863143737" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id401616863143757">myForm.MoveNew() ' Basic</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id381622549678558" localize="false">form.MoveNew() # Python</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id381622549678558">form.MoveNew() # Python</paragraph>
</pycode>
</section>
<section id="MoveNext">
@@ -744,11 +744,11 @@
</bookmark>
<h2 id="hd _id111616863143256" localize="false">MoveNext</h2>
<paragraph role="paragraph" id="par_id541616863143461" xml-lang="en-US">The form cursor is positioned on the next record. Returns <literal>True</literal> if successful.</paragraph>
- <h3 id="hd _id331616863143670" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id291622549045804" localize="false"><input>svc.MoveNext(opt offset: int): bool</input></paragraph>
- <h3 id="hd _id261616863582793" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph role="paragraph" id="par_id271616863582607"><emph>offset</emph>: The number of records to go forward (Default = 1).</paragraph>
- <h3 id="hd _id71616863143475" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id591616863143862">myForm.MoveNext() ' Basic</paragraph>
</bascode>
@@ -764,11 +764,11 @@
</bookmark>
<h2 id="hd _id371616863794447" localize="false">MovePrevious</h2>
<paragraph role="paragraph" id="par_id616168637945" xml-lang="en-US">The form cursor is positioned on the previous record. Returns <literal>True</literal> if successful.</paragraph>
- <h3 id="hd _id67161686379485" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id981622549054028" localize="false"><input>svc.MovePrevious(opt offset: int): bool</input></paragraph>
- <h3 id="hd _id141616863794433" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph role="paragraph" id="par_id751616863794125"><emph>offset</emph>: The number of records to go backwards (Default = 1).</paragraph>
- <h3 id="hd _id511616863794613" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id941616863794988">myForm.MovePrevious() ' Basic</paragraph>
</bascode>
@@ -783,15 +783,15 @@
</bookmark>
<h2 id="hd _id551616864216705" localize="false">Requery</h2>
<paragraph role="paragraph" id="par_id811616864216529" xml-lang="en-US">Reloads the current data from the database and refreshes the form. The cursor is positioned on the first record. Returns <literal>True</literal> if successful.</paragraph>
- <h3 id="hd _id51616864216609" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" localize="false" id="par_id731622550132517">svc.Requery(): bool</paragraph>
- <h3 id="hd _id411616864216103" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id211616864216116">myForm.Requery() ' Basic</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id401622550186725">form.Requery() # Python</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id401622550186725">form.Requery() # Python</paragraph>
</pycode>
</section>
<section id="Subforms">
@@ -809,14 +809,14 @@
<paragraph id="par_id591616864510445" role="listitem" xml-lang="en-US">If the optional <literal>subform</literal> argument is provided, the method returns a new <literal>SFDocuments</literal>.<literal>Form</literal> instance based on the specified form/subform name or index.</paragraph>
</listitem>
</list>
- <h3 id="hd _id54161686451092" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functsyntax"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" localize="false" id="par_id541622550497960"><input>svc.Subforms(): str[0..*]</input></paragraph>
<paragraph role="paragraph" localize="false" id="par_id161623413158150"><input>svc.Subforms(subform: str): svc</input></paragraph>
<paragraph role="paragraph" localize="false" id="par_id31623413181836"><input>svc.Subforms(subform: int): svc</input></paragraph>
- <h3 id="hd _id7516168645106" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functparameters"/></h3>
- <paragraph role="paragraph" id="par_id341616864510747"><emph>subform</emph> : A subform stored in the current <literal>Form</literal> class instance given by its name or index.</paragraph>
- <paragraph role="paragraph" id="par_id211618230389251">When this argument is absent, the method returns a list of available subforms as a zero-based array. If the form has a single subform, you can set <literal>Subform = 0</literal> to get access to it.</paragraph>
- <h3 id="hd _id491616864510587" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3>
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+ <paragraph role="paragraph" id="par_id341616864510747"><emph>subform</emph>: A subform stored in the current <literal>Form</literal> class instance given by its name or index.</paragraph>
+ <paragraph role="paragraph" id="par_id211618230389251">When this argument is absent, the method returns a list of available subforms as a zero-based array. If the form has a single subform, you can set <literal>subform = 0</literal> to get access to it.</paragraph>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph role="bascode" localize="false" id="bas_id821616864510402">Dim myForm As Object, myList As Variant, mySubform As Object</paragraph>
<paragraph role="bascode" localize="false" id="bas_id81616864510872">myList = myform.Subforms()</paragraph>
diff --git a/source/text/sbasic/shared/03/sf_formcontrol.xhp b/source/text/sbasic/shared/03/sf_formcontrol.xhp
index a082a3293..afc8ba2b7 100644
--- a/source/text/sbasic/shared/03/sf_formcontrol.xhp
+++ b/source/text/sbasic/shared/03/sf_formcontrol.xhp
@@ -1062,8 +1062,8 @@
</bookmark>
<h2 id="hd _id95158454125767" localize="false">Controls</h2>
<paragraph role="paragraph" id="par_id161584541257982">This method is applicable only to controls of the <literal>TableControl</literal> type. The returned value depends on the arguments provided.</paragraph>
- <paragraph role="paragraph" id="par_id701618777636827">If the optional argument <literal>ControlName</literal> is absent, then a zero-based Array containing the names of all controls is returned.</paragraph>
- <paragraph role="paragraph" id="par_id851618777715892">On the other hand, if a <literal>ControlName</literal> is provided, the method returns a <literal>FormControl</literal> class instance corresponding to the specified control.</paragraph>
+ <paragraph role="paragraph" id="par_id701618777636827">If the optional argument <literal>controlname</literal> is absent, then a zero-based Array containing the names of all controls is returned.</paragraph>
+ <paragraph role="paragraph" id="par_id851618777715892">On the other hand, if a <literal>controlname</literal> is provided, the method returns a <literal>FormControl</literal> class instance corresponding to the specified control.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" localize="false" id="par_id181622558671497"><input>svc.Controls(): str[0..*]</input></paragraph>
<paragraph role="paragraph" localize="false" id="par_id531622558833434"><input>svc.Controls(controlname: str): svc</input></paragraph>
diff --git a/source/text/sbasic/shared/03/sf_intro.xhp b/source/text/sbasic/shared/03/sf_intro.xhp
index 7f75754d4..785a2e06f 100644
--- a/source/text/sbasic/shared/03/sf_intro.xhp
+++ b/source/text/sbasic/shared/03/sf_intro.xhp
@@ -72,7 +72,7 @@
<paragraph role="pycode" localize="false" id="pyc_id561623366689495">bas.MsgBox("Hello!")</paragraph>
</pycode>
<paragraph role="paragraph" id="par_id701623366829587">To run the example above, enter each line in the Python shell, one by one, pressing the Enter key after you type each line of code.</paragraph>
- <paragraph role="paragraph" id="par_id471623366906045">Now you can start executing Python commands using any of the ScriptForge services. For example, the code snippet below uses the <literal>UI</literal> service to create a blank writer document.</paragraph>
+ <paragraph role="paragraph" id="par_id471623366906045">Now you can start executing Python commands using any of the ScriptForge services. For example, the code snippet below uses the <literal>UI</literal> service to create a blank Writer document.</paragraph>
<pycode>
<paragraph role="pycode" localize="false" id="pyc_id331623367002488">ui = CreateScriptService("UI")</paragraph>
<paragraph role="pycode" localize="false" id="pyc_id501623367002935">doc = ui.CreateDocument("Writer")</paragraph>
@@ -107,7 +107,7 @@
<paragraph id="par_id111623368679893" role="listitem">Go to <menuitem>Tools - Macros - Run Macros</menuitem> .</paragraph>
</listitem>
<listitem>
- <paragraph id="par_id421623368680565" role="listitem">Choose My Macros - sf_test in the library selector. Then choose the <literal>increment_cell</literal> function under the <menuitem>Macro Name</menuitem> list.</paragraph>
+ <paragraph id="par_id421623368680565" role="listitem">Choose My Macros - sf_test in the library selector. Then choose the <literal>increment_cell</literal> function under the <menuitem>Macro Name</menuitem> list.</paragraph>
</listitem>
<listitem>
<paragraph id="par_id131623368875763" role="listitem">Click <emph>Run</emph>. Note that the value in cell "A1" was incremented by 1.</paragraph>
@@ -119,10 +119,10 @@
<paragraph id="par_id501623369002537" role="listitem">First open APSO by going to <menuitem>Tools - Macros - Organize Python Scripts</menuitem>.</paragraph>
</listitem>
<listitem>
- <paragraph id="par_id521623369004825" role="listitem">In the macro list, navigate to <menuitem>My Macros - sf_test - increment_cell</menuitem> .</paragraph>
+ <paragraph id="par_id521623369004825" role="listitem">In the macro list, navigate to <menuitem>My Macros - sf_test - increment_cell</menuitem>.</paragraph>
</listitem>
<listitem>
- <paragraph id="par_id101623369005929" role="listitem">Click <menuitem>Execute</menuitem> .</paragraph>
+ <paragraph id="par_id101623369005929" role="listitem">Click <menuitem>Execute</menuitem>.</paragraph>
</listitem>
</list>
diff --git a/source/text/sbasic/shared/03/sf_ui.xhp b/source/text/sbasic/shared/03/sf_ui.xhp
index 94d8cdb33..ce4f93b01 100644
--- a/source/text/sbasic/shared/03/sf_ui.xhp
+++ b/source/text/sbasic/shared/03/sf_ui.xhp
@@ -152,10 +152,10 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id511620761856238" role="tablecontent">MACROEXECALWAYS</paragraph>
+ <paragraph id="par_id511620761856238" localize="false" role="tablecontent">MACROEXECALWAYS</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id761620761856107" role="tablecontent">2</paragraph>
+ <paragraph id="par_id761620761856107" localize="false" role="tablecontent">2</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id341620761856238" role="tablecontent">Macros are always executed</paragraph>
@@ -163,10 +163,10 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id661620761881513" role="tablecontent">MACROEXECNEVER</paragraph>
+ <paragraph id="par_id661620761881513" localize="false" role="tablecontent">MACROEXECNEVER</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id661620761891082" role="tablecontent">1</paragraph>
+ <paragraph id="par_id661620761891082" localize="false" role="tablecontent">1</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id101620761893011" role="tablecontent">Macros are never executed</paragraph>
@@ -174,10 +174,10 @@
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id311620761888379" role="tablecontent">MACROEXECNORMAL</paragraph>
+ <paragraph id="par_id311620761888379" localize="false" role="tablecontent">MACROEXECNORMAL</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id951620761899067" role="tablecontent">0</paragraph>
+ <paragraph id="par_id951620761899067" localize="false" role="tablecontent">0</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id11620761899780" role="tablecontent">Macro execution depends on user settings</paragraph>
@@ -200,11 +200,11 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id21620312350189">svcUI = CreateScriptService("UI")</paragraph>
- <paragraph role="pycode" id="pyc_id631620312351013">sBasic = CreateScriptService("Basic")</paragraph>
- <paragraph role="pycode" id="pyc_id141620312351286">openDocs = svcUI.Documents()</paragraph>
- <paragraph role="pycode" id="pyc_id661620312351500">strDocs = "\n".join(openDocs)</paragraph>
- <paragraph role="pycode" id="pyc_id801620312351676">sBasic.MsgBox(strDocs)</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id21620312350189">svcUI = CreateScriptService("UI")</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id631620312351013">sBasic = CreateScriptService("Basic")</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id141620312351286">openDocs = svcUI.Documents()</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id661620312351500">strDocs = "\n".join(openDocs)</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id801620312351676">sBasic.MsgBox(strDocs)</paragraph>
</pycode>
<table id="tab_id891606472825856">
@@ -281,7 +281,7 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id361620323808010">myBase = svcUI.CreateBaseDocument(r"C:\Databases\MyBaseFile.odb", "FIREBIRD")</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id361620323808010">myBase = svcUI.CreateBaseDocument(r"C:\Databases\MyBaseFile.odb", "FIREBIRD")</paragraph>
</pycode>
</section>
@@ -297,7 +297,7 @@
<input>svc.CreateDocument(documenttype: str = '', templatefile: str = '', hidden: bool = False): svc</input>
</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
- <paragraph role="paragraph" id="par_id51588521753302"><emph>documenttype</emph> : "Calc", "Writer", etc. If absent, the <literal>TemplateFile</literal> argument must be present.</paragraph>
+ <paragraph role="paragraph" id="par_id51588521753302"><emph>documenttype</emph> : "Calc", "Writer", etc. If absent, the <literal>templatefile</literal> argument must be present.</paragraph>
<paragraph role="paragraph" id="par_id401588522663325" xml-lang="en-US"><emph>templatefile</emph> : The full <literal>FileName</literal> of the template to build the new document on. If the file does not exist, the argument is ignored. The <literal>FileSystem</literal> service provides the <literal>TemplatesFolder</literal> and <literal>UserTemplatesFolder</literal> properties to help to build the argument.</paragraph>
<paragraph role="paragraph" id="par_id131588522824366" xml-lang="en-US"><emph>hidden</emph>: if <literal>True</literal>, open the new document in the background (default = <literal>False</literal>). To use with caution: activation or closure afterwards can only happen programmatically.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
@@ -403,8 +403,8 @@
<input>svc.OpenBaseDocument(filename: str = '', registrationname: str = '', macroexecution: int = 0): svc</input>
</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
- <paragraph role="paragraph" id="par_id231596555746385"><emph>filename</emph> : Identifies the file to open. It must follow the SF_FileSystem.FileNaming notation. If the file already exists, it is overwritten without warning</paragraph>
- <paragraph role="paragraph" id="par_id711596555746281" xml-lang="en-US"><emph>registrationname</emph> : The name to use to find the database in the databases register. It is ignored if <literal>FileName</literal> &lt;&gt; "".</paragraph>
+ <paragraph role="paragraph" id="par_id231596555746385"><emph>filename</emph>: Identifies the file to open. It must follow the <literal>SF_FileSystem.FileNaming</literal> notation. If the file already exists, it is overwritten without warning</paragraph>
+ <paragraph role="paragraph" id="par_id711596555746281" xml-lang="en-US"><emph>registrationname</emph>: The name to use to find the database in the databases register. It is ignored if <literal>FileName</literal> &lt;&gt; "".</paragraph>
<paragraph role="paragraph" id="id721596556313545" xml-lang="en-US"><emph>macroexecution</emph>: 0 = behaviour is defined by the user configuration, 1 = macros are not executable, 2 = macros are executable.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
@@ -472,7 +472,7 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id971620331945744">svcUI.Resize(width = 500, height = 500)</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id971620331945744">svcUI.Resize(width = 500, height = 500)</paragraph>
</pycode>
<tip id="par_id21620332301809">To resize a window that is not active, first activate it using the <literal>Activate</literal> method.</tip>
</section>
@@ -504,11 +504,11 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id631620332653004">from time import sleep</paragraph>
- <paragraph role="pycode" id="pyc_id351620332422330">for i in range(101):</paragraph>
- <paragraph role="bascode" id="bas_id261620332627647"> svcUI.SetStatusbar("Test:", i)</paragraph>
- <paragraph role="pycode" id="pyc_id181620332715974"> sleep(0.05)</paragraph>
- <paragraph role="pycode" id="pyc_id381620332733373">svcUI.SetStatusbar()</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id631620332653004">from time import sleep</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id351620332422330">for i in range(101):</paragraph>
+ <paragraph role="pycode" localize="false" id="bas_id261620332627647"> svcUI.SetStatusbar("Test:", i)</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id181620332715974"> sleep(0.05)</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id381620332733373">svcUI.SetStatusbar()</paragraph>
</pycode>
</section>
@@ -570,8 +570,8 @@
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
- <paragraph role="pycode" id="pyc_id441620333481074">if svcUI.WindowExists(r"C:\Document\My file.odt"):</paragraph>
- <paragraph role="pycode" id="pyc_id801620333495532"> # ...</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id441620333481074">if svcUI.WindowExists(r"C:\Document\My file.odt"):</paragraph>
+ <paragraph role="pycode" localize="false" id="pyc_id801620333495532"> # ...</paragraph>
</pycode>
</section>