diff options
Diffstat (limited to 'helpcontent2/source/text/sbasic')
420 files changed, 51895 insertions, 0 deletions
diff --git a/helpcontent2/source/text/sbasic/guide/access2base.xhp b/helpcontent2/source/text/sbasic/guide/access2base.xhp new file mode 100644 index 000000000..507a63c9d --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/access2base.xhp @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- +=================================================================================================================== +=== The Access2Base library is a part of the LibreOffice project. === +=== Full documentation is available on http://www.access2base.com === +=================================================================================================================== + + Access2Base is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + + Access2Base is free software; you can redistribute it and/or modify it under the terms of either (at your option): + + 1) 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/ . + + 2) The GNU Lesser General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. If a copy of the LGPL was not + distributed with this file, see http://www.gnu.org/licenses/ . + --> + + +<helpdocument version="1.0"> +<meta> + <topic id="textsbasicsharedA2B001xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Access2Base</title> + <filename>/text/sbasic/guide/access2base.xhp</filename> + </topic> + <history> + <created date="2013-11-01T00:00:00">Access2Base topic first insertion, by Jean-Pierre Ledure</created> + </history> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_idA2B001"> +<bookmark_value>Access2Base</bookmark_value> +<bookmark_value>Microsoft Access; Access2Base</bookmark_value> +<bookmark_value>Access databases; run in Base</bookmark_value> +</bookmark> + <paragraph role="heading" id="hd_idA2B002" xml-lang="en-US" level="1">Access2Base</paragraph> + <paragraph role="heading" id="hd_idA2B003" xml-lang="en-US" level="2">What is Access2Base?</paragraph> + <paragraph role="paragraph" id="par_idA2B004" xml-lang="en-US">Access2Base is a %PRODUCTNAME BASIC library of macros for (business or personal) application developers and advanced users. It is one of the libraries stored in "Application macros and dialogs".</paragraph> + <paragraph role="paragraph" id="par_idA2B005" xml-lang="en-US">The functionalities provided by the implemented macros are all directly inspired by Microsoft Access. The macros are callable mainly from a %PRODUCTNAME <emph>Base</emph> application, but also from <emph>any</emph> %PRODUCTNAME document (Writer, Calc, ...) where access to data stored in a database makes sense.</paragraph> + <paragraph role="paragraph" id="par_idA2B006" xml-lang="en-US">The API provided by Access2Base is intended to be more concise, intuitive and easy to learn than the standard UNO API (API = Application Programming Interface).</paragraph> + <paragraph role="warning" id="par_idA2B007" xml-lang="en-US"><emph>The library is documented online on </emph><link href="http://www.access2base.com" name="http://www.access2base.com"><emph>http://www.access2base.com</emph></link>.</paragraph> + <paragraph role="heading" id="hd_idA2B008" xml-lang="en-US" level="2">The implemented macros include:</paragraph> + <list type="ordered" format="1"> + <listitem> + <paragraph role="listitem" id="par_idA2B009" xml-lang="en-US">a simplified and extensible API for <emph>forms</emph>, <emph>dialogs</emph> and <emph>controls</emph> manipulations similar with the Microsoft Access object model,</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_idA2B010" xml-lang="en-US">an API for database access with the <emph>table</emph>, <emph>query</emph>, <emph>recordset</emph> and <emph>field</emph> objects,</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_idA2B011" xml-lang="en-US">a number of <emph>actions</emph> with a syntax identical to their corresponding Microsoft Access macros/actions,</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_idA2B012" xml-lang="en-US">the <emph>DLookup</emph>, <emph>DSum</emph>, ... database functions,</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_idA2B013" xml-lang="en-US">the support of the shortcut notations like <item type="literal">Forms!myForm!myControl</item></paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_idA2B014" xml-lang="en-US">in addition</paragraph> + <list type="ordered" format="1" startwith="6"> + <listitem> + <paragraph role="listitem" id="par_idA2B015" xml-lang="en-US">a consistent errors and exceptions handler,</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_idA2B016" xml-lang="en-US">facilities for programming form, dialog and control <emph>events</emph> and</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_idA2B017" xml-lang="en-US">the support of both embedded forms and standalone (Writer) forms.</paragraph> + </listitem> + </list> + <paragraph role="heading" id="hd_idA2B018" xml-lang="en-US" level="2">Compare Access2Base with Microsoft Access VBA</paragraph> + <bascode> + <paragraph role="bascode" id="hd_idA2B019" xml-lang="en-US" localize="false">REM Open a form ... </paragraph> + <paragraph role="bascode" id="hd_idA2B020" xml-lang="en-US" localize="false"> OpenForm("myForm") </paragraph> + <paragraph role="bascode" id="hd_idA2B021" xml-lang="en-US" localize="false">REM Move a form to new left-top coordinates ... </paragraph> + <paragraph role="bascode" id="hd_idA2B022" xml-lang="en-US" localize="false"> Dim ofForm As Object ' In VBA => Dim ofForm As Form </paragraph> + <paragraph role="bascode" id="hd_idA2B023" xml-lang="en-US" localize="false"> Set ofForm = Forms("myForm") </paragraph> + <paragraph role="bascode" id="hd_idA2B024" xml-lang="en-US" localize="false"> ofForm.Move(100, 200) </paragraph> + <paragraph role="bascode" id="hd_idA2B025" xml-lang="en-US" localize="false">REM Get the value of a control ... </paragraph> + <paragraph role="bascode" id="hd_idA2B026" xml-lang="en-US" localize="false"> Dim ocControl As Object </paragraph> + <paragraph role="bascode" id="hd_idA2B027" xml-lang="en-US" localize="false"> ocControl = ofForm.Controls("myControl") </paragraph> + <paragraph role="bascode" id="hd_idA2B028" xml-lang="en-US" localize="false"> MsgBox ocControl.Value </paragraph> + <paragraph role="bascode" id="hd_idA2B029" xml-lang="en-US" localize="false">REM Hide a control ... </paragraph> + <paragraph role="bascode" id="hd_idA2B030" xml-lang="en-US" localize="false"> ocControl.Visible = False </paragraph> + <paragraph role="bascode" id="hd_idA2B031" xml-lang="en-US" localize="false">REM ... or alternatively ... </paragraph> + <paragraph role="bascode" id="hd_idA2B032" xml-lang="en-US" localize="false"> setValue("Forms!myForm!myControl.Visible", False) ' Shortcut notation </paragraph> + <paragraph role="bascode" id="hd_idA2B033" xml-lang="en-US" localize="false"> ' In VBA => Forms!myForm!myControl.Visible = False </paragraph> + </bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/basic_2_python.xhp b/helpcontent2/source/text/sbasic/guide/basic_2_python.xhp new file mode 100644 index 000000000..4ea2d89f4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/basic_2_python.xhp @@ -0,0 +1,181 @@ +<?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="text/sbasic/guide/basic_2_python"> + <title id="tit" xml-lang="en-US">Basic to Python</title> + <filename>/text/sbasic/guide/basic_2_python.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0430"> + <bookmark_value>Basic;Calling Python</bookmark_value> + <bookmark_value>API;SimpleFileAccess</bookmark_value> + <bookmark_value>API;PathSettings</bookmark_value> + <bookmark_value>API;XScript</bookmark_value> + </bookmark> + <h1 id="hd_id811571848401485"><variable id="basic2python"><link href="text/sbasic/guide/basic_2_python.xhp" name="Basic Programming Examples">Calling Python Scripts from Basic</link></variable></h1> + <paragraph role="paragraph" id="N0432">Calling Python scripts from %PRODUCTNAME Basic macros is possible, and valuable features can be obtained such as:</paragraph> + <list type="unordered"> + <listitem><paragraph role="listitem" id="N0433"><literal>ComputerName</literal> identification or <literal>OSName</literal> detection are possible,</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0434">Basic <literal>FileLen()</literal> function and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1ucb_1_1SimpleFileAccess.html" name="ucb.SimpleFileAccess">com.sun.star.ucb.SimpleFileAccess.</link><literal>getSize()</literal> API function exhibit a 2 Gigabytes file size upper limit that Python helps to overcome,</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0435"><link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1util_1_1PathSettings.html" name="util.PathSettings">com.sun.star.util.PathSettings</link> can be normalized,</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0436">and many more.</paragraph></listitem> + </list> + <tip id="N0437">A reasonable exposure to %PRODUCTNAME Basic and to <link href="https://api.libreoffice.org/" name="Application Programming Interface">Application Programming Interface (API)</link> features is recommended prior to perform inter-language calls from Basic to Python, to JavaScript or any other script engine.</tip> + <h2 id="N0438">Retrieving Python Scripts</h2> + <paragraph role="paragraph" id="N0439">Python scripts can be personal, shared, or embedded in documents. In order to execute them, %PRODUCTNAME Basic needs to be provided with Python script locations. Locating <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1script_1_1provider_1_1XScript.html" name="script.provider.XScript">com.sun.star.script.provider.XScript</link> interface compliant UNO objects allows the execution of Python scripts:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="N0440">Option Explicit</paragraph> + <paragraph role="bascode" localize="false" id="N0441"> </paragraph> + <paragraph role="bascode" localize="false" id="N0442">Public Function GetPythonScript(macro As String, _</paragraph> + <paragraph role="bascode" localize="false" id="N0443"> Optional location As String) As com.sun.star.script.provider.Xscript</paragraph> + <paragraph role="bascode" id="N0444"> ''' Grab Python script object before execution</paragraph> + <paragraph role="bascode" id="N0445"> ' Arguments:</paragraph> + <paragraph role="bascode" id="N0446"> ' macro : as "library/module.py$macro" or "module.py$macro"</paragraph> + <paragraph role="bascode" id="N0447"> ' location: as "document", "share", "user" or ENUM(eration)</paragraph> + <paragraph role="bascode" id="N0448"> ' Result:</paragraph> + <paragraph role="bascode" id="N0449"> ' located com.sun.star.script.provider.XScript UNO service'''</paragraph> + <paragraph role="bascode" localize="false" id="N0450"> If IsMissing(location) Then location = "user"</paragraph> + <paragraph role="bascode" localize="false" id="N0451"> Dim mspf As Object ' com.sun.star.script.provider.MasterScriptProviderFactory</paragraph> + <paragraph role="bascode" id="N0452"> Dim sp As Object ' com.sun.star.script.provider.XScriptProvider compatible</paragraph> + <paragraph role="bascode" localize="false" id="N0453"> Dim uri As String</paragraph> + <paragraph role="bascode" localize="false" id="N0454"> If location="document" Then</paragraph> + <paragraph role="bascode" localize="false" id="N0455"> sp = ThisComponent.getScriptProvider()</paragraph> + <paragraph role="bascode" localize="false" id="N0456"> Else</paragraph> + <paragraph role="bascode" localize="false" id="N0457"> mspf = CreateUNOService("com.sun.star.script.provider.MasterScriptProviderFactory")</paragraph> + <paragraph role="bascode" localize="false" id="N0458"> sp = mspf.createScriptProvider("")</paragraph> + <paragraph role="bascode" localize="false" id="N0459"> End If</paragraph> + <paragraph role="bascode" localize="false" id="N0460"> uri = "vnd.sun.star.script:"& macro &"?language=Python&location="& location</paragraph> + <paragraph role="bascode" localize="false" id="N0461"> GetPythonScript = sp.getScript(uri)</paragraph> + <paragraph role="bascode" localize="false" id="N0462">End Function ' GetPythonScript</paragraph> + </bascode> + <h2 id="N0463">Executing Python Scripts</h2> + <embed href="text/sbasic/python/python_2_basic.xhp#APIScriptingFramework" /> + <h3 id="N0464">Syntax</h3> + <paragraph role="paragraph" localize="false" id="N0465"><literal>workstation_name = script.invoke(Array(), Array(), Array())</literal></paragraph> + <paragraph role="paragraph" id="N0466"><literal>opSysName = script.invoke(Array(), in_outs, Array())</literal> ' in_out is an Array</paragraph> + <paragraph role="paragraph" localize="false" id="N0467"><literal>file_len = script.invoke(Array(systemFilePath), Array(), Array())</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0468"><literal>normalizedPath = script.invoke(Array(systemFilePath), Array(), Array())</literal></paragraph> + <h3 id="N0469">Embedded Scripts Examples</h3> + <paragraph role="paragraph" id="N0470">Below <literal>ComputerName</literal>, and <literal>GetFilelen</literal> routines are calling their Python counterparts, using aforementioned <literal>GetPythonScript</literal> function. Exception handling is not detailed.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="N0471">Option Explicit</paragraph> + <paragraph role="bascode" id="N0472">Option Compatible ' Properties are supported</paragraph> + <paragraph role="bascode" localize="false" id="N0473"> </paragraph> + <paragraph role="bascode" localize="false" id="N0474">Private scr As Object ' com.sun.star.script.provider.XScript</paragraph> + <paragraph role="bascode" localize="false" id="N0475"> </paragraph> + <paragraph role="bascode" localize="false" id="N0476">Private Property Get ComputerName As String</paragraph> + <paragraph role="bascode" id="N0477"> '''Workstation name'''</paragraph> + <paragraph role="bascode" localize="false" id="N0478"> scr = GetPythonScript("Platform.py$computer_name", "document")</paragraph> + <paragraph role="bascode" localize="false" id="N0479"> ComputerName = scr.invoke(Array(), Array(), Array())</paragraph> + <paragraph role="bascode" localize="false" id="N0480">End Property ' ComputerName</paragraph> + <paragraph role="bascode" localize="false" id="N0481"> </paragraph> + <paragraph role="bascode" localize="false" id="N0482">Private Function GetFilelen(systemFilePath As String) As Currency</paragraph> + <paragraph role="bascode" id="N0483"> '''File size in bytes'''</paragraph> + <paragraph role="bascode" localize="false" id="N0484"> scr = GetPythonScript("Os/Path.py$get_size", Script.ISEMBEDDED)</paragraph> + <paragraph role="bascode" localize="false" id="N0485"> GetFilelen = scr.invoke(Array(systemFilePath), Array(), Array(),)</paragraph> + <paragraph role="bascode" localize="false" id="N0486">End Function ' GetFilelen</paragraph> + <paragraph role="bascode" localize="false" id="N0487"> </paragraph> + <paragraph role="bascode" localize="false" id="N0488">Private Type _SCRIPT_LOCATION</paragraph> + <paragraph role="bascode" id="N0489"> ISEMBEDDED As String ' document script</paragraph> + <paragraph role="bascode" id="N0490"> ISPERSONAL As String ' user script</paragraph> + <paragraph role="bascode" id="N0491"> ISSHARED As String ' %PRODUCTNAME macro</paragraph> + <paragraph role="bascode" localize="false" id="N0492">End Type ' _SCRIPT_LOCATION</paragraph> + <paragraph role="bascode" localize="false" id="N0493"> </paragraph> + <paragraph role="bascode" localize="false" id="N0494">Public Function Script() As Object ' Text enumeration</paragraph> + <paragraph role="bascode" localize="false" id="N0495"> Static enums As _SCRIPT_LOCATION : With enums</paragraph> + <paragraph role="bascode" localize="false" id="N0496"> If .ISEMBEDDED = "" Then</paragraph> + <paragraph role="bascode" id="N0497"> .ISEMBEDDED = "document" ' document script</paragraph> + <paragraph role="bascode" id="N0498"> .ISPERSONAL = "user" ' user scripts</paragraph> + <paragraph role="bascode" id="N0499"> .ISSHARED = "share" ' %PRODUCTNAME macro</paragraph> + <paragraph role="bascode" localize="false" id="N0500"> End If : End With ' enums</paragraph> + <paragraph role="bascode" localize="false" id="N0501"> Script = enums</paragraph> + <paragraph role="bascode" localize="false" id="N0502">End Function ' Script</paragraph> + </bascode> + <paragraph role="paragraph" id="N0503">Two different Python modules are called. They can either be embedded in the current document, either be stored on the file system. Argument type checking is skipped for clarity:</paragraph> + <list type="unordered"> + <listitem><paragraph localize="false" role="paragraph" id="N0504">Platform.py</paragraph></listitem> + </list> + <pycode> + <paragraph role="pycode" localize="false" id="N0505"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0506">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0507"> </paragraph> + <paragraph role="pycode" localize="false" id="N0508">import platform</paragraph> + <paragraph role="pycode" localize="false" id="N0509"> </paragraph> + <paragraph role="pycode" localize="false" id="N0510">def computer_name() -> str:</paragraph> + <paragraph role="pycode" localize="false" id="N0511"> return platform.node()</paragraph> + <paragraph role="pycode" localize="false" id="N0512"> </paragraph> + <paragraph role="pycode" localize="false" id="N0513">def OSname() -> str:</paragraph> + <paragraph role="pycode" localize="false" id="N0514"> return platform.system()</paragraph> + </pycode> + <list type="unordered"> + <listitem><paragraph localize="false" role="paragraph" id="N0515">Os/Path.py</paragraph></listitem> + </list> + <pycode> + <paragraph role="pycode" localize="false" id="N0516"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0517">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0518"> </paragraph> + <paragraph role="pycode" localize="false" id="N0519">import os.path</paragraph> + <paragraph role="pycode" localize="false" id="N0520"> </paragraph> + <paragraph role="pycode" localize="false" id="N0521">def get_size(systemFilePath: str) -> str:</paragraph> + <paragraph role="pycode" localize="false" id="N0522"> return str(os.path.getsize(systemFilePath))</paragraph> + <paragraph role="pycode" localize="false" id="N0523"> </paragraph> + <paragraph role="pycode" localize="false" id="N0524">def normalyze(systemPath: str) -> str:</paragraph> + <paragraph role="pycode" localize="false" id="N0525"> return os.path.normpath(systemPath)</paragraph> + </pycode> + <h3 id="N0526">Personal or Shared Scripts Examples</h3> + <paragraph role="paragraph" id="N0527">The calling mechanism for personal or shared Python scripts is identical to that of embedded scripts. Library names are mapped to folders. Computing %PRODUCTNAME user profile and shared modules system file paths can be performed as detailed in <link href="text/sbasic/python/python_session.xhp">Getting session information</link>. Below <literal>OSName</literal>, <literal>HelloWorld</literal> and <literal>NormalizePath</literal> routines are calling their Python counterparts, using aforementioned <literal>GetPythonScript</literal> function. Exception handling is not detailed.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="N0528">Option Explicit</paragraph> + <paragraph role="bascode" id="N0529">Option Compatible ' Properties are supported</paragraph> + <paragraph role="bascode" localize="false" id="N0530"> </paragraph> + <paragraph role="bascode" localize="false" id="N0531">Private scr As Object ' com.sun.star.script.provider.XScript</paragraph> + <paragraph role="bascode" localize="false" id="N0532"> </paragraph> + <paragraph role="bascode" localize="false" id="N0533">Private Property Get OSName As String</paragraph> + <paragraph role="bascode" id="N0534"> '''Platform name as "Linux", "Darwin" or "Windows"'''</paragraph> + <paragraph role="bascode" localize="false" id="N0535"> scr = GetPythonScript("Platform.py$OSname", Script.ISPERSONAL)</paragraph> + <paragraph role="bascode" localize="false" id="N0536"> OSName = scr.invoke(Array(), Array(), Array()) </paragraph> + <paragraph role="bascode" localize="false" id="N0537">End Property ' OSName</paragraph> + <paragraph role="bascode" localize="false" id="N0538"> </paragraph> + <paragraph role="bascode" localize="false" id="N0539">Private Sub HelloWorld()</paragraph> + <paragraph role="bascode" id="N0540"> '''%PRODUCTNAME Python shared sample'''</paragraph> + <paragraph role="bascode" localize="false" id="N0541"> scr = GetPythonScript("HelloWorld.py$HelloWorldPython", Script.ISSHARED)</paragraph> + <paragraph role="bascode" localize="false" id="N0542"> scr.invoke(Array(), Array(), Array(),)</paragraph> + <paragraph role="bascode" localize="false" id="N0543">End Sub ' HelloWorld</paragraph> + <paragraph role="bascode" localize="false" id="N0544"> </paragraph> + <paragraph role="bascode" localize="false" id="N0545">Public Function NormalizePath(systemFilePath As String) As String</paragraph> + <paragraph role="bascode" id="N0546"> '''Strip superfluous '\..' in path'''</paragraph> + <paragraph role="bascode" localize="false" id="N0547"> scr = GetPythonScript("Os/Path.py$normalyze", "user")</paragraph> + <paragraph role="bascode" localize="false" id="N0548"> NormalizePath = scr.invoke(Array(systemFilePath), Array(), Array())</paragraph> + <paragraph role="bascode" localize="false" id="N0549">End Function ' NormalizePath</paragraph> + </bascode> + <h2 id="N0550">Python standard modules</h2> + <paragraph role="paragraph" id="N0551">%PRODUCTNAME embedded Python contains many standard libraries to benefit from. They bear a rich feature set, such as but not limited to:</paragraph> + <list type="unordered"> + <listitem><paragraph role="listitem" id="N0552"><emph>argparse</emph> Parser for command-line options, arguments and sub-commands</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0553"><emph>cmath</emph> Mathematical functions for complex numbers</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0554"><emph>csv</emph> CSV files reading and writing</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0555"><emph>datetime</emph> Genuine date and time types</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0556"><emph>json</emph> JSON encoder and decoder</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0557"><emph>math</emph> Mathematical functions</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0558"><emph>re</emph> Regular expression operations</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0559"><emph>socket</emph> Low-level networking interface</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0560"><emph>sys</emph> System-specific parameters and functions</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0561"><emph>unittest</emph> and <emph>trace</emph> Unit testing framework and Track Python execution</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0562"><emph>xml.etree.ElementTree</emph> ElementTree XML API</paragraph></listitem> + </list> + <section id="relatedtopics" > + <embed href="text/sbasic/python/python_2_basic.xhp#py2ba_h1"/> + <embed href="text/sbasic/shared/main0601.xhp#mainsbasic"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/basic_examples.xhp b/helpcontent2/source/text/sbasic/guide/basic_examples.xhp new file mode 100644 index 000000000..97b11c065 --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/basic_examples.xhp @@ -0,0 +1,36 @@ +<?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="basicexamples" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Basic Programming Examples</title> + <filename>/text/sbasic/guide/basic_examples.xhp</filename> + </topic> + </meta> + <body> + <bookmark xml-lang="en-US" branch="index" id="bm_id171559140731329"> + <bookmark_value>Basic;programming examples</bookmark_value> + </bookmark> + <section id="basicexamplesh1"> + <h1 id="hd_id471559139063621"><variable id="basicexamplestit"><link href="text/sbasic/guide/basic_examples.xhp" name="Basic Programming Examples">Basic Programming Examples</link></variable></h1> + </section> + <embed href="text/sbasic/python/python_handler.xhp#pythonhandler_h1"/> + <embed href="text/sbasic/python/python_listener.xhp#pythonlistener"/> + <embed href="text/sbasic/python/python_session.xhp#pythonsession"/> + <embed href="text/sbasic/python/python_platform.xhp#pythonplatform"/> + <embed href="text/sbasic/python/python_document_events.xhp#pythonmonitor"/> + <embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> + <embed href="text/sbasic/guide/sample_code.xhp#sample_code"/> + <embed href="text/sbasic/guide/basic_2_python.xhp#basic2python"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/main0601.xhp#mainsbasic"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/calc_borders.xhp b/helpcontent2/source/text/sbasic/guide/calc_borders.xhp new file mode 100644 index 000000000..23fa7b885 --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/calc_borders.xhp @@ -0,0 +1,248 @@ +<?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_FormControl" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Formatting Borders in Calc with Macros</title> + <filename>/text/sbasic/guide/calc_borders.xhp</filename> + </topic> +</meta> + +<body> + <bookmark localize="false" branch="index" id="bm_id41582391760114"> + <bookmark_value>macros;format borders</bookmark_value> + </bookmark> + <h1 id="hd_id461623364876507"><variable id="title"><link href="text/sbasic/guide/calc_borders.xhp" name="Calc_Borders_h1">Formatting Borders in Calc with Macros</link></variable></h1> + <paragraph role="paragraph" id="par_id461630536347127">By using Basic or Python programming languages it is possible to write macros that apply formats to ranges of cells in Calc.</paragraph> + + <h2 id="hd_id81630536486560">Formatting Borders in Ranges of Cells</h2> + <paragraph role="paragraph" id="par_id871630536518700">The code snippet below creates a <literal>Sub</literal> called <literal>FormatCellBorder</literal> that applies new border formats to a given range address in the current Calc sheet.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id161630537784558">Sub FormatCellBorder(cellAddress as String, newStyle as Byte, newWidth as Long, Optional newColor as Long)</paragraph> + <paragraph role="bascode" id="bas_id131630537785605"> ' Creates the UNO struct that will store the new line format</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751630537785844"> Dim lineFormat as New com.sun.star.table.BorderLine2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331630537786054"> lineFormat.LineStyle = newStyle</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561630537786262"> lineFormat.LineWidth = newWidth</paragraph> + <paragraph role="bascode" localize="false" id="bas_id731630537786476"> If Not IsMissing(newColor) Then lineFormat.Color = newColor</paragraph> + <paragraph role="bascode" id="bas_id971630537786724"> ' Gets the target cell</paragraph> + <paragraph role="bascode" localize="false" id="bas_id221630537786925"> Dim oCell as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id301630537787141"> Set oCell = ThisComponent.CurrentController.ActiveSheet.getCellRangeByName(cellAddress)</paragraph> + <paragraph role="bascode" id="bas_id791630537787373"> ' Applies the new format to all borders</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291630537787589"> oCell.TopBorder = lineFormat</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471630537787829"> oCell.RightBorder = lineFormat</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21630537788070"> oCell.LeftBorder = lineFormat</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491630537788285"> oCell.BottomBorder = lineFormat</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531630537788597">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id141630537941393">The <literal>Sub</literal> described above takes in four arguments:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id841630538209958" role="listitem"><emph>cellAddress</emph> is a string denoting the range to be formatted in the format "A1".</paragraph> + </listitem> + <listitem> + <paragraph id="par_id821630538210271" role="listitem"><emph>newStyle</emph> is an integer value that corresponds to the border line style (see <link href="text/sbasic/guide/calc_borders.xhp#LineStyles_h2" name="LineStyles_link">Line Styles</link> below).</paragraph> + </listitem> + <listitem> + <paragraph id="par_id191630538210607" role="listitem"><emph>newWidth</emph> is an integer value that defines the line width.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id71630538211142" role="listitem"><emph>newColor</emph> is an integer value corresponding to a color defined using the <link href="text/sbasic/shared/03010305.xhp" name="RGB_link">RGB</link> function.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id201630538522838">To call <literal>FormatCellBorder</literal> create a new macro and pass the desired arguments, as shown below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id871630538918984">Sub MyMacro</paragraph> + <paragraph role="bascode" id="bas_id651630603779228"> ' Gives access to the line style constants</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961630603780188"> Dim cStyle as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741630603780429"> Set cStyle = com.sun.star.table.BorderLineStyle</paragraph> + <paragraph role="bascode" id="bas_id321630538931144"> ' Formats "B5" with solid blue borders</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001630538931505"> FormatCellBorder("B5", cStyle.SOLID, 20, RGB(0, 0, 255))</paragraph> + <paragraph role="bascode" id="bas_id91630538931686"> ' Formats all borders in the range "D2:F6" with red dotted borders</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261630538932143"> FormatCellBorder("D2:F6", cStyle.DOTTED, 20, RGB(255, 0, 0))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471630539067462">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id31630540159114">It is possible to implement the same functionality in Python:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id381630541980340">from uno import createUnoStruct</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231630541980607">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801630542013431"></paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221630540777433">def formatCellBorder(cellAddress, newStyle, newWidth, newColor=0):</paragraph> + <paragraph role="pycode" id="pyc_id411630540777672"> # Defines the new line format</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id731630540777889"> line_format = createUnoStruct("com.sun.star.table.BorderLine2")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id341630540778097"> line_format.LineStyle = newStyle</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id301630540778329"> line_format.LineWidth = newWidth</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id691630540778577"> line_format.Color = newColor</paragraph> + <paragraph role="pycode" id="pyc_id361630540778786"> # Scriptforge service to access cell ranges</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id471630540778985"> doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id551630540779225"> cell = doc.XCellRange(cellAddress)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id51630540779426"> cell.TopBorder = line_format</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id31630540779643"> cell.RightBorder = line_format</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id401630540779834"> cell.LeftBorder = line_format</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id291630540780067"> cell.BottomBorder = line_format</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id931630541661889">The code snippet below implements a macro named <literal>myMacro</literal> that calls <literal>formatCellBorder</literal>:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id131630605507740">from com.sun.star.table import BorderLineStyle as cStyle</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id351630605508043"></paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181630541791470">def myMacro():</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id1001630541791803"> bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id531630541792043"> formatCellBorder("B5", cStyle.SOLID, 20, bas.RGB(0, 0, 255))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id601630541792230"> formatCellBorder("D2:F6", cStyle.DOTTED, 20, bas.RGB(255, 0, 0))</paragraph> + </pycode> + <note id="par_id261630541889040">The Python code presented above uses the <link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="SF_link">ScriptForge library</link> that is available since %PRODUCTNAME 7.2.</note> + + <section id="LineStyles_h2"> + <h2 id="hd_id361630539136798">Line Styles</h2> + </section> + <paragraph role="paragraph" id="par_id501630539147234">Line styles are defined as integer constants. The table below lists the constants for the line styles available in <menuitem>Format - Cells - Borders</menuitem>:</paragraph> + <table id="tab_id531630539273987"> + <tablerow> + <tablecell> + <paragraph id="par_id651630604006712" role="tablehead">Constant name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501630539273987" role="tablehead">Integer value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id191630539273987" role="tablehead">Line style name</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id301630604024530" localize="false" role="tablecontent">SOLID</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861630539273987" localize="false" role="tablecontent">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691630539273987" role="tablecontent">Solid</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id571630604044791" localize="false" role="tablecontent">DOTTED</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321630539319305" localize="false" role="tablecontent">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591630539325162" role="tablecontent">Dotted</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id921630604090581" localize="false" role="tablecontent">DASHED</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261630539430102" localize="false" role="tablecontent">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881630539433260" role="tablecontent">Dashed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id981630604124169" localize="false" role="tablecontent">FINE_DASHED</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701630539460809" localize="false" role="tablecontent">14</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111630539463634" role="tablecontent">Fine dashed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311630604157101" localize="false" role="tablecontent">DOUBLE_THIN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id101630539468131" localize="false" role="tablecontent">15</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261630539471483" role="tablecontent">Double thin</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id911630604171290" localize="false" role="tablecontent">DASH_DOT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id851630539475055" localize="false" role="tablecontent">16</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id671630539478101" role="tablecontent">Dash dot</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id841630604186084" localize="false" role="tablecontent">DASH_DOT_DOT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id481630539481944" localize="false" role="tablecontent">17</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701630539484498" role="tablecontent">Dash dot dot</paragraph> + </tablecell> + </tablerow> + </table> + <tip id="par_id751630539680866">Refer to the <link href="https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star_1_1table_1_1BorderLineStyle.html" name="BorderLineStyle_link">BorderLineStyle Constant Reference</link> in the LibreOffice API documentation to learn more about line style constants.</tip> + + <h2 id="hd_id31630542361666">Formatting Borders Using TableBorder2</h2> + <paragraph role="paragraph" id="par_id11630542436346">Range objects have a property named <literal>TableBorder2</literal> that can be used to format range borders as it is done in the <menuitem>Format - Cells - Borders</menuitem> dialog in the <emph>Line Arrangement</emph> section.</paragraph> + <paragraph role="paragraph" id="par_id641630542724480">In addition to top, bottom, left and right borders, <literal>TableBorder2</literal> also defines vertical and horizontal borders. The macro below applies only the top and bottom borders to the range "B2:E5".</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id761630543331847">Sub TableBorder2Example</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261630606415938"> Dim cStyle as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831630606416281"> Set cStyle = com.sun.star.table.BorderLineStyle</paragraph> + <paragraph role="bascode" id="bas_id191630543332073"> ' Defines the new line format</paragraph> + <paragraph role="bascode" localize="false" id="bas_id111630543332260"> Dim lineFormat as New com.sun.star.table.BorderLine2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101630543332460"> lineFormat.LineStyle = cStyle.SOLID</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241630543332688"> lineFormat.LineWidth = 15</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631630543332874"> lineFormat.Color = RGB(0, 0, 0)</paragraph> + <paragraph role="bascode" id="bas_id281630543333061"> ' Struct that stores the new TableBorder2 definition</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691630543333288"> Dim tableFormat as New com.sun.star.table.TableBorder2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id451630543333501"> tableFormat.TopLine = lineFormat</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661630543333742"> tableFormat.BottomLine = lineFormat</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151630543333968"> tableFormat.IsTopLineValid = True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211630543334181"> tableFormat.IsBottomLineValid = True</paragraph> + <paragraph role="bascode" id="bas_id11630543334395"> ' Applies the table format to the range "B2:E5"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id761630543334607"> Dim oCell as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531630543334821"> oCell = ThisComponent.CurrentController.ActiveSheet.getCellRangeByName("B2:E5")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851630543335050"> oCell.TableBorder2 = tableFormat</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51630543335289">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id401630544066231">The macro can be implemented in Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id131630605507120">from com.sun.star.table import BorderLineStyle as cStyle</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id21630606279912">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id351630605508087"></paragraph> + <paragraph role="pycode" localize="false" id="pyc_id791630544113462">def tableBorder2Example():</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id461630606297116"> bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221630544113741"> line_format = createUnoStruct("com.sun.star.table.BorderLine2")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id271630544113941"> line_format.LineStyle = cStyle.SOLID</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id41630544114154"> line_format.LineWidth = 18</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id921630544114367"> line_format.Color = bas.RGB(0, 0, 0)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id421630544114568"> table_format = createUnoStruct("com.sun.star.table.TableBorder2")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id721630544114809"> table_format.TopLine = line_format</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id481630544115021"> table_format.BottomLine = line_format</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id371630544115248"> table_format.IsTopLineValid = True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id171630544115462"> table_format.IsBottomLineValid = True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id761630544115702"> doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id341630544115915"> cell = doc.XCellRange("B2:E5")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841630544116128"> cell.TableBorder2 = table_format</paragraph> + </pycode> + <tip id="par_id751630539680102">Refer to the <link href="https://api.libreoffice.org/docs/idl/ref/structcom_1_1sun_1_1star_1_1table_1_1TableBorder2.html" name="BorderLineStyle_link">TableBorder2 Struct Reference</link> in the LibreOffice API documentation to learn more about its attributes.</tip> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#ScriptForge_lib"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/control_properties.xhp b/helpcontent2/source/text/sbasic/guide/control_properties.xhp new file mode 100644 index 000000000..7d8ff2c3e --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/control_properties.xhp @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicguidecontrol_propertiesxml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Changing the Properties of Controls in the Dialog Editor</title> +<filename>/text/sbasic/guide/control_properties.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145786"><bookmark_value>properties; controls in dialog editor</bookmark_value> +<bookmark_value>changing;control properties</bookmark_value> +<bookmark_value>controls;changing properties</bookmark_value> +<bookmark_value>dialog editor;changing control properties</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3145786" xml-lang="en-US" level="1"><variable id="control_properties"><link href="text/sbasic/guide/control_properties.xhp" name="Changing the Properties of Controls in the Dialog Editor">Changing the Properties of Controls in the Dialog Editor</link> +</variable></paragraph> +<paragraph role="paragraph" id="par_id3147317" xml-lang="en-US">You can set the properties of control that you add to a dialog. For example, you can change the color, name, and size of a button that you added. You can change most control properties when you create or edit a dialog. However, you can only change some properties at runtime.</paragraph> +<paragraph role="paragraph" id="par_id3145749" xml-lang="en-US">To change the properties of a control in design mode, right-click the control, and then choose <emph>Properties</emph>.</paragraph> +<section id="relatedtopics"> +<embed href="text/sbasic/guide/create_dialog.xhp#create_dialog"/> +<embed href="text/sbasic/guide/insert_control.xhp#insert_control"/> +<embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> +<embed href="text/sbasic/guide/sample_code.xhp#sample_code"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/create_dialog.xhp b/helpcontent2/source/text/sbasic/guide/create_dialog.xhp new file mode 100644 index 000000000..e948d4467 --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/create_dialog.xhp @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + + <helpdocument version="1.0"> +<meta> +<topic id="textsbasicguidecreate_dialogxml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Creating a Basic Dialog</title> +<filename>/text/sbasic/guide/create_dialog.xhp</filename> +</topic> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149346"><bookmark_value>dialogs;creating Basic dialogs</bookmark_value> +</bookmark><paragraph role="heading" id="hd_id3149346" xml-lang="en-US" level="1"><variable id="create_dialog"><link href="text/sbasic/guide/create_dialog.xhp" name="Creating a Basic Dialog">Creating a Basic Dialog</link> +</variable></paragraph> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3163802" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Dialogs</emph>, and then click <emph>New</emph>.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3150447" xml-lang="en-US">Enter a name for the dialog and click <emph>OK</emph>. To rename the dialog later, right-click the name on the tab and choose <emph>Rename</emph>.<comment>UFI: issue #i51589#</comment></paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_idN1065F" xml-lang="en-US">Click <emph>Edit</emph>. The Basic dialog editor opens and contains a blank dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3153726" xml-lang="en-US">If you do not see the <emph>Toolbox</emph> bar, click the arrow next to the <emph>Insert Controls </emph>icon to open the <emph>Toolbox</emph> bar.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3148455" xml-lang="en-US">Click a tool and then drag in the dialog to create the control.</paragraph> +</listitem> +</list> +<section id="relatedtopics"> +<embed href="text/sbasic/guide/control_properties.xhp#control_properties"/> +<embed href="text/sbasic/guide/insert_control.xhp#insert_control"/> +<embed href="text/sbasic/guide/translation.xhp#translation"/> +<embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> +<embed href="text/sbasic/guide/sample_code.xhp#sample_code"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/insert_control.xhp b/helpcontent2/source/text/sbasic/guide/insert_control.xhp new file mode 100644 index 000000000..cbc6fdbdb --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/insert_control.xhp @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicguideinsert_controlxml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Creating Controls in the Dialog Editor</title> +<filename>/text/sbasic/guide/insert_control.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149182"><bookmark_value>controls; creating in the dialog editor</bookmark_value> +<bookmark_value>dialog editor;creating controls</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3149182" xml-lang="en-US" level="1"><variable id="insert_control"><link href="text/sbasic/guide/insert_control.xhp" name="Creating Controls in the Dialog Editor">Creating Controls in the Dialog Editor</link> +</variable></paragraph> +<paragraph role="paragraph" id="par_id3146797" xml-lang="en-US">Use the tools on the <emph>Toolbox </emph>of the BASIC dialog editor to add controls to your dialog.</paragraph> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3150276" xml-lang="en-US">To open the <emph>Toolbox</emph>, click the arrow next to the <emph>Insert Controls</emph> icon on the <emph>Macro</emph> toolbar.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3145068" xml-lang="en-US">Click a tool on the toolbar, for example, <emph>Button</emph>.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3153360" xml-lang="en-US">On the dialog, drag the button to the size you want.</paragraph> +</listitem> +</list> +<section id="relatedtopics"> +<embed href="text/sbasic/guide/control_properties.xhp#control_properties"/> +<embed href="text/sbasic/guide/create_dialog.xhp#create_dialog"/> +<embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> +<embed href="text/sbasic/guide/sample_code.xhp#sample_code"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/read_write_values.xhp b/helpcontent2/source/text/sbasic/guide/read_write_values.xhp new file mode 100644 index 000000000..b8dab321c --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/read_write_values.xhp @@ -0,0 +1,196 @@ +<?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_FormControl" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Reading and Writing values to Ranges</title> + <filename>/text/sbasic/guide/read_write_values.xhp</filename> + </topic> +</meta> + +<body> + <bookmark localize="false" branch="index" id="bm_id41582391760114"> + <bookmark_value>macros;read values from cells</bookmark_value> + <bookmark_value>macros;write values to cells</bookmark_value> + </bookmark> + <h1 id="hd_id461623364876507"><variable id="title"><link href="text/sbasic/guide/read_write_values.xhp" name="ReadWriteValues_h1">Reading and Writing values to Ranges</link></variable></h1> + <paragraph role="paragraph" id="par_id781633210592228">Macros in %PRODUCTNAME Calc often need to read and write values from/to sheets. This help page describes the various approaches to accessing sheets and ranges to read or write their values.</paragraph> + <note id="par_id191633214565965">All examples presented in this page can be implemented both in Basic and Python.</note> + + <h2 id="hd_id331633213558740">Accessing a Single Cell</h2> + <paragraph role="paragraph" id="par_id731633213581386">The example below enters the numeric value 123 into cell "A1" of the current sheet.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id1001633213643422">Dim oSheet as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871633213643663">Dim oCell as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591633213643809">oSheet = ThisComponent.CurrentController.getActiveSheet()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311633213803255">oCell = oSheet.getCellRangeByName("A1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321633213808005">oCell.setValue(123)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id131633213887433">The same can be accomplished with Python:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id641633214066390">doc = XSCRIPTCONTEXT.getDocument()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id201633214066644">sheet = doc.getCurrentController().getActiveSheet()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id831633214066790">cell = sheet.getCellRangeByName("A1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id371633214066935">cell.setValue(123)</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id861633214219511">Note that in the previous examples the cell is accessed using its range name "A1". It is also possible to access cells using indices as though the sheet were a matrix where columns and rows are indexed starting from zero.</paragraph> + <paragraph role="paragraph" id="par_id161633214461067">This can be done using the <literal>getCellByPosition(colIndex, rowIndex)</literal> method, that takes in a column and a row index. The example below in Basic changes the text value in cell "C1" (column 2, row 0).</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id111633214658017">oSheet = ThisComponent.CurrentController.getActiveSheet()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81633214658358">oCell = oSheet.getCellByPosition(2, 0)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121633214658518">oCell.setString("Hello")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id221633214713436">This example can also be implemented in Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id501633214747969">doc = XSCRIPTCONTEXT.getDocument()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id321633214748196">sheet = doc.getCurrentController().getActiveSheet()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id581633214748362">cell = sheet.getCellByPosition(2, 0)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id11633214748538">cell.setString("Hello")</paragraph> + </pycode> + <note id="par_id101633215142970">The main difference between Python and Basic scripts lies on how to get access to the sheet object by using the <literal>XSCRIPTCONTEXT</literal> context variable. After that, all methods and properties are identical in Basic and Python.</note> + <h2 id="hd_id411633215666257">Values, Strings and Formulas</h2> + <paragraph role="paragraph" id="par_id861633215682610">Calc cells can have three types of values: numeric, strings and formulas. Each type has its own set and get methods:</paragraph> + <table id="tab_id841633215791905"> + <tablerow> + <tablecell> + <paragraph id="par_id191633215791905" role="tablehead">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381633215791905" localize="false" role="tablehead">Get Method</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111633215791905" localize="false" role="tablehead">Set Method</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181633215791905" role="tablecontent">Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701633215791905" localize="false" role="tablecontent"><literal>getValue()</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391633215791905" localize="false" role="tablecontent"><literal>setValue(newValue)</literal></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id961633215932180" role="tablecontent">Text</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id641633215941293" localize="false" role="tablecontent"><literal>getString()</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731633215943212" localize="false" role="tablecontent"><literal>setString(newString)</literal></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id651633215984116" role="tablecontent">Formula</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151633215985290" localize="false" role="tablecontent"><literal>getFormula()</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661633215985584" localize="false" role="tablecontent"><literal>setFormula(newFormula)</literal></paragraph> + </tablecell> + </tablerow> + </table> + <note id="par_id21633215845395">Dates and currency values are considered as numeric values in Calc.</note> + <paragraph role="paragraph" id="par_id221633216111353">The following example enters numeric values into cells "A1" and "A2" and inserts a formula in cell "A3" that returns the multiplication of these values.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id101633216444190">oSheet = ThisComponent.CurrentController.getActiveSheet()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71633216444993">oCell = oSheet.getCellRangeByName("A1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id551633216445179">oCell.setValue(10)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291633216445364">oCell = oSheet.getCellRangeByName("A2")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831633216445527">oCell.setValue(20)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351633216445704">oCell = oSheet.getCellRangeByName("A3")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371633216445928">oCell.setFormula("=A1*A2")</paragraph> + </bascode> + <h2 id="hd_id321633216630043">Accessing Ranges in Different Sheets</h2> + <paragraph role="paragraph" id="par_id371633216672570">The previous examples used only the active sheet to perform operations. It is possible to access cell ranges in different sheets by their indices or names.</paragraph> + <paragraph role="paragraph" id="par_id861633216843382">The example below enters a numeric value into cell "A1" of the sheet named "Sheet2".</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id451633216955038">oSheet = ThisComponent.Sheets.getByName("Sheet2")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291633216955305">oCell = oSheet.getCellRangeByName("A1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971633216955455">oCell.setValue(123)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id611633217090743">This example can also be implemented in Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id701633217100520">doc = XSCRIPTCONTEXT.getDocument()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id821633217100824">sheet = doc.Sheets["Sheet2"]</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941633217101010">cell = sheet.getCellRangeByName("A1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id551633217101223">cell.setValue(123)</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id631633217279518">Sheets can also be accessed using zero-based indices indicating which sheet considering the order they appear in the Calc file.</paragraph> + <paragraph role="paragraph" id="par_id291633264880172">In Basic, instead of using the <literal>getByName</literal> method, use <literal>Sheets(sheetIndex)</literal> as shown next:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id101633264967469">oSheet = ThisComponent.Sheets(0)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id891633265000047">This can be done in a similar fashion in Python:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id91633265043348">sheet = doc.Sheets[0]</paragraph> + </pycode> + <h2 id="hd_id451633265241066">Using the ScriptForge Library</h2> + <paragraph role="paragraph" id="par_id731633265268585">The Calc service of the ScriptForge library can be used to get and set cell values as follows:</paragraph> + <bascode> + <paragraph role="paragraph" id="par_id551633265526538">' Loads the ScriptForge library</paragraph> + <paragraph role="paragraph" localize="false" id="par_id841633265526803">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="paragraph" id="par_id581633265527001">' Gets access to the current Calc document</paragraph> + <paragraph role="paragraph" localize="false" id="par_id721633265527202">oDoc = CreateScriptService("Calc")</paragraph> + <paragraph role="paragraph" id="par_id751633265527427">' Sets the value of cells A1 and A2</paragraph> + <paragraph role="paragraph" localize="false" id="par_id261633265527616">oDoc.setValue("A1", "Hello")</paragraph> + <paragraph role="paragraph" localize="false" id="par_id511633265527793">oDoc.setValue("A2", 123)</paragraph> + </bascode> + <note id="par_id781633267324929">The <literal>setValue</literal> method can be used to set both numeric and text values. To set a cell formula, use the <literal>setFormula</literal> method.</note> + <paragraph role="paragraph" id="par_id251633265634883">With the Calc service, getting and setting cell values can be done with a single line of code. The example below gets the value from cell "A1" and shows it on a message box.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id981633265860659">Dim val as Variant, oDoc as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321633265860947">oDoc = CreateScriptService("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961633265861153">val = oDoc.getValue("A1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id161633265861435">MsgBox val</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id521633608223310">The ScriptForge library also makes it simpler to access ranges in different sheets, as demonstrated in the example below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id761633608365821">Dim val1, val2</paragraph> + <paragraph role="bascode" id="bas_id521633608366292">' Gets cell "A1" from the sheet named "Sheet1"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351633608366132">val1 = oDoc.getValue("Sheet1.A1")</paragraph> + <paragraph role="bascode" id="bas_id661633608366484">' Gets cell "B3" from the sheet named "Sheet2"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351633608366882">val2 = oDoc.getValue("Sheet2.B3")</paragraph> + <paragraph role="bascode" id="bas_id501633608516381">' Places the result into cell "A1" of sheet "Report"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391633608564643">Dim result : result = val1 * val2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171633608516608">oDoc.setValue("Report.A1", result)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id431633266057163">The examples above can also be implemented in Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id421633266075692">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181633266076836">doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id951633266077067">doc.setValue("A1", "Hello")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id181633266076867">doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id631633266227188">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id471633266077260">val = doc.getValue("A1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id751633266077419">bas.MsgBox(val)</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id51633608688348">first_val = doc.getValue("Sheet1.A1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id601633608688574">second_val = doc.getValue("Sheet2.B3")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801633608688713">result = first_val * second_val</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941633608688898">doc.setValue("Report.A1", result)</paragraph> + </pycode> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#ScriptForge_lib"/> + <embed href="text/sbasic/shared/03/sf_calc.xhp#CalcService"/> + <embed href="text/sbasic/python/python_programming.xhp#pythonprogrammingheading"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/sample_code.xhp b/helpcontent2/source/text/sbasic/guide/sample_code.xhp new file mode 100644 index 000000000..cdb79e383 --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/sample_code.xhp @@ -0,0 +1,139 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> + <meta> + <topic id="textsbasicguidesample_codexml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Programming Examples for Controls in the Dialog Editor</title> + <filename>/text/sbasic/guide/sample_code.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> + </meta> +<body> + <bookmark xml-lang="en-US" branch="index" id="bm_id3155338"><bookmark_value>programming examples for controls</bookmark_value> + <bookmark_value>dialogs;loading (example)</bookmark_value> + <bookmark_value>dialogs;displaying (example)</bookmark_value> + <bookmark_value>controls;reading or editing properties (example)</bookmark_value> + <bookmark_value>list boxes;removing entries from (example)</bookmark_value> + <bookmark_value>list boxes;adding entries to (example)</bookmark_value> + <bookmark_value>examples; programming controls</bookmark_value> + <bookmark_value>dialog editor;programming examples for controls</bookmark_value> + <bookmark_value>Tools;LoadDialog</bookmark_value> +</bookmark> +<section id="samplecode"> + <paragraph role="heading" id="hd_id3155338" xml-lang="en-US" level="1"><variable id="sample_code"><link href="text/sbasic/guide/sample_code.xhp" name="Programming Examples for Controls in the Dialog Editor">Programming Examples for Controls in the Dialog Editor</link> + </variable></paragraph> +</section> +<paragraph role="paragraph" id="par_id3153031" xml-lang="en-US">The following examples are for a new <link href="text/sbasic/guide/create_dialog.xhp" name="dialog">dialog</link> called "Dialog1". Use the tools on the <emph>Toolbox</emph> bar in the dialog editor to create the dialog and add the following controls: a <emph>Check Box</emph> called "CheckBox1", a <emph>Label Field</emph> called "Label1", a <emph>Button</emph> called "CommandButton1", and a <emph>List Box</emph> called "ListBox1".</paragraph> +<paragraph role="warning" id="par_id3154141" xml-lang="en-US">Be consistent with uppercase and lowercase letter when you attach a control to an object variable.</paragraph> +<paragraph role="heading" id="hd_id3154909" xml-lang="en-US" level="3">Global Function for Loading Dialogs</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3153193" xml-lang="en-US" localize="false">Function LoadDialog(Libname as String, DialogName as String, Optional oLibContainer)</paragraph> +<paragraph role="bascode" id="par_id3145787" xml-lang="en-US" localize="false">Dim oLib as Object ' com.sun.star.script.XLibraryContainer</paragraph> +<paragraph role="bascode" id="par_id3148576" xml-lang="en-US" localize="false">Dim oLibDialog as Object</paragraph> +<paragraph role="bascode" id="par_id3153726" xml-lang="en-US" localize="false">Dim oRuntimeDialog as Object</paragraph> +<paragraph role="bascode" id="par_id3149261" xml-lang="en-US" localize="false"> If IsMissing(oLibContainer) Then</paragraph> +<paragraph role="bascode" id="par_id3148646" xml-lang="en-US" localize="false"> oLibContainer = DialogLibraries</paragraph> +<paragraph role="bascode" id="par_id3151115" xml-lang="en-US" localize="false"> End If</paragraph> +<paragraph role="bascode" id="par_id3146986" xml-lang="en-US" localize="false"> oLibContainer.LoadLibrary(LibName)</paragraph> +<paragraph role="bascode" id="par_id3145366" xml-lang="en-US" localize="false"> oLib = oLibContainer.GetByName(Libname)</paragraph> +<paragraph role="bascode" id="par_id3145271" xml-lang="en-US" localize="false"> oLibDialog = oLib.GetByName(DialogName)</paragraph> +<paragraph role="bascode" id="par_id3144764" xml-lang="en-US" localize="false"> oRuntimeDialog = CreateUnoDialog(oLibDialog)</paragraph> +<paragraph role="bascode" id="par_id3153876" xml-lang="en-US" localize="false"> LoadDialog() = oRuntimeDialog</paragraph> +<paragraph role="bascode" id="par_id3156286" xml-lang="en-US" localize="false">End Function</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3153032" xml-lang="en-US"><literal>LoadDialog</literal> function is stored in <literal>Tools.ModuleControls</literal> available from Application Macros and Dialogs.</paragraph> +<paragraph role="heading" id="hd_id3149412" xml-lang="en-US" level="3">Displaying a Dialog</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3145801" xml-lang="en-US">REM global definition of variables</paragraph> +<paragraph role="bascode" id="par_id3150716" xml-lang="en-US" localize="false">Dim oDialog1 AS Object</paragraph> +<paragraph role="bascode" id="par_id3154510" xml-lang="en-US" localize="false">Sub StartDialog1</paragraph> +<paragraph role="bascode" id="par_id6715587" xml-lang="en-US" localize="false"> With GlobalScope.BasicLibraries</paragraph> +<paragraph role="bascode" id="par_id3148575" xml-lang="en-US" localize="false"> If Not .IsLibraryLoaded("Tools") Then .LoadLibrary("Tools")</paragraph> +<paragraph role="bascode" id="par_id5815587" xml-lang="en-US" localize="false"> End With</paragraph> +<paragraph role="bascode" id="par_id3150327" xml-lang="en-US" localize="false"> oDialog1 = Tools.ModuleControls.LoadDialog("Standard", "Dialog1")</paragraph> +<paragraph role="bascode" id="par_id3155767" xml-lang="en-US" localize="false"> oDialog1.Execute()</paragraph> +<paragraph role="bascode" id="par_id3149019" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3150042" xml-lang="en-US" level="3">Read or Edit Properties of Controls in the Program</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3159267" xml-lang="en-US" localize="false">Sub Sample1</paragraph> +<paragraph role="bascode" id="par_id6715588" xml-lang="en-US" localize="false"> With GlobalScope.Basiclibraries</paragraph> +<paragraph role="bascode" id="par_id3148576" xml-lang="en-US" localize="false"> If Not .IsLibraryLoaded("Tools") Then .LoadLibrary("Tools")</paragraph> +<paragraph role="bascode" id="par_id5815588" xml-lang="en-US" localize="false"> End With</paragraph> +<paragraph role="bascode" id="par_id3163808" xml-lang="en-US" localize="false"> oDialog1 = Tools.LoadDialog("Standard", "Dialog1")</paragraph> +<paragraph role="bascode" id="par_id3145232" xml-lang="en-US"> REM get dialog model</paragraph> +<paragraph role="bascode" id="par_id3146316" xml-lang="en-US" localize="false"> oDialog1Model = oDialog1.Model</paragraph> +<paragraph role="bascode" id="par_id3154021" xml-lang="en-US"> REM display text of Label1</paragraph> +<paragraph role="bascode" id="par_id3150301" xml-lang="en-US" localize="false"> oLabel1 = oDialog1.GetControl("Label1")</paragraph> +<paragraph role="bascode" id="par_id3152584" xml-lang="en-US" localize="false"> MsgBox oLabel1.Text</paragraph> +<paragraph role="bascode" id="par_id3151277" xml-lang="en-US"> REM set new text for control Label1</paragraph> +<paragraph role="bascode" id="par_id3154119" xml-lang="en-US"> oLabel1.Text = "New Files"</paragraph> +<paragraph role="bascode" id="par_id3155115" xml-lang="en-US"> REM display model properties for the control CheckBox1</paragraph> +<paragraph role="bascode" id="par_id3166426" xml-lang="en-US" localize="false"> oCheckBox1Model = oDialog1Model.CheckBox1</paragraph> +<paragraph role="bascode" id="par_id3153270" xml-lang="en-US" localize="false"> MsgBox oCheckBox1Model.Dbg_Properties</paragraph> +<paragraph role="bascode" id="par_id3149817" xml-lang="en-US"> REM set new state for CheckBox1 for model of control</paragraph> +<paragraph role="bascode" id="par_id3145134" xml-lang="en-US" localize="false"> oCheckBox1Model.State = 1</paragraph> +<paragraph role="bascode" id="par_id3159102" xml-lang="en-US"> REM display model properties for control CommandButton1</paragraph> +<paragraph role="bascode" id="par_id3152777" xml-lang="en-US" localize="false"> oCMD1Model = oDialog1Model.CommandButton1</paragraph> +<paragraph role="bascode" id="par_id3149209" xml-lang="en-US" localize="false"> MsgBox oCMD1Model.Dbg_Properties</paragraph> +<paragraph role="bascode" id="par_id3150368" xml-lang="en-US"> REM display properties of control CommandButton1</paragraph> +<paragraph role="bascode" id="par_id3150883" xml-lang="en-US" localize="false"> oCMD1 = oDialog1.GetControl("CommandButton1")</paragraph> +<paragraph role="bascode" id="par_id3155380" xml-lang="en-US" localize="false"> MsgBox oCMD1.Dbg_Properties</paragraph> +<paragraph role="bascode" id="par_id3150201" xml-lang="en-US"> REM execute dialog</paragraph> +<paragraph role="bascode" id="par_id3154485" xml-lang="en-US" localize="false"> oDialog1.Execute()</paragraph> +<paragraph role="bascode" id="par_id3146115" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3145387" xml-lang="en-US" level="3">Add an Entry to a ListBox</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3155088" xml-lang="en-US" localize="false">Sub AddEntry</paragraph> +<paragraph role="bascode" id="par_id6715589" xml-lang="en-US" localize="false"> With GlobalScope.Basiclibraries</paragraph> +<paragraph role="bascode" id="par_id3148577" xml-lang="en-US" localize="false"> If Not .IsLibraryLoaded("Tools") Then .LoadLibrary("Tools")</paragraph> +<paragraph role="bascode" id="par_id5815589" xml-lang="en-US" localize="false"> End With</paragraph> +<paragraph role="bascode" id="par_id3159222" xml-lang="en-US" localize="false"> oDialog1 = ModuleControls.LoadDialog("Standard", "Dialog1")</paragraph> +<paragraph role="bascode" id="par_id3148700" xml-lang="en-US"> REM adds a new entry to the ListBox</paragraph> +<paragraph role="bascode" id="par_id3159173" xml-lang="en-US" localize="false"> oDialog1Model = oDialog1.Model</paragraph> +<paragraph role="bascode" id="par_id3153305" xml-lang="en-US" localize="false"> oListBox = oDialog1.GetControl("ListBox1")</paragraph> +<paragraph role="bascode" id="par_id3153914" xml-lang="en-US" localize="false"> Dim iCount as integer</paragraph> +<paragraph role="bascode" id="par_id3151243" xml-lang="en-US" localize="false"> iCount = oListbox.ItemCount</paragraph> +<paragraph role="bascode" id="par_id3144504" xml-lang="en-US"> oListbox.additem("New Item" & iCount,0)</paragraph> +<paragraph role="bascode" id="par_id3149328" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3147071" xml-lang="en-US" level="3">Remove an Entry from a ListBox</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3159095" xml-lang="en-US" localize="false">Sub RemoveEntry</paragraph> +<paragraph role="bascode" id="par_id6715590" xml-lang="en-US" localize="false"> With GlobalScope.Basiclibraries</paragraph> +<paragraph role="bascode" id="par_id3148578" xml-lang="en-US" localize="false"> If Not .IsLibraryLoaded("Tools") Then .LoadLibrary("Tools")</paragraph> +<paragraph role="bascode" id="par_id5815590" xml-lang="en-US" localize="false"> End With</paragraph> +<paragraph role="bascode" id="par_id3149443" xml-lang="en-US" localize="false"> oDialog1 = Tools.ModuleControls.LoadDialogLoadDialog("Standard", "Dialog1")</paragraph> +<paragraph role="bascode" id="par_id3153247" xml-lang="en-US"> REM remove the first entry from the ListBox</paragraph> +<paragraph role="bascode" id="par_id3151302" xml-lang="en-US" localize="false"> oDialog1Model = oDialog1.Model</paragraph> +<paragraph role="bascode" id="par_id3153976" xml-lang="en-US" localize="false"> oListBox = oDialog1.GetControl("ListBox1")</paragraph> +<paragraph role="bascode" id="par_id3155383" xml-lang="en-US" localize="false"> oListbox.removeitems(0,1)</paragraph> +<paragraph role="bascode" id="par_id3150892" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> +<embed href="text/sbasic/guide/control_properties.xhp#control_properties"/> +<embed href="text/sbasic/guide/create_dialog.xhp#create_dialog"/> +<embed href="text/sbasic/guide/insert_control.xhp#insert_control"/> +<embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/show_dialog.xhp b/helpcontent2/source/text/sbasic/guide/show_dialog.xhp new file mode 100644 index 000000000..117ff796c --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/show_dialog.xhp @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicguideshow_dialogxml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Opening a Dialog With Basic</title> +<filename>/text/sbasic/guide/show_dialog.xhp</filename> +</topic> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154140"> + <bookmark_value>module/dialog toggle</bookmark_value> + <bookmark_value>dialogs;using Basic to show (example)</bookmark_value> + <bookmark_value>examples; showing a dialog with Basic</bookmark_value> + <bookmark_value>Tools;LoadDialog</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3154140" xml-lang="en-US" level="1"><variable id="show_dialog"><link href="text/sbasic/guide/show_dialog.xhp" name="Opening a Dialog With Basic">Opening a Dialog With Basic</link> +</variable></paragraph> +<paragraph role="paragraph" id="par_id3145171" xml-lang="en-US">In the <item type="productname">%PRODUCTNAME</item> BASIC window for a dialog that you created, leave the dialog editor by clicking the name tab of the Module that the dialog is assigned to. The name tab is at the bottom of the window.</paragraph> +<paragraph role="paragraph" id="par_id3153968" xml-lang="en-US">Enter the following code for a subroutine called <emph>Dialog1Show</emph>. In this example, the name of the dialog that you created is "Dialog1":</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3156443" xml-lang="en-US" localize="false">Sub Dialog1Show</paragraph> +<paragraph role="bascode" id="par_id6715587" xml-lang="en-US" localize="false"> With GlobalScope.BasicLibraries</paragraph> +<paragraph role="bascode" id="par_id3148575" xml-lang="en-US" localize="false"> If Not .IsLibraryLoaded("Tools") Then .LoadLibrary("Tools")</paragraph> +<paragraph role="bascode" id="par_id5815587" xml-lang="en-US" localize="false"> End With</paragraph> +<paragraph role="bascode" id="par_id3152463" xml-lang="en-US" localize="false"> oDialog1 = Tools.ModuleControls.LoadDialog("Standard", "Dialog1")</paragraph> +<paragraph role="bascode" id="par_id3148646" xml-lang="en-US" localize="false"> oDialog1.Execute()</paragraph> +<paragraph role="bascode" id="par_id3147349" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3152596" xml-lang="en-US">Without using "LoadDialog" you can call the code as follows:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3163710" xml-lang="en-US" localize="false">Sub Dialog1Show</paragraph> +<paragraph role="bascode" id="par_id3146985" xml-lang="en-US" localize="false"> DialogLibraries.LoadLibrary("Standard")</paragraph> +<paragraph role="bascode" id="par_id3155418" xml-lang="en-US" localize="false"> oDialog1 = CreateUnoDialog( DialogLibraries.Standard.Dialog1 )</paragraph> +<paragraph role="bascode" id="par_id3154944" xml-lang="en-US" localize="false"> oDialog1.Execute()</paragraph> +<paragraph role="bascode" id="par_id3145800" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3153157" xml-lang="en-US">When you execute this code, "Dialog1" opens. To close the dialog, click the close button (x) on its title bar.</paragraph> +<section id="relatedtopics"> +<embed href="text/sbasic/guide/control_properties.xhp#control_properties"/> +<embed href="text/sbasic/guide/create_dialog.xhp#create_dialog"/> +<embed href="text/sbasic/guide/insert_control.xhp#insert_control"/> +<embed href="text/sbasic/python/python_dialogs.xhp#pythondialog"/> +<embed href="text/sbasic/guide/sample_code.xhp#sample_code"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/guide/translation.xhp b/helpcontent2/source/text/sbasic/guide/translation.xhp new file mode 100644 index 000000000..38608ddea --- /dev/null +++ b/helpcontent2/source/text/sbasic/guide/translation.xhp @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + + <helpdocument version="1.0"> +<meta> +<topic id="textsbasicguidetranslationxml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Translation of Controls in the Dialog Editor</title> +<filename>/text/sbasic/guide/translation.xhp</filename> +</topic> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id8915372"><bookmark_value>dialogs;translating</bookmark_value> +<bookmark_value>localizing dialogs</bookmark_value> +<bookmark_value>translating dialogs</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3574896" xml-lang="en-US" level="1"><variable id="translation"><link href="text/sbasic/guide/translation.xhp">Translation of Controls in the Dialog Editor</link> +</variable></paragraph> +<paragraph role="paragraph" id="par_id4601940" xml-lang="en-US">The Language toolbar in the Basic IDE dialog editor shows controls to enable and manage localizable dialogs.</paragraph> +<paragraph role="paragraph" id="par_id9538560" xml-lang="en-US">By default, any dialog that you create only contains string resources for one language. You may want to create dialogs that automatically show localized strings according to the user's language settings.</paragraph> +<bookmark xml-lang="en-US" branch="hid/.uno:CurrentLanguage" id="bm_id9421979" localize="false"/><paragraph role="paragraph" id="par_id6998809" xml-lang="en-US"><ahelp hid="." visibility="hidden">Select the language for the strings that you want to edit. Click the Manage Languages icon to add languages.</ahelp></paragraph><comment>Manage Language icon is in sbasic/shared/02/20000000.xhp</comment> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managelanguages/ManageLanguagesDialog" id="bm_id1646778" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managelanguages/@@nowidget@@" id="bm_id1646778" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managelanguages/treeview" id="bm_id16467781" localize="false"/><paragraph role="paragraph" id="par_id71413" xml-lang="en-US"><ahelp hid="." visibility="hidden">Click a language, then click Default to set the language as default, or click Delete to remove the language from the list.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managelanguages/add" id="bm_id1228370" localize="false"/><paragraph role="paragraph" id="par_id2924283" xml-lang="en-US"><ahelp hid="." visibility="hidden">Opens a dialog where you can add a language to the list.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managelanguages/delete" id="bm_id1601611" localize="false"/><paragraph role="paragraph" id="par_id5781731" xml-lang="en-US"><ahelp hid="." visibility="hidden">Select a language in the list and click Delete to remove that language. When you remove all languages, the string resources for localizable dialogs are removed from all dialogs in the current library.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managelanguages/default" id="bm_id733359" localize="false"/><paragraph role="paragraph" id="par_id6942045" xml-lang="en-US"><ahelp hid="." visibility="hidden">Select a language in the list and click Default to set the language as default language.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/defaultlanguage/DefaultLanguageDialog" id="bm_id879849" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/defaultlanguage/@@nowidget@@" id="bm_id879849" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/defaultlanguage/entries" id="bm_id879848" localize="false"/><paragraph role="paragraph" id="par_id4721823" xml-lang="en-US"><ahelp hid="." visibility="hidden">The default language will be used as a source for all other language strings.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/defaultlanguage/checkedentries" id="bm_id8675191" localize="false"/><paragraph role="paragraph" id="par_id5806756" xml-lang="en-US"><ahelp hid="." visibility="hidden">Add UI languages for your dialog strings.</ahelp></paragraph> +<paragraph role="heading" id="hd_id6596881" xml-lang="en-US" level="2">To enable localizable dialogs</paragraph> +<list type="ordered"> +<listitem> +<paragraph role="paragraph" id="par_id8750572" xml-lang="en-US">In the Basic IDE dialog editor, open the Language toolbar choosing <item type="menuitem">View - Toolbars - Language</item>. </paragraph> +<paragraph role="paragraph" id="par_id2224494" xml-lang="en-US">If the current library already contains a localizable dialog, the Language toolbar is shown automatically.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id7359233" xml-lang="en-US">Click the <emph>Manage Languages</emph> icon +<image id="img_id2526017" src="cmd/sc_managelanguage.png" width="0.1665inch" height="0.1665inch"><alt id="alt_id2526017" xml-lang="en-US">Manage Language icon</alt> + </image> on the Language toolbar or on the Toolbox bar.</paragraph> +<paragraph role="paragraph" id="par_id6549272" xml-lang="en-US">You see the Manage User Interface Language dialog. The dialog manages languages for the current library. The name of the current library is shown on the title bar.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id6529740" xml-lang="en-US">Click Add in the dialog to add a language entry. </paragraph> +<paragraph role="paragraph" id="par_id7811822" xml-lang="en-US">This step enables all new dialogs to contain localizable string resources.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id9121982" xml-lang="en-US">The first time you click Add, you see the Set Default User Interface Language dialog. The following times you click Add, this dialog has the name Add User Interface Language.</paragraph> +<paragraph role="paragraph" id="par_id3640247" xml-lang="en-US">You can also change the default language in the Manage User Interface Language dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id3808404" xml-lang="en-US">Select a language. </paragraph> +<paragraph role="paragraph" id="par_id4585100" xml-lang="en-US">This adds string resources to contain the translated versions of all strings to the dialog properties. The set of dialog strings of the default language is copied to the new set of strings. Later, you can switch to the new language and then translate the strings.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id2394482" xml-lang="en-US">Close the dialog or add additional languages.</paragraph> +</listitem> +</list> +<paragraph role="heading" id="hd_id631733" xml-lang="en-US" level="2">To edit localizable controls in your dialog</paragraph> +<paragraph role="paragraph" id="par_id2334665" xml-lang="en-US">Once you have added the resources for localizable strings in your dialogs, you can select the current language from the Current Language listbox on the Language toolbar.</paragraph> +<list type="ordered"> +<listitem> +<paragraph role="paragraph" id="par_id8956572" xml-lang="en-US">Switch the Current Language listbox to display the default language.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id500808" xml-lang="en-US">Insert any number of controls to your dialog and enter all strings you want.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id8366649" xml-lang="en-US">Select another language in the Current Language listbox.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id476393" xml-lang="en-US">Using the control's property dialogs, edit all strings to the other language.</paragraph> +</listitem> +<listitem> +<paragraph role="paragraph" id="par_id2655720" xml-lang="en-US">Repeat for all languages that you added.</paragraph> +</listitem> +</list> +<paragraph role="paragraph" id="par_id3682058" xml-lang="en-US">The user of your dialog will see the strings of the user interface language of the user's version of %PRODUCTNAME, if you did provide strings in that language. </paragraph> +<paragraph role="paragraph" id="par_id5977965" xml-lang="en-US">If no language matches the user's version, the user will see the default language strings. </paragraph> +<paragraph role="paragraph" id="par_id3050325" xml-lang="en-US">If the user has an older version of %PRODUCTNAME that does not know localizable string resources for Basic dialogs, the user will see the default language strings.</paragraph> +<section id="relatedtopics"> +<embed href="text/sbasic/guide/create_dialog.xhp#create_dialog"/> +<embed href="text/sbasic/guide/insert_control.xhp#insert_control"/> +<embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> +<embed href="text/sbasic/guide/sample_code.xhp#sample_code"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/main0000.xhp b/helpcontent2/source/text/sbasic/python/main0000.xhp new file mode 100644 index 000000000..e84d9b2d3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/main0000.xhp @@ -0,0 +1,45 @@ +<?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="pythonmain0000" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Python Scripts</title> + <filename>/text/sbasic/python/main0000.xhp</filename> + </topic> + </meta> + <body> + <bookmark xml-lang="en-US" branch="index" id="bm_id491543348147708"> + <bookmark_value>macros;Python scripts</bookmark_value> + <bookmark_value>Python;macros</bookmark_value> + <bookmark_value>scripts;Python</bookmark_value> + </bookmark> + <h1 id="hd_id3154232"><variable id="pythonscriptshelp"><link href="text/sbasic/python/main0000.xhp" name="mainpython">%PRODUCTNAME Python Scripts Help</link></variable></h1> + + <section id="pythonold"> + <paragraph id="par_id3153894" role="paragraph" xml-lang="en-US">%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></paragraph> + <paragraph id="par_id3147226" role="paragraph" xml-lang="en-US">This help section explains the most common Python script functions for %PRODUCTNAME. For more in-depth information please refer to the <link href="https://wiki.documentfoundation.org/Macros/Python_Design_Guide" name="wiki.documentfoundation.org PYTHON Guide">Designing & Developing Python Applications</link> on the Wiki.</paragraph> + </section> + <h2 id="hd_id3146957">Working with Python Scripts in %PRODUCTNAME</h2> + <paragraph role="paragraph" id="N0102">You can execute Python scripts choosing <menuitem>Tools - Macros - Run Macro</menuitem>. Editing scripts can be done with your preferred text editor. Python scripts are present in various locations detailed hereafter. You can refer to Programming examples for macros illustrating how to run the Python interactive console from %PRODUCTNAME.</paragraph> + <switch select="sys"> + <case select="UNIX"> + <warning id="par_id131568902936659">The %PRODUCTNAME scripting framework for Python is optional on some GNU/Linux distributions. If it is installed, selecting <menuitem>Tools - Macros - Run Macro</menuitem> and checking <literal>Application Macros</literal> for the presence of <literal>HelloWorld – HelloWorldPython</literal> macro is sufficient. If absent, please refer to your distribution documentation in order to install the %PRODUCTNAME scripting framework for Python.</warning> + </case> + </switch> + <embed href="text/shared/guide/scripting.xhp#scripting"/> + <embed href="text/sbasic/python/python_ide.xhp#pythonideh1"/> + <embed href="text/sbasic/python/python_locations.xhp#pythonlocations1"/> + <embed href="text/sbasic/python/python_shell.xhp#pythonshell1"/> + <embed href="text/sbasic/python/python_programming.xhp#pythonprogrammingheading"/> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + <embed href="text/sbasic/shared/03/sf_intro.xhp#title"/> + <embed href="text/swriter/main0000.xhp#helpabouthelp"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_2_basic.xhp b/helpcontent2/source/text/sbasic/python/python_2_basic.xhp new file mode 100644 index 000000000..0ce9f4417 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_2_basic.xhp @@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="UTF-8"?> + <!-- + * 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/. + * + --> +<helpdocument version="1.0"> + <meta> + <topic id="python_2_basic"> + <title id="tit" xml-lang="en-US">Python to Basic</title> + <filename>/text/sbasic/python/python_2_basic.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0330"> + <bookmark_value>Python;Calling Basic</bookmark_value> + <bookmark_value>ParamArray</bookmark_value> + </bookmark> + <h1 id="N0331"><variable id="py2ba_h1"><link href="text/sbasic/python/python_2_basic.xhp" name="Calling Basic macros from Python">Calling Basic Macros from Python</link></variable></h1> + <paragraph role="paragraph" id="N0332">You can call %PRODUCTNAME Basic macros from Python scripts, and notable features can be obtained in return such as:</paragraph> + <list type="unordered"> + <listitem><paragraph role="listitem" id="N0333">Simple logging facilities out of <literal>Access2Base</literal> library Trace console,</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0334"><literal>InputBox</literal> and <literal>MsgBox</literal> screen I/O functions based on Basic to ease Python development,</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0335"><literal>Xray</literal> calls interrupting Python script execution to help inspect variables.</paragraph></listitem> + </list> + <section id="APIScriptingFramework" > + <paragraph role="paragraph" id="N0336">The %PRODUCTNAME Application Programming Interface (API) Scripting Framework supports inter-language script execution between Python and Basic, or other supported programming languages for that matter. Arguments can be passed back and forth across calls, provided that they represent primitive data types that both languages recognize, and assuming that the Scripting Framework converts them appropriately.</paragraph> + </section> + <tip id="N0337">It is recommended to have knowledge of Python standard modules and %PRODUCTNAME API features prior to perform inter-language calls from Python to Basic, JavaScript or any other script engine.</tip> + <!-- WIP - Context clarifications needed in below warning --> + <warning id="N0338">When running Python scripts from an Integrated Development Environment (IDE), the %PRODUCTNAME-embedded Basic engine may be absent. Avoid Python-to-%PRODUCTNAME Basic calls in such contexts. However Python environment and Universal Networks Objects (UNO) are fully available. Refer to <link href="text/sbasic/python/python_ide.xhp" name ="Setting Up an Integrated IDE for Python">Setting Up an Integrated IDE for Python</link> for more information.</warning> + <h2 id="N0339">Retrieving %PRODUCTNAME Basic Scripts</h2> + <paragraph role="paragraph" id="N0340">%PRODUCTNAME Basic macros can be personal, shared, or embedded in documents. In order to execute them, Python run time needs to be provided with Basic macro locations. Implementing the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1script_1_1provider_1_1XScript.html" name ="XScriptProvider interface">com.sun.star.script.provider.XScriptProvider</link> interface allows the retrieval of executable scripts:</paragraph> + <section id="Python_getBasicScript" > + <bookmark branch="index" id="N0341"> + <bookmark_value>API;script.provider.MasterScriptProviderFactory: Retrieving Basic scripts</bookmark_value> + <bookmark_value>API;script.provider.XScript: Executing Basic scripts</bookmark_value> + <bookmark_value>API;XScriptProvider: Retrieving Basic scripts</bookmark_value> + </bookmark> + <pycode> + <paragraph role="pycode" id="N0342" localize="false">import uno</paragraph> + <paragraph role="pycode" id="N0343" localize="false">from com.sun.star.script.provider import Xscript</paragraph> + <paragraph role="pycode" id="N0344" localize="false"> </paragraph> + <paragraph role="pycode" id="N0345" localize="false">def getBasicScript(macro='Main', module='Module1', library='Standard',</paragraph> + <paragraph role="pycode" id="N0346" localize="false"> isEmbedded=False) -> XScript:</paragraph> + <paragraph role="pycode" id="N0347"> '''Grab Basic script object before invocation.'''</paragraph> + <paragraph role="pycode" id="N0348" localize="false"> ctx = uno.getComponentContext()</paragraph> + <paragraph role="pycode" id="N0349" localize="false"> smgr = ctx.ServiceManager</paragraph> + <paragraph role="pycode" id="N0350" localize="false"> if isEmbedded:</paragraph> + <paragraph role="pycode" id="N0351" localize="false"> desktop = smgr.createInstanceWithContext('com.sun.star.frame.Desktop', ctx)</paragraph> + <paragraph role="pycode" id="N0352" localize="false"> scriptPro = desktop.CurrentComponent.getScriptProvider()</paragraph> + <paragraph role="pycode" id="N0353" localize="false"> location = "document"</paragraph> + <paragraph role="pycode" id="N0354" localize="false"> else:</paragraph> + <paragraph role="pycode" id="N0355" localize="false"> mspf = smgr.createInstanceWithContext(</paragraph> + <paragraph role="pycode" id="N0356" localize="false"> "com.sun.star.script.provider.MasterScriptProviderFactory", ctx)</paragraph> + <paragraph role="pycode" id="N0357" localize="false"> scriptPro = mspf.createScriptProvider("")</paragraph> + <paragraph role="pycode" id="N0358" localize="false"> location = "application"</paragraph> + <paragraph role="pycode" id="N0359" localize="false"> scriptName = "vnd.sun.star.script:"+library+"."+module+"."+macro+ \</paragraph> + <paragraph role="pycode" id="N0360" localize="false"> "?language=Basic&location="+location</paragraph> + <paragraph role="pycode" id="N0361" localize="false"> xScript = scriptPro.getScript(scriptName)</paragraph> + <paragraph role="pycode" id="N0362" localize="false"> return xScript</paragraph> + </pycode> + </section> + <h2 id="N0363">Executing %PRODUCTNAME Basic Scripts</h2> + <section id="APIScriptingFramework_XScript" > + <bookmark branch="index" id="N0364ndx"> + <bookmark_value>API;script.provider.XScript : Executing Basic scripts</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="N0364">The %PRODUCTNAME Software Development Kit (SDK) documentation for <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1script_1_1provider_1_1XScript.html#a11a551f5a2520f74c5109cd8c9f8c7b7" name ="XScript interface">com.sun.star.script.provider.XScript</link> interface details the calling convention for inter-language calls. Invocation of functions requires three arrays:</paragraph> + <list type="unordered"> + <listitem><paragraph role="listitem" id="N0365">the first lists the arguments of the called routine</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0366">the second identifies modified arguments</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0367">the third stores the return values</paragraph></listitem> + </list> + </section> + <h3 id="N0368">Python Syntax</h3> + <paragraph role="paragraph" localize="false" id="N0369"><input>results = script.invoke((prompt,buttons,title), (), ())</input></paragraph> + <paragraph role="paragraph" localize="false" id="N0370"><input>script.invoke((message,), tuple, ())</input></paragraph> + <paragraph role="paragraph" localize="false" id="N0371"><input>script.invoke((args), (), results)</input></paragraph> + <h3 id="N0372">Examples of Personal or Shared Scripts</h3> + <paragraph role="paragraph" id="N0373">Examples in <link href="text/sbasic/python/python_screen.xhp" name ="Input/Output to Screen">Input/Output to Screen</link> detail Python to Basic invocation calls. <link href="text/sbasic/python/python_document_events.xhp" name ="Monitoring Document Events">Monitoring Document Events</link> illustrates the usage of *args Python idiom to print a variable number of parameters to <literal>Access2Base</literal> logging console dialog.</paragraph> + <tip id="N0374">At time of development you can interrupt Python script execution using <link href="https://berma.pagesperso-orange.fr/index2.html" name ="Xray extension">Xray extension</link> in order to inspect properties and methods of UNO objects. The APSO extension debugger allows object introspection using either Xray either MRI extensions.</tip> + <pycode> + <paragraph role="pycode" id="N0375" localize="false">def xray(myObject):</paragraph> + <paragraph role="pycode" id="N0376" localize="false"> script = getBasicScript(library="XrayTool", module="_Main", macro="Xray")</paragraph> + <paragraph role="pycode" id="N0377" localize="false"> script.invoke((myObject,), (), ())</paragraph> + </pycode> + <h3 id="N0378">Examples of Embedded Scripts in Documents</h3> + <paragraph role="paragraph" id="N0379"><literal>*args</literal>Python simplified syntax can be used in conjunction with %PRODUCTNAME Basic routines that accept a variable number of arguments. Below <literal>Print</literal> and <literal>SUM</literal> Python functions call their Basic <literal>Print</literal> and <literal>SUM</literal> counterparts, using aforementioned <literal>getBasicScript</literal> function. Exception handling is not detailed.</paragraph> + <pycode> + <paragraph role="pycode" id="N0380" localize="false"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" id="N0381" localize="false">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" id="N0382" localize="false"> </paragraph> + <paragraph role="pycode" id="N0383" localize="false">def Print(*args):</paragraph> + <paragraph role="pycode" id="N0384"> """Outputs the specified strings or numeric expressions in a dialog box."""</paragraph> + <paragraph role="pycode" id="N0385" localize="false"> xScript = getBasicScript("Print", "Scripting", embedded=True)</paragraph> + <paragraph role="pycode" id="N0386" localize="false"> xScript.invoke((args), (), ())</paragraph> + <paragraph role="pycode" id="N0387" localize="false"> </paragraph> + <paragraph role="pycode" id="N0388" localize="false">def SUM(*args):</paragraph> + <paragraph role="pycode" id="N0389"> """SUM the specified number expression."""</paragraph> + <paragraph role="pycode" id="N0390" localize="false"> xScript = getBasicScript("SUM", "Scripting", embedded=True)</paragraph> + <paragraph role="pycode" id="N0391" localize="false"> res = xScript.invoke((args), (), ())</paragraph> + <paragraph role="pycode" id="N0392" localize="false"> return res[0]</paragraph> + <paragraph role="pycode" id="N0393" localize="false"> </paragraph> + <paragraph role="pycode" id="N0394" localize="false"># def getBasicScript() # see above</paragraph> + <paragraph role="pycode" id="N0395" localize="false"> </paragraph> + <paragraph role="pycode" id="N0396" localize="false">def playWithArgs():</paragraph> + <paragraph role="pycode" id="N0397" localize="false"> Print("Fun with *args ", -9.81, 297864.681974, 8762E-137)</paragraph> + <paragraph role="pycode" id="N0398" localize="false"> Print(SUM(45, -9.81, 297864.681974))</paragraph> + <paragraph role="pycode" id="N0399" localize="false"> Print(SUM(45, -9.81, 297864.681974, 8762E+137))</paragraph> + <paragraph role="pycode" id="N0400" localize="false"> </paragraph> + <paragraph role="pycode" id="N0401" localize="false">g_exportedScripts = (playWithArgs,)</paragraph> + </pycode> + <paragraph role="paragraph" id="N0402">The %PRODUCTNAME Basic <literal>Print</literal> and <literal>SUM</literal> document-based routines accept a variable number of arguments. The <literal>Private</literal> or <literal>Public</literal> attributes have no effect. The arguments type checking is skipped for clarity.</paragraph> + <bascode> + <paragraph role="bascode" id="N0403" localize="false">Option Compatible ' "Standard.Scripting" module</paragraph> + <paragraph role="bascode" id="N0404" localize="false">Option Explicit</paragraph> + <paragraph role="bascode" id="N0405" localize="false"> </paragraph> + <paragraph role="bascode" id="N0406" localize="false">Private Sub Print(ParamArray args() As Variant, Optional sep As String = " ")</paragraph> + <paragraph role="bascode" id="N0407"> ''' Print item list of variable number '''</paragraph> + <paragraph role="bascode" id="N0408"> ' all CStr() convertible args are accepted</paragraph> + <paragraph role="bascode" id="N0409" localize="false"> Dim str As String, i As Integer</paragraph> + <paragraph role="bascode" id="N0410" localize="false"> If UBound(args) >= 0 Then</paragraph> + <paragraph role="bascode" id="N0411" localize="false"> For i = 0 To UBound(args)</paragraph> + <paragraph role="bascode" id="N0412" localize="false"> str = str + Cstr(args(i))+ sep </paragraph> + <paragraph role="bascode" id="N0413" localize="false"> Next i</paragraph> + <paragraph role="bascode" id="N0414" localize="false"> End If</paragraph> + <paragraph role="bascode" id="N0415" localize="false"> Print str</paragraph> + <paragraph role="bascode" id="N0416" localize="false">End Sub ' Standard.Scripting.Print()</paragraph> + <paragraph role="bascode" id="N0417" localize="false"> </paragraph> + <paragraph role="bascode" id="N0418" localize="false">Public Function SUM(ParamArray args() As Variant) As Variant</paragraph> + <paragraph role="bascode" id="N0419"> ''' SUM a variable list of numbers '''</paragraph> + <paragraph role="bascode" id="N0420" localize="false"> Dim ndx As Integer</paragraph> + <paragraph role="bascode" id="N0421" localize="false"> If UBound(args) >= 0 Then</paragraph> + <paragraph role="bascode" id="N0422" localize="false"> For ndx = 0 To UBound(args)</paragraph> + <paragraph role="bascode" id="N0423" localize="false"> SUM = SUM + args(ndx)</paragraph> + <paragraph role="bascode" id="N0424" localize="false"> Next ndx</paragraph> + <paragraph role="bascode" id="N0425" localize="false"> End If</paragraph> + <paragraph role="bascode" id="N0426" localize="false">End Function ' Standard.Scripting.SUM()</paragraph> + </bascode> + <section id="relatedtopics" > + <embed href="text/sbasic/guide/basic_2_python.xhp#basic2python"/> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + <embed href="text/sbasic/shared/main0601.xhp#mainsbasic"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_dialogs.xhp b/helpcontent2/source/text/sbasic/python/python_dialogs.xhp new file mode 100644 index 000000000..ee6c6ee0f --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_dialogs.xhp @@ -0,0 +1,75 @@ +<?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="text/sbasic/python/Python_Dialog"> + <title id="tit" xml-lang="en-US">Opening a Dialog with Python</title> + <filename>/text/sbasic/python/python_dialogs.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0334"> + <bookmark_value>Python;dialogs</bookmark_value> + <bookmark_value>dialog box;Python</bookmark_value> + <bookmark_value>dialogs;Python</bookmark_value> + </bookmark> + <section id="pythondialog1"> + <h1 id="N0336"><variable id="pythondialog"><link href="text/sbasic/python/python_dialogs.xhp" name="command_name">Opening a Dialog with Python</link></variable></h1> + </section> + <paragraph role="paragraph" id="N0337">%PRODUCTNAME static dialogs are created with the <link href="text/sbasic/guide/create_dialog.xhp" name="dialog editor">Dialog editor</link> and are stored in varying places according to their personal (My Macros), shared (Application Macros) or document-embedded nature. In reverse, dynamic dialogs are constructed at runtime, from Basic or Python scripts, or using any other <link href="text/shared/guide/scripting.xhp">%PRODUCTNAME supported language</link> for that matter. Opening static dialogs with Python is illustrated herewith. Exception handling and internationalization are omitted for clarity.</paragraph> + <h2 id="N0338">My Macros or Application Macros dialogs</h2> + <paragraph role="paragraph" id="N0339">The examples below open <literal>Access2Base Trace</literal> console or the imported <literal>TutorialsDialog</literal> dialog with <menuitem>Tools - Macros - Run Macro</menuitem> menu:</paragraph> + <pycode> + <paragraph role="pycode" id="N0340" localize="false"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" id="N0341" localize="false">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" id="N0342" localize="false"> </paragraph> + <paragraph role="pycode" id="N0343" localize="false">def consoleDlg():</paragraph> + <paragraph role="pycode" id="N0344" localize="false"> ctx =XSCRIPTCONTEXT.getComponentContext()</paragraph> + <paragraph role="pycode" id="N0345" localize="false"> smgr = ctx.getServiceManager()</paragraph> + <paragraph role="pycode" id="N0346" localize="false"> dp = smgr.createInstanceWithContext("com.sun.star.awt.DialogProvider", ctx)</paragraph> + <paragraph role="pycode" id="N0348" localize="false"> dlg = dp.createDialog( "vnd.sun.star.script:Access2Base.dlgTrace?location=application")</paragraph> + <paragraph role="pycode" id="N0350" localize="false"> dlg.execute()</paragraph> + <paragraph role="pycode" id="N0351" localize="false"> dlg.dispose()</paragraph> + <paragraph role="pycode" id="N0352" localize="false"> </paragraph> + <paragraph role="pycode" id="N0353" localize="false">def tutorDialog():</paragraph> + <paragraph role="pycode" id="N0354" localize="false"> ctx =XSCRIPTCONTEXT.getComponentContext()</paragraph> + <paragraph role="pycode" id="N0355" localize="false"> smgr = ctx.getServiceManager()</paragraph> + <paragraph role="pycode" id="N0356" localize="false"> dp = smgr.createInstanceWithContext("com.sun.star.awt.DialogProvider", ctx)</paragraph> + <paragraph role="pycode" id="N0358" localize="false"> dlg = dp.createDialog("vnd.sun.star.script:Standard.TutorialsDialog?location=application")</paragraph> + <paragraph role="pycode" id="N0360" localize="false"> dlg.execute()</paragraph> + <paragraph role="pycode" id="N0361" localize="false"> dlg.dispose()</paragraph> + <paragraph role="pycode" id="N0362" localize="false"> </paragraph> + <paragraph role="pycode" id="N0363" localize="false">g_exportedScripts = (consoleDlg, tutorDialog)</paragraph> + </pycode> + <h2 id="N0364">Document embedded dialogs</h2> + <paragraph role="paragraph" id="N0365">The example below opens a newly edited <literal>Dialog1</literal> dialog from a document with <menuitem>Tools - Macros - Run Macro</menuitem> menu:</paragraph> + <pycode> + <paragraph role="pycode" id="N0366" localize="false"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" id="N0367" localize="false">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" id="N0368" localize="false"> </paragraph> + <paragraph role="pycode" id="N0369" localize="false">def docDialog():</paragraph> + <paragraph role="pycode" id="N0370"> """ Display a doc-based dialog """</paragraph> + <paragraph role="pycode" id="N0371" localize="false"> model = XSCRIPTCONTEXT.getDocument()</paragraph> + <paragraph role="pycode" id="N0372" localize="false"> smgr = XSCRIPTCONTEXT.getComponentContext().ServiceManager</paragraph> + <paragraph role="pycode" id="N0373" localize="false"> dp = smgr.createInstanceWithArguments( "com.sun.star.awt.DialogProvider", (model,))</paragraph> + <paragraph role="pycode" id="N0375" localize="false"> dlg = dp.createDialog( "vnd.sun.star.script:Standard.Dialog1?location=document")</paragraph> + <paragraph role="pycode" id="N0377" localize="false"> dlg.execute()</paragraph> + <paragraph role="pycode" id="N0378" localize="false"> dlg.dispose()</paragraph> + <paragraph role="pycode" id="N0379" localize="false"> </paragraph> + <paragraph role="pycode" id="N0380" localize="false">g_exportedScripts = (docDialog,)</paragraph> + </pycode> + <paragraph role="paragraph" id="N0381">Refer to <literal>msgbox.py</literal> in <literal>{installation}/program/</literal> directory for Python dynamic dialog examples.</paragraph> + <section id="relatedtopics" > + <embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_document_events.xhp b/helpcontent2/source/text/sbasic/python/python_document_events.xhp new file mode 100644 index 000000000..814047b1b --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_document_events.xhp @@ -0,0 +1,293 @@ +<?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="text/sbasic/python/python_document_events"> + <title id="tit" xml-lang="en-US">Monitoring Document Events</title> + <filename>/text/sbasic/python/python_document_events.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0526"> + <bookmark_value>Basic;Monitoring Document Events</bookmark_value> + <bookmark_value>Python;Monitoring Document Events</bookmark_value> + <bookmark_value>Access2Base;Console</bookmark_value> + <bookmark_value>Access2Base;Trace</bookmark_value> + <bookmark_value>API;document.DocumentEvent: Monitoring Document Event</bookmark_value> + <bookmark_value>API;document.XDocumentEventBroadcaster: Monitoring Document Event</bookmark_value> + <bookmark_value>API;document.XDocumentEventListener: Monitoring Document Event</bookmark_value> + <bookmark_value>API;lang.EventObject: Monitoring Document Event</bookmark_value> + </bookmark> + <section id="pythonmonitor1"> + <h1 id="N0527"><variable id="pythonmonitor"><link href="text/sbasic/python/python_document_events.xhp" name="Monitoring Document Events">Listening to Document Events</link></variable></h1> + <paragraph role="paragraph" id="par_id641630582314861">Listening to document events can help in the following situations:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id431630582396327" role="listitem">Identify a new document at opening time, as opposed to existing ones, and perform a dedicated setup.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id461630582396782" role="listitem">Control the processing of document save, document copy, print or mailmerge requests.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id631630582394790" role="listitem">Recalculate table of contents, indexes or table entries of a Writer document when document is going to be closed</paragraph> + </listitem> + <listitem> + <paragraph id="par_id601630582398998" role="listitem">Import math Python packages before opening a Calc document. Release these packages when the document closes.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="N0528">Next to <link href="text/sbasic/shared/01040000.xhp" name ="assigning macros to events">assigning macros to events</link>, one can monitor events raised by %PRODUCTNAME documents. Application Programming Interface (API) broadcasters are responsible for calling event scripts. Unlike listeners that require to define all supported methods, even if unused, document monitors require only two methods next to hooked event scripts.</paragraph> + </section> + <h2 id="N0529">Monitoring Document Events</h2> + <paragraph role="paragraph" id="N0530">Monitoring is illustrated herewith for Basic and Python languages using object-oriented programming. Assigning <literal>OnLoad</literal> script, to the <menuitem>Open Document</menuitem> event, suffices to initiate and terminate document event monitoring. <menuitem>Tools - Customize</menuitem> menu <menuitem>Events</menuitem> tab is used to assign either scripts.</paragraph> + <paragraph role="paragraph" id="N0531">Intercepting events helps setting scripts pre- and post-conditions such as loading and unloading libraries or track script processing in the background. <literal>Access2Base.Trace</literal> module usage is illustrating that second context.</paragraph> + <h3 id="N0532">With Python</h3> + <bookmark xml-lang="en-US" branch="index" id="bm_id721622446590963"> + <bookmark_value>API;frame.Desktop: Monitoring Document Event</bookmark_value> + <bookmark_value>API;script.provider.MasterScriptProviderFactory: Monitoring Document Event</bookmark_value> + <bookmark_value>API;script.provider.XScript: Monitoring Document Event</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="N0533">Events monitoring starts from object instantiation and ultimately stops when Python releases the object. Raised events are reported using <literal>Access2Base</literal> console.</paragraph> + <note id="N0534"><literal>OnLoad</literal> and <literal>OnUnload</literal> events can be used to respectively set and unset Python programs path. They are described as <menuitem>Open document</menuitem> and <menuitem>Document closed</menuitem>.</note> + <pycode> + <paragraph role="pycode" localize="false" id="N0535"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0536">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0537"> </paragraph> + <paragraph role="pycode" localize="false" id="N0538">import os.path, uno, unohelper</paragraph> + <paragraph role="pycode" localize="false" id="N0539">from com.sun.star.document import DocumentEvent, \</paragraph> + <paragraph role="pycode" localize="false" id="N0540"> XDocumentEventListener as AdapterPattern</paragraph> + <paragraph role="pycode" localize="false" id="N0541">from com.sun.star.lang import EventObject</paragraph> + <paragraph role="pycode" localize="false" id="N0542"> </paragraph> + <paragraph role="pycode" localize="false" id="N0543">class UiDocument(unohelper.Base, AdapterPattern):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0544"> """ Monitor document events """</paragraph> + <paragraph role="pycode" localize="false" id="N0545"> '''</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0546"> adapted from 'Python script to monitor OnSave event' at</paragraph> + <paragraph role="pycode" localize="false" id="N0547"> https://forum.openoffice.org/en/forum/viewtopic.php?t=68887</paragraph> + <paragraph role="pycode" localize="false" id="N0548"> '''</paragraph> + <paragraph role="pycode" localize="false" id="N0549"> def __init__(self):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0550"> """ Document events monitor """</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0551"> ''' report using Access2Base.Trace console OR</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0552"> report in 1st sheet, 1st column for Calc docs '''</paragraph> + <paragraph role="pycode" localize="false" id="N0553"> ctx = uno.getComponentContext()</paragraph> + <paragraph role="pycode" localize="false" id="N0554"> smgr = ctx.getServiceManager()</paragraph> + <paragraph role="pycode" localize="false" id="N0555"> desktop = smgr.createInstanceWithContext(</paragraph> + <paragraph role="pycode" localize="false" id="N0556"> 'com.sun.star.frame.Desktop' , ctx)</paragraph> + <paragraph role="pycode" localize="false" id="N0557"> self.doc = desktop.CurrentComponent</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0558"> #self.row = 0 # uncomment for Calc documents only</paragraph> + <paragraph role="pycode" localize="false" id="N0559"> Console.setLevel("DEBUG")</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0560"> self.listen() # Start monitoring doc. events</paragraph> + <paragraph role="pycode" localize="false" id="N0562"> </paragraph> + <paragraph role="pycode" localize="false" id="N0563"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0564"> def Filename(self) -> str:</paragraph> + <paragraph role="pycode" localize="false" id="N0565"> sys_filename = uno.fileUrlToSystemPath(self.doc.URL)</paragraph> + <paragraph role="pycode" localize="false" id="N0566"> return os.path.basename(sys_filename)</paragraph> + <paragraph role="pycode" localize="false" id="N0567"> </paragraph> + <paragraph role="pycode" localize="false" id="N0568"> def setCell(self, calcDoc, txt: str):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0569"> """ Output doc. events on 1st column of a Calc spreadsheet """</paragraph> + <paragraph role="pycode" localize="false" id="N0570"> sheet = calcDoc.getSheets().getByIndex(0)</paragraph> + <paragraph role="pycode" localize="false" id="N0571"> sheet.getCellByPosition(0,self.row).setString(txt)</paragraph> + <paragraph role="pycode" localize="false" id="N0572"> self.row = self.row + 1</paragraph> + <paragraph role="pycode" localize="false" id="N0574"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0575"> def listen(self, *args): # OnLoad/OnNew at the earliest</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0576"> """ Start doc. events monitoring """</paragraph> + <paragraph role="pycode" localize="false" id="N0577"> self.doc.addDocumentEventListener(self)</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0578"> Console.log("INFO", "Document events are being logged", True)</paragraph> + <paragraph role="pycode" localize="false" id="N0579"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0580"> def sleep(self, *args): # OnUnload at the latest (optional)</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0581"> """ Stop doc. events monitoring """</paragraph> + <paragraph role="pycode" localize="false" id="N0582"> self.doc.removeDocumentEventListener(self)</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0583"> Console.log("INFO", "Document events have been logged", True)</paragraph> + <paragraph role="pycode" localize="false" id="N0585"> </paragraph> + <paragraph role="pycode" localize="false" id="N0586"> def documentEventOccured(self, event: DocumentEvent):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0587"> """ Intercepts all doc. events """</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0588"> #self.setCell(event.Source, event.EventName) # only for Calc docs</paragraph> + <paragraph role="pycode" localize="false" id="N0589"> Console.log("DEBUG",</paragraph> + <paragraph role="pycode" localize="false" id="N0590"> event.EventName+" in "+self.Filename,</paragraph> + <paragraph role="pycode" localize="false" id="N0591"> False)</paragraph> + <paragraph role="pycode" localize="false" id="N0593"> </paragraph> + <paragraph role="pycode" localize="false" id="N0594"> def disposing(self, event: EventObject):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0595"> """ Release all activities """</paragraph> + <paragraph role="pycode" localize="false" id="N0596"> self.sleep()</paragraph> + <paragraph role="pycode" localize="false" id="N0597"> Console.show()</paragraph> + <paragraph role="pycode" localize="false" id="N0599"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0601">def OnLoad(*args): # 'Open Document' event</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0602"> listener = UiDocument() # Initiates listening</paragraph> + <paragraph role="pycode" localize="false" id="N0603"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0604">def OnUnload(*args): # 'Document has been closed' event</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0605"> pass # (optional) performed when disposed</paragraph> + <paragraph role="pycode" localize="false" id="N0606"> </paragraph> + <paragraph role="pycode" localize="false" id="N0607">g_exportedScripts = (OnLoad,)</paragraph> + <paragraph role="pycode" localize="false" id="N0609"> </paragraph> + <paragraph role="pycode" localize="false" id="N0610">from com.sun.star.script.provider import XScript</paragraph> + <paragraph role="pycode" localize="false" id="N0611">class Console():</paragraph> + <paragraph role="pycode" localize="false" id="N0612"> """</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0613"> (Back/Fore)ground console to report/log program execution.</paragraph> + <paragraph role="pycode" localize="false" id="N0614"> """</paragraph> + <paragraph role="pycode" localize="false" id="N0615"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0616"> def trace(*args,**kwargs):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0617"> """ Print free item list to console """</paragraph> + <paragraph role="pycode" localize="false" id="N0618"> scr = Console._a2bScript(script='DebugPrint', module='Compatible')</paragraph> + <paragraph role="pycode" localize="false" id="N0619"> scr.invoke((args),(),())</paragraph> + <paragraph role="pycode" localize="false" id="N0620"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0621"> def log(level: str, text: str, msgBox=False):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0622"> """ Append log message to console, optional user prompt """</paragraph> + <paragraph role="pycode" localize="false" id="N0623"> scr = Console._a2bScript(script='TraceLog')</paragraph> + <paragraph role="pycode" localize="false" id="N0624"> scr.invoke((level,text,msgBox),(),())</paragraph> + <paragraph role="pycode" localize="false" id="N0625"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0626"> def setLevel(logLevel: str):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0627"> """ Set log messages lower limit """</paragraph> + <paragraph role="pycode" localize="false" id="N0628"> scr = Console._a2bScript(script='TraceLevel')</paragraph> + <paragraph role="pycode" localize="false" id="N0629"> scr.invoke((logLevel,),(),())</paragraph> + <paragraph role="pycode" localize="false" id="N0630"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0631"> def show():</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0632"> """ Display console content/dialog """</paragraph> + <paragraph role="pycode" localize="false" id="N0633"> scr = Console._a2bScript(script='TraceConsole')</paragraph> + <paragraph role="pycode" localize="false" id="N0634"> scr.invoke((),(),())</paragraph> + <paragraph role="pycode" localize="false" id="N0635"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0636"> def _a2bScript(script: str, library='Access2Base',</paragraph> + <paragraph role="pycode" localize="false" id="N0637"> module='Trace') -> XScript:</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0638"> ''' Grab application-based Basic script '''</paragraph> + <paragraph role="pycode" localize="false" id="N0639"> sm = uno.getComponentContext().ServiceManager</paragraph> + <paragraph role="pycode" localize="false" id="N0640"> mspf = sm.createInstanceWithContext(</paragraph> + <paragraph role="pycode" localize="false" id="N0641"> "com.sun.star.script.provider.MasterScriptProviderFactory",</paragraph> + <paragraph role="pycode" localize="false" id="N0642"> uno.getComponentContext())</paragraph> + <paragraph role="pycode" localize="false" id="N0643"> scriptPro = mspf.createScriptProvider("")</paragraph> + <paragraph role="pycode" localize="false" id="N0644"> scriptName = "vnd.sun.star.script:"+library+"."+module+"."+script+"?language=Basic&location=application"</paragraph> + <paragraph role="pycode" localize="false" id="N0645"> xScript = scriptPro.getScript(scriptName)</paragraph> + <paragraph role="pycode" localize="false" id="N0646"> return xScript</paragraph> + </pycode> + <warning id="N0647">Mind the misspelled <literal>documentEventOccured</literal> method that inherits a typo from %PRODUCTNAME Application Programming Interface (API).</warning> + <paragraph role="tip" id="N0648"><menuitem>Start application</menuitem> and <menuitem>Close application</menuitem> events can respectively be used to set and to unset Python path for user scripts or %PRODUCTNAME scripts. In a similar fashion, document based Python libraries or modules can be loaded and released using <menuitem>Open document</menuitem> and <menuitem>Document closed</menuitem> events. Refer to <link href="text/sbasic/python/python_import.xhp" name ="Importing Python Modules">Importing Python Modules</link> for more information.</paragraph> + <h3 id="N0649">With %PRODUCTNAME Basic</h3> + <bookmark xml-lang="en-US" branch="index" id="bm_id591622446367707"> + <bookmark_value>API;GlobalScope.BasicLibraries</bookmark_value> + <bookmark_value>Tools;Strings</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="N0650">Using <menuitem>Tools - Customize</menuitem> menu <menuitem>Events</menuitem> tab, the <menuitem>Open document</menuitem> event fires a <literal>ConsoleLogger</literal> initialisation. <literal>_documentEventOccured</literal> routine - set by <literal>ConsoleLogger</literal> - serves as a unique entry point to trap all document events.</paragraph> + <h4 id="hd_id421630510141729">controller.Events module</h4> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id591630567376295">Option Explicit</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101630567377583"></paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id431630567378062">Global _obj As Object ' controller.ConsoleLogger instance</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971630567378798"></paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0655">Sub OnLoad(evt As com.sun.star.document.DocumentEvent) ' >> Open Document <<</paragraph> + <paragraph role="bascode" localize="false" id="N0656"> _obj = New ConsoleLogger : _obj.StartAdapter(evt)</paragraph> + <paragraph role="bascode" localize="false" id="N0657">End Sub ' controller.OnLoad</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201630509594858">Sub _documentEventOccured(evt As com.sun.star.document.DocumentEvent)</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id371630509596674"> ''' ConsoleLogger unique entry point '''</paragraph> + <paragraph role="bascode" localize="false" id="bas_id551630509597227"> _obj.DocumentEventOccurs(evt)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id511630509597425">End Sub ' controller._documentEventOccured</paragraph> + </bascode> + <h4 id="hd_id721630511986813">controller.ConsoleLogger class module</h4> + <paragraph role="paragraph" id="par_id901630509435225">Events monitoring starts from the moment a <literal>ConsoleLogger</literal> object is instantiated and ultimately stops upon document closure. <literal>StartAdapter</literal> routine loads necessary Basic libraries, while caught events are reported using <literal>Access2Base.Trace</literal> module.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="N0660">Option Explicit</paragraph> + <paragraph role="bascode" localize="false" id="N0661">Option Compatible</paragraph> + <paragraph role="bascode" localize="false" id="N0662">Option ClassModule</paragraph> + <paragraph role="bascode" localize="false" id="N0663"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0664">' ADAPTER design pattern object to be instantiated in the "Open Document" event</paragraph> + <paragraph role="bascode" localize="false" id="N0665">Private Const UI_PROMPT = True</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0666">Private Const UI_NOPROMPT = False ' Set it to True to visualise documents events</paragraph> + <paragraph role="bascode" localize="false" id="N0667"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0674">' MEMBERS</paragraph> + <paragraph role="bascode" localize="false" id="N0675">Private _evtAdapter As Object ' com.sun.star.document.XDocumentEventBroadcaster</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id131630510956418">Private _txtMsg As String ' text message to log in console</paragraph> + <paragraph role="bascode" localize="false" id="N0676"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0677">' PROPERTIES</paragraph> + <paragraph role="bascode" localize="false" id="N0678">Private Property Get FileName As String</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0679"> ''' System-dependent filename '''</paragraph> + <paragraph role="bascode" localize="false" id="N0680"> Const _LIBRARY = "Tools" : With GlobalScope.BasicLibraries</paragraph> + <paragraph role="bascode" localize="false" id="N0681"> If Not .IsLibraryLoaded(_LIBRARY) Then .LoadLibrary(_LIBRARY)</paragraph> + <paragraph role="bascode" localize="false" id="N0682"> End With</paragraph> + <paragraph role="bascode" localize="false" id="N0683"> Filename = Tools.Strings.FilenameOutofPath(ThisComponent.URL)</paragraph> + <paragraph role="bascode" localize="false" id="N0684">End Property ' controller.ConsoleLogger.Filename</paragraph> + <paragraph role="bascode" localize="false" id="N0685"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0686">' METHODS</paragraph> + <paragraph role="bascode" localize="false" id="N0687">Public Sub DocumentEventOccurs(evt As com.sun.star.document.DocumentEvent)</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0688"> ''' Monitor document events '''</paragraph> + <paragraph role="bascode" localize="false" id="N0689"> Access2Base.Trace.TraceLog("DEBUG", _</paragraph> + <paragraph role="bascode" localize="false" id="N0690"> evt.EventName &" in "& Filename(evt.Source.URL), _</paragraph> + <paragraph role="bascode" localize="false" id="N0691"> UI_NOPROMPT)</paragraph> + <paragraph role="bascode" localize="false" id="N0692"> Select Case evt.EventName</paragraph> + <paragraph role="bascode" localize="false" id="N0693"> Case "OnUnload" : _StopAdapter(evt)</paragraph> + <paragraph role="bascode" localize="false" id="N0694"> End Select</paragraph> + <paragraph role="bascode" localize="false" id="N0695">End Sub ' controller.ConsoleLogger.DocumentEventOccurs</paragraph> + <paragraph role="bascode" localize="false" id="N0696"> </paragraph> + <paragraph role="bascode" localize="false" id="N0700">Public Sub StartAdapter(Optional evt As com.sun.star.document.DocumentEvent)</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0701"> ''' Initialize document events logging '''</paragraph> + <paragraph role="bascode" localize="false" id="N0702"> Const _LIBRARY = "Access2Base" : With GlobalScope.BasicLibraries</paragraph> + <paragraph role="bascode" localize="false" id="N0703"> If Not .IsLibraryLoaded(_LIBRARY) Then .LoadLibrary(_LIBRARY)</paragraph> + <paragraph role="bascode" localize="false" id="N0704"> End With : Access2Base.Trace.TraceLevel("DEBUG")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211630511166427"> If IsMissing(evt) Then _txtMsg = "" Else _txtMsg = evt.EventName & "-"</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0705"> Access2Base.Trace.TraceLog("INFO", _txtMsg & "Document events are being logged", UI_PROMPT)</paragraph> + <paragraph role="bascode" localize="false" id="N0709"> _evtAdapter = CreateUnoListener( "_", "com.sun.star.document.XDocumentEventListener" )</paragraph> + <paragraph role="bascode" localize="false" id="N0710"> ThisComponent.addDocumentEventListener( _evtAdapter )</paragraph> + <paragraph role="bascode" localize="false" id="N0711">End Sub ' controller.ConsoleLogger.StartAdapter</paragraph> + <paragraph role="bascode" localize="false" id="N0712"> </paragraph> + <paragraph role="bascode" localize="false" id="N0713">Private Sub _StopAdapter(Optional evt As com.sun.star.document.DocumentEvent)</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0714"> ''' Terminate document events logging '''</paragraph> + <paragraph role="bascode" localize="false" id="N0715"> ThisComponent.removeDocumentEventListener( _evtAdapter )</paragraph> + <paragraph role="bascode" localize="false" id="N0716"> If IsMissing(evt) Then _txtMsg = "" Else _txtMsg = evt.EventName & "-"</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0717"> Access2Base.Trace.TraceLog("INFO", _txtMsg & "Document events have been logged", UI_PROMPT)</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0719"> Access2Base.Trace.TraceConsole() ' Captured events dialog</paragraph> + <paragraph role="bascode" localize="false" id="N0720">End Sub ' controller.ConsoleLogger._StopAdapter</paragraph> + <paragraph role="bascode" localize="false" id="N0721"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0722">' EVENTS</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0723">' Your code for handled events goes here</paragraph> + </bascode> + <warning id="N0724">Mind the misspelled <literal>_documentEventOccured</literal> method that inherits a typo from %PRODUCTNAME Application Programming Interface (API).</warning> + <h2 id="N0725">Discovering Documents Events</h2> + <bookmark xml-lang="en-US" branch="index" id="bm_id681622445958242"> + <bookmark_value>API;frame.GlobalEventBroadcaster: Monitoring Document Event</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="N0726">The broadcaster API object provides the list of events it is responsible for:</paragraph> + <h3 id="N0727">With Python</h3> + <pycode> + <paragraph role="pycode" localize="false" id="N0728"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0729">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0730"> </paragraph> + <paragraph role="pycode" localize="false" id="N0731">import uno, apso_utils as ui</paragraph> + <paragraph role="pycode" localize="false" id="N0732"> </paragraph> + <paragraph role="pycode" localize="false" id="N0733">def displayAvailableEvents():</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0734"> """ Display document events """</paragraph> + <paragraph role="pycode" localize="false" id="N0735"> '''</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0736"> adapted from DisplayAvailableEvents() by A. Pitonyak</paragraph> + <paragraph role="pycode" localize="false" id="N0737"> https://forum.openoffice.org/en/forum/viewtopic.php?&t=43689</paragraph> + <paragraph role="pycode" localize="false" id="N0738"> '''</paragraph> + <paragraph role="pycode" localize="false" id="N0739"> ctx = XSCRIPTCONTEXT.getComponentContext()</paragraph> + <paragraph role="pycode" localize="false" id="N0740"> smgr = ctx.ServiceManager</paragraph> + <paragraph role="pycode" localize="false" id="N0741"> geb = smgr.createInstanceWithContext(</paragraph> + <paragraph role="pycode" localize="false" id="N0742"> "com.sun.star.frame.GlobalEventBroadcaster", ctx)</paragraph> + <paragraph role="pycode" localize="false" id="N0743"> events = geb.Events.getElementNames()</paragraph> + <paragraph role="pycode" localize="false" id="N0744"> ui.msgbox('; '.join(events))</paragraph> + <paragraph role="pycode" localize="false" id="N0745"> </paragraph> + <paragraph role="pycode" localize="false" id="N0746">g_exportedScripts = (displayAvailableEvents,)</paragraph> + </pycode> + <note id="N0747">The <link href="https://extensions.libreoffice.org/extensions/apso-alternative-script-organizer-for-python" name ="Alternative Python Script Organizer">Alternative Python Script Organizer (APSO)</link> extension is used to render events information on screen.</note> + <h3 id="N0748">With %PRODUCTNAME Basic</h3> + <bascode> + <paragraph role="bascode" localize="false" id="N0749">Sub DisplayAvailableEvents</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0750"> ''' Display document events '''</paragraph> + <paragraph role="bascode" localize="false" id="N0751"> Dim geb As Object ' com.sun.star.frame.GlobalEventBroadcaster</paragraph> + <paragraph role="bascode" localize="false" id="N0752"> Dim events() As String</paragraph> + <paragraph role="bascode" localize="false" id="N0753"> geb = CreateUnoService("com.sun.star.frame.GlobalEventBroadcaster")</paragraph> + <paragraph role="bascode" localize="false" id="N0754"> events = geb.Events.ElementNames()</paragraph> + <paragraph role="bascode" localize="false" id="N0755"> MsgBox Join(events, "; ")</paragraph> + <paragraph role="bascode" localize="false" id="N0756">End Sub</paragraph> + </bascode> + <section id="relatedtopics" > + <embed href="text/sbasic/python/python_listener.xhp#pythonlistener"/> + <embed href="text/sbasic/python/python_import.xhp#pythonimporth1"/> + <embed href="text/sbasic/python/python_handler.xhp#pythonhandler_h1"/> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + <embed href="text/sbasic/python/python_programming.xhp#pythonprogrammingheading"/> + <embed href="text/sbasic/python/python_2_basic.xhp#py2ba_h1"/> + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/python/python_examples.xhp b/helpcontent2/source/text/sbasic/python/python_examples.xhp new file mode 100644 index 000000000..c5b496ed0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_examples.xhp @@ -0,0 +1,42 @@ +<?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="pythonexamples" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Python examples</title> + <filename>/text/sbasic/python/python_examples.xhp</filename> + </topic> + </meta> + <body> + <section id="pythonexamples"> + <bookmark xml-lang="en-US" branch="index" id="bm_id20191031405"> + <bookmark_value>Python;examples</bookmark_value> + <bookmark_value>Python;shell</bookmark_value> + <bookmark_value>Python;platform</bookmark_value> + <bookmark_value>Python;session</bookmark_value> + <bookmark_value>Python;screen input/output</bookmark_value> + </bookmark> + <h1 id="hd_id201901031407"><variable id="pythonexamples2"><link href="text/sbasic/python/python_examples.xhp" name="python examples">Python programming examples</link></variable></h1> + </section> + <embed href="text/sbasic/python/python_session.xhp#pythonsession"/> + <embed href="text/sbasic/python/python_platform.xhp#pythonplatform"/> + <embed href="text/sbasic/python/python_import.xhp#pythonimporth1"/> + <embed href="text/sbasic/python/python_screen.xhp#ioscreen"/> + <embed href="text/sbasic/python/python_document_events.xhp#pythonmonitor"/> + <embed href="text/sbasic/python/python_dialogs.xhp#pythondialog"/> + <embed href="text/sbasic/python/python_handler.xhp#pythonhandler_h1"/> + <embed href="text/sbasic/python/python_listener.xhp#pythonlistener"/> + <embed href="text/sbasic/python/python_2_basic.xhp#py2ba_h1"/> + <section id="relatedtopics"> + <embed href="text/sbasic/guide/basic_2_python.xhp#basic2python"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_handler.xhp b/helpcontent2/source/text/sbasic/python/python_handler.xhp new file mode 100644 index 000000000..87887105e --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_handler.xhp @@ -0,0 +1,169 @@ +<?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="text/sbasic/python/python_handler"> + <title id="tit" xml-lang="en-US">Creating A Dialog Handler</title> + <filename>/text/sbasic/python/python_handler.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0664"> + <bookmark_value>Basic;Dialog Handler</bookmark_value> + <bookmark_value>Python;Dialog Handler</bookmark_value> + <bookmark_value>Access2Base;dlgTrace</bookmark_value> + <bookmark_value>Access2Base;_DumpToFile</bookmark_value> + <bookmark_value>API;DialogProvider2</bookmark_value> + <bookmark_value>API;XDialogEventHandler</bookmark_value> + </bookmark> + <bookmark xml-lang="en-US" branch="hid/cui/ui/assigncomponentdialog/AssignComponent" id="bm_id66701251" localize="false"/> + <h1 id="N0665"><variable id="pythonhandler_h1"><link href="text/sbasic/python/python_handler.xhp" name="Creating a Dialog Handler">Creating a Dialog Handler</link></variable></h1> + <paragraph role="paragraph" id="N0666">Next to <link href="text/sbasic/shared/01040000.xhp" name ="Assigning macros to events">assigning macros to events</link> or <link href="text/sbasic/basic/python/python_listener" name ="creating event listeners">creating event listeners</link>, one can use dialog handlers, whose principle is to define UNO keywords, or methods, that are mapped to events to watch for. The event handler is responsible for executing methods using the <literal>vnd.sun.star.UNO:<method_name></literal> protocol. Unlike listeners that require to define all supported methods, even if unused, dialog handlers require only two methods on top of intended control hook scripts.</paragraph> + <paragraph role="paragraph" id="N0667">The advantages of this approach are:</paragraph> + <list type="unordered"> + <listitem><paragraph role="listitem" id="N0668">It packs the code that handles event-driven macros,</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0669">it decorrelates events from macros names which facilitates maintenance or updates, in particular when moving macros or modules.</paragraph></listitem> + </list> + <paragraph role="paragraph" id="N0670">This mechanism is illustrated herewith for Basic and Python languages using an imported copy of <literal>Access2Base</literal> <literal>dlgTrace</literal> dialog. Exception handling and localisation are omitted for clarity.</paragraph> + <h2 id="N0671">Assigning Dialog methods</h2> + <paragraph role="paragraph" id="N0672">Export <literal>Access2Base</literal> <literal>dlgTrace</literal> dialog and import it into <literal>MyLib</literal> application library.</paragraph> + <paragraph role="paragraph" id="N0673">Inside the control properties pane of the <link href="text/sbasic/guide/create_dialog.xhp" name ="Dialog Editor">Dialog Editor</link>, use the Events tab to replace macro assignments by component assignments, and type in the intended method names:</paragraph> + <list type="unordered"> + <listitem><paragraph role="listitem" id="N0674">Set <literal>Dump to file</literal> dialog button component method name to <literal>_dump2File</literal></paragraph></listitem> + <listitem><paragraph role="listitem" id="N0675">Optionally define <literal>txtTracelog</literal> key pressed and mouse button pressed events component method names as <literal>_openHelp</literal></paragraph></listitem> + <listitem><paragraph role="listitem" id="N0676">Optionally define <literal>Ok</literal> button receiving focus event component method name as <literal>onOkHasfocus</literal></paragraph></listitem> + </list> + <paragraph role="paragraph" id="N0677">Events assigned actions should mention the <literal>vnd.sun.star.UNO:</literal> protocol.</paragraph> + <h2 id="N0678">Creating the handler</h2> + <paragraph role="paragraph" id="N0679"><literal>createDialogWithHandler</literal> method of <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1DialogProvider2.html" name ="com.sun.star.awt.DialogProvider2">com.sun.star.awt.DialogProvider2</link> service is used to set the dialog and its handler. The handler is responsible for implementing <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XDialogEventHandler.html" name ="com.sun.star.awt.XDialogEventHandler">com.sun.star.awt.XDialogEventHandler</link> interface.</paragraph> + <warning id="N0680">All component method names must be explicitly declared when using a dialog handler.</warning> + <h3 id="N0681">With Python</h3> + <paragraph role="paragraph" id="N0682">In this example the dialog is located on the computer.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="N0683"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0684">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0685"> </paragraph> + <paragraph role="pycode" localize="false" id="N0686">import uno, unohelper</paragraph> + <paragraph role="pycode" localize="false" id="N0687">from com.sun.star.awt import XDialogEventHandler</paragraph> + <paragraph role="pycode" localize="false" id="N0688"> </paragraph> + <paragraph role="pycode" localize="false" id="N0689">_DLG_PROVIDER = "com.sun.star.awt.DialogProvider2"</paragraph> + <paragraph role="pycode" localize="false" id="N0690"> </paragraph> + <paragraph role="pycode" localize="false" id="N0691">class Console(unohelper.Base, XDialogEventHandler):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0692"> """ Access2Base Console Handler """</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0693"> ''' adapted from « Créer un dialogue avec gestionnaire d'événements » by JM Zambon</paragraph> + <paragraph role="pycode" localize="false" id="N0694"> https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler '''</paragraph> + <paragraph role="pycode" localize="false" id="N0695"> def show(self):</paragraph> + <paragraph role="pycode" localize="false" id="N0696"> dialog = self.getDialog("MyLib.dlgTrace", embedded=True)</paragraph> + <paragraph role="pycode" localize="false" id="N0697"> dialog.Title = "Konsole"</paragraph> + <paragraph role="pycode" localize="false" id="N0698"> dialog.execute()</paragraph> + <paragraph role="pycode" localize="false" id="N0699"> </paragraph> + <paragraph role="pycode" localize="false" id="N0700"> def callHandlerMethod(self, dialog, event, method):</paragraph> + <paragraph role="pycode" localize="false" id="N0701"> if method == '_dump2File':</paragraph> + <paragraph role="pycode" localize="false" id="N0702"> event.Source.setLabel("dump requested")</paragraph> + <paragraph role="pycode" localize="false" id="N0703"> scr = getBasicScript(script="_DumpToFile", module="Trace",</paragraph> + <paragraph role="pycode" localize="false" id="N0704"> library='Access2Base')</paragraph> + <paragraph role="pycode" localize="false" id="N0705"> scr.invoke((event,), (), ())</paragraph> + <paragraph role="pycode" localize="false" id="N0706"> elif method == '_openHelp':</paragraph> + <paragraph role="pycode" localize="false" id="N0707"> _msgbox('Not yet implemented')</paragraph> + <paragraph role="pycode" localize="false" id="N0708"> dialog.endDialog(1)</paragraph> + <paragraph role="pycode" localize="false" id="N0709"> else:</paragraph> + <paragraph role="pycode" localize="false" id="N0710"> return False</paragraph> + <paragraph role="pycode" localize="false" id="N0711"> </paragraph> + <paragraph role="pycode" localize="false" id="N0712"> def getSupportedMethodNames(self):</paragraph> + <paragraph role="pycode" localize="false" id="N0713"> return ('_dump2File', '_openHelp')</paragraph> + <paragraph role="pycode" localize="false" id="N0714"> </paragraph> + <paragraph role="pycode" localize="false" id="N0715"> def getDialog(self, libr_dlg: str, embedded=False):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0716"> """ Create a Dialog from its location """</paragraph> + <paragraph role="pycode" localize="false" id="N0717"> smgr = XSCRIPTCONTEXT.getComponentContext().ServiceManager</paragraph> + <paragraph role="pycode" localize="false" id="N0718"> if embedded:</paragraph> + <paragraph role="pycode" localize="false" id="N0719"> model = XSCRIPTCONTEXT.getDocument()</paragraph> + <paragraph role="pycode" localize="false" id="N0720"> dp = smgr.createInstanceWithArguments(_DLG_PROVIDER, (model,))</paragraph> + <paragraph role="pycode" localize="false" id="N0721"> location = "?location=document"</paragraph> + <paragraph role="pycode" localize="false" id="N0722"> else:</paragraph> + <paragraph role="pycode" localize="false" id="N0723"> dp = smgr.createInstanceWithContext(_DLG_PROVIDER, ctx)</paragraph> + <paragraph role="pycode" localize="false" id="N0724"> location = "?location=application"</paragraph> + <paragraph role="pycode" localize="false" id="N0725"> dlg = dp.createDialogWithHandler("vnd.sun.star.script:"+libr_dlg+location, self)</paragraph> + <paragraph role="pycode" localize="false" id="N0726"> return dlg</paragraph> + <paragraph role="pycode" localize="false" id="N072A"> </paragraph> + <!-- WIP need extra work to embed remote code + <embed href="text/sbasic/python/Python_2_Basic.xhp#Python_getBasicScript" /> --> + <paragraph role="pycode" localize="false" id="N072B"># def getBasicScript() # see note</paragraph> + <paragraph role="pycode" localize="false" id="N0727"> </paragraph> + <paragraph role="pycode" localize="false" id="N0728">def _msgbox(prompt='', title=''):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0729"> ''' Ugly MsgBox '''</paragraph> + <paragraph role="pycode" localize="false" id="N0730"> import msgbox</paragraph> + <paragraph role="pycode" localize="false" id="N0731"> mb = msgbox.MsgBox(uno.getComponentContext())</paragraph> + <paragraph role="pycode" localize="false" id="N0732"> mb.addButton('Howdy')</paragraph> + <paragraph role="pycode" localize="false" id="N0733"> mb.show(prompt,0,title)</paragraph> + <paragraph role="pycode" localize="false" id="N0734"> </paragraph> + <paragraph role="pycode" localize="false" id="N0735">def ConsoleHandler():</paragraph> + <paragraph role="pycode" localize="false" id="N0736"> Console().show()</paragraph> + <paragraph role="pycode" localize="false" id="N0737"> </paragraph> + <paragraph role="pycode" localize="false" id="N0738">g_exportedScripts = (ConsoleHandler,)</paragraph> + <paragraph role="pycode" localize="false" id="N0739"> </paragraph> + </pycode> + <note id="N0740">As expected, <literal>onOkHasFocus</literal> missing method throws an exception.</note> + <tip id="N0741">Refer to <link href="text/sbasic/python/python_2_basic.xhp" name ="Python calls to %PRODUCTNAME Basic">Python calls to %PRODUCTNAME Basic</link> page for <literal>getBasicScript</literal> routine description and for details about cross-language scripting execution.</tip> + <h3 id="N0742">With %PRODUCTNAME Basic</h3> + <paragraph role="paragraph" id="N0743">In this example the dialog is embedded in a document, and can equally be located on the computer.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="N0744">' <MyLib>.<Handler> module</paragraph> + <paragraph role="bascode" localize="false" id="N0745"> </paragraph> + <paragraph role="bascode" localize="false" id="N0746">Public Sub Console_Show()</paragraph> + <paragraph role="bascode" localize="false" id="N0747"> Dim dp as Object ' com.sun.star.awt.DialogProvider2</paragraph> + <paragraph role="bascode" localize="false" id="N0748"> Dim dialog As Object ' com.sun.star.awt.XDialog, com.sun.star.awt.XDialogEventHandler</paragraph> + <paragraph role="bascode" localize="false" id="N0749"> Dim eventHandler As Object ' com.sun.star.awt.XDialogEventHandler</paragraph> + <paragraph role="bascode" localize="false" id="N0750"> dp = CreateUnoService("com.sun.star.awt.DialogProvider2")</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0751"> dp.Initialize(Array(ThisComponent)) ' if doc-embedded dialog</paragraph> + <paragraph role="bascode" localize="false" id="N0752"> eventHandler = CreateUnoListener("Console_", "com.sun.star.awt.XDialogEventHandler")</paragraph> + <paragraph role="bascode" localize="false" id="N0753"> dialog = dp.createDialogWithHandler("vnd.sun.star.script:MyLib.dlgTrace?location=document", eventHandler)</paragraph> + <paragraph role="bascode" localize="false" id="N0754"> dialog.Title = "Konsole"</paragraph> + <paragraph role="bascode" localize="false" id="N0755"> dialog.execute()</paragraph> + <paragraph role="bascode" localize="false" id="N0756">End Sub ' <Handler>.Console_Show()</paragraph> + <paragraph role="bascode" localize="false" id="N0757"> </paragraph> + <paragraph role="bascode" localize="false" id="N0758a">Private Function Console_callHandlerMethod(dialog as Object, _</paragraph> + <paragraph role="bascode" localize="false" id="N0758b"> event As com.sun.star.document.DocumentEvent, _</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0958c"> method As String) As Boolean</paragraph> + <paragraph role="bascode" localize="false" id="N0759"> ''' Intercept dialog events using .UNO protocol '''</paragraph> + <paragraph role="bascode" localize="false" id="N0760"> Console_callHandlerMethod = True</paragraph> + <paragraph role="bascode" localize="false" id="N0761"> Select Case method</paragraph> + <paragraph role="bascode" localize="false" id="N0762"> Case "_dump2File"</paragraph> + <paragraph role="bascode" localize="false" id="N0763"> event.Source.setLabel("dump requested")</paragraph> + <paragraph role="bascode" localize="false" id="N0764"> With GlobalScope.BasicLibraries</paragraph> + <paragraph role="bascode" localize="false" id="N0765"> If Not .IsLibraryLoaded("Access2Base") Then .LoadLibrary("Access2Base")</paragraph> + <paragraph role="bascode" localize="false" id="N0766"> End With</paragraph> + <paragraph role="bascode" localize="false" id="N0767"> Access2Base.Trace._DumpToFile</paragraph> + <paragraph role="bascode" localize="false" id="N0768"> Case "_openHelp" </paragraph> + <paragraph role="bascode" localize="false" id="N0769"> MsgBox "Not yet implemented",0 , "Howdy"</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0770"> 'dialog.endDialog(1) if computer-based dialog</paragraph> + <paragraph role="bascode" localize="false" id="N0771"> Case Else : Console_callHandlerMethod = False</paragraph> + <paragraph role="bascode" localize="false" id="N0772"> End Select</paragraph> + <paragraph role="bascode" localize="false" id="N0773">End Function ' <Handler>.Console_callHandlerMethod</paragraph> + <paragraph role="bascode" localize="false" id="N0774"> </paragraph> + <paragraph role="bascode" localize="false" id="N0775">Private Function Console_getSupportedMethodNames()</paragraph> + <paragraph role="bascode" localize="false" id="N0776"> Console_getSupportedMethodNames = Array("_dump2File", "_openHelp")</paragraph> + <paragraph role="bascode" localize="false" id="N0777">End Function ' <Handler>.Console _getSupportedMethodNames</paragraph> + <paragraph role="bascode" localize="false" id="N0778"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0779">' adapted from « Créer un dialogue avec gestionnaire d'événements » by JM Zambon</paragraph> + <paragraph role="bascode" localize="false" id="N0780">' https://wiki.openoffice.org/wiki/FR/Documentation/Python/Creating_Dialog_with_Handler</paragraph> + </bascode> + <note id="N0781">As expected, <literal>onOkHasFocus</literal> missing method throws an exception.</note> + <section id="relatedtopics" > + <embed href="text/sbasic/python/python_2_basic.xhp#py2ba_h1"/> + <embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> + <paragraph role="paragraph" id="N0505"><link href="text/sbasic/shared/03132000.xhp" name ="CreateUnoListener Function">CreateUnoListener Function</link></paragraph> + <embed href="text/sbasic/python/python_listener.xhp#pythonlistener"/> + <embed href="text/sbasic/python/python_dialogs.xhp#pythondialog"/> + <embed href="text/sbasic/python/python_document_events.xhp#pythonmonitor"/> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_ide.xhp b/helpcontent2/source/text/sbasic/python/python_ide.xhp new file mode 100644 index 000000000..e6d715630 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_ide.xhp @@ -0,0 +1,36 @@ +<?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="pythonidesetup" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IDE for Python</title> + <filename>/text/sbasic/python/python_ide.xhp</filename> + </topic> + </meta> + <body> + <section id="pythonideheading"> + <bookmark id="bm_id341543348965463" xml-lang="en-US" branch="hid/zzzz" localize="false"/> + <bookmark xml-lang="en-US" branch="index" id="bm_id761543349138561"> + <bookmark_value>APSO</bookmark_value> + <bookmark_value>Alternative Python Scripts Organizer</bookmark_value> + <bookmark_value>python;IDE - integrated development environment</bookmark_value> + <bookmark_value>python;editor</bookmark_value> + </bookmark> + <h1 id="hd_id151543348965464"><variable id="pythonideh1"><link href="text/sbasic/python/python_ide.xhp" name="Python IDE Setup">Setting up an Integrated Development Environment (IDE) for Python</link></variable></h1> + <paragraph id="par_id541543348965465" role="paragraph" xml-lang="en-US">Writing Python macros requires extra configuration steps to set an IDE of choice.</paragraph> + </section> + <paragraph role="paragraph" id="N0106">Unlike Basic language macros development in %PRODUCTNAME, developing Python scripts for %PRODUCTNAME requires to configure an external Integrated Development Environment (IDE). Multiple IDEs are available that range from beginners to advanced Python coders. While using a Python IDE programmers benefit from numerous features such as syntax highlighting, code folding, class browsing, code completion, coding standard enforcement, test driven development, debugging, version control and many more. You can refer to <link href="https://wiki.documentfoundation.org/Macros/Python_Design_Guide" name="Designing & Developing Python Applications">Designing & Developing Python Applications</link> on the Wiki for more in-depth information about the setup of a bridge between your IDE and a running instance %PRODUCTNAME.</paragraph> + <h2 id="hd_id761544698669786">The APSO Extension</h2> + <paragraph role="paragraph" id="N0104">The <link href="https://extensions.libreoffice.org/extensions/apso-alternative-script-organizer-for-python" name="Alternative Python Script Organizer (APSO)">Alternative Python Script Organizer (APSO)</link> extension eases the edition of Python scripts, in particular when embedded in a document. Using APSO you can configure your preferred source code editor, start the integrated Python shell and debug Python scripts. Extensions exist that help inspect arbitrary UNO objects, refer to <link href="https://wiki.documentfoundation.org/Macros/Python_Design_Guide" name="eDesigning & Developing Python Applications">Designing & Developing Python Applications</link> for additional details on such extensions.</paragraph> + <section id="relatedtopics"> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + </section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/python/python_import.xhp b/helpcontent2/source/text/sbasic/python/python_import.xhp new file mode 100644 index 000000000..af3b243d3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_import.xhp @@ -0,0 +1,118 @@ +<?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="text/sbasic/python/python_import"> + <title id="tit" xml-lang="en-US">Python : Importing Modules</title> + <filename>/text/sbasic/python/python_import.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0461"> + <bookmark_value>Python;import</bookmark_value> + <bookmark_value>Python;Modules</bookmark_value> + <bookmark_value>Python;pythonpath</bookmark_value> + <bookmark_value>PythonLibraries</bookmark_value> + </bookmark> + <h1 id="N0462"><variable id="pythonimporth1"><link href="text/sbasic/python/python_import.xhp" name="python imports">Importing Python Modules</link></variable></h1> + <paragraph role="paragraph" id="N0463">%PRODUCTNAME Python scripts come in three distinct flavors, they can be personal, shared or embedded in documents. They are stored in varying places described in <link href="text/sbasic/python/python_locations.xhp">Python Scripts Organization and Location</link>. In order to import Python modules, their locations must be known from Python at run time.</paragraph> + <paragraph role="paragraph" id="N0464">This mechanism is illustrated for file system based modules and document based modules. Exception handling is omitted for clarity. The terms library or directory, scripts or modules are used interchangeably. A Python macro refers to a function inside a module.</paragraph> + <warning id="N0465">Note that <literal><User Profile>/Scripts/python/pythonpath</literal> local directory is always explored when running a Python macro from <literal><User Profile>/Scripts/python</literal>.</warning> + <h2 id="N0466">File System module import</h2> + <embed href="text/sbasic/python/python_programming.xhp#PythonFileSystemImport"/> + <h3 id="N0467">User or Shared Modules</h3> + <paragraph role="paragraph" id="N0468">Personal & shared Python scripts can be imported once their directories are included in Python run time path. Refer to <link href="text/sbasic/python/python_session.xhp">Getting session information</link> page for more details regarding omitted Session Class.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="N0469"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0470">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0471">import sys</paragraph> + <paragraph role="pycode" localize="false" id="N0472"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0473">user_lib = Session().UserPythonScripts # User scripts location</paragraph> + <paragraph role="pycode" localize="false" id="N0474">if not user_lib in sys.path:</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0475"> sys.path.insert(0, user_lib) # Add to search path</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0476">import screen_io as ui # 'screen_io.py' module resides in user_lib directory</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0477"># Your code follows here</paragraph> + </pycode> + <paragraph role="paragraph" id="N0478">This Python example exposes a local XSCRIPTCONTEXT variable to an imported module:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="N0479"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0480">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0481">import uno, sys</paragraph> + <paragraph role="pycode" localize="false" id="N0482"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0483">share_lib = Session.SharedPythonScripts() # Shared scripts location</paragraph> + <paragraph role="pycode" localize="false" id="N0484">if not share_lib in sys.path:</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0485"> sys.path.insert(0, share_lib) # Add to search path</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0486">from IDE_utils import ScriptContext # 'IDE_utils.py' sits with shared Python scripts.</paragraph> + <paragraph role="pycode" localize="false" id="N0487">XSCRIPTCONTEXT = ScriptContext(uno.getComponentContext)</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0488"># Your code follows here</paragraph> + </pycode> + <h3 id="N0489">Installation Modules for Applications</h3> + <paragraph role="paragraph" id="N0490">Unlike personal and shared scripts, %PRODUCTNAME installation scripts can be imported any time. Next to <literal>uno</literal> & <literal>unohelper</literal> %PRODUCTNAME Python modules, other scripts present in <literal><installation_path>/program</literal> directory can be imported directly, such as the <literal>msgbox</literal> module.</paragraph> + <paragraph role="paragraph" id="N0491">With Python shell:</paragraph> + <paragraph role="paragraph" localize="false" id="N0492"><literal>>>> import msgbox, uno</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0494"><literal>>>> myBox = msgbox.MsgBox(uno.getComponentContext())</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0495"><literal>>>> myBox.addButton("okay")</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0496"><literal>>>> myBox.renderFromButtonSize()</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0497"><literal>>>> myBox.numberOflines = 2</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0499"><literal>>>> print(myBox.show("A small message",0,"Dialog title"))</literal></paragraph> + <h2 id="N0534">Document Module Import</h2> + <paragraph role="paragraph" id="N0535">Importing a Python document embedded module is illustrated below. Error handling is not detailed. Python run time path is updated when document has been opened and before closure. Refer to <link href="text/sbasic/shared/01040000.xhp">Event-Driven Macros</link> to learn how to associate Python macros to document events.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="N0536"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0536">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0537"> </paragraph> + <paragraph role="pycode" localize="false" id="N0538">import sys, uno</paragraph> + <paragraph role="pycode" localize="false" id="N0539"> </paragraph> + <paragraph role="pycode" localize="false" id="N0540">def OnDocPostOpenLoadPython():</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0541"> """ Prepare Python modules import when doc. loaded """</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0542"> PythonLibraries.loadLibrary('lib/subdir') # Add directory to search path </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0543"> PythonLibraries.loadLibrary('my_gui', 'screen_io') # Add dir. & import screen_io</paragraph> + <paragraph role="pycode" localize="false" id="N0544"> </paragraph> + <paragraph role="pycode" localize="false" id="N0545">def OnDocQueryCloseUnloadPython():</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0546"> """ Cleanup PYTHON_PATH when doc. Gets closed """ </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0547"> PythonLibraries.unloadLibrary('my_gui') # Python runtime path cleanup</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0548"> # Note: imported modules remain loaded in this example.</paragraph> + <paragraph role="pycode" localize="false" id="N0549"> </paragraph> + <paragraph role="pycode" localize="false" id="N0552">class PythonLibraries():</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0553"> """ Python library loader and module importer</paragraph> + <paragraph role="pycode" localize="false" id="N0554"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0555"> adapted from 'Bibliothèque de fonctions' by Hubert Lambert</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0556"> at https://forum.openoffice.org/fr/forum/viewtopic.php?p=286213 """</paragraph> + <paragraph role="pycode" localize="false" id="N0557"> def isImportedModule(module_name: str) -> bool:</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0558"> """ Check run time module list """</paragraph> + <paragraph role="pycode" localize="false" id="N0559"> return (module_name in sys.modules.keys())</paragraph> + <paragraph role="pycode" localize="false" id="N0560"> def isLoadedLibrary(lib_name: str) -> bool:</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0561"> """ Check PYTHON_PATH content """</paragraph> + <paragraph role="pycode" localize="false" id="N0562"> return (lib_name in sys.path)</paragraph> + <paragraph role="pycode" localize="false" id="N0563"> def loadLibrary(lib_name: str, module_name=None):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0564"> """ add directory to PYTHON_PATH, import named module """</paragraph> + <paragraph role="pycode" localize="false" id="N0565"> doc = XSCRIPTCONTEXT.getDocument()</paragraph> + <paragraph role="pycode" localize="false" id="N0566"> url = uno.fileUrlToSystemPath(</paragraph> + <paragraph role="pycode" localize="false" id="N0567"> '{}/{}'.format(doc.URL,'Scripts/python/'+lib_name)</paragraph> + <paragraph role="pycode" localize="false" id="N0568"> if not url in sys.path:</paragraph> + <paragraph role="pycode" localize="false" id="N0569"> sys.path.insert(0, url)</paragraph> + <paragraph role="pycode" localize="false" id="N0570"> if module_name and not module_name in sys.modules.keys():</paragraph> + <paragraph role="pycode" localize="false" id="N0571"> return zipimport.zipimporter(url).load_module(module_name)</paragraph> + <paragraph role="pycode" localize="false" id="N0572"> def unloadLibrary(lib_name: str):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0573"> """ remove directory from PYTHON_PATH """</paragraph> + <paragraph role="pycode" localize="false" id="N0574"> sys.path.remove(lib_name)</paragraph> + <paragraph role="pycode" localize="false" id="N0575"> </paragraph> + <paragraph role="pycode" localize="false" id="N0576">g_exportedScripts = (OnDocPostOpenLoadPython, OnDocQueryCloseUnloadPython)</paragraph> + </pycode> + <section id="relatedtopics" > + <embed href="text/sbasic/python/python_session.xhp#pythonsession"/> + <embed href="text/sbasic/python/python_programming.xhp#pythonprogrammingheading"/> + <embed href="text/sbasic/python/python_locations.xhp#pythonlocations1"/> + <paragraph role="paragraph" id="N0580"> + Refer to <link href="text/sbasic/python/python_listener.xhp">Creating a Python Listener</link> for examples of event-driven macros. + </paragraph> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_listener.xhp b/helpcontent2/source/text/sbasic/python/python_listener.xhp new file mode 100644 index 000000000..6cffde6a6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_listener.xhp @@ -0,0 +1,166 @@ +<?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="text/sbasic/python/python_listener.xhp"> + <title id="tit" xml-lang="en-US">Python Listeners : Creating Event Listeners</title> + <filename>/text/sbasic/python/python_listener.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0385"> + <bookmark_value>Python;Event Listener</bookmark_value> + <bookmark_value>Python;createUnoListener</bookmark_value> + <bookmark_value>Basic;Event Listener</bookmark_value> + <bookmark_value>API;ActionEvent</bookmark_value> + <bookmark_value>API;DialogProvider</bookmark_value> + <bookmark_value>API;EventObject</bookmark_value> + <bookmark_value>API;ExecutableDialogResults</bookmark_value> + <bookmark_value>API;XActionListener</bookmark_value> + </bookmark> + <section id="pythonlistener1"> + <h1 id="N0386"><variable id="pythonlistener"><link href="text/sbasic/python/python_listener.xhp" name="python listeners">Creating Event Listeners</link></variable></h1> + </section> + <paragraph role="paragraph" id="N0387">Events raised by dialogs, documents, forms or graphical controls can be linked to macros, which is referred to as event-driven programming. The most common method to relate events to macros are the <literal>Events</literal> tab in <menuitem>Tools – Customize</menuitem> menu and the <link href="text/sbasic/guide/create_dialog.xhp" name ="Create dialog">Dialog Editor</link> Control properties pane from <menuitem>Tools - Macros – Organise Dialogs...</menuitem> menu.</paragraph> + <paragraph role="paragraph" id="N0388">Graphical artifacts, keyboard inputs, mouse moves and other man/machine interactions can be controlled using UNO listeners that watch for the user’s behavior. Listeners are dynamic program code alternatives to macro assignments. One may create as many UNO listeners as events to watch for. A single listener can also handle multiple user interface controls.</paragraph> + <h2 id="N0389">Creating an event listener</h2> + <paragraph role="paragraph" id="N0390">Listeners get attached to controls held in dialogs, as well as to document or form events. Listeners are also used when creating runtime dialogs or when adding controls to a dialog on the fly.</paragraph> + <paragraph role="paragraph" id="N0391">This example creates a listener for <literal>Button1</literal> control of <literal>Dialog1</literal> dialog in <literal>Standard</literal> library.</paragraph> + <h3 id="N0392">With Python</h3> + <pycode> + <paragraph role="pycode" localize="false" id="N0393"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0394">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0395"> </paragraph> + <paragraph role="pycode" localize="false" id="N0396">import uno, unohelper</paragraph> + <paragraph role="pycode" localize="false" id="N0397">from com.sun.star.awt import XActionListener</paragraph> + <paragraph role="pycode" localize="false" id="N0398">from com.sun.star.awt import ActionEvent</paragraph> + <paragraph role="pycode" localize="false" id="N0399">from com.sun.star.lang import EventObject</paragraph> + <paragraph role="pycode" localize="false" id="N0400">from com.sun.star.ui.dialogs.ExecutableDialogResults \</paragraph> + <paragraph role="pycode" localize="false" id="N0401"> import OK, CANCEL</paragraph> + <paragraph role="pycode" localize="false" id="N0402">import msgbox as util</paragraph> + <paragraph role="pycode" localize="false" id="N0403"> </paragraph> + <paragraph role="pycode" localize="false" id="N0404">_MY_BUTTON = "Button1"</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0405">_MY_LABEL = 'Python listens..'</paragraph> + <paragraph role="pycode" localize="false" id="N0406">_DLG_PROVIDER = "com.sun.star.awt.DialogProvider"</paragraph> + <paragraph role="pycode" localize="false" id="N0407"> </paragraph> + <paragraph role="pycode" localize="false" id="N0408">def Main(*args):</paragraph> + <paragraph role="pycode" localize="false" id="N0409"> ui = createUnoDialog("Standard.Dialog1", embedded=True)</paragraph> + <paragraph role="pycode" localize="false" id="N0410"> ui.Title = "Python X[any]Listener"</paragraph> + <paragraph role="pycode" localize="false" id="N0411"> ctl = ui.getControl(_MY_BUTTON)</paragraph> + <paragraph role="pycode" localize="false" id="N0412"> ctl.Model.Label = _MY_LABEL</paragraph> + <paragraph role="pycode" localize="false" id="N0413"> act = ActionListener()</paragraph> + <paragraph role="pycode" localize="false" id="N0414"> ctl.addActionListener(act)</paragraph> + <paragraph role="pycode" localize="false" id="N0415"> rc = ui.execute()</paragraph> + <paragraph role="pycode" localize="false" id="N0416"> if rc == OK:</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0417"> MsgBox("The user acknowledged the dialog.")</paragraph> + <paragraph role="pycode" localize="false" id="N0418"> elif rc == CANCEL:</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0419"> MsgBox("The user canceled the dialog.")</paragraph> + <paragraph role="pycode" localize="false" id="N0420"> ui.dispose() # ui.endExecute</paragraph> + <paragraph role="pycode" localize="false" id="N0421"> ctl.removeActionListener(act)</paragraph> + <paragraph role="pycode" localize="false" id="N0422"> </paragraph> + <paragraph role="pycode" localize="false" id="N0423">def createUnoDialog(libr_dlg: str, embedded=False):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0424"> """ Create a Dialog from its location """</paragraph> + <paragraph role="pycode" localize="false" id="N0425"> smgr = XSCRIPTCONTEXT.getComponentContext().ServiceManager</paragraph> + <paragraph role="pycode" localize="false" id="N0426"> if embedded:</paragraph> + <paragraph role="pycode" localize="false" id="N0427"> model = XSCRIPTCONTEXT.getDocument()</paragraph> + <paragraph role="pycode" localize="false" id="N0428"> dp = smgr.createInstanceWithArguments(_DLG_PROVIDER, (model,))</paragraph> + <paragraph role="pycode" localize="false" id="N0429"> location = "?location=document"</paragraph> + <paragraph role="pycode" localize="false" id="N0430"> else:</paragraph> + <paragraph role="pycode" localize="false" id="N0431"> dp = smgr.createInstanceWithContext(_DLG_PROVIDER, ctx)</paragraph> + <paragraph role="pycode" localize="false" id="N0432"> location = "?location=application"</paragraph> + <paragraph role="pycode" localize="false" id="N0433"> dlg = dp.createDialog("vnd.sun.star.script:"+libr_dlg+location)</paragraph> + <paragraph role="pycode" localize="false" id="N0434"> return dlg</paragraph> + <paragraph role="pycode" localize="false" id="N0435"> </paragraph> + <paragraph role="pycode" localize="false" id="N0436">class ActionListener(unohelper.Base, XActionListener):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0437"> """ Listen to & count button clicks """</paragraph> + <paragraph role="pycode" localize="false" id="N0438"> def __init__(self):</paragraph> + <paragraph role="pycode" localize="false" id="N0439"> self.count = 0</paragraph> + <paragraph role="pycode" localize="false" id="N0440"> </paragraph> + <paragraph role="pycode" localize="false" id="N0441"> def actionPerformed(self, evt: ActionEvent):</paragraph> + <paragraph role="pycode" localize="false" id="N0442"> self.count = self.count + 1</paragraph> + <paragraph role="pycode" localize="false" id="N0443"> #mri(evt)</paragraph> + <paragraph role="pycode" localize="false" id="N0444"> if evt.Source.Model.Name == _MY_BUTTON:</paragraph> + <paragraph role="pycode" localize="false" id="N0445"> evt.Source.Model.Label = _MY_LABEL+ str( self.count )</paragraph> + <paragraph role="pycode" localize="false" id="N0446"> return</paragraph> + <paragraph role="pycode" localize="false" id="N0447"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0448"> def disposing(self, evt: EventObject): # mandatory routine</paragraph> + <paragraph role="pycode" localize="false" id="N0449"> pass</paragraph> + <paragraph role="pycode" localize="false" id="N0450"> </paragraph> + <paragraph role="pycode" localize="false" id="N0451">def MsgBox(txt: str):</paragraph> + <paragraph role="pycode" localize="false" id="N0452"> mb = util.MsgBox(uno.getComponentContext())</paragraph> + <paragraph role="pycode" localize="false" id="N0453"> mb.addButton("Ok")</paragraph> + <paragraph role="pycode" localize="false" id="N0454"> mb.show(txt, 0, "Python")</paragraph> + <paragraph role="pycode" localize="false" id="N0455"> </paragraph> + <paragraph role="pycode" localize="false" id="N0456">g_exportedScripts = (Main,)</paragraph> + </pycode> + <paragraph role="paragraph" id="N0457"> + <emph>msgbox.py</emph> in <emph>{installation}/program/</emph> directory has some examples of button listeners. + </paragraph> + <h3 id="N0458">With %PRODUCTNAME Basic</h3> + <bascode> + <paragraph role="bascode" localize="false" id="N0459a">Option Explicit</paragraph> + <paragraph role="bascode" localize="false" id="N0459b"> </paragraph> + <paragraph role="bascode" localize="false" id="N0459c">Const MY_LIBRARY = "Standard", MY_DIALOG = "Dialog1", MY_BUTTON = "Button1"</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0459d">Const MY_LABEL = "Basic listens.."</paragraph> + <paragraph role="bascode" localize="false" id="N0459e">Dim count As Integer</paragraph> + <paragraph role="bascode" localize="false" id="N0459f"> </paragraph> + <paragraph role="bascode" localize="false" id="N0459">Sub Main</paragraph> + <paragraph role="bascode" localize="false" id="N0460"> Dim libr As Object ' com.sun.star.script.XLibraryContainer</paragraph> + <paragraph role="bascode" localize="false" id="N0461"> Dim dlg As Object</paragraph> + <paragraph role="bascode" localize="false" id="N0462"> Dim ui As Object ' stardiv.Toolkit.UnoDialogControl</paragraph> + <paragraph role="bascode" localize="false" id="N0463"> Dim ctl As Object ' stardiv.Toolkit.UnoButtonControl</paragraph> + <paragraph role="bascode" localize="false" id="N0464"> Dim act As Object ' com.sun.star.awt.XActionListener</paragraph> + <paragraph role="bascode" localize="false" id="N0465"> Dim rc As Object : rc = com.sun.star.ui.dialogs.ExecutableDialogResults</paragraph> + <paragraph role="bascode" localize="false" id="N0466"> </paragraph> + <paragraph role="bascode" localize="false" id="N0467"> BasicLibraries.LoadLibrary(MY_LIBRARY)</paragraph> + <paragraph role="bascode" localize="false" id="N0468"> libr = DialogLibraries.GetByName(MY_LIBRARY)</paragraph> + <paragraph role="bascode" localize="false" id="N0469"> dlg = libr.GetByName(MY_DIALOG)</paragraph> + <paragraph role="bascode" localize="false" id="N0470"> ui = CreateUnoDialog(dlg)</paragraph> + <paragraph role="bascode" localize="false" id="N0471"> ui.Title = "Basic X[any]Listener example"</paragraph> + <paragraph role="bascode" localize="false" id="N0472"> count = 0</paragraph> + <paragraph role="bascode" localize="false" id="N0473"> ctl = ui.GetControl(MY_BUTTON)</paragraph> + <paragraph role="bascode" localize="false" id="N0474"> ctl.Model.Label = MY_LABEL</paragraph> + <paragraph role="bascode" localize="false" id="N0475"> act = CreateUnoListener("awt_", "com.sun.star.awt.XActionListener")</paragraph> + <paragraph role="bascode" localize="false" id="N0476"> ctl.addActionListener(act)</paragraph> + <paragraph role="bascode" localize="false" id="N0477"> Select Case ui.Execute</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0478"> Case rc.OK : MsgBox "The user acknowledged the dialog.",, "Basic"</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0479"> Case rc.CANCEL : MsgBox "The user canceled the dialog.",, "Basic"</paragraph> + <paragraph role="bascode" localize="false" id="N0480"> End Select</paragraph> + <paragraph role="bascode" localize="false" id="N0481"> ui.dispose ' ui.endExecute()</paragraph> + <paragraph role="bascode" localize="false" id="N0482"> ctl.removeActionListener(act)</paragraph> + <paragraph role="bascode" localize="false" id="N0483">End Sub</paragraph> + <paragraph role="bascode" localize="false" id="N0484"> </paragraph> + <paragraph role="bascode" localize="false" id="N0485">Private Sub awt_actionPerformed(evt As com.sun.star.awt.ActionEvent)</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0486"> ''' Listen to & count button clicks '''</paragraph> + <paragraph role="bascode" localize="false" id="N0487"> With evt.Source.Model</paragraph> + <paragraph role="bascode" localize="false" id="N0488"> If .Name = MY_BUTTON Then</paragraph> + <paragraph role="bascode" localize="false" id="N0489"> count = count + 1</paragraph> + <paragraph role="bascode" localize="false" id="N0490"> .Label = MY_LABEL+Cstr(count)</paragraph> + <paragraph role="bascode" localize="false" id="N0491"> End If</paragraph> + <paragraph role="bascode" localize="false" id="N0492"> End With</paragraph> + <paragraph role="bascode" localize="false" id="N0493">End Sub ' awt_actionPerformed</paragraph> + <paragraph role="bascode" localize="false" id="N0494"> </paragraph> + <paragraph role="bascode" localize="false" id="N0495">Private Sub awt_disposing(evt As com.sun.star.lang.EventObject) ' mandatory Sub</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0496"> ' your code goes here</paragraph> + <paragraph role="bascode" localize="false" id="N0497">End Sub ' awt_disposing</paragraph> + </bascode> + <h2 id="N0498">Other Event Listeners</h2> + <paragraph role="paragraph" id="N0499">Listeners are usually coded along with <link href="text/sbasic/python/python_dialogs.xhp" name ="dialog opening">dialog opening</link>. Numerous listener approaches are possible such as event handlers for dialogs or event monitors for documents or forms.</paragraph> + <section id="relatedtopics" > + <embed href="text/sbasic/guide/sample_code.xhp#sample_code"/> + <paragraph role="paragraph" id="N0505"><link href="text/sbasic/shared/03132000.xhp" name ="CreateUnoListener Function">CreateUnoListener Function</link></paragraph> + <paragraph role="paragraph" id="N0506"><link href="text/swriter/01/05060700.xhp" name ="Events mapping to objects">Events mapping to objects</link></paragraph> + <paragraph role="paragraph" id="N0509">See also <link href="text/sbasic/shared/01040000.xhp" name ="Document events">Document events</link>, <link href="text/shared/02/01170202.xhp" name ="Form events">Form events</link>.</paragraph> + <embed href="text/sbasic/python/python_handler.xhp#pythonhandler_h1"/> + <embed href="text/sbasic/python/python_document_events.xhp#pythonmonitor"/> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_locations.xhp b/helpcontent2/source/text/sbasic/python/python_locations.xhp new file mode 100644 index 000000000..9f145416a --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_locations.xhp @@ -0,0 +1,72 @@ +<?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="pythonlocations" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Python Scripts Organization</title> + <filename>/text/sbasic/python/python_locations.xhp</filename> + </topic> + </meta> + <body> + <section id="pythonlocation"> + <paragraph id="hd_id391543358231021" role="heading" level="1" xml-lang="en-US"><variable id="pythonlocations1"><link href="text/sbasic/python/python_locations.xhp" name="command_name">Python Scripts Organization and Location</link></variable></paragraph> + <paragraph id="par_id481636114810038" role="paragraph" xml-lang="en-US">%PRODUCTNAME macros are grouped in module files, modules are usually grouped in library folders, and libraries are grouped in library containers although containers can contain modules too.</paragraph> + <paragraph role="paragraph" id="par_id771543358231022">A library is used as a major grouping for either an entire category of macros, or for an entire application. Modules usually split functionality, such as user interaction and calculations. Individual macros are subroutines and functions. The Figure below shows an example of the hierarchical structure of macro libraries in %PRODUCTNAME.</paragraph> + <paragraph role="image" id="par_id771636279690940"><image src="media/helpimg/sbasic/Library-Container.svg" id="img_id121636285791637" width="8cm" height="5.5cm"><alt id="alt_id471636279690940">Library Container diagram</alt></image></paragraph> + <paragraph role="paragraph" id="par_id171636114787810"><emph>Figure:</emph> Macro Library hierarchy</paragraph> + <paragraph role="paragraph" id="par_id801636114790638">The containers are accessible in all %PRODUCTNAME programs through the user interface. Go to <menuitem>Tools > Macros > Organize Macros > Python</menuitem>, to open the Python Macros dialog.</paragraph> + <paragraph role="paragraph" id="par_id801636114808666">Three library containers are shown in the Macro From list:</paragraph> + <list type="ordered"> + <listitem> + <paragraph id="par_id321636114854594" role="listitem"><emph>My Macros:</emph> personal macros available for the %PRODUCTNAME user</paragraph> + </listitem> + <listitem> + <paragraph id="par_id471636114847530" role="listitem"><emph>Application Macros:</emph> system macros distributed with %PRODUCTNAME for every computer user</paragraph> + </listitem> + <listitem> + <paragraph id="par_id191636114858218" role="listitem"><emph>Document macros:</emph> every document can contain macro libraries available in that document for all users</paragraph> + </listitem> + </list> + </section> + <h2 id="hd_id911544049584458">Python Script Locations</h2> + <paragraph id="par_id121551089455774" role="paragraph" xml-lang="en-US">Refer to <link href="text/sbasic/python/python_session.xhp" name="Getting Session Information">Getting Session Information</link> in order to get programmatic access to Python script locations.</paragraph> + <h3 id="hd_id591544049572647">Application Macros</h3> + <paragraph role="paragraph" id="par_id261544049064421">Existing macros in this location (container) were copied by the installation program and are available to every computer user, and any open document can access macros stored the container. You need administrative rights to store or edit macros here.</paragraph> + <paragraph role="paragraph" id="par_id861544210028670">The %PRODUCTNAME Macros container location in the file system depends on the operating system:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id191544210072242" role="listitem">For <emph>Windows</emph>: <literal>{Installation}\share\Scripts\python</literal>.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id61544210078654" role="listitem">For <emph>Linux</emph> and <emph>macOS</emph>: <literal>{Installation}/share/Scripts/python</literal>.</paragraph> + </listitem> + </list> + <h3 id="hd_id861544049692222">My Macros</h3> + <paragraph role="paragraph" id="par_id981544049055996">This container is accessible only by the %PRODUCTNAME user. Any open document can access macros stored the container. Macros in this location are stored in the %PRODUCTNAME user profile.</paragraph> + <paragraph role="paragraph" id="par_id341544210187846">The My Macros container location is in the user space and depends on the operating system:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id381544210213190" role="listitem">For <emph>Windows</emph>,<br/><literal>%APPDATA%\LibreOffice\4\user\Scripts\python</literal>.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id691544210219850" role="listitem">For <emph>Linux</emph> and <emph>macOS</emph>,<br/><literal>$HOME/.config/libreoffice/4/user/Scripts/python</literal>.</paragraph> + </listitem> + </list> + <h3 id="hd_id101544049707712">Document macros</h3> + <paragraph role="paragraph" id="par_id31544049046497">Document macros are embedded in the document and are accessible only when the document is open.</paragraph> + <h2 id="hd_id171544049715310">Libraries, Modules and Macros</h2> + <paragraph role="paragraph" id="par_id181544209916707">Python macros can be organized in libraries, modules and macros. Use the Macro Library hierarchy as a guide when creating or installing new macros in module files, new module files in library folders or new library folders in containers.</paragraph> + <section id="relatedtopics"> + <embed href="text/sbasic/python/python_session.xhp#pythonsession"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_platform.xhp b/helpcontent2/source/text/sbasic/python/python_platform.xhp new file mode 100644 index 000000000..364e067f3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_platform.xhp @@ -0,0 +1,129 @@ +<?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="text/sbasic/python/Python_Platform"> + <title id="tit" xml-lang="en-US">Python : Platform class</title> + <filename>/text/sbasic/python/python_platform.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0508"> + <bookmark_value>Platform;isLinux</bookmark_value> + <bookmark_value>Platform;isMacOsX</bookmark_value> + <bookmark_value>Platform;isWindows</bookmark_value> + <bookmark_value>Platform;ComputerName</bookmark_value> + <bookmark_value>Platform;OSName</bookmark_value> + <bookmark_value>API;ConfigurationAccess</bookmark_value> + <bookmark_value>Tools;GetRegistryContent</bookmark_value> + </bookmark> + <h1 id="N0509"><variable id="pythonplatform"><link href="text/sbasic/python/python_platform.xhp" name="platform01">Identifying the operating system</link></variable></h1> + <paragraph role="paragraph" id="N0510">Identifying the operating system can be performed with Python or Basic language.</paragraph> + <note id="N0511">ComputerName property is solely available for Windows. Basic calls to Python macros help overcome %PRODUCTNAME Basic limitations.</note> + <h2 id="N0512">Using a Python class:</h2> + <pycode> + <paragraph role="pycode" localize="false" id="N0513">import os, platform</paragraph> + <paragraph role="pycode" localize="false" id="N0514">class Platform():</paragraph> + <paragraph role="pycode" localize="false" id="N0515"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0516"> def ComputerName(self): return platform.node()</paragraph> + <paragraph role="pycode" localize="false" id="N0517"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0518"> def DirSeparator(self): return os.sep</paragraph> + <paragraph role="pycode" localize="false" id="N0519"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0520"> def isLinux(self): return (self.OSName=='Linux')</paragraph> + <paragraph role="pycode" localize="false" id="N0521"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0522"> def isMacOSX(self): return (self.OSName=='Darwin')</paragraph> + <paragraph role="pycode" localize="false" id="N0523"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0524"> def isWindows(self): return (self.OSName=='Windows')</paragraph> + <paragraph role="pycode" localize="false" id="N0525"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0526"> def OSName(self): return platform.system()</paragraph> + <paragraph role="pycode" localize="false" id="N0527"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0528"> def PathDelimiter(self): return os.pathsep</paragraph> + </pycode> + <h2 id="N0529">Using a Basic classmodule:</h2> + <tip id="NO529b">%PRODUCTNAME Basic lacks MacOS X native recognition. Platform identification is possible using %PRODUCTNAME Application Programming Interface (API).</tip> + <bascode> + <paragraph role="bascode" localize="false" id="N0530">Option Compatible</paragraph> + <paragraph role="bascode" localize="false" id="N0531">Option ClassModule</paragraph> + <paragraph role="bascode" localize="false" id="N0532">Option Explicit</paragraph> + <paragraph role="bascode" localize="false" id="N0533"></paragraph> + <paragraph role="bascode" localize="false" id="N0534">Public Property Get ComputerName As String</paragraph> + <paragraph role="bascode" localize="false" id="N0535"> If isWindows Then ComputerName = Environ("ComputerName")</paragraph> + <paragraph role="bascode" localize="false" id="N0536">End Property ' Platform.ComputerName</paragraph> + <paragraph role="bascode" localize="false" id="N0537"></paragraph> + <paragraph role="bascode" localize="false" id="N0538">Public Property Get DirSeparator As String</paragraph> + <paragraph role="bascode" localize="false" id="N0539"> DirSeparator = GetPathSeparator()</paragraph> + <paragraph role="bascode" localize="false" id="N0540">End Property ' Platform.DirSeparator</paragraph> + <paragraph role="bascode" localize="false" id="N0541"></paragraph> + <paragraph role="bascode" localize="false" id="N0542">Public Property Get IsLinux As Boolean</paragraph> + <paragraph role="bascode" localize="false" id="N0543"> isLinux = ( GetGUIType()=4 ) ' Applies to macOS as well </paragraph> + <paragraph role="bascode" localize="false" id="N0544">End Property ' Platform.isLinux</paragraph> + <paragraph role="bascode" localize="false" id="N0545"></paragraph> + <paragraph role="bascode" localize="false" id="M0542">Public Property Get IsMacOSX As Boolean</paragraph> + <paragraph role="bascode" localize="false" id="M0543"> isMacOSX = ( OSName="MAC" )</paragraph> + <paragraph role="bascode" localize="false" id="M0544">End Property ' Platform.isMacOSX</paragraph> + <paragraph role="bascode" localize="false" id="M0545"></paragraph> + <paragraph role="bascode" localize="false" id="N0546">Public Property Get IsWindows As Boolean</paragraph> + <paragraph role="bascode" localize="false" id="N0547"> isWindows = ( GetGUIType()=1 )</paragraph> + <paragraph role="bascode" localize="false" id="N0548">End Property ' Platform.isWindows</paragraph> + <paragraph role="bascode" localize="false" id="N0549"></paragraph> + <paragraph role="bascode" localize="false" id="N0550">Public Property Get OSName As String</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0451"> ' Return platform name as "MAC", "UNIX", "WIN"</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0551"> ' Inferred from "Tools.UCB.ShowHelperDialog" function</paragraph> + <paragraph role="bascode" localize="false" id="N0552"> With GlobalScope.Basiclibraries</paragraph> + <paragraph role="bascode" localize="false" id="M0552"> If Not .IsLibraryLoaded("Tools") Then .LoadLibrary("Tools")</paragraph> + <paragraph role="bascode" localize="false" id="O0552"> End With</paragraph> + <paragraph role="bascode" localize="false" id="N0553"> Dim keyNode As Object ' com.sun.star.configuration.ConfigurationAccess</paragraph> + <paragraph role="bascode" localize="false" id="M0553"> keyNode = Tools.Misc.GetRegistryKeyContent("org.openoffice.Office.Common/Help")</paragraph> + <paragraph role="bascode" localize="false" id="N0554"> OSName = keyNode.GetByName("System")</paragraph> + <paragraph role="bascode" localize="false" id="N0555">End Property ' Platform.OSName</paragraph> + <paragraph role="bascode" localize="false" id="N0556"></paragraph> + <paragraph role="bascode" localize="false" id="N0557">Public Property Get PathDelimiter As String</paragraph> + <paragraph role="bascode" localize="false" id="N0559"> Select Case OSName</paragraph> + <paragraph role="bascode" localize="false" id="N0560"> Case "MAC", "UNIX" : PathDelimiter = ":"</paragraph> + <paragraph role="bascode" localize="false" id="N0561"> Case "WIN" : PathDelimiter = ";"</paragraph> + <paragraph role="bascode" localize="false" id="N0562"> End Select</paragraph> + <paragraph role="bascode" localize="false" id="N0563">End Property ' Platform.PathDelimiter</paragraph> + </bascode> + <h2 id="N0564">Examples:</h2> + <paragraph role="paragraph" id="N0565">With Python</paragraph> + <paragraph role="paragraph" localize="false" id="N0566"><literal>>>> from <the_module> import Platform</literal></paragraph> + <paragraph role="paragraph" xml-lang="en-US" id="N0567"><literal>>>> print(Platform().isMacOSX) # object property</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0568"><literal>True</literal></paragraph> + <paragraph role="paragraph" xml-lang="en-US" id="N0569"><literal>>>> input(Platform().OSName) # object property</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0570"><literal>Darwin</literal></paragraph> + <paragraph role="paragraph" id="N0571"> + From <menuitem>Tools – Macros - Run Macro...</menuitem> menu.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="N0572">from <the_module> import Platform</paragraph> + <paragraph role="pycode" localize="false" id="N0573">import screen_io as ui</paragraph> + <paragraph role="pycode" localize="false" id="N0574">p = Platform()</paragraph> + <paragraph role="pycode" localize="false" id="N0575">ui.MsgBox(''.join(['isMacOS: ',str(p.isMacOSX)]),0,p.OSName)</paragraph> + </pycode> + <paragraph role="paragraph" id="N0576">With %PRODUCTNAME Basic</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="N0577">Sub Platform_example()</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0578"> Dim p As New Platform ' instance of Platform class</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0579"> MsgBox p.isLinux ' object property</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0580"> Print p.isWindows, p.OSName ' object properties</paragraph> + <paragraph role="bascode" localize="false" id="N0581">End Sub ' Platform_example</paragraph> + </bascode> + <section id="relatedtopics"> + <embed href="text/sbasic/python/python_screen.xhp#ioscreen"/> + <embed href="text/sbasic/shared/03132100.xhp#getguitype2"/> + <embed href="text/sbasic/shared/GetPathSeparator.xhp#getpathseparator01"/> +<!--WIP + <paragraph role="paragraph" id="N0585"> + <link href="text/sbasic/python/python_from_basic.xhp">Basic to Python function calls</link> + </paragraph>--> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + </section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/python/python_programming.xhp b/helpcontent2/source/text/sbasic/python/python_programming.xhp new file mode 100644 index 000000000..96deb8606 --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_programming.xhp @@ -0,0 +1,321 @@ +<?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="text/sbasic/python/Python_Programming"> + <title id="tit" xml-lang="en-US">Python : Programming with Python</title> + <filename>/text/sbasic/python/python_programming.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0218"> + <bookmark_value>Python;Programming</bookmark_value> + <bookmark_value>XSCRIPTCONTEXT;Python</bookmark_value> + <bookmark_value>XSCRIPTCONTEXT;getComponentContext()</bookmark_value> + <bookmark_value>uno.py</bookmark_value> + <bookmark_value>uno.py;getComponentContext()</bookmark_value> + </bookmark> + <section id="pythonprogramming"> + <h1 id="hd_id691546462755220"><variable id="pythonprogrammingheading"><link href="text/sbasic/python/python_programming.xhp" name="python programming">Programming with Python Scripts</link></variable></h1> + </section> + <paragraph role="paragraph" id="N0220">A Python macro is a function within a .py file, identified as a module. Unlike %PRODUCTNAME Basic and its dozen of <link href="text/sbasic/shared/uno_objects.xhp" name="UNO objects functions or services">UNO objects functions or services</link>, Python macros use the <literal>XSCRIPTCONTEXT</literal> UNO single object, shared with JavaScript and BeanShell. The <literal>g_exportedScripts</literal> global tuple explicitly lists selectable macros from a module. Python modules hold autonomous code logic, and are independent from one another.</paragraph> + <h2 id="N0221">XSCRIPTCONTEXT Global Variable</h2> + <paragraph role="paragraph" id="N0222">Genuine Basic UNO facilities can be inferred from <literal>XSCRIPTCONTEXT</literal> global variable. Refer to %PRODUCTNAME API for a complete <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1script_1_1provider_1_1XScriptContext.html" name="description of XSCRIPTCONTEXT">description of XSCRIPTCONTEXT</link>. <literal>XSCRIPTCONTEXT</literal> methods summarize as:</paragraph> + <table id="N0223"> + <tablerow> + <tablecell> + <paragraph role="tablehead" id="N0224">Methods</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablehead" id="N0225">Description</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablehead" id="N0226">Mapped in Basic as</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0227">getDocument()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0228">The document reference on which the script can operate.</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0229">ThisComponent</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0230">getDesktop()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0231">The desktop reference on which the script can operate.</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0232">StarDesktop</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0233">getComponentContext()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0234">The component context which the script can use to create other uno components.</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0235">GetDefaultContext</paragraph> + </tablecell> + </tablerow> + </table> + <paragraph role="paragraph" id="N0237"><emph>HelloWorld</emph> and <emph>Capitalise</emph> installation shared scripts illustrate UNO-related macros making use of <literal>XSCRIPTCONTEXT</literal> global variable.</paragraph> + <tip id="N0238">Python standard output file is not available when running Python macros from <menuitem>Tools - Macros - Run Macro</menuitem> menu. Refer to <emph>Input/Output to Screen</emph> for more information.</tip> + <h2 id="N0239">Module import</h2> + <warning id="N0240"><literal>XSCRIPTCONTEXT</literal> is not provided to imported modules.</warning> + <section id="PythonFileSystemImport" > + <paragraph role="paragraph" id="N0241">%PRODUCTNAME Basic libraries contain classes, routines and variables, Python modules contain classes, functions and variables. Common pieces of reusable Python or UNO features must be stored in <link href="text/sbasic/python/python_locations.xhp" name="My macros">My macros</link> within <literal>(User Profile)/Scripts/python/pythonpath</literal>. Python libraries help organize modules in order to prevent module name collisions. Import <literal>uno.py</literal> inside shared modules.</paragraph> + </section> + <paragraph role="paragraph" id="N0242">Genuine BASIC UNO facilities can be inferred using <literal>uno.py</literal> module. Use <link href="text/sbasic/python/python_shell.xhp" name="Python interactive shell">Python interactive shell</link> to get a complete module description using <literal>dir()</literal> and <literal>help()</literal> Python commands.</paragraph> + <table id="N0243"> + <tablerow> + <tablecell> + <paragraph role="tablehead" id="N0244">Functions</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablehead" id="N0245">Description</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablehead" id="N0246">Mapped in Basic as</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0247">absolutize()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0248">Returns an absolute file url from the given urls.</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0250">createUnoStruct()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0251">Creates a UNO struct or exception given by typeName.</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0252">CreateUNOStruct()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0253">fileUrlToSystemPath()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0254">Returns a system path.</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0255">ConvertFromURL()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0256">getClass()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0257">Returns the class of a concrete UNO exception, struct, or interface.</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0259">getComponentContext()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0260">Returns the UNO component context used to initialize the Python runtime.</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0261">GetDefaultContext()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0262">Enum()</paragraph> + <paragraph role="tablecontent" localize="false" id="N0263">getConstantByName()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0264">Looks up the value of an IDL constant by giving its explicit name.</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0265">See API constant groups</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0266">isInterface()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0267">Returns True, when obj is a class of a UNO interface.</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0269">systemPathToFileUrl()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="N0270">Returns a file URL for the given system path.</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0271">ConvertToURL()</paragraph> + </tablecell> + </tablerow> + </table> + <paragraph role="paragraph" id="N0272"><emph>LibreLogo</emph> and <emph>TableSample</emph> installation shared scripts use <literal>uno.py</literal> module.</paragraph> + <h2 id="N0273">More Python-Basic samples</h2> + <table id="N0274"> + <tablerow> + <tablecell> + <paragraph role="tablehead" id="N0275">Python UNO</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablehead" id="N0276">Basic UNO features</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0277">ctx = uno.getComponentContext()</paragraph> + <paragraph role="tablecontent" localize="false" id="N0278">smgr = ctx.getServiceManager()</paragraph> + <paragraph role="tablecontent" localize="false" id="N0279">obj = smgr.createInstanceWithContext( .. , ctx)</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0280">CreateUnoService()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" id="N0284">See <link href="text/sbasic/python/python_dialogs.xhp" name="Opening a Dialog">Opening a Dialog</link></paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0285">CreateUnoDialog()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" id="N0286">See <link href="text/sbasic/python/python_listener.xhp" name="Creating a Listener">Creating a Listener</link></paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0287">CreateUnoListener()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" id="N0288">See UNO data types</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0289">CreateUnoValue()</paragraph> + <paragraph role="tablecontent" localize="false" id="N0290">CreateObject()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0292">EqualUnoObjects()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0281">ctx = uno.getComponentContext()</paragraph> + <paragraph role="tablecontent" localize="false" id="N0282">smgr = ctx.getServiceManager()</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0283">GetProcessServiceManager()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0292">def hasUnoInterfaces(obj, *interfaces):</paragraph> + <paragraph role="tablecontent" localize="false" id="N0293">return set(interfaces).issubset(t.typeName for t in obj.Types)</paragraph> + <!-- Credits: + [Python]Equivalent 'supportsService' by Hubert Lambert + @ https://forum.openoffice.org/fr/forum/viewtopic.php?f=8&t=56597 + --> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0294">HasUnoInterfaces()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0296">IsUnoStruct()</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0297">ctx = uno.getComponentContext()</paragraph> + <paragraph role="tablecontent" localize="false" id="N0298">smgr = ctx.getServiceManager()</paragraph> + <paragraph role="tablecontent" localize="false" id="N0299">DESK = 'com.sun.star.frame.Desktop'</paragraph> + <paragraph role="tablecontent" localize="false" id="N0300">desktop = smgr.createInstanceWithContext(DESK , ctx)</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0301">StarDesktop</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0298">desktop = smgr.createInstanceWithContext(DESK , ctx)</paragraph> + <paragraph role="tablecontent" localize="false" id="N0299">doc = desktop.CurrentComponent</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="N0301">ThisComponent</paragraph> + </tablecell> + </tablerow> + </table> + <h2 id="N0297">Importing an embedded Module</h2> + <section id="PythonEmbeddedImport" > + <paragraph role="paragraph" id="N0298">Similarly to %PRODUCTNAME Basic that supports browsing and dynamic loading of libraries, Python libraries can be explored and imported on demand. For more information on library containers, visit <link href="https://api.libreoffice.org/" name="API Documentation site">%PRODUCTNAME Application Programming Interface</link> (API) or download <link href="https://www.libreoffice.org/download/download/" name="SDK download page">%PRODUCTNAME Software Development Kit</link> (SDK).</paragraph> + <paragraph role="paragraph" id="N0299">Importing a Python document embedded module is illustrated below, exception handling is not detailed:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="N0300">import uno, sys</paragraph> + <paragraph role="pycode" localize="false" id="N0301"></paragraph> + <paragraph role="pycode" localize="false" id="N0302">def load_library(library_name: str, module_name=None):</paragraph> + <paragraph role="pycode" id="N0303"> """ load library and import module</paragraph> + <paragraph role="pycode" localize="false" id="N0304"> </paragraph> + <paragraph role="pycode" id="N0305"> Adapted from 'Bibliothèque de fonctions' by Hubert Lambert</paragraph> + <paragraph role="pycode" id="N0306"> at https://forum.openoffice.org/fr/forum/viewtopic.php?p=286213"""</paragraph> + <paragraph role="pycode" id="N0307"> doc = XSCRIPTCONTEXT.getDocument() # current document</paragraph> + <paragraph role="pycode" localize="false" id="N0308"> url = uno.fileUrlToSystemPath( \</paragraph> + <paragraph role="pycode" localize="false" id="N0309"> '{}/{}'.format(doc.URL, 'Scripts/python'+library_name)) # ConvertToURL()</paragraph> + <paragraph role="pycode" id="N0310"> if not url in sys.path: # add path if necessary</paragraph> + <paragraph role="pycode" id="N0311"> sys.path.insert(0, url) # doclib takes precedence</paragraph> + <paragraph role="pycode" id="N0312"> if module_name: # import if requested</paragraph> + <paragraph role="pycode" localize="false" id="N0313"> return zipimport.zipimporter(url).load_module(module_name)</paragraph> + <paragraph role="pycode" localize="false" id="N0314"></paragraph> + <paragraph role="pycode" localize="false" id="N0315">def import_embedded_python():</paragraph> + <paragraph role="pycode" id="N0316"> ui = load_library("my_gui",'screen_io') # add <lib> path + import <module> </paragraph> + <paragraph role="pycode" localize="false" id="N0317"> ui.MsgBox(sys.modules.keys())</paragraph> + <paragraph role="pycode" localize="false" id="N0314"></paragraph> + <paragraph role="pycode" localize="false" id="N0319">g_exportedScripts = (import_embedded_python,) # Public macros</paragraph> + </pycode> + </section> + <section id="relatedtopics"> + <paragraph role="paragraph" id="N0321"><link href="text/sbasic/shared/uno_objects.xhp" name="UNO objects page">Basic UNO Objects, Functions and Services</link></paragraph> + <embed href="text/sbasic/python/python_import.xhp#pythonimporth1"/> + <embed href="text/sbasic/python/python_screen.xhp#ioscreen"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_screen.xhp b/helpcontent2/source/text/sbasic/python/python_screen.xhp new file mode 100644 index 000000000..b88fa923a --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_screen.xhp @@ -0,0 +1,108 @@ +<?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="text/sbasic/python/python_screen"> + <title id="tit">Python : Screen Input/Output</title> + <filename>/text/sbasic/python/python_screen.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" xml-lang="en-US" id="N0433"> + <bookmark_value>Python;InputBox</bookmark_value> + <bookmark_value>Python;MsgBox</bookmark_value> + <bookmark_value>Python;Print</bookmark_value> + <bookmark_value>API;script.provider.MasterScriptProvider: Screen Input/Output</bookmark_value> + <bookmark_value>API;script.provider.XScript: Screen Input/Output</bookmark_value> + </bookmark> + <h1 id="N0434"><variable id="ioscreen"><link href="text/sbasic/python/python_screen.xhp" name="IO to screen">Input/Output to Screen</link></variable></h1> + <paragraph role="paragraph" id="N0435">Python standard output file is not available when running Python macros from <menuitem>Tools – Macros - Run Macro</menuitem>... menu. Presenting the output of a module requires the Python interactive console. Features such as <literal>input()</literal>, <literal>print()</literal>, <literal>repr()</literal> and <literal>str()</literal> are available from the Python shell.</paragraph> + <paragraph role="tip" id="N0436">The <link href="https://extensions.libreoffice.org/extensions/apso-alternative-script-organizer-for-python" name="apso">Alternative Python Script Organizer</link> (APSO) extension offers a msgbox() function out of its <literal>apso_utils</literal> module.</paragraph> + <paragraph role="paragraph" id="N0437">%PRODUCTNAME Basic proposes <literal>InputBox()</literal>, <literal>Msgbox()</literal> and <literal>Print()</literal> screen I/O functions. Python alternatives exist relying either on %PRODUCTNAME API Abstract Windowing Toolkit, either on Python to Basic function calls. The latter proposes a syntax that is intentionally close to that of Basic, and uses a Python module next to a Basic module. The API Scripting Framework is used to perform Basic, BeanShell, JavaScript and Python inter-languages function calls.</paragraph> + <h2 id="N0438">Python syntax:</h2> + <paragraph role="code" id="N0439" localize="false">MsgBox(txt, buttons=0, title=None)<br/></paragraph> + <paragraph role="code" id="N0440" localize="false">InputBox(txt, title=None, default=None)<br/></paragraph> + <paragraph role="code" id="N0441" localize="false">Print(txt)</paragraph> + <h2 id="N0442">Examples:</h2> + <paragraph role="paragraph" localize="false" id="N0443"><literal>>>> import screen_io as ui</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0445"><literal>>>> reply = ui.InputBox('Please enter a phrase', title='Dear user', defaultValue="here..")</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0446"><literal>>>> rc = ui.MsgBox(reply, title="Confirmation of phrase")</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0447"><literal>>>> age = ui.InputBox('How old are you?', title="Hi")</literal></paragraph> + <paragraph role="paragraph" localize="false" id="N0448"><literal>>>> ui.Print(age)</literal></paragraph> + <h2 id="N0449">Installation:</h2> + <list type="unordered"> + <listitem> + <paragraph role="listitem" id="N0450">Copy <literal>screen_io</literal> Python module in <link href="text/sbasic/python/python_locations.xhp" name="User macros">My macros</link> within <UserProfile>/Scripts/python/pythonpath,</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="N0451">Copy <literal>uiScripts</literal> Basic module in <link href="text/sbasic/python/python_locations.xhp" name="User macros">My macros</link> Standard Basic library,</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="N0452">Restart %PRODUCTNAME.</paragraph> + </listitem> + </list> + <h3 id="N0453"><literal>screen_io</literal> Python module</h3> + <pycode> + <paragraph role="pycode" localize="false" id="N0454"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" localize="false" id="N0455">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" localize="false" id="N0456"></paragraph> + <paragraph role="pycode" localize="false" id="N0466">def MsgBox(prompt: str, buttons=0, title='LibreOffice') -> int:</paragraph> + <paragraph role="pycode" id="N0467"> """ Displays a dialog box containing a message and returns a value."""</paragraph> + <paragraph role="pycode" localize="false" id="N0468"> xScript = _getScript("_MsgBox")</paragraph> + <paragraph role="pycode" localize="false" id="N0469"> res = xScript.invoke((prompt,buttons,title), (), ())</paragraph> + <paragraph role="pycode" localize="false" id="N0470"> return res[0]</paragraph> + <paragraph role="pycode" localize="false" id="N0471"></paragraph> + <paragraph role="pycode" localize="false" id="N0472">def InputBox(prompt: str, title='LibreOffice', defaultValue='') -> str:</paragraph> + <paragraph role="pycode" id="N0473"> """ Displays a prompt in a dialog box at which the user can enter text."""</paragraph> + <paragraph role="pycode" localize="false" id="N0474"> xScript = _getScript("_InputBox")</paragraph> + <paragraph role="pycode" localize="false" id="N0475"> res = xScript.invoke((prompt,title,defaultValue), (), ())</paragraph> + <paragraph role="pycode" localize="false" id="N0476"> return res[0]</paragraph> + <paragraph role="pycode" localize="false" id="N0477"></paragraph> + <paragraph role="pycode" localize="false" id="N0478">def Print(message: str):</paragraph> + <paragraph role="pycode" id="N0479"> """Outputs the specified strings or numeric expressions in a dialog box."""</paragraph> + <paragraph role="pycode" localize="false" id="N0480"> xScript = _getScript("_Print")</paragraph> + <paragraph role="pycode" localize="false" id="N0481"> xScript.invoke((message,), (), ())</paragraph> + <paragraph role="pycode" localize="false" id="N0482"></paragraph> + <paragraph role="pycode" localize="false" id="N0483">import uno</paragraph> + <paragraph role="pycode" localize="false" id="N0484">from com.sun.star.script.provider import XScript</paragraph> + <paragraph role="pycode" localize="false" id="N0485">def _getScript(script: str, library='Standard', module='uiScripts') -> XScript:</paragraph> + <paragraph role="pycode" localize="false" id="N0486"> sm = uno.getComponentContext().ServiceManager</paragraph> + <paragraph role="pycode" localize="false" id="N0487"> mspf = sm.createInstanceWithContext("com.sun.star.script.provider.MasterScriptProviderFactory", uno.getComponentContext())</paragraph> + <paragraph role="pycode" localize="false" id="N0488"> scriptPro = mspf.createScriptProvider("")</paragraph> + <paragraph role="pycode" localize="false" id="N0489"> scriptName = "vnd.sun.star.script:"+library+"."+module+"."+script+"?language=Basic&location=application"</paragraph> + <paragraph role="pycode" localize="false" id="N0490"> xScript = scriptPro.getScript(scriptName)</paragraph> + <paragraph role="pycode" localize="false" id="N0491"> return xScript</paragraph> + </pycode> + <h3 id="N0492"><literal>uiScripts</literal> Basic module</h3> + <bascode> + <paragraph role="bascode" localize="false" id="N0493">Option Explicit</paragraph> + <paragraph role="bascode" localize="false" id="N0494">Private Function _MsgBox( prompt As String, Optional buttons As Integer, _</paragraph> + <paragraph role="bascode" localize="false" id="N0495"> Optional title As String ) As Integer</paragraph> + <paragraph role="bascode" localize="false" id="N0496"> _MsgBox = MsgBox( prompt, buttons, title )</paragraph> + <paragraph role="bascode" localize="false" id="N0497">End Function</paragraph> + <paragraph role="bascode" localize="false" id="N0498">Private Function _InputBox( prompt As String, Optional title As String, _</paragraph> + <paragraph role="bascode" localize="false" id="N0499"> Optional default As String) As String</paragraph> + <paragraph role="bascode" localize="false" id="N0500"> _InputBox = InputBox( prompt, title, default )</paragraph> + <paragraph role="bascode" localize="false" id="N0501">End Function</paragraph> + <paragraph role="bascode" localize="false" id="N0502">Private Sub _Print( msg As String )</paragraph> + <paragraph role="bascode" localize="false" id="N0503"> Print msg</paragraph> + <paragraph role="bascode" localize="false" id="N0504">End Sub</paragraph> + </bascode> + <section id="relatedtopics"> + <!-- + <paragraph role="paragraph" id="N0505"><link href="text/sbasic/python/python_2_basic.xhp" name="Calling Basic macros from Python">Calling Basic macros from Python</link></paragraph> + --> + <embed href="text/sbasic/shared/03010000.xhp#BasicScreenIO"/> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + <embed href="text/sbasic/python/python_2_basic.xhp#py2ba_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_session.xhp b/helpcontent2/source/text/sbasic/python/python_session.xhp new file mode 100644 index 000000000..f8c378dee --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_session.xhp @@ -0,0 +1,158 @@ +<?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="text/sbasic/python/python_session"> + <title id="tit" xml-lang="en-US">Python_Session : Session class</title> + <filename>/text/sbasic/python/python_session.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0339"> + <bookmark_value>Session;UserName</bookmark_value> + <bookmark_value>Session;SharedScripts</bookmark_value> + <bookmark_value>Session;SharedPythonScripts</bookmark_value> + <bookmark_value>Session;UserProfile</bookmark_value> + <bookmark_value>Session;UserScripts</bookmark_value> + <bookmark_value>Session;UserPythonScripts</bookmark_value> + <bookmark_value>API;PathSubstitution</bookmark_value> + </bookmark> + <h1 id="N0340"><variable id="pythonsession"><link href="text/sbasic/python/python_session.xhp" name="session01">Getting Session Information</link></variable></h1> + <paragraph role="paragraph" id="N0341">Computing %PRODUCTNAME user profile and shared modules system file paths can be performed with Python or with Basic languages. BeanShell, Java, JavaScript and Python scripts locations can be derived from this information.</paragraph> + <h2 id="N0343">Examples:</h2> + <paragraph role="paragraph" id="N0344">With Python shell.</paragraph> + <paragraph role="paragraph" localize="false" id="N0345"><literal>>>> from <the_module> import Session</literal></paragraph> + <paragraph role="paragraph" xml-lang="en-US" id="N0346"><literal>>>> print(Session.SharedPythonScripts()) # static method</literal></paragraph> + <paragraph role="paragraph" xml-lang="en-US" id="N0347"><literal>>>> print(Session().UserName) # object property</literal></paragraph> + <paragraph role="paragraph" xml-lang="en-US" id="N0348"><literal>>>> input(Session().UserProfile) # object property</literal></paragraph> + <h3 id="N0349">From <menuitem>Tools – Macros - Run Macro</menuitem>... menu.</h3> + <pycode> + <paragraph role="pycode" localize="false" id="N0350">from <the_module> import Session</paragraph> + <paragraph role="pycode" localize="false" id="N0351"> </paragraph> + <paragraph role="pycode" localize="false" id="N0352">def demo_session():</paragraph> + <paragraph role="pycode" localize="false" id="N0353"> import screen_io as ui</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0354"> ui.MsgBox(Session.Share(),title='Installation Share') # static method</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0355"> ui.Print(Session.SharedPythonScripts()) # static method</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0356"> s = Session() # instance creation</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0357"> ui.MsgBox(s.UserName,title='Hello') # object property</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0358"> ui.Print(s.UserPythonScripts) # object property</paragraph> + <paragraph role="pycode" localize="false" id="N0359"> </paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0360">g_exportedScripts = (demo_session,) # public macros</paragraph> + </pycode> + <h3 id="N0361">With %PRODUCTNAME Basic.</h3> + <bascode> + <paragraph role="bascode" localize="false" id="N0362">Sub Session_example()</paragraph> + <paragraph role="bascode" localize="false" id="N0363"> Dim s As New Session ' instance of Session class</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0364"> Print "Shared scripts location:", s.SharedScripts</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0365"> MsgBox s.UserName,,"Hello"</paragraph> + <paragraph role="bascode" localize="false" id="N0366"> Print s.UserScripts, Chr(13), s.UserPythonScripts</paragraph> + <paragraph role="bascode" localize="false" id="N0367">End Sub ' Session_example</paragraph> + </bascode> + <h3 id="N0368">Using COM/OLE and Visual Basic Scripting language.</h3> + <bascode> + <paragraph role="bascode" xml-lang="en-US" id="N0369">' The service manager is always the entry point</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0370">' If there is no office running then an office is started up</paragraph> + <paragraph role="bascode" localize="false" id="N0371">Set sm = WScript.CreateObject("com.sun.star.ServiceManager")</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0372">' PathSubstitution service exhibits information to infer</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0373">' <UserProfile|Share>/Scripts/python locations from</paragraph> + <paragraph role="bascode" localize="false" id="N0374">Set obj = sm.createInstance("com.sun.star.util.PathSubstitution")</paragraph> + <paragraph role="bascode" localize="false" id="N0375"> </paragraph> + <paragraph role="bascode" localize="false" id="N0376">MsgBox CreateObject("WScript.Network").UserName,, "Hello"</paragraph> + <paragraph role="bascode" localize="false" id="N0377">user = obj.getSubstituteVariableValue("$(user)")</paragraph> + <paragraph role="bascode" localize="false" id="N0378">MsgBox user & "/Scripts",, "User scripts location"</paragraph> + <paragraph role="bascode" localize="false" id="N0379">libO = Replace(obj.getSubstituteVariableValue("$(inst)"), "program/..", "Share")</paragraph> + <paragraph role="bascode" localize="false" id="N0380">MsgBox libO & "/Scripts",, "Shared scripts location"</paragraph> + </bascode> + <h2 id="N0381">Python Session class:</h2> + <pycode> + <paragraph role="pycode" localize="false" id="N0382">import getpass, os, os.path, uno</paragraph> + <paragraph role="pycode" localize="false" id="N0383"> </paragraph> + <paragraph role="pycode" localize="false" id="N0384">class Session():</paragraph> + <paragraph role="pycode" localize="false" id="N0385"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0386"> def substitute(var_name):</paragraph> + <paragraph role="pycode" localize="false" id="N0387"> ctx = uno.getComponentContext()</paragraph> + <paragraph role="pycode" localize="false" id="N0388"> ps = ctx.getServiceManager().createInstanceWithContext(</paragraph> + <paragraph role="pycode" localize="false" id="N0389"> 'com.sun.star.util.PathSubstitution', ctx)</paragraph> + <paragraph role="pycode" localize="false" id="N0390"> return ps.getSubstituteVariableValue(var_name)</paragraph> + <paragraph role="pycode" localize="false" id="N0391"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0392"> def Share():</paragraph> + <paragraph role="pycode" localize="false" id="N0393"> inst = uno.fileUrlToSystemPath(Session.substitute("$(prog)"))</paragraph> + <paragraph role="pycode" localize="false" id="N0394"> return os.path.normpath(inst.replace('program', "Share"))</paragraph> + <paragraph role="pycode" localize="false" id="N0395"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0396"> def SharedScripts():</paragraph> + <paragraph role="pycode" localize="false" id="N0397"> return ''.join([Session.Share(), os.sep, "Scripts"])</paragraph> + <paragraph role="pycode" localize="false" id="N0398"> @staticmethod</paragraph> + <paragraph role="pycode" localize="false" id="N0399"> def SharedPythonScripts():</paragraph> + <paragraph role="pycode" localize="false" id="N0400"> return ''.join([Session.SharedScripts(), os.sep, 'python'])</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="N0401"> @property # alternative to '$(username)' variable</paragraph> + <paragraph role="pycode" localize="false" id="N0402"> def UserName(self): return getpass.getuser()</paragraph> + <paragraph role="pycode" localize="false" id="N0403"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0404"> def UserProfile(self):</paragraph> + <paragraph role="pycode" localize="false" id="N0405"> return uno.fileUrlToSystemPath(Session.substitute("$(user)"))</paragraph> + <paragraph role="pycode" localize="false" id="N0406"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0407"> def UserScripts(self):</paragraph> + <paragraph role="pycode" localize="false" id="N0408"> return ''.join([self.UserProfile, os.sep, 'Scripts'])</paragraph> + <paragraph role="pycode" localize="false" id="N0409"> @property</paragraph> + <paragraph role="pycode" localize="false" id="N0410"> def UserPythonScripts(self):</paragraph> + <paragraph role="pycode" localize="false" id="N0411"> return ''.join([self.UserScripts, os.sep, "python"])</paragraph> + </pycode> + <note id="N0342">Unlike Basic, pathname normalization is performed with Python inside Session class.</note> + <h2 id="N0412">%PRODUCTNAME Basic Session class:</h2> + <bascode> + <paragraph role="bascode" localize="false" id="N0413">Option Explicit</paragraph> + <paragraph role="bascode" localize="false" id="N0414">Option Compatible</paragraph> + <paragraph role="bascode" localize="false" id="N0415">Option ClassModule</paragraph> + <paragraph role="bascode" localize="false" id="N0416"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0417">Private _ps As Object ' Private member</paragraph> + <paragraph role="bascode" localize="false" id="N0418"> </paragraph> + <paragraph role="bascode" localize="false" id="N0419">Private Sub Class_Initialize()</paragraph> + <paragraph role="bascode" localize="false" id="N0420"> GlobalScope.BasicLibraries.LoadLibrary("Tools")</paragraph> + <paragraph role="bascode" localize="false" id="N0421"> Set _ps = CreateUnoService("com.sun.star.util.PathSubstitution")</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0422">End Sub ' Constructor</paragraph> + <paragraph role="bascode" localize="false" id="N0423"> </paragraph> + <paragraph role="bascode" localize="false" id="N0424">Private Sub Class_Terminate()</paragraph> + <paragraph role="bascode" localize="false" id="N0425"> _ps = Nothing</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0426">End Sub ' Destructor</paragraph> + <paragraph role="bascode" localize="false" id="N0427"> </paragraph> + <paragraph role="bascode" localize="false" id="N0428">Public Property Get SharedScripts() As String</paragraph> + <paragraph role="bascode" localize="false" id="N0429"> Dim inst As String, shr As String</paragraph> + <paragraph role="bascode" localize="false" id="N0430"> inst = ConvertFromURL(_ps.getSubstituteVariableValue("$(prog)"))</paragraph> + <paragraph role="bascode" localize="false" id="N0431"> shr = Tools.Strings.ReplaceString(inst,"Share","program")</paragraph> + <paragraph role="bascode" localize="false" id="N0432"> SharedScripts = shr & GetPathSeparator() &"Scripts"</paragraph> + <paragraph role="bascode" localize="false" id="N0433">End Property ' Session.sharedScripts</paragraph> + <paragraph role="bascode" localize="false" id="N0434"> </paragraph> + <paragraph role="bascode" localize="false" id="N0435">Public Property Get SharedPythonScripts() As String</paragraph> + <paragraph role="bascode" localize="false" id="N0436"> sharedPythonScripts = sharedScripts() & GetPathSeparator() &"python"</paragraph> + <paragraph role="bascode" localize="false" id="N0437">End Property ' Session.sharedPythonScripts</paragraph> + <paragraph role="bascode" localize="false" id="N0438"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0439">Public Property Get UserName() As String ' User account name </paragraph> + <paragraph role="bascode" localize="false" id="N0440"> userName = _ps.getSubstituteVariableValue("$(username)")</paragraph> + <paragraph role="bascode" localize="false" id="N0441">End Property ' Session.userName</paragraph> + <paragraph role="bascode" localize="false" id="N0442"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0443">Public Property Get UserProfile() As String ' User profile system path</paragraph> + <paragraph role="bascode" localize="false" id="N0444"> userProfile = ConvertFromURL(_ps.getSubstituteVariableValue("$(user)"))</paragraph> + <paragraph role="bascode" localize="false" id="N0445">End Property ' Session.userProfile</paragraph> + <paragraph role="bascode" localize="false" id="N0446"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0447">Public Property Get UserScripts() As String ' User scripts system path</paragraph> + <paragraph role="bascode" localize="false" id="N0448"> userScripts = userProfile() & GetPathSeparator() &"Scripts"</paragraph> + <paragraph role="bascode" localize="false" id="N0449">End Property ' Session.userScripts</paragraph> + <paragraph role="bascode" localize="false" id="N0450"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0451">Public Property Get UserPythonScripts() As String ' User Python scripts system path</paragraph> + <paragraph role="bascode" localize="false" id="N0452"> userPythonScripts = userScripts() & GetPathSeparator() &"python"</paragraph> + <paragraph role="bascode" localize="false" id="N0453">End Property ' Session.userPythonScripts</paragraph> + </bascode> + <section id="relatedtopics"> + <embed href="text/sbasic/python/python_locations.xhp#pythonlocations1"/> + <embed href="text/sbasic/python/python_import.xhp#pythonimporth1"/> + <embed href="text/sbasic/python/python_screen.xhp#ioscreen"/> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/python/python_shell.xhp b/helpcontent2/source/text/sbasic/python/python_shell.xhp new file mode 100644 index 000000000..52cea354a --- /dev/null +++ b/helpcontent2/source/text/sbasic/python/python_shell.xhp @@ -0,0 +1,81 @@ +<?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="python_shell" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Python Interactive Shell</title> + <filename>/text/sbasic/python/python_shell.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0117"> + <bookmark_value>Python console</bookmark_value> + <bookmark_value>Python Interactive Shell</bookmark_value> + </bookmark> + <section id="pythonshell"> + <h1 id="N0118"><variable id="pythonshell1"><link href="text/sbasic/python/python_shell.xhp" name="python shell">Running Python Interactive Console</link></variable></h1> + </section> + <paragraph role="paragraph" id="N0119">The Python interactive console, also known as Python interpreter or Python shell, provides programmers with a quick way to execute commands and try out and test code without creating a file. UNO objects introspection as well as %PRODUCTNAME Python modules documentation can be obtained from the terminal.</paragraph> + + <note id="par_id851633601202270">From a full-featured %PRODUCTNAME installed package, use either Basic or Python:</note> + <h2 id="N0121">Using a Basic macro</h2> + <bascode> + <paragraph role="bascode" id="N0122" localize="false">Sub interpreter_console</paragraph> + <paragraph role="bascode" id="bas_id731633624333087" localize="false"> Const UNIX = 4</paragraph> + <paragraph role="bascode" id="N0123" localize="false"> ps = CreateUnoService("com.sun.star.util.PathSettings")</paragraph> + <paragraph role="bascode" id="N0124" localize="false"> install_path = ConvertFromURL(ps.Module)</paragraph> + <paragraph role="bascode" id="bas_id461633624179286" localize="false"> cmd = IIF(GetGuiType()=UNIX,"x-terminal-emulator -e ","")</paragraph> + <paragraph role="bascode" id="N0125" localize="false"> Shell(cmd + install_path + GetPathSeparator() + "python" )</paragraph> + <paragraph role="bascode" id="N0126" localize="false">End Sub</paragraph> + </bascode> + + <h2 id="N0127">Using a Python macro</h2> + <pycode> + <paragraph role="pycode" id="N0128" localize="false"># -*- coding: utf-8 -*-</paragraph> + <paragraph role="pycode" id="N0129" localize="false">from __future__ import unicode_literals</paragraph> + <paragraph role="pycode" id="N0130" localize="false"> </paragraph> + <paragraph role="pycode" id="N0131" localize="false">import uno, os, subprocess</paragraph> + <paragraph role="pycode" id="N0132" localize="false"> </paragraph> + <paragraph role="pycode" id="N0133" localize="false">def interpreter_console():</paragraph> + <paragraph role="pycode" id="N0134" localize="false"> ctx = XSCRIPTCONTEXT.getComponentContext()</paragraph> + <paragraph role="pycode" id="N0135" localize="false"> smgr = ctx.getServiceManager()</paragraph> + <paragraph role="pycode" id="N0136" localize="false"> ps = smgr.createInstanceWithContext("com.sun.star.util.PathSettings", ctx)</paragraph> + <paragraph role="pycode" id="N0137" localize="false"> install_path = uno.fileUrlToSystemPath(ps.Module)</paragraph> + <paragraph role="pycode" id="N0138" localize="false"> pgm = install_path + os.sep + "python" # Python shell/console path</paragraph> + <paragraph role="pycode" id="N0139" localize="false"> subprocess.Popen(pgm) # Start Python interactive Shell</paragraph> + <paragraph role="pycode" id="N0140" localize="false"> </paragraph> + </pycode> + <h3 id="N0141">Example output</h3> + <paragraph role="paragraph" id="N0142"> + <image src="media/helpimg/python/python_interactive_console.png" id="N0143"><alt id="N0143">Python Interactive Console</alt></image> + </paragraph> + + <switch select="sys"> + <case select="UNIX"> + <h2 id="hd_id381633446811095">Using the Terminal</h2> + <note id="par_id801633601715910">From a %PRODUCTNAME copy included in a GNU/Linux platform, use the terminal as shown:</note> + <paragraph role="paragraph" id="par_id531633444780190"><literal>whereis</literal> or <literal>type</literal> terminal commands help locate Python interactive console:</paragraph> + <paragraph role="paragraph" id="par_id871633361808210" localize="false"><br/><input>user@computer:~$ </input><emph>type -p python3</emph><br/><input>/usr/bin/python3</input><br/> <input>user@computer:~$ </input><emph>/usr/bin/python3</emph><br/> <input>Python 3.7.5 (default, Nov 20 2019, 09:21:52)</input><br/><input>[GCC 9.2.1 20191008] on linux</input><br/><input>Type "help", "copyright", "credits" or "license" for more information.</input><br/><input>>>> </input><emph>import uno</emph><br/><input>>>> </input><emph>dir(uno)</emph><br/><input>['Any', 'Bool', 'ByteSequence', 'Char', 'Enum', 'PY2', 'Type', '_ConstantGroup', '__builtin__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', '_builtin_import', '_component_context', '_impl_getConstantGroupByName', '_uno_extract_printable_stacktrace', '_uno_import', '_uno_struct__eq__', '_uno_struct__getattr__', '_uno_struct__init__', '_uno_struct__ne__', '_uno_struct__repr__', '_uno_struct__setattr__', '_uno_struct__str__', 'absolutize', 'createUnoStruct', 'fileUrlToSystemPath', 'generateUuid', 'getClass', 'getComponentContext', 'getConstantByName', 'getCurrentContext', 'getTypeByName', 'invoke', 'isInterface', 'os', 'pyuno', 'setCurrentContext', 'six_string_types', 'socket', 'sys', 'systemPathToFileUrl', 'traceback', 'warnings']</input><br/><input>>>> </input><emph>exit()</emph><br/><input>user@computer:~$</input></paragraph> + </case> + </switch> + + <h2 id="hd_id311633513620803">Alternative console</h2> + <paragraph role="paragraph" id="par_id81632760673283">Use <link href="https://extensions.libreoffice.org/extensions/apso-alternative-script-organizer-for-Python" name="APSO extension">APSO extension</link> console as an alternative:</paragraph> + <paragraph role="paragraph" id="N0144"> + <image src="media/helpimg/python/python_shell.png" id="N0144"><alt id="N0144">APSO console</alt></image> + </paragraph> + <section id="relatedtopics"> + <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + <paragraph role="paragraph" id="par_id351633599611244"><link href="text/sbasic/shared/03/sf_exception.xhp?#PythonShell" name="PythonShell method"><literal>PythonShell</literal></link> function in <link href="text/sbasic/shared/03/sf_exception.xhp" name="ScriptForge.Exception service"><literal>ScriptForge.Exception</literal></link> service</paragraph> + + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/00000002.xhp b/helpcontent2/source/text/sbasic/shared/00000002.xhp new file mode 100644 index 000000000..295664a71 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/00000002.xhp @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared00000002xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">$[officename] Basic Glossary</title> +<filename>/text/sbasic/shared/00000002.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<h1 id="hd_id3145068"><link href="text/sbasic/shared/00000002.xhp" name="$[officename] Basic Glossary">$[officename] Basic Glossary</link></h1> +<paragraph role="paragraph" id="par_id3150792" xml-lang="en-US">This glossary explains some technical terms that you may come across when working with $[officename] Basic.</paragraph> +<sort order="asc" descendant="h2"> +<section id="dezimal"> +<h2 id="hd_id3155133">Decimal Point</h2> +<paragraph role="paragraph" id="par_id3156443" xml-lang="en-US">When converting numbers, $[officename] Basic uses the locale settings of the system for determining the type of decimal and thousand separator.</paragraph> +<paragraph role="paragraph" id="par_id3153092" xml-lang="en-US">The behavior has an effect on both the implicit conversion ( 1 + "2.3" = 3.3 ) as well as the function <link href="text/sbasic/shared/03102700.xhp" name="IsNumeric">IsNumeric</link>.</paragraph> +</section> +<section id="colors"> +<h2 id="hd_id3155854">Colors</h2> +<paragraph role="paragraph" id="par_id3145366" xml-lang="en-US">In $[officename] Basic, colors are treated as long integer value. The return value of color queries is also always a long integer value. When defining properties, colors can be specified using their RGB code that is converted to a long integer value using the <link href="text/sbasic/shared/03010305.xhp" name="RGB function">RGB function</link>.</paragraph> +</section> +<section id="measurementunits"> +<h2 id="hd_id3146119">Measurement Units</h2> +<paragraph role="paragraph" id="par_id3154013" xml-lang="en-US">In $[officename] Basic, a <emph>method parameter</emph> or a <emph>property</emph> expecting unit information can be specified either as integer or long integer expression without a unit, or as a character string containing a unit. If no unit is passed to the method the default unit defined for the active document type will be used. If the parameter is passed as a character string containing a measurement unit, the default setting will be ignored. The default measurement unit for a document type can be set under <switchinline select="sys"><caseinline select="MAC"><emph>%PRODUCTNAME - Preferences</emph></caseinline><defaultinline><emph>Tools - Options</emph></defaultinline></switchinline><emph> - (Document Type) - General</emph>.</paragraph> +</section> +<section id="twips"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145801"><bookmark_value>twips; definition</bookmark_value> +</bookmark> +<h2 id="hd_id3145801">Twips</h2> +<paragraph role="paragraph" id="par_id3154731" xml-lang="en-US">A twip is a screen-independent unit which is used to define the uniform position and size of screen elements on all display systems. A twip is 1/1440th of an inch or 1/20 of a printer's point. There are 1440 twips to an inch or about 567 twips to a centimeter.</paragraph> +</section> +<section id="urlnotation"> +<h2 id="hd_id3153159">URL Notation</h2> +<paragraph role="paragraph" id="par_id3153415" xml-lang="en-US">URLs (<emph>Uniform Resource Locators</emph>) are used to determine the location of a resource like a file in a file system, typically inside a network environment. A URL consists of a protocol specifier, a host specifier and a file and path specifier:</paragraph> +<paragraph role="paragraph" id="par_id3149121" xml-lang="en-US"> +<emph>protocol</emph>://<emph>host.name</emph>/<emph>path/to/the/file.html</emph> +</paragraph> +<paragraph role="paragraph" id="par_id3168612" xml-lang="en-US">The most common usage of URLs is on the internet when specifying web pages. Example for protocols are <emph>http</emph>, <emph>ftp</emph>, or <emph>file</emph>. The <emph>file</emph> protocol specifier is used when referring to a file on the local file system.</paragraph> +<paragraph role="paragraph" id="par_id3150324" xml-lang="en-US">URL notation does not allow certain special characters to be used. These are either replaced by other characters or encoded. A slash (<emph>/</emph>) is used as a path separator. For example, a file referred to as <emph>C:\Users\alice\Documents\My File.odt</emph> on the local host in "Windows notation" becomes <emph>file:///C:/Users/alice/Documents/My%20File.odt</emph> in URL notation.</paragraph> +</section> +</sort> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/00000003.xhp b/helpcontent2/source/text/sbasic/shared/00000003.xhp new file mode 100644 index 000000000..05b579478 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/00000003.xhp @@ -0,0 +1,352 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> +<meta> + <topic id="textsbasicshared00000003xml" indexer="exclude" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Information</title> + <filename>/text/sbasic/shared/00000003.xhp</filename> + </topic> +</meta> +<body> +<h1 id="hd_id3148550">Information</h1> +<section id="languageformat"> +<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US">You can set the locale used for controlling the formatting numbers, dates and currencies in $[officename] Basic in <switchinline select="sys"><caseinline select="MAC"><emph>%PRODUCTNAME - Preferences</emph> +</caseinline><defaultinline><emph>Tools - Options</emph></defaultinline></switchinline><emph> - Language Settings - Languages</emph>. In Basic format codes, the decimal point (<emph>.</emph>) is always used as <emph>placeholder</emph> for the decimal separator defined in your locale and will be replaced by the corresponding character.</paragraph> +<paragraph id="par_id3150870" role="paragraph" xml-lang="en-US">The same applies to the locale settings for date, time and currency formats. The Basic format code will be interpreted and displayed according to your locale setting.</paragraph> +</section> +<section id="colorcodes"> +<paragraph id="par_id3156424" role="paragraph" xml-lang="en-US">The color values of the 16 basic colors are as follows:</paragraph> +<table id="tbl_id3147434"> + <tablerow> + <tablecell> + <paragraph id="par_id3153091" role="tablehead" xml-lang="en-US"><emph>Color Value</emph></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154319" role="tablehead" xml-lang="en-US"><emph>Color Name</emph></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3151112" role="tablecontent" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155854" role="tablecontent" xml-lang="en-US">Black</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3154942" role="tablecontent" xml-lang="en-US">128</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154731" role="tablecontent" xml-lang="en-US">Blue</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3145645" role="tablecontent" xml-lang="en-US">32768</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3149400" role="tablecontent" xml-lang="en-US">Green</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150753" role="tablecontent" xml-lang="en-US">32896</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153765" role="tablecontent" xml-lang="en-US">Cyan</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3154756" role="tablecontent" xml-lang="en-US">8388608</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3159266" role="tablecontent" xml-lang="en-US">Red</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3163807" role="tablecontent" xml-lang="en-US">8388736</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145150" role="tablecontent" xml-lang="en-US">Magenta</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3147002" role="tablecontent" xml-lang="en-US">8421376</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3152778" role="tablecontent" xml-lang="en-US">Yellow</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150088" role="tablecontent" xml-lang="en-US">8421504</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3159239" role="tablecontent" xml-lang="en-US">White</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150206" role="tablecontent" xml-lang="en-US">12632256</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3149817" role="tablecontent" xml-lang="en-US">Gray</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150363" role="tablecontent" xml-lang="en-US">255</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154576" role="tablecontent" xml-lang="en-US">Light blue</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3150367" role="tablecontent" xml-lang="en-US">65280</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3150202" role="tablecontent" xml-lang="en-US">Light green</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3154487" role="tablecontent" xml-lang="en-US">65535</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3151332" role="tablecontent" xml-lang="en-US">Light cyan</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3148702" role="tablecontent" xml-lang="en-US">16711680</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153067" role="tablecontent" xml-lang="en-US">Light red</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3153912" role="tablecontent" xml-lang="en-US">16711935</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3159097" role="tablecontent" xml-lang="en-US">Light magenta</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3155266" role="tablecontent" xml-lang="en-US">16776960</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3157978" role="tablecontent" xml-lang="en-US">Light yellow</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3153286" role="tablecontent" xml-lang="en-US">16777215</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3151302" role="tablecontent" xml-lang="en-US">Transparent white</paragraph> + </tablecell> + </tablerow> +</table> +</section> +<section id="dialoglibhowtoget"> + <paragraph role="paragraph" id="par_id631529990528928" xml-lang="en-US">Open <item type="menuitem">Tools - Macros - Organize Dialogs</item> and select <item type="menuitem">%PRODUCTNAME Dialogs</item> container.</paragraph> +</section> +<section id="basiclibhowtoget"> + <paragraph role="paragraph" id="par_id631529000528928" xml-lang="en-US">Open <item type="menuitem">Tools - Macros - %PRODUCTNAME Basic - Edit</item> and select <item type="menuitem">Application Macros</item> container.</paragraph> +</section> +<section id="basiclibwarning"> + <paragraph role="paragraph" id="par_id971529072633266" xml-lang="en-US"><variable id="basiclibrarynote">This library must be loaded before execution. Execute the following statement before running any macro that uses this library:</variable></paragraph> +</section> +<section id="vbasupport"> + <warning id="par_id051920171018124524">This constant, function or object is enabled with the statement <link href="text/sbasic/shared/03103350.xhp" name="optionvbasupport"><literal>Option VBASupport 1</literal></link> placed before the executable program code in a module.</warning> +</section> +<section id="beforeexecutable"> + <warning id="par_id3145172">This statement must be added before the executable program code in a module.</warning> +</section> +<section id="functsyntax"> +<h2 id="hd_id061420171139089682"><variable id="functsyntax">Syntax:</variable></h2> +</section> +<section id="functvalue"> +<h2 id="hd_id061420171139087480"><variable id="functvalue">Return value:</variable></h2> +</section> +<section id="functparameters"> +<h2 id="hd_id061420171139084157"><variable id="functparameters">Parameters:</variable></h2> +</section> +<section id="functexample"> +<h2 id="hd_id061420171139088233"><variable id="functexample">Example:</variable></h2> +</section> +<section id="In_Basic"> +<h4 id="hd_id191620312698501">In Basic</h4> +</section> +<section id="In_Python"> +<h4 id="hd_id831620312769993">In Python</h4> +</section> +<section id="Basic_Only"> +<note id="par_id701621038131185">This method is only available for <emph>Basic</emph> scripts.</note> +</section> +<section id="Python_Only"> +<note id="par_id701621038131336">This method is only available for <emph>Python</emph> scripts.</note> +</section> +<section id="Requires_APSO"> +<warning id="par_id81621427048241">This method requires the installation of the <link href="https://extensions.libreoffice.org/en/extensions/show/apso-alternative-script-organizer-for-python" name="APSO Link">APSO (Alternative Script Organizer for Python)</link> extension. In turn APSO requires the presence of %PRODUCTNAME Python scripting framework. If APSO or Python are missing, an error occurs.</warning> +</section> +<section id="Python_Support"> +<note id="par_id21624295605301">This service is fully supported in both Basic and Python languages. All examples are expressed using the Basic programming language and can be easily converted to Python.</note> +</section> +<paragraph role="paragraph" id="par_id161599082457466"><variable id="stringfunctions"><link href="text/sbasic/shared/03120300.xhp" name="string functions">String functions</link></variable></paragraph> +<paragraph id="par_id06142017015837916" role="paragraph" xml-lang="en-US"><variable id="VBA-Financial"><link href="text/sbasic/shared/special_vba_func.xhp#VBAFinancial">VBA financial functions</link></variable></paragraph> +<paragraph id="par_id06142017016837917" role="paragraph" xml-lang="en-US"><variable id="VBATimeAndDate"><link href="text/sbasic/shared/special_vba_func.xhp#VBADateTime">VBA Time and Date functions</link></variable></paragraph> +<paragraph id="par_id06142017016837918" role="paragraph" xml-lang="en-US"><variable id="VBAIO"><link href="text/sbasic/shared/special_vba_func.xhp#VBAIO">VBA I/O functions</link></variable></paragraph> +<paragraph id="par_id06142017016837919" role="paragraph" xml-lang="en-US"><variable id="VBAMath"><link href="text/sbasic/shared/special_vba_func.xhp#VBAMath">VBA Mathematical functions</link></variable></paragraph> +<paragraph id="par_id06142017016837920" role="paragraph" xml-lang="en-US"><variable id="VBAObject"><link href="text/sbasic/shared/special_vba_func.xhp#VBAObject">VBA Object functions</link></variable></paragraph> +<section id="errorcode"> +<h2 id="hd_id3152869"><variable id="errorcode">Error codes:</variable></h2> +</section> +<section id="allerrors"> +<paragraph id="par_id315509599" role="paragraph" xml-lang="en-US"><variable id="err1">1 An exception occurred</variable></paragraph> +<paragraph id="par_id3155095" role="paragraph" xml-lang="en-US"><variable id="err2">2 Syntax error</variable></paragraph> +<paragraph id="par_id3149126" role="paragraph" xml-lang="en-US"><variable id="err3">3 Return without Gosub</variable></paragraph> +<paragraph id="par_id3153976" role="paragraph" xml-lang="en-US"><variable id="err4">4 Incorrect entry; please retry</variable></paragraph> +<paragraph id="par_id3150891" role="paragraph" xml-lang="en-US"><variable id="err5">5 Invalid procedure call</variable></paragraph> +<paragraph id="par_id3159227" role="paragraph" xml-lang="en-US"><variable id="err6">6 Overflow</variable></paragraph> +<paragraph id="par_id3154649" role="paragraph" xml-lang="en-US"><variable id="err7">7 Not enough memory</variable></paragraph> +<paragraph id="par_id3150050" role="paragraph" xml-lang="en-US"><variable id="err8">8 Array already dimensioned</variable></paragraph> +<paragraph id="par_id3148900" role="paragraph" xml-lang="en-US"><variable id="err9">9 Index out of defined range</variable></paragraph> +<paragraph id="par_id3153806" role="paragraph" xml-lang="en-US"><variable id="err10">10 Duplicate definition</variable></paragraph> +<paragraph id="par_id3146963" role="paragraph" xml-lang="en-US"><variable id="err11">11 Division by zero</variable></paragraph> +<paragraph id="par_id3153013" role="paragraph" xml-lang="en-US"><variable id="err12">12 Variable not defined</variable></paragraph> +<paragraph id="par_id3155593" role="paragraph" xml-lang="en-US"><variable id="err13">13 Data type mismatch</variable></paragraph> +<paragraph id="par_id3151197" role="paragraph" xml-lang="en-US"><variable id="err14">14 Invalid parameter</variable></paragraph> +<paragraph id="par_id3154710" role="paragraph" xml-lang="en-US"><variable id="err18">18 Process interrupted by user</variable></paragraph> +<paragraph id="par_id3147504" role="paragraph" xml-lang="en-US"><variable id="err20">20 Resume without error</variable></paragraph> +<paragraph id="par_id3145319" role="paragraph" xml-lang="en-US"><variable id="err28">28 Not enough stack memory</variable></paragraph> +<paragraph id="par_id3146110" role="paragraph" xml-lang="en-US"><variable id="err35">35 Sub-procedure or function procedure not defined</variable></paragraph> +<paragraph id="par_id3147246" role="paragraph" xml-lang="en-US"><variable id="err48">48 Error loading DLL file</variable></paragraph> +<paragraph id="par_id3146101" role="paragraph" xml-lang="en-US"><variable id="err49">49 Wrong DLL call convention</variable></paragraph> +<paragraph id="par_id3153957" role="paragraph" xml-lang="en-US"><variable id="err51">51 Internal error</variable></paragraph> +<paragraph id="par_id3154404" role="paragraph" xml-lang="en-US"><variable id="err52">52 Invalid file name or file number</variable></paragraph> +<paragraph id="par_id3151338" role="paragraph" xml-lang="en-US"><variable id="err53">53 File not found</variable></paragraph> +<paragraph id="par_id3147298" role="paragraph" xml-lang="en-US"><variable id="err54">54 Incorrect file mode</variable></paragraph> +<paragraph id="par_id3148747" role="paragraph" xml-lang="en-US"><variable id="err55">55 File already open</variable></paragraph> +<paragraph id="par_id3145233" role="paragraph" xml-lang="en-US"><variable id="err57">57 Device I/O error</variable></paragraph> +<paragraph id="par_id3156399" role="paragraph" xml-lang="en-US"><variable id="err58">58 File already exists</variable></paragraph> +<paragraph id="par_id3149324" role="paragraph" xml-lang="en-US"><variable id="err59">59 Incorrect record length</variable></paragraph> +<paragraph id="par_id3147409" role="paragraph" xml-lang="en-US"><variable id="err61">61 Disk or hard drive full</variable></paragraph> +<paragraph id="par_id3149146" role="paragraph" xml-lang="en-US"><variable id="err62">62 Reading exceeds EOF</variable></paragraph> +<paragraph id="par_id3150456" role="paragraph" xml-lang="en-US"><variable id="err63">63 Incorrect record number</variable></paragraph> +<paragraph id="par_id3146883" role="paragraph" xml-lang="en-US"><variable id="err67">67 Too many files</variable></paragraph> +<paragraph id="par_id3146818" role="paragraph" xml-lang="en-US"><variable id="err68">68 Device not available</variable></paragraph> +<paragraph id="par_id3145225" role="paragraph" xml-lang="en-US"><variable id="err70">70 Access denied</variable></paragraph> +<paragraph id="par_id3150372" role="paragraph" xml-lang="en-US"><variable id="err71">71 Disk not ready</variable></paragraph> +<paragraph id="par_id3148894" role="paragraph" xml-lang="en-US"><variable id="err73">73 Not implemented</variable></paragraph> +<paragraph id="par_id3152981" role="paragraph" xml-lang="en-US"><variable id="err74">74 Renaming on different drives impossible</variable></paragraph> +<paragraph id="par_id3149355" role="paragraph" xml-lang="en-US"><variable id="err75">75 Path/file access error</variable></paragraph> +<paragraph id="par_id3150477" role="paragraph" xml-lang="en-US"><variable id="err76">76 Path not found</variable></paragraph> +<paragraph id="par_id3154678" role="paragraph" xml-lang="en-US"><variable id="err91">91 Object variable not set</variable></paragraph> +<paragraph id="par_id3149890" role="paragraph" xml-lang="en-US"><variable id="err93">93 Invalid string pattern</variable></paragraph> +<paragraph id="par_id3146942" role="paragraph" xml-lang="en-US"><variable id="err94">94 Use of zero not permitted</variable></paragraph> +<paragraph id="par_id31469429" role="paragraph" xml-lang="en-US"><variable id="err250">250 DDE Error</variable></paragraph> +<paragraph id="par_id31469428" role="paragraph" xml-lang="en-US"><variable id="err280">280 Awaiting response to DDE connection</variable></paragraph> +<paragraph id="par_id31469427" role="paragraph" xml-lang="en-US"><variable id="err281">281 No DDE channels available</variable></paragraph> +<paragraph id="par_id31469426" role="paragraph" xml-lang="en-US"><variable id="err282">282 No application responded to DDE connect initiation</variable></paragraph> +<paragraph id="par_id31469425" role="paragraph" xml-lang="en-US"><variable id="err283">283 Too many applications responded to DDE connect initiation</variable></paragraph> +<paragraph id="par_id31469424" role="paragraph" xml-lang="en-US"><variable id="err284">284 DDE channel locked</variable></paragraph> +<paragraph id="par_id31469423" role="paragraph" xml-lang="en-US"><variable id="err285">285 External application cannot execute DDE operation</variable></paragraph> +<paragraph id="par_id31469422" role="paragraph" xml-lang="en-US"><variable id="err286">286 Timeout while waiting for DDE response</variable></paragraph> +<paragraph id="par_id31469421" role="paragraph" xml-lang="en-US"><variable id="err287">287 user pressed ESCAPE during DDE operation</variable></paragraph> +<paragraph id="par_id31469420" role="paragraph" xml-lang="en-US"><variable id="err288">288 External application busy</variable></paragraph> +<paragraph id="par_id31469419" role="paragraph" xml-lang="en-US"><variable id="err289">289 DDE operation without data</variable></paragraph> +<paragraph id="par_id31469418" role="paragraph" xml-lang="en-US"><variable id="err290">290 Data are in wrong format</variable></paragraph> +<paragraph id="par_id31469417" role="paragraph" xml-lang="en-US"><variable id="err291">291 External application has been terminated</variable></paragraph> +<paragraph id="par_id31469416" role="paragraph" xml-lang="en-US"><variable id="err292">292 DDE connection interrupted or modified</variable></paragraph> +<paragraph id="par_id31469415" role="paragraph" xml-lang="en-US"><variable id="err293">293 DDE method invoked with no channel open</variable></paragraph> +<paragraph id="par_id31469414" role="paragraph" xml-lang="en-US"><variable id="err294">294 Invalid DDE link format</variable></paragraph> +<paragraph id="par_id31469413" role="paragraph" xml-lang="en-US"><variable id="err295">295 DDE message has been lost</variable></paragraph> +<paragraph id="par_id31469412" role="paragraph" xml-lang="en-US"><variable id="err296">296 Paste link already performed</variable></paragraph> +<paragraph id="par_id31469411" role="paragraph" xml-lang="en-US"><variable id="err297">297 Link mode cannot be set due to invalid link topic</variable></paragraph> +<paragraph id="par_id31469410" role="paragraph" xml-lang="en-US"><variable id="err298">298 DDE requires the DDEML.DLL file</variable></paragraph> +<paragraph id="par_id3150028" role="paragraph" xml-lang="en-US"><variable id="err323">323 Module cannot be loaded; invalid format</variable></paragraph> +<paragraph id="par_id3148434" role="paragraph" xml-lang="en-US"><variable id="err341">341 Invalid object index</variable></paragraph> +<paragraph id="par_id3143219" role="paragraph" xml-lang="en-US"><variable id="err366">366 Object is not available</variable></paragraph> +<paragraph id="par_id3144744" role="paragraph" xml-lang="en-US"><variable id="err380">380 Incorrect property value</variable></paragraph> +<paragraph id="par_id3147420" role="paragraph" xml-lang="en-US"><variable id="err382">382 This property is read-only</variable></paragraph> +<paragraph id="par_id3147472" role="paragraph" xml-lang="en-US"><variable id="err394">394 This property is write-only</variable></paragraph> +<paragraph id="par_id3148583" role="paragraph" xml-lang="en-US"><variable id="err420">420 Invalid object reference</variable></paragraph> +<paragraph id="par_id3153329" role="paragraph" xml-lang="en-US"><variable id="err423">423 Property or method not found</variable></paragraph> +<paragraph id="par_id3148738" role="paragraph" xml-lang="en-US"><variable id="err424">424 Object required</variable></paragraph> +<paragraph id="par_id3159084" role="paragraph" xml-lang="en-US"><variable id="err425">425 Invalid use of an object</variable></paragraph> +<paragraph id="par_id3146806" role="paragraph" xml-lang="en-US"><variable id="err430">430 OLE Automation is not supported by this object</variable></paragraph> +<paragraph id="par_id3146130" role="paragraph" xml-lang="en-US"><variable id="err438">438 This property or method is not supported by the object</variable></paragraph> +<paragraph id="par_id3154374" role="paragraph" xml-lang="en-US"><variable id="err440">440 OLE automation error</variable></paragraph> +<paragraph id="par_id3149685" role="paragraph" xml-lang="en-US"><variable id="err445">445 This action is not supported by given object</variable></paragraph> +<paragraph id="par_id3150282" role="paragraph" xml-lang="en-US"><variable id="err446">446 Named arguments are not supported by given object</variable></paragraph> +<paragraph id="par_id3150142" role="paragraph" xml-lang="en-US"><variable id="err447">447 The current locale setting is not supported by the given object</variable></paragraph> +<paragraph id="par_id3152771" role="paragraph" xml-lang="en-US"><variable id="err448">448 Named argument not found</variable></paragraph> +<paragraph id="par_id3145145" role="paragraph" xml-lang="en-US"><variable id="err449">449 Argument is not optional</variable></paragraph> +<paragraph id="par_id3154399" role="paragraph" xml-lang="en-US"><variable id="err450">450 Invalid number of arguments</variable></paragraph> +<paragraph id="par_id3146137" role="paragraph" xml-lang="en-US"><variable id="err451">451 Object is not a list</variable></paragraph> +<paragraph id="par_id3149507" role="paragraph" xml-lang="en-US"><variable id="err452">452 Invalid ordinal number</variable></paragraph> +<paragraph id="par_id3154566" role="paragraph" xml-lang="en-US"><variable id="err453">453 Specified DLL function not found</variable></paragraph> +<paragraph id="par_id3145595" role="paragraph" xml-lang="en-US"><variable id="err460">460 Invalid clipboard format</variable></paragraph> +<paragraph id="par_id31455951" role="paragraph" xml-lang="en-US"><variable id="err951">951 Unexpected symbol:</variable></paragraph> +<paragraph id="par_id31455952" role="paragraph" xml-lang="en-US"><variable id="err952">952 Expected:</variable></paragraph> +<paragraph id="par_id31455953" role="paragraph" xml-lang="en-US"><variable id="err953">953 Symbol expected</variable></paragraph> +<paragraph id="par_id31455954" role="paragraph" xml-lang="en-US"><variable id="err954">954 Variable expected</variable></paragraph> +<paragraph id="par_id31455955" role="paragraph" xml-lang="en-US"><variable id="err955">955 Label expected</variable></paragraph> +<paragraph id="par_id31455956" role="paragraph" xml-lang="en-US"><variable id="err956">956 Value cannot be applied</variable></paragraph> +<paragraph id="par_id31455957" role="paragraph" xml-lang="en-US"><variable id="err957">957 Variable already defined</variable></paragraph> +<paragraph id="par_id31455958" role="paragraph" xml-lang="en-US"><variable id="err958">958 Sub procedure or function procedure already defined</variable></paragraph> +<paragraph id="par_id31455959" role="paragraph" xml-lang="en-US"><variable id="err959">959 Label already defined</variable></paragraph> +<paragraph id="par_id31455960" role="paragraph" xml-lang="en-US"><variable id="err960">960 Variable not found</variable></paragraph> +<paragraph id="par_id31455961" role="paragraph" xml-lang="en-US"><variable id="err961">961 Array or procedure not found</variable></paragraph> +<paragraph id="par_id31455962" role="paragraph" xml-lang="en-US"><variable id="err962">962 Procedure not found</variable></paragraph> +<paragraph id="par_id31455963" role="paragraph" xml-lang="en-US"><variable id="err963">963 Label undefined</variable></paragraph> +<paragraph id="par_id31455964" role="paragraph" xml-lang="en-US"><variable id="err964">964 Unknown data type</variable></paragraph> +<paragraph id="par_id31455965" role="paragraph" xml-lang="en-US"><variable id="err965">965 Exit expected</variable></paragraph> +<paragraph id="par_id31455966" role="paragraph" xml-lang="en-US"><variable id="err966">966 Statement block still open: missing</variable></paragraph> +<paragraph id="par_id31455967" role="paragraph" xml-lang="en-US"><variable id="err967">967 Parentheses do not match</variable></paragraph> +<paragraph id="par_id31455968" role="paragraph" xml-lang="en-US"><variable id="err968">968 Symbol already defined differently</variable></paragraph> +<paragraph id="par_id31455969" role="paragraph" xml-lang="en-US"><variable id="err969">969 Parameters do not correspond to procedure</variable></paragraph> +<paragraph id="par_id31455970" role="paragraph" xml-lang="en-US"><variable id="err970">970 Invalid character in number</variable></paragraph> +<paragraph id="par_id31455971" role="paragraph" xml-lang="en-US"><variable id="err971">971 Array must be dimensioned</variable></paragraph> +<paragraph id="par_id31455972" role="paragraph" xml-lang="en-US"><variable id="err972">972 Else/Endif without If</variable></paragraph> +<paragraph id="par_id31455973" role="paragraph" xml-lang="en-US"><variable id="err973">973 not allowed within a procedure</variable></paragraph> +<paragraph id="par_id31455974" role="paragraph" xml-lang="en-US"><variable id="err974">974 not allowed outside a procedure</variable></paragraph> +<paragraph id="par_id31455975" role="paragraph" xml-lang="en-US"><variable id="err975">975 Dimension specifications do not match</variable></paragraph> +<paragraph id="par_id31455976" role="paragraph" xml-lang="en-US"><variable id="err976">976 Unknown option:</variable></paragraph> +<paragraph id="par_id31455977" role="paragraph" xml-lang="en-US"><variable id="err977">977 Constant redefined</variable></paragraph> +<paragraph id="par_id31455978" role="paragraph" xml-lang="en-US"><variable id="err978">978 Program too large</variable></paragraph> +<paragraph id="par_id31455979" role="paragraph" xml-lang="en-US"><variable id="err979">979 Strings or arrays not permitted</variable></paragraph> +<paragraph id="par_id31455980" role="paragraph" xml-lang="en-US"><variable id="err1000">1000 Object does not have this property</variable></paragraph> +<paragraph id="par_id31455981" role="paragraph" xml-lang="en-US"><variable id="err1001">1001 Object does not have this method</variable></paragraph> +<paragraph id="par_id31455982" role="paragraph" xml-lang="en-US"><variable id="err1002">1002 Required argument lacking</variable></paragraph> +<paragraph id="par_id31455983" role="paragraph" xml-lang="en-US"><variable id="err1003">1003 Invalid number of arguments</variable></paragraph> +<paragraph id="par_id31455984" role="paragraph" xml-lang="en-US"><variable id="err1004">1004 Error executing a method</variable></paragraph> +<paragraph id="par_id31455985" role="paragraph" xml-lang="en-US"><variable id="err1005">1005 Unable to set property</variable></paragraph> +<paragraph id="par_id31455986" role="paragraph" xml-lang="en-US"><variable id="err1006">1006 Unable to determine property</variable></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01/06130000.xhp b/helpcontent2/source/text/sbasic/shared/01/06130000.xhp new file mode 100644 index 000000000..5bf476bff --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01/06130000.xhp @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0106130000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Macro</title> +<filename>/text/sbasic/shared/01/06130000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145786"><bookmark_value>macros; Basic IDE</bookmark_value> +<bookmark_value>Basic IDE; macros</bookmark_value> +</bookmark><comment>this file needs more work, see i62546</comment> +<paragraph role="heading" id="hd_id3145786" xml-lang="en-US" level="1">Macro</paragraph> +<paragraph role="paragraph" id="par_id3152886" xml-lang="en-US"><variable id="makro"><ahelp hid=".uno:ChooseMacro">Opens the <emph>Macro</emph> dialog, where you can create, edit, organize, and run $[officename] Basic macros.</ahelp></variable></paragraph> +<paragraph role="heading" id="hd_id3154145" xml-lang="en-US" level="2">Macro name</paragraph> +<paragraph role="paragraph" id="par_id3151116" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/basicmacrodialog/macronameedit">Displays the name of the selected macro. To create or to change the name of a macro, enter a name here.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3153729" xml-lang="en-US" level="2">Macro from / Save macro in</paragraph> +<paragraph role="paragraph" id="par_id3153190" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/basicmacrodialog/libraries">Lists the libraries and the modules where you can open or save your macros. To save a macro with a particular document, open the document, and then open this dialog.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3146975" xml-lang="en-US" level="2">Run / Save</paragraph> +<paragraph role="paragraph" id="par_id3154791" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/basicmacrodialog/ok">Runs or saves the current macro.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3153158" xml-lang="en-US" level="2">Assign</paragraph> +<paragraph role="paragraph" id="par_id3149961" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/basicmacrodialog/assign">Opens the Customize dialog, where you can assign the selected macro to a menu command, a toolbar, or an event.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3145799" xml-lang="en-US" level="2">Edit</paragraph> +<paragraph role="paragraph" id="par_id3147127" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/basicmacrodialog/edit">Starts the $[officename] Basic editor and opens the selected macro for editing.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3149400" xml-lang="en-US" level="2">New/Delete</paragraph> +<paragraph role="paragraph" id="par_id3155602" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/basicmacrodialog/delete">Creates a new macro, or deletes the selected macro.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id3149124" xml-lang="en-US">To create a new macro, select the "Standard" module in the <emph>Macro from</emph> list, and then click <emph>New</emph>.</paragraph> +<paragraph role="paragraph" id="par_id3150749" xml-lang="en-US">To delete a macro, select it, and then click <emph>Delete</emph>.</paragraph> +<paragraph role="heading" id="hd_id3153764" xml-lang="en-US" level="2">Organizer</paragraph> +<paragraph role="paragraph" id="par_id3148405" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/basicmacrodialog/organize">Opens the <emph>Macro Organizer</emph> dialog, where you can add, edit, or delete existing macro modules, dialogs, and libraries.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3166447" xml-lang="en-US" level="3">Module/Dialog</paragraph> +<paragraph role="paragraph" id="par_id3155959" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/modulepage/library">Lists the existing macros and dialogs.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id3149922" xml-lang="en-US">You can drag-and-drop a module or a dialog between libraries.</paragraph> +<paragraph role="paragraph" id="par_id3159333" xml-lang="en-US">To copy a dialog or a module, hold down the <switchinline select="sys"><caseinline select="MAC">Command</caseinline><defaultinline>Ctrl</defaultinline></switchinline> key while you drag-and-drop.</paragraph> +<paragraph role="heading" id="hd_id3147131" xml-lang="en-US" level="3">Edit</paragraph> +<paragraph role="paragraph" id="par_id3149816" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/modulepage/edit">Opens the selected macro or dialog for editing.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3151214" xml-lang="en-US" level="3">New</paragraph> +<paragraph role="paragraph" id="par_id3154202" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/modulepage/newmodule">Creates a new module.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id3153269" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/modulepage/newdialog">Creates a new dialog.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3154587" xml-lang="en-US" level="3">Libraries tab page</paragraph> +<paragraph role="paragraph" id="par_id3153705" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/modulepage/newdialog">Lets you manage the macro libraries.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3145259" xml-lang="en-US" level="3">Location</paragraph> +<paragraph role="paragraph" id="par_id3153234" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/libpage/location">Select the location containing the macro libraries that you want to organize.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3148460" xml-lang="en-US" level="3">Library</paragraph> +<paragraph role="paragraph" id="par_id3150828" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/libpage/library">Lists the macro libraries in the chosen location.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3145134" xml-lang="en-US" level="3">Edit</paragraph> +<paragraph role="paragraph" id="par_id3150518" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/libpage/edit">Opens the $[officename] Basic editor so that you can modify the selected library.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3150371" xml-lang="en-US" level="3">Password</paragraph> +<paragraph role="paragraph" id="par_id3166430" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/libpage/password">Assigns or edits the <link href="text/sbasic/shared/01/06130100.xhp" name="password">password</link> for the selected library. "Standard" libraries cannot have a password.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3154372" xml-lang="en-US" level="3">New</paragraph> +<paragraph role="paragraph" id="par_id3145387" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/libpage/new">Creates a new library.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3154259" xml-lang="en-US" level="3">Name</paragraph> +<paragraph role="paragraph" id="par_id3156169" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/newlibdialog/NewLibDialog">Enter a name for the new module, dialog, or library.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3151183" xml-lang="en-US" level="3">Append</paragraph> +<paragraph role="paragraph" id="par_id3155126" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/libpage/import">Locate that $[officename] Basic library that you want to add to the current list, and then click <emph>Open</emph>.</ahelp></paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01/06130100.xhp b/helpcontent2/source/text/sbasic/shared/01/06130100.xhp new file mode 100644 index 000000000..3ccfab746 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01/06130100.xhp @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0106130100xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Change Password</title> +<filename>/text/sbasic/shared/01/06130100.xhp</filename> +</topic> +</meta> +<body><paragraph role="heading" id="hd_id3159399" xml-lang="en-US" level="1">Change Password</paragraph> +<paragraph role="paragraph" id="par_id3150276" xml-lang="en-US"><ahelp hid="svx/ui/passwd/PasswordDialog">Protects the selected library with a password.</ahelp> You can enter a new password, or change the current password.</paragraph> +<paragraph role="heading" id="hd_id3154285" xml-lang="en-US" level="2">Old password</paragraph> +<paragraph role="heading" id="hd_id3153665" xml-lang="en-US" level="3">Password</paragraph> +<paragraph role="paragraph" id="par_id3155628" xml-lang="en-US"><ahelp hid="svx/ui/passwd/oldpassEntry">Enter the current password for the selected library.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3153126" xml-lang="en-US" level="2">New password</paragraph> +<paragraph role="heading" id="hd_id3153628" xml-lang="en-US" level="3">Password</paragraph> +<paragraph role="paragraph" id="par_id3159413" xml-lang="en-US"><ahelp hid="svx/ui/passwd/newpassEntry">Enter a new password for the selected library.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3148947" xml-lang="en-US" level="3">Confirm</paragraph> +<paragraph role="paragraph" id="par_id3149457" xml-lang="en-US"><ahelp hid="svx/ui/passwd/confirmpassEntry">Repeat the new password for the selected library.</ahelp><comment>i66515</comment></paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01/06130500.xhp b/helpcontent2/source/text/sbasic/shared/01/06130500.xhp new file mode 100644 index 000000000..d7d978604 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01/06130500.xhp @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0106130500xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Append libraries</title> +<filename>/text/sbasic/shared/01/06130500.xhp</filename> +</topic> +</meta> +<body> + +<bookmark xml-lang="en-US" branch="index" id="bm_id3150502"> +<bookmark_value>libraries; adding</bookmark_value> +<bookmark_value>inserting;Basic libraries</bookmark_value> +</bookmark> + <paragraph xml-lang="en-US" id="hd_id3150502" role="heading" level="1">Append libraries</paragraph> + <paragraph xml-lang="en-US" id="par_id3154840" role="paragraph">Locate that <item type="productname">%PRODUCTNAME</item> Basic library that you want to add to the current list, and then click <emph>Open</emph>.</paragraph> + +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/importlibdialog/ImportLibDialog" id="bm_id3109850" localize="false"/> + <paragraph xml-lang="en-US" id="hd_id3149119" role="heading" level="2">File name:</paragraph> + <paragraph xml-lang="en-US" id="par_id3147102" role="paragraph"><ahelp hid="modules/BasicIDE/ui/importlibdialog/ImportLibDialog">Enter a name or the path to the library that you want to append.</ahelp> You can also select a library from the list.</paragraph> + <paragraph xml-lang="en-US" id="hd_id3147291" role="heading" level="2">Options</paragraph> + <paragraph xml-lang="en-US" id="hd_id3147226" role="heading" level="3">Insert as reference (read-only)</paragraph> + <paragraph xml-lang="en-US" id="par_id3155892" role="paragraph"><ahelp hid="modules/BasicIDE/ui/importlibdialog/ref">Adds the selected library as a read-only file. The library is reloaded each time you start <item type="productname">%PRODUCTNAME</item>.</ahelp></paragraph> + <paragraph xml-lang="en-US" id="hd_id3145071" role="heading" level="3">Replace existing libraries</paragraph> + <paragraph xml-lang="en-US" id="par_id3149812" role="paragraph"><ahelp hid="modules/BasicIDE/ui/importlibdialog/replace">Replaces a library that has the same name with the current library.</ahelp></paragraph> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01000000.xhp b/helpcontent2/source/text/sbasic/shared/01000000.xhp new file mode 100644 index 000000000..786937634 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01000000.xhp @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01000000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Programming with $[officename] Basic </title> +<filename>/text/sbasic/shared/01000000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="programming"> + <paragraph id="hd_id3156027" role="heading" level="1" xml-lang="en-US"><variable id="doc_title"><link href="text/sbasic/shared/01000000.xhp" name="Programming with $[officename] Basic ">Programming with $[officename] Basic </link></variable></paragraph> + <paragraph role="paragraph" id="par_id3153708" xml-lang="en-US">This is where you find general information about working with macros and $[officename] Basic.</paragraph> + </section> + <embed href="text/sbasic/shared/01010210.xhp#modular"/> + <embed href="text/sbasic/shared/01020000.xhp#syntax"/> + <embed href="text/sbasic/shared/01030000.xhp#ide"/> + <embed href="text/sbasic/shared/01040000.xhp#eventmacros"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01010210.xhp b/helpcontent2/source/text/sbasic/shared/01010210.xhp new file mode 100644 index 000000000..e60bdab22 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01010210.xhp @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + + <helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01010210xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Basics</title> +<filename>/text/sbasic/shared/01010210.xhp</filename> +</topic> +</meta> +<body> +<section id="modular"> +<bookmark xml-lang="en-US" branch="index" id="bm_id4488967"><bookmark_value>fundamentals</bookmark_value> +<bookmark_value>subroutines</bookmark_value> +<bookmark_value>variables;global and local</bookmark_value> +<bookmark_value>modules;subroutines and functions</bookmark_value> +</bookmark><paragraph role="heading" id="hd_id3154927" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01010210.xhp" name="Basics">Basics</link></paragraph> +<paragraph role="paragraph" id="par_id3156023" xml-lang="en-US">This section provides the fundamentals for working with $[officename] Basic.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US">$[officename] Basic code is based on subroutines and functions that are specified between <emph>sub...end sub</emph> and <emph>function...end function</emph> sections. Each Sub or Function can call other Subs and Functions. If you take care to write generic code for a Sub or Function, you can probably re-use it in other programs. See also <link href="text/sbasic/shared/01020300.xhp" name="Procedures and Functions">Procedures and Functions</link>.</paragraph> + +<paragraph role="note" id="par_id314756320" xml-lang="en-US">Some restrictions apply for the names of your public variables, subs, and functions. You must not use the same name as one of the modules of the same library.</paragraph> + +<paragraph role="heading" id="hd_id3150398" xml-lang="en-US" level="2">What is a Sub?</paragraph> +<paragraph role="paragraph" id="par_id3148797" xml-lang="en-US"> +<emph>Sub</emph> is the short form of <emph>subroutine</emph>, that is used to handle a certain task within a program. Subs are used to split a task into individual procedures. Splitting a program into procedures and sub-procedures enhances readability and reduces the error-proneness. A sub possibly takes some arguments as parameters but does not return any values back to the calling sub or function, for example:</paragraph> +<paragraph role="code" id="par_id3150868" xml-lang="en-US">DoSomethingWithTheValues(MyFirstValue,MySecondValue)</paragraph> +<paragraph role="heading" id="hd_id3156282" xml-lang="en-US" level="2">What is a Function?</paragraph> +<paragraph role="paragraph" id="par_id3156424" xml-lang="en-US">A <emph>function</emph> is essentially a sub, which returns a value. You may use a function at the right side of a variable declaration, or at other places where you normally use values, for example:</paragraph> +<paragraph role="code" id="par_id3146985" xml-lang="en-US">MySecondValue = myFunction(MyFirstValue)</paragraph> +<paragraph role="heading" id="hd_id3153364" xml-lang="en-US" level="2">Global and local variables</paragraph> +<paragraph role="paragraph" id="par_id3151112" xml-lang="en-US">Global variables are valid for all subs and functions inside a module. They are declared at the beginning of a module before the first sub or function starts.</paragraph> +<paragraph role="paragraph" id="par_id3154012" xml-lang="en-US">Variables that you declare within a sub or function are valid only inside this sub or function. These variables override global variables with the same name and local variables with the same name coming from superordinate subs or functions.</paragraph> +<paragraph role="heading" id="hd_id3150010" xml-lang="en-US" level="2">Structuring</paragraph> +<paragraph role="paragraph" id="par_id3153727" xml-lang="en-US">After separating your program into procedures and functions (Subs and Functions), you can save these procedures and functions as files for reuse in other projects. $[officename] Basic supports <link href="text/sbasic/shared/01020500.xhp" name="Modules and Libraries">Modules and Libraries</link>. Subs and functions are always contained in modules. You can define modules to be global or part of a document. Multiple modules can be combined to a library.</paragraph> +<paragraph role="paragraph" id="par_id3152578" xml-lang="en-US">You can copy or move subs, functions, modules and libraries from one file to another by using the <link href="text/sbasic/shared/01/06130000.xhp" name="Macro">Macro</link> dialog.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01020000.xhp b/helpcontent2/source/text/sbasic/shared/01020000.xhp new file mode 100644 index 000000000..ccec8f509 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01020000.xhp @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01020000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Syntax</title> +<filename>/text/sbasic/shared/01020000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="syntax"> + <paragraph id="hd_id3148946" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/01020000.xhp" name="Syntax">Syntax</link></paragraph> + <paragraph role="paragraph" id="par_id3150793" xml-lang="en-US">This section describes the basic syntax elements of $[officename] Basic. For a detailed description please refer to the $[officename] Basic Guide which is available separately.</paragraph> + </section> + <embed href="text/sbasic/shared/01020100.xhp#variable"/> + <embed href="text/sbasic/shared/01020200.xhp#objects"/> + <embed href="text/sbasic/shared/01020300.xhp#procedures"/> + <embed href="text/sbasic/shared/01020500.xhp#biblio"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01020100.xhp b/helpcontent2/source/text/sbasic/shared/01020100.xhp new file mode 100644 index 000000000..ed5ce1eaa --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01020100.xhp @@ -0,0 +1,266 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared01020100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Using Variables</title> + <filename>/text/sbasic/shared/01020100.xhp</filename> + </topic> +</meta> + +<body> + +<section id="variable"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149346"> + <bookmark_value>names of variables</bookmark_value> + <bookmark_value>variables; using</bookmark_value> + <bookmark_value>types of variables</bookmark_value> + <bookmark_value>declaring variables</bookmark_value> + <bookmark_value>values;of variables</bookmark_value> + <bookmark_value>literals;date</bookmark_value> + <bookmark_value>literals;integer</bookmark_value> + <bookmark_value>literals;integer</bookmark_value> + <bookmark_value>literals;floating point</bookmark_value> + <bookmark_value>constants</bookmark_value> + <bookmark_value>arrays;declaring</bookmark_value> + <bookmark_value>defining;constants</bookmark_value> +</bookmark> + + +<h1 id="hd_id3149346"><link href="text/sbasic/shared/01020100.xhp" name="Using Variables">Using Variables</link></h1> +<paragraph id="par_id3154346" role="paragraph" xml-lang="en-US">The following describes the basic use of variables in $[officename] Basic.</paragraph> +</section> + +<h2 id="hd_id3153361">Naming Conventions for Variable Identifiers</h2> +<paragraph id="par_id3148797" role="paragraph" xml-lang="en-US">A variable name can consist of a maximum of 255 characters. The first character of a variable name <emph>must</emph> be a letter A-Z or a-z. Numbers can also be used in a variable name, but punctuation symbols and special characters are not permitted, with exception of the underscore character ("_"). In $[officename] Basic variable identifiers are not case-sensitive. Variable names may contain spaces but must be enclosed in square brackets if they do.</paragraph> +<paragraph id="par_id3156422" role="paragraph" xml-lang="en-US">Examples for variable identifiers:</paragraph> + +<bascode> + <paragraph id="par_idm1341272896" role="bascode">MyNumber=5 'Correct'</paragraph> + <paragraph id="par_idm1341267456" role="bascode">MyNumber5=15 'Correct'</paragraph> + <paragraph id="par_idm1341262016" role="bascode">MyNumber_5=20 'Correct'</paragraph> + <paragraph id="par_idm1341256576" role="bascode">My Number=20 'Not valid, variable with space must be enclosed in square brackets'</paragraph> + <paragraph id="par_idm1341251088" role="bascode">[My Number]=12 'Correct'</paragraph> + <paragraph id="par_idm1341245648" role="bascode">DéjàVu=25 'Not valid, special characters are not allowed'</paragraph> + <paragraph id="par_idm1341240176" role="bascode">5MyNumber=12 'Not valid, variable may not begin with a number'</paragraph> + <paragraph id="par_idm1341234704" role="bascode">Number,Mine=12 'Not valid, punctuation marks are not allowed'</paragraph> +</bascode> + +<h2 id="hd_id3146317">Declaring Variables</h2> +<paragraph id="par_id3150299" role="paragraph" xml-lang="en-US">In $[officename] Basic you don't need to declare variables explicitly. A variable declaration can be performed with the <emph>Dim</emph> statement. You can declare more than one variable at a time by separating the names with a comma. To define the variable type, use either a type-declaration sign after the name, or the appropriate key word. </paragraph> +<paragraph id="par_id3154118" role="paragraph" xml-lang="en-US">Examples for variable declarations:</paragraph> + +<bascode> + <paragraph id="par_idm1341222320" role="bascode">Dim a$ 'Declares the variable "a" as a String'</paragraph> + <paragraph id="par_idm1341216864" role="bascode">Dim a As String 'Declares the variable "a" as a String'</paragraph> + <paragraph id="par_idm1341211408" role="bascode">Dim a$, b As Integer 'Declares one variable as a String and one as an Integer'</paragraph> + <paragraph id="par_idm1341205936" role="bascode">Dim c As Boolean 'Declares c as a Boolean variable that can be TRUE or FALSE'</paragraph> +</bascode> + +<warning id="par_id3144770">Once you have declared a variable as a certain type, you cannot declare the variable under the same name again as a different type!</warning> + +<paragraph role="paragraph" id="par_id421619551219763">When you declare multiple variables in a single line of code you need to specify the type of each variable. If the type of a variable is not explicitly specified, then Basic will assume that the variable is of the <emph>Variant</emph> type.</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id321619555442706">' Both variables "a" and "b" are of the Integer type</paragraph> + <paragraph role="bascode" localize="false" id="bas_id511619551568768">Dim a As Integer, b As Integer</paragraph> + <paragraph role="bascode" id="bas_id451619555463988">' Variable "c" is a Variant and "d" is an Integer</paragraph> + <paragraph role="bascode" localize="false" id="bas_id511619551568144">Dim c, d As Integer</paragraph> + <paragraph role="bascode" id="bas_id161619555482237">' A variable can also be explicitly declared as a Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id601619552527089">Dim e As Variant, f As Double</paragraph> +</bascode> +<note id="par_id521619551687371">The <emph>Variant</emph> type is a special data type that can store any kind of value. To learn more, refer to the section <link href="text/sbasic/shared/01020100.xhp#VariantTypeH2" name="Variant Type">The Variant type</link> below.</note> + +<h3 id="hd_id3149331">Forcing Variable Declarations</h3> +<paragraph id="par_id3149443" role="paragraph" xml-lang="en-US">To force declaration of variables, use the following command:</paragraph> +<bascode> +<paragraph id="par_idm1341182432" role="bascode" localize="false" xml-lang="en-US">Option Explicit</paragraph> +</bascode> +<paragraph id="par_id3155072" role="paragraph" xml-lang="en-US">The <emph>Option Explicit</emph> statement has to be the first line in the module, before the first SUB. Generally, only arrays need to be declared explicitly. All other variables are declared according to the type-declaration character, or - if omitted - as the default type <emph>Single</emph>.</paragraph> + +<h2 id="hd_id3154614">Variable Types</h2> +<paragraph id="par_id3155383" role="paragraph" xml-lang="en-US">$[officename] Basic supports four variable classes:</paragraph> + +<list type="unordered"> + <listitem> + <paragraph id="par_id3153972" role="listitem" xml-lang="en-US"> <emph>Numeric</emph> variables can contain number values. Some variables are used to store large or small numbers, and others are used for floating-point or fractional numbers. </paragraph> + </listitem> + <listitem> + <paragraph id="par_id3159226" role="listitem" xml-lang="en-US"> <emph>String</emph> variables contain character strings.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3145217" role="listitem" xml-lang="en-US"> <emph>Boolean</emph> variables contain either the TRUE or the FALSE value.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3154762" role="listitem" xml-lang="en-US"> <emph>Object</emph> variables can store objects of various types, like tables and documents within a document.</paragraph> + </listitem></list> + +<h3 id="hd_id3153805">Integer Variables</h3> +<paragraph id="par_id3146966" role="paragraph" xml-lang="en-US">Integer variables range from -32768 to 32767. If you assign a floating-point value to an integer variable, the decimal places are rounded to the next integer. Integer variables are rapidly calculated in procedures and are suitable for counter variables in loops. An integer variable only requires two bytes of memory. "%" is the type-declaration character.</paragraph> +<bascode> +<paragraph id="par_idm1341159200" role="bascode" localize="false" xml-lang="en-US">Dim Variable%</paragraph> +<paragraph id="par_idm1341157968" role="bascode" localize="false" xml-lang="en-US">Dim Variable As Integer</paragraph> +</bascode> + +<h3 id="hd_id3147546">Long Integer Variables</h3> +<paragraph id="par_id3151193" role="paragraph" xml-lang="en-US">Long integer variables range from -2147483648 to 2147483647. If you assign a floating-point value to a long integer variable, the decimal places are rounded to the next integer. Long integer variables are rapidly calculated in procedures and are suitable for counter variables in loops for large values. A long integer variable requires four bytes of memory. "&" is the type-declaration character.</paragraph> +<bascode> +<paragraph id="par_idm1341151984" role="bascode" localize="false" xml-lang="en-US">Dim Variable&</paragraph> +<paragraph id="par_idm1341150736" role="bascode" localize="false" xml-lang="en-US">Dim Variable As Long</paragraph> +</bascode> + +<h3 id="hd_id7596972">Decimal Variables<comment>see i64349</comment></h3> +<paragraph id="par_id2649311" role="paragraph" xml-lang="en-US">Decimal variables can take positive or negative numbers or zero. Accuracy is up to 29 digits.</paragraph><comment>i85284</comment> +<paragraph id="par_id7617114" role="paragraph" xml-lang="en-US">You can use plus (+) or minus (-) signs as prefixes for decimal numbers (with or without spaces).</paragraph> +<paragraph id="par_id1593676" role="paragraph" xml-lang="en-US">If a decimal number is assigned to an integer variable, %PRODUCTNAME Basic rounds the figure up or down.<comment>information from "Programming Guide for BASIC" about decimal variables</comment></paragraph> + +<h3 id="hd_id3147500">Single Variables</h3> +<paragraph id="par_id3153070" role="paragraph" xml-lang="en-US">Single variables can take positive or negative values ranging from 3.402823 x 10E38 to 1.401298 x 10E-45. Single variables are floating-point variables, in which the decimal precision decreases as the non-decimal part of the number increases. Single variables are suitable for mathematical calculations of average precision. Calculations require more time than for Integer variables, but are faster than calculations with Double variables. A Single variable requires 4 bytes of memory. The type-declaration character is "!".</paragraph> +<bascode> +<paragraph id="par_idm1341137456" role="bascode" localize="false" xml-lang="en-US">Dim Variable!</paragraph> +<paragraph id="par_idm1341136224" role="bascode" localize="false" xml-lang="en-US">Dim Variable As Single</paragraph> +</bascode> + +<h3 id="hd_id3155753">Double Variables</h3> +<paragraph id="par_id3150953" role="paragraph" xml-lang="en-US">Double variables can take positive or negative values ranging from 1.79769313486232 x 10E308 to 4.94065645841247 x 10E-324. Double variables are floating-point variables, in which the decimal precision decreases as the non-decimal part of the number increases. Double variables are suitable for precise calculations. Calculations require more time than for Single variables. A Double variable requires 8 bytes of memory. The type-declaration character is "#".</paragraph> +<bascode> +<paragraph id="par_idm1341130144" role="bascode" xml-lang="en-US">Dim Variable#</paragraph> +<paragraph id="par_idm1341128912" role="bascode" localize="false" xml-lang="en-US">Dim Variable As Double</paragraph> +</bascode> + +<h3 id="hd_id3155747">Currency Variables</h3> +<paragraph id="par_id3153337" role="paragraph" xml-lang="en-US">Currency variables are internally stored as 64-bit numbers (8 Bytes) and displayed as a fixed-decimal number with 15 non-decimal and 4 decimal places. The values range from -922337203685477.5808 to +922337203685477.5807. Currency variables are used to calculate currency values with a high precision. The type-declaration character is "@".</paragraph> +<bascode> +<paragraph id="par_idm1341123216" role="bascode" localize="false" xml-lang="en-US">Dim Variable@</paragraph> +<paragraph id="par_idm1341121984" role="bascode" localize="false" xml-lang="en-US">Dim Variable As Currency</paragraph> +</bascode> + +<h3 id="hd_id301576839713868">Literals for integers</h3> +<paragraph role="paragraph" id="par_id1001576839723156">Numbers can be encoded using octal and hexadecimal forms.</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id331576850637825" localize="false">xi = &o13 ' 8 + 3</paragraph> + <paragraph role="bascode" id="bas_id761576850640144" localize="false">ci = &h65 ' 6*16 + 5</paragraph> + <paragraph role="bascode" id="bas_id511576850640336" localize="false">MAX_Integer = &o77777 ' 32767 = &h7FFF</paragraph> + <paragraph role="bascode" id="bas_id571576850640536" localize="false">MIN_Integer = &o100000 ' -32768 = &h8000</paragraph> + <paragraph role="bascode" id="bas_id541576850641922" localize="false">MAX_Long = &h7fffffff ' 2147483647 = &o17777777777</paragraph> + <paragraph role="bascode" id="bas_id481576850564801" localize="false">MIN_Long = &h80000000 ' -2147483648 = &o20000000000</paragraph> +</bascode> + +<h3 id="hd_id3148742">String Variables</h3> +<paragraph id="par_id3151393" role="paragraph" xml-lang="en-US">String variables can hold character strings with up to 2,147,483,648 characters. Each character is stored as the corresponding Unicode value. String variables are suitable for word processing within programs and for temporary storage of any non-printable character up to a maximum length of 2 Gbytes. The memory required for storing string variables depends on the number of characters in the variable. The type-declaration character is "$".</paragraph> +<tip id="par_id381599081637549">In BASIC String functions, the first character of the string has index 1.</tip> +<bascode> +<paragraph id="par_idm1341116176" role="bascode" localize="false" xml-lang="en-US">Dim Variable$</paragraph> +<paragraph id="par_idm1341114944" role="bascode" localize="false" xml-lang="en-US">Dim Variable As String</paragraph> +</bascode> + +<h3 id="hd_id3150534">Boolean Variables</h3> +<paragraph id="par_id3145632" role="paragraph" xml-lang="en-US">Boolean variables store only one of two values: TRUE or FALSE. A number 0 evaluates to FALSE, every other value evaluates to TRUE.</paragraph> +<bascode> +<paragraph id="par_idm1341109456" role="bascode" localize="false" xml-lang="en-US">Dim Variable As Boolean</paragraph> +</bascode> + +<h3 id="hd_id3149722">Date Variables</h3> +<paragraph id="par_id3159116" role="paragraph" xml-lang="en-US">Date variables can only contain dates and time values stored in an internal format. Values assigned to Date variables with <link href="text/sbasic/shared/03030101.xhp" name="Dateserial"><emph>Dateserial</emph></link>, <link href="text/sbasic/shared/03030102.xhp" name="Datevalue"><emph>Datevalue</emph></link>, <link href="text/sbasic/shared/03030205.xhp" name="Timeserial"><emph>Timeserial</emph></link> or <link href="text/sbasic/shared/03030206.xhp" name="Timevalue"><emph>Timevalue</emph></link> are automatically converted to the internal format. Date-variables are converted to normal numbers by using the <link href="text/sbasic/shared/03030103.xhp" name="Day"><emph>Day</emph></link>, <link href="text/sbasic/shared/03030104.xhp" name="Month"><emph>Month</emph></link>, <link href="text/sbasic/shared/03030106.xhp" name="Year"><emph>Year</emph></link> or the <link href="text/sbasic/shared/03030201.xhp" name="Hour"><emph>Hour</emph></link>, <link href="text/sbasic/shared/03030202.xhp" name="Minute"><emph>Minute</emph></link>, <link href="text/sbasic/shared/03030204.xhp" name="Second"><emph>Second</emph></link> function. The internal format enables a comparison of date/time values by calculating the difference between two numbers. These variables can only be declared with the key word <emph>Date</emph>.</paragraph> +<bascode> +<paragraph id="par_idm1341092144" role="bascode" localize="false" xml-lang="en-US">Dim Variable As Date</paragraph> +</bascode> + +<bookmark xml-lang="en-US" branch="index" id="bm_id3150669"> + <bookmark_value>ampersand symbol; in literal notation</bookmark_value> + <bookmark_value>literals;hexadecimal</bookmark_value> + <bookmark_value>literals;octal</bookmark_value> + <bookmark_value>literals;&h notation</bookmark_value> + <bookmark_value>literals;&o notation</bookmark_value> +</bookmark> +<h3 id="hd_DateLiterals">Literals for Dates</h3> +<section id="DateLiterals"> +<paragraph role="paragraph" id="par_id151616083357363">Date literals allow to specify unambiguous date variables that are independent from the current language. Literals are enclosed between hash signs <literal>#</literal>. Possible formats are:</paragraph> +<list type="unordered"> + <listitem> + <paragraph id="par_id41616083766108" role="listitem" localize="false"><literal>#yyyy-mm-dd#</literal></paragraph> + </listitem> + <listitem> + <paragraph id="par_id271616083874773" role="listitem" localize="false"><literal>#mm/dd/yyyy#</literal></paragraph> + </listitem> +</list> +</section> +<bascode> + <paragraph role="bascode" id="bas_id201616314705492" localize="false">start_date = #12/30/1899# ' = 1</paragraph> + <paragraph role="bascode" id="bas_id616163714705267" localize="false">dob = #2010-09-28#</paragraph> +</bascode> + +<bookmark xml-lang="en-US" branch="index" id="bm_id601619552599885"> + <bookmark_value>The Variant type</bookmark_value> + <bookmark_value>The Any type</bookmark_value> +</bookmark> +<h2 id="VariantTypeH2">The Variant type</h2> +<paragraph role="paragraph" id="par_id1001619552129323">Variables declared as <emph>Variant</emph> can handle any data type. This means that the actual data type is defined during runtime as a value is assigned to the variable.</paragraph> +<paragraph role="paragraph" id="par_id631619552417188">There are three main ways to create a <emph>Variant</emph> variable, as shown below:</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id751619554900163">Dim varA ' The type is not specified, hence the variable is a Variant</paragraph> + <paragraph role="bascode" id="bas_id181619554965451">Dim varB as Variant ' The variable is explicitly declared as a Variant</paragraph> + <paragraph role="bascode" id="bas_id371619554853094">varC = "abc" ' Previously undeclared variables are treated as Variants</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id631619552417343">The example below uses the <link href="text/sbasic/shared/03103600.xhp" name="TypeName function">TypeName function</link> to show how the type of a <emph>Variant</emph> variable changes upon assignment.</paragraph> +<bascode> + <paragraph role="bascode" localize="false" id="bas_id221619552494450">Dim myVar As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id221619553194424">MsgBox TypeName(myVar) ' Empty</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671619553194736">myVar = "Hello!"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91619553195040">MsgBox TypeName(myVar) ' String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id731619553195384">myVar = 10</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211619553195648">MsgBox TypeName(myVar) ' Integer</paragraph> +</bascode> +<note id="par_id141619553442668">A <emph>Variant</emph> variable is initialized with the <link href="text/sbasic/shared/03040000.xhp#objectconstants" name=" object constants">Empty</link> special data type. You can use the <link href="text/sbasic/shared/03102400.xhp" name="IsEmpty function">IsEmpty function</link> to test if a variable is an <emph>Empty Variant</emph>.</note> +<paragraph role="paragraph" id="par_id541619552755706">You can also use the keyword <emph>Any</emph> to declare a variable as a <emph>Variant</emph>. However, <emph>Any</emph> is deprecated and is available for backward compatibility.</paragraph> +<warning id="par_id711619622934043">Arguments with type <emph>Variant</emph> or <emph>Any</emph> passed in function calls are not checked for their types.</warning> +<bascode> + <paragraph role="bascode" id="bas_id141619552837486">Dim myVar As Any ' Variable "myVar" is a Variant</paragraph> +</bascode> + +<h2 id="hd_id3148732">Initial Variable Values</h2> +<paragraph id="par_id3154549" role="paragraph" xml-lang="en-US">As soon as the variable has been declared, it is automatically set to the "Null" value. Note the following conventions:</paragraph> +<paragraph id="par_id3143222" role="paragraph" xml-lang="en-US"> <emph>Numeric</emph> variables are automatically assigned the value "0" as soon as they are declared.</paragraph> +<paragraph id="par_id3150693" role="paragraph" xml-lang="en-US"> <emph>Date variables</emph> are assigned the value 0 internally; equivalent to converting the value to "0" with the <link href="text/sbasic/shared/03030103.xhp" name="Day"><emph>Day</emph></link>, <link href="text/sbasic/shared/03030104.xhp" name="Month"><emph>Month</emph></link>, <link href="text/sbasic/shared/03030106.xhp" name="Year"><emph>Year</emph></link> or the <link href="text/sbasic/shared/03030201.xhp" name="Hour"><emph>Hour</emph></link>, <link href="text/sbasic/shared/03030202.xhp" name="Minute"><emph>Minute</emph></link>, <link href="text/sbasic/shared/03030204.xhp" name="Second"><emph>Second</emph></link> function.</paragraph> +<paragraph id="par_id3154807" role="paragraph" xml-lang="en-US"> <emph>String variables</emph> are assigned an empty-string ("") when they are declared.</paragraph> + +<h2 id="hd_id3153936">Arrays</h2> +<paragraph id="par_id3148736" role="paragraph" xml-lang="en-US">$[officename] Basic knows one- or multi-dimensional arrays, defined by a specified variable type. Arrays are suitable for editing lists and tables in programs. Individual elements of an array can be addressed through a numeric index.</paragraph> +<paragraph id="par_id3149546" role="paragraph" xml-lang="en-US">Arrays <emph>must</emph> be declared with the <emph>Dim</emph> statement. There are several ways to define the index range of an array:</paragraph> + +<bascode> + <paragraph id="par_idm1341065280" role="bascode">Dim Text$(20) '21 elements numbered from 0 to 20'</paragraph> + <paragraph id="par_idm1341059776" role="bascode">Dim Text$(5,4) '30 elements (a matrix of 6 x 5 elements)'</paragraph> + <paragraph id="par_idm1341054256" role="bascode">Dim Text$(5 To 25) '21 elements numbered from 5 to 25'</paragraph> + <paragraph id="par_idm1341048752" role="bascode">Dim Text$(-15 To 5) '21 elements (including 0), numbered from -15 to 5'</paragraph> +</bascode> + +<paragraph id="par_id3153005" role="paragraph" xml-lang="en-US">The index range can include positive as well as negative numbers. <comment>i36558</comment></paragraph> + +<h2 id="hd_id3154507">Constants</h2> +<paragraph id="par_id3156357" role="paragraph" xml-lang="en-US">Constants have a fixed value. They are only defined once in the program and cannot be redefined later:</paragraph> +<bascode> +<paragraph id="par_idm1341038256" role="bascode" localize="false" xml-lang="en-US">Const ConstName=Expression</paragraph> +</bascode> + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id281619620439154" localize="false"><embedvar href="text/sbasic/shared/03040000.xhp#basicconstantsh1" markup="ignore"/></paragraph> + <paragraph role="paragraph" id="par_id641619620637722" localize="false"><embedvar href="text/sbasic/shared/03102100.xhp#Dimh1" markup="ignore"/></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01020200.xhp b/helpcontent2/source/text/sbasic/shared/01020200.xhp new file mode 100644 index 000000000..186a43f39 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01020200.xhp @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01020200xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Using Objects</title> +<filename>/text/sbasic/shared/01020200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="objects"> +<paragraph role="heading" id="hd_id3145645" xml-lang="en-US" level="1"><variable id="01020200"><link href="text/sbasic/shared/01020200.xhp">Using the Object Catalog</link> +</variable></paragraph> +<paragraph role="paragraph" id="par_id3153707" xml-lang="en-US">The object catalog provides an overview of all modules and dialogs you have created in $[officename].</paragraph> +</section> +<section id="object_catalog"> +<paragraph role="paragraph" id="par_id3147346" xml-lang="en-US">Click the <emph>Object Catalog</emph> icon +<image id="img_id3147341" src="cmd/sc_objectcatalog.png" width="0.564cm" height="0.564cm"><alt id="alt_id3147341" xml-lang="en-US">Icon</alt> + </image> in the Macro toolbar to display the object catalog.</paragraph> +<paragraph role="paragraph" id="par_id3155114" xml-lang="en-US">The dialog shows a list of all existing objects in a hierarchical representation. Double-clicking a list entry opens its subordinate objects.</paragraph> +<paragraph role="paragraph" id="par_id3150786" xml-lang="en-US">To display a certain module in the Editor or to position the cursor in a selected SUB or FUNCTION, double click on the corresponding entry.</paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01020300.xhp b/helpcontent2/source/text/sbasic/shared/01020300.xhp new file mode 100644 index 000000000..b50699fe2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01020300.xhp @@ -0,0 +1,169 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> +<meta> + <topic id="textsbasicshared01020300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Using Procedures, Functions or Properties</title> + <filename>/text/sbasic/shared/01020300.xhp</filename> + </topic> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149456"> + <bookmark_value>procedures</bookmark_value> + <bookmark_value>functions;using</bookmark_value> + <bookmark_value>variables;passing to procedures, functions, properties</bookmark_value> + <bookmark_value>parameters;for procedures, functions or properties</bookmark_value> + <bookmark_value>parameters;passing by reference or value</bookmark_value> + <bookmark_value>variables;scope</bookmark_value> + <bookmark_value>scope of variables</bookmark_value> + <bookmark_value>GLOBAL variables</bookmark_value> + <bookmark_value>PUBLIC variables</bookmark_value> + <bookmark_value>PRIVATE variables</bookmark_value> + <bookmark_value>functions;return value type</bookmark_value> + <bookmark_value>return value type of functions</bookmark_value> +</bookmark> +<section id="procedures"> +<h1 id="hd_id3149456"><variable id="UsingSubs_h1"><link href="text/sbasic/shared/01020300.xhp">Using Procedures, Functions and Properties</link></variable></h1> +<paragraph id="par_id3150767" role="paragraph">The following describes the basic use of procedures, functions and properties in %PRODUCTNAME Basic.</paragraph> +</section> +<note id="par_id3151215">When you create a new module, %PRODUCTNAME Basic automatically inserts a <literal>Sub</literal> called "<literal>Main</literal>". This default name has nothing to do with the order or the starting point of a %PRODUCTNAME Basic project. You can also safely rename this <literal>Sub</literal>routine.</note> +<note id="par_id314756320">Some restrictions apply for the names of your public variables, subroutines, functions and properties. You must not use the same name as one of the modules of the same library.</note> +<paragraph id="par_id3154124" role="paragraph" xml-lang="en-US">Procedures (<literal>Sub</literal>routines) functions (<literal>Function</literal>) and properties (<literal>Property</literal>) help you maintaining a structured overview by separating a program into logical pieces.</paragraph> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US">One benefit of procedures, functions and properties is that, once you have developed a program code containing task components, you can use this code in another project.</paragraph> +<h2 id="hd_id3153770">Passing Variables to Procedures, Functions or Properties</h2> +<paragraph id="par_id3155414" role="paragraph" xml-lang="en-US">Variables can be passed to both procedures, functions or properties. The <literal>Sub</literal> <literal>Function</literal> or <literal>Property</literal> must be declared to expect parameters:</paragraph> +<bascode> + <paragraph id="par_idm1340846688" role="bascode" localize="false">Sub SubName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...)</paragraph> + <paragraph id="par_id3151114" role="bascode" xml-lang="en-US"> ' your code goes here</paragraph> + <paragraph id="par_idm1340843712" role="bascode" localize="false">End Sub</paragraph> +</bascode> +<paragraph id="par_id3152577" role="paragraph" xml-lang="en-US">The <literal>Sub</literal> is called using the following syntax:</paragraph> +<bascode> + <paragraph id="par_idm1341029952" role="bascode" localize="false" xml-lang="en-US">[Call] SubName( [Parameter1:=]Value1, [Parameter2:=]Value2, ...)</paragraph> +</bascode> +<paragraph id="par_id3147124" role="paragraph" xml-lang="en-US">The parameters passed to a <literal>Sub</literal> must fit to those specified in the <literal>Sub</literal> declaration.</paragraph> +<paragraph id="par_id3147397" role="paragraph" xml-lang="en-US">The same process applies to a <literal>Function</literal>. In addition, functions always return a function result. The result of a function is defined by assigning the return value to the function name:</paragraph> +<bascode> + <paragraph id="par_idm1341024672" role="bascode" localize="false">Function FunctionName(Parameter1 As TYPENAME, Parameter2 As TYPENAME,...) As TYPENAME</paragraph> + <paragraph id="par_id3156284" role="bascode" xml-lang="en-US"> ' your code goes here</paragraph> + <paragraph id="par_id3145799" role="bascode" localize="false"> FunctionName=Result</paragraph> + <paragraph id="par_idm1341019952" role="bascode" localize="false">End Function</paragraph> +</bascode> +<paragraph id="par_id3153839" role="paragraph" xml-lang="en-US">The <literal>Function</literal> is called using the following syntax:</paragraph> +<bascode> + <paragraph id="par_id3146914" role="bascode" xml-lang="en-US" localize="false">Variable = FunctionName( [Parameter1:=]Value1, [Parameter2:=]Value2, ...)</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id981584288549909">Properties combine the syntax of procedures and functions. A <literal>Property</literal> usually requires up to one parameter.</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id521585039888250" localize="false">Private _IsApproved As TYPENAME</paragraph> + <paragraph role="bascode" id="bas_id471584288905523" localize="false">Property Get IsApproved As TYPENAME</paragraph> + <paragraph role="bascode" id="bas_id961584288948497" xml-lang="en-US"> ' your code goes here</paragraph> + <paragraph role="bascode" id="bas_id851585039999280" localize="false"> IsApproved = some_computation</paragraph> + <paragraph role="bascode" id="bas_id631584288950491" localize="false">End Property</paragraph> + <paragraph role="bascode" id="bas_id271584288951107" localize="false">Property Let IsApproved(value As TYPENAME)</paragraph> + <paragraph role="bascode" id="bas_id921584288951588" xml-lang="en-US"> ' your code goes here</paragraph> + <paragraph role="bascode" id="bas_id721584289581705" localize="false"> _IsApproved = computed_value</paragraph> + <paragraph role="bascode" id="bas_id491584288952356" localize="false">End Property</paragraph> +</bascode> +<paragraph id="par_id3153389" role="paragraph" xml-lang="en-US">The <literal>Property</literal> is called using the following syntax:</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id511584289696025" localize="false">var = IsApproved</paragraph> + <paragraph role="bascode" id="bas_id551584289696697" localize="false">IsApproved = some_value</paragraph> +</bascode> +<tip id="par_idN107B3">You can also use the fully qualified name to call a procedure, function or property:<br/> <literal>[Call] Library.Module.Macro()</literal>, where <literal>Call</literal> is optional.<br/> For example, to call the Autotext macro from the Gimmicks library, use the following command:<br/> <literal>Gimmicks.AutoText.Main()</literal></tip> +<h2 id="hd_id3156276">Passing Variables by Value or Reference</h2> +<paragraph id="par_id3155765" role="paragraph" xml-lang="en-US">Parameters can be passed to a procedure, a function or a property either by reference or by value. Unless otherwise specified, a parameter is always passed by reference. That means that a <literal>Sub</literal>, a <literal>Function</literal> or a <literal>Property</literal> gets the parameter and can read and modify its value.</paragraph> +<paragraph id="par_id3145640" role="paragraph" xml-lang="en-US">If you want to pass a parameter by value insert the key word <literal>ByVal</literal> in front of the parameter when you call a <literal>Sub</literal>, a <literal>Function</literal> or a <literal>Property</literal>, for example:</paragraph> +<bascode> + <paragraph id="par_id3150042" role="bascode" localize="false">Function ReadOnlyParms(ByVal p2, ByVal p2)</paragraph> + <paragraph role="bascode" id="bas_id81584367761978"> ' your code goes here</paragraph> + <paragraph role="bascode" id="bas_id131584367516784" localize="false">End Function</paragraph> + <paragraph role="bascode" id="bas_id801584367475787" localize="false">result = ReadOnlyParms(parm1, parm2)</paragraph> +</bascode> +<paragraph id="par_id3149258" role="paragraph" xml-lang="en-US">In this case, the original content of the parameter will not be modified by the <literal>Function</literal> since it only gets the value and not the parameter itself.</paragraph> +<h2 id="hd_id161584366585035">Defining Optional Parameters</h2> +<paragraph role="paragraph" id="par_id31584367006971">Functions, procedures or properties can be defined with optional parameters, for example:</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id761584366669997" localize="false">Sub Rounding(number, Optional decimals, Optional format)</paragraph> + <paragraph role="bascode" id="bas_id111584366809406"> ' your code goes here</paragraph> + <paragraph role="bascode" id="bas_id251584366745722" localize="false">End Sub</paragraph> +</bascode> +<h2 id="hd_id951622730099178">Positional or Keyword Arguments</h2> +<paragraph role="paragraph" id="par_id591622730131786">When you call a function or a subroutine, you may pass its arguments by position or by name. Passing by position means just listing the arguments in the order in which the parameters are defined in the function or subroutine. Passing by name requires you to prefix the argument with the name of the corresponding parameter followed by a colon and an equal sign (<literal>:=</literal>). Keyword arguments may appear in any order. Refer to Basic Replace() function for such examples.</paragraph> +<section id="kwargs"> +<paragraph role="paragraph" id="par_id591622730284162">When needing to pass less parameters, use keywords arguments. Passing values for fewer parameters by position requires to supply values for all parameters before them, optional or not. This ensures that the values are in the correct positions. If you pass the parameters by name - using keyword arguments - you may omit all other intermediate arguments.</paragraph> +</section> +<h2 id="hd_id3150982">Scope of Variables</h2> +<paragraph id="par_id3149814" role="paragraph" xml-lang="en-US">A variable defined within a <literal>Sub</literal>, a <literal>Function</literal> or a <literal>Property</literal>, only remains valid until the procedure is exited. This is known as a "local" variable. In many cases, you need a variable to be valid in all procedures, in every module of all libraries, or after a <literal>Sub</literal>, a <literal>Function</literal> or a <literal>Property</literal> is exited.</paragraph> +<h3 id="hd_id3154186">Declaring Variables Outside a <literal>Sub</literal> a <literal>Function</literal> or a <literal>Property</literal></h3> +<bascode> +<paragraph id="par_id3150208" role="bascode" xml-lang="en-US" localize="false">Global VarName As TYPENAME</paragraph> +</bascode> +<paragraph id="par_id3145258" role="paragraph" xml-lang="en-US">The variable is valid as long as the %PRODUCTNAME session lasts.</paragraph> +<bascode> +<paragraph id="par_id3153198" role="bascode" xml-lang="en-US" localize="false">Public VarName As TYPENAME</paragraph> +</bascode> +<paragraph id="par_id3150088" role="paragraph" xml-lang="en-US" >The variable is valid in all modules.</paragraph> +<bascode> +<paragraph id="par_id3158212" role="bascode" xml-lang="en-US" localize="false">Private VarName As TYPENAME</paragraph> +</bascode> +<paragraph id="par_id3152994" role="paragraph" xml-lang="en-US">The variable is only valid in this module.</paragraph> +<bascode> +<paragraph id="par_id3150886" role="bascode" xml-lang="en-US" localize="false">Dim VarName As TYPENAME</paragraph> +</bascode> +<paragraph id="par_id3150368" role="paragraph" xml-lang="en-US">The variable is only valid in this module.</paragraph> +<h3 id="hd_id5097506">Example for private variables</h3> +<paragraph id="par_id8738975" role="paragraph" xml-lang="en-US">Enforce private variables to be private across modules by setting <literal>CompatibilityMode(True)</literal>.</paragraph><comment>from i17948, see i54894</comment> +<bascode> + <paragraph id="par_idm1340976400" role="bascode" localize="false">' ***** Module1 *****</paragraph> + <paragraph id="par_idm1340975168" role="bascode" localize="false">Private myText As String</paragraph> + <paragraph id="par_idm1340973920" role="bascode" localize="false">Sub initMyText</paragraph> + <paragraph id="par_id9475997" role="bascode" xml-lang="en-US"> myText = "Hello"</paragraph> + <paragraph id="par_id6933500" role="bascode" xml-lang="en-US"> Print "In module1 : ", myText</paragraph> + <paragraph id="par_idm1340970208" role="bascode" localize="false">End Sub</paragraph> + <paragraph id="par_idm1340968976" role="bascode" localize="false"> </paragraph> + <paragraph id="par_idm1340967728" role="bascode" localize="false">' ***** Module2 *****</paragraph> + <paragraph id="par_idm1340966496" role="bascode" localize="false">'Option Explicit</paragraph> + <paragraph id="par_idm1340965264" role="bascode" localize="false">Sub demoBug</paragraph> + <paragraph id="par_idm1340964032" role="bascode" localize="false"> CompatibilityMode( True )</paragraph> + <paragraph id="par_idm1340962784" role="bascode" localize="false"> initMyText</paragraph> + <paragraph id="par_id4104129" role="bascode" xml-lang="en-US"> ' Now returns empty string</paragraph> + <paragraph id="par_id7906125" role="bascode" xml-lang="en-US"> ' (or raises error for Option Explicit)</paragraph> + <paragraph id="par_id8055970" role="bascode" xml-lang="en-US"> Print "Now in module2 : ", myText</paragraph> + <paragraph id="par_idm1340957792" role="bascode" localize="false">End Sub</paragraph> +</bascode> +<h3 id="hd_id3154368">Saving Variable Content after Exiting a <literal>Sub</literal> a <literal>Function</literal> or a <literal>Property</literal></h3> +<bascode> + <paragraph id="par_id3156288" role="bascode" xml-lang="en-US" localize="false">Static VarName As TYPENAME</paragraph> +</bascode> +<paragraph id="par_id3154486" role="paragraph" xml-lang="en-US">The variable retains its value until the next time the a <literal>Function</literal>, <literal>Sub</literal> or <literal>Property</literal> is entered. The declaration must exist inside a <literal>Sub</literal>, a <literal>Function</literal> or a <literal>Property</literal>.</paragraph> +<h2 id="hd_id3155809">Specifying the Return Value Type of a <literal>Function</literal> or a <literal>Property</literal></h2> +<paragraph id="par_id3149404" role="paragraph" xml-lang="en-US">As with variables, include a type-declaration character after the function name, or the type indicated by <literal>As</literal> and the corresponding data type at the end of the parameter list to define the type of the function or property's return value, for example:</paragraph> +<bascode> + <paragraph id="par_idm1340946176" role="bascode" localize="false" xml-lang="en-US">Function WordCount(WordText As String) As Integer</paragraph> +</bascode> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/compatibilitymode.xhp#compatibilitymodeh1"/> + <embed href="text/sbasic/shared/03103300.xhp#explicitstatement"/> + <paragraph role="paragraph" id="N0237"><link href="text/sbasic/shared/03104100.xhp" name ="Optional keyword">Optional keyword</link></paragraph> + <paragraph role="paragraph" id="N0238"><link href="text/sbasic/shared/property.xhp" name ="Property Statement">Property Statement</link></paragraph> + <paragraph role="paragraph" id="N0239"><link href="text/sbasic/shared/03103500.xhp" name ="Static Statement">Static Statement</link></paragraph> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/01020500.xhp b/helpcontent2/source/text/sbasic/shared/01020500.xhp new file mode 100644 index 000000000..4be972c38 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01020500.xhp @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01020500xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Libraries, Modules and Dialogs</title> +<filename>/text/sbasic/shared/01020500.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="biblio"> +<paragraph role="heading" id="hd_id3147317" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01020500.xhp" name="Libraries, Modules and Dialogs">Libraries, Modules and Dialogs</link></paragraph> +<paragraph role="paragraph" id="par_id3147427" xml-lang="en-US">The following describes the basic use of libraries, modules and dialogs in $[officename] Basic.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3146120" xml-lang="en-US">$[officename] Basic provides tools to help you structuring your projects. It supports various "units" which enable you to group individual SUBS and FUNCTIONS in a Basic project.</paragraph> +<paragraph role="heading" id="hd_id3148575" xml-lang="en-US" level="2">Libraries</paragraph> +<paragraph role="paragraph" id="par_id3150011" xml-lang="en-US">Libraries serve as a tool for organizing modules, and can either be attached to a document or a template. When the document or a template is saved, all modules contained in the library are automatically saved as well.</paragraph> +<paragraph role="paragraph" id="par_id3151112" xml-lang="en-US">A library can contain up to 16,000 modules.</paragraph> +<paragraph role="heading" id="hd_id3149262" xml-lang="en-US" level="2">Modules</paragraph> +<paragraph role="paragraph" id="par_id3156441" xml-lang="en-US">A module contains SUBS and FUNCTIONS along with variable declarations. The length of the program that can be saved in a module is limited to 64 kB. If more space is required you can divide a $[officename] Basic project among several modules, and then save them in a single library.</paragraph> +<paragraph role="heading" id="hd_id3152577" xml-lang="en-US" level="2">Dialog Modules</paragraph> +<paragraph role="paragraph" id="par_id3149377" xml-lang="en-US">Dialog modules contain dialog definitions, including the dialog box properties, the properties of each dialog element and the events assigned. Since a dialog module can only contain a single dialog, they are often referred to as "dialogs".</paragraph> +<section id="relatedtopics"> +<embed href="text/sbasic/shared/01030400.xhp#01030400"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01030000.xhp b/helpcontent2/source/text/sbasic/shared/01030000.xhp new file mode 100644 index 000000000..da133db88 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01030000.xhp @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01030000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Integrated Development Environment (IDE)</title> +<filename>/text/sbasic/shared/01030000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="ide"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145090"><bookmark_value>Basic IDE;Integrated Development Environment</bookmark_value> +<bookmark_value>IDE;Integrated Development Environment</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3145090" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01030000.xhp" name="Integrated Development Environment (IDE)">Integrated Development Environment (IDE)</link></paragraph> +<paragraph role="paragraph" id="par_id3146795" xml-lang="en-US">This section describes the Integrated Development Environment for $[officename] Basic.</paragraph> +</section> +<embed href="text/sbasic/shared/01030100.xhp#overview"/> +<embed href="text/sbasic/shared/01030400.xhp#libs_modules"/> +<embed href="text/sbasic/shared/01030200.xhp#basiceditor"/> +<embed href="text/sbasic/shared/01030300.xhp#basicdebugging"/> +<embed href="text/shared/optionen/BasicIDE.xhp#basicide"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01030100.xhp b/helpcontent2/source/text/sbasic/shared/01030100.xhp new file mode 100644 index 000000000..027ee2806 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01030100.xhp @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01030100xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">IDE Overview</title> +<filename>/text/sbasic/shared/01030100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<bookmark xml-lang="en-US" branch="hid/BASCTL_HID_BASICIDE_MODULWINDOW" id="bm_id3093440" localize="false"/> +<section id="overview"> +<paragraph role="heading" id="hd_id3147291" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01030100.xhp" name="IDE Overview">IDE Overview</link></paragraph> +</section> +<paragraph role="paragraph" id="par_id3156344" xml-lang="en-US">The <link href="text/sbasic/shared/main0211.xhp" name="Macro Toolbar"><emph>Macro Toolbar</emph></link> in the IDE provides various icons for editing and testing programs.</paragraph> +<paragraph role="paragraph" id="par_id3151210" xml-lang="en-US">In the <link href="text/sbasic/shared/01030200.xhp" name="Editor window"><emph>Editor window</emph></link>, directly below the Macro toolbar, you can edit the Basic program code. The column on the left side is used to set breakpoints in the program code.</paragraph> +<paragraph role="paragraph" id="par_id3154686" xml-lang="en-US">The <link href="text/sbasic/shared/01050100.xhp" name="Watch"><emph>Watch window</emph></link> (observer) is located below the Editor window at the left, and displays the contents of variables or arrays during a single step process.</paragraph> +<paragraph role="paragraph" id="par_id3145787" xml-lang="en-US">The <emph>Call Stack</emph> window to the right provides information about the call stack of SUBS and FUNCTIONS when a program runs.</paragraph> +<section id="relatedtopics"> +<paragraph role="paragraph" id="par_id3147434" xml-lang="en-US"><link href="text/sbasic/shared/01050000.xhp" name="Basic IDE">Basic IDE</link></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01030200.xhp b/helpcontent2/source/text/sbasic/shared/01030200.xhp new file mode 100644 index 000000000..bafdfa0ec --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01030200.xhp @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01030200xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">The Basic Editor</title> +<filename>/text/sbasic/shared/01030200.xhp</filename> +</topic> +</meta> +<body> +<bookmark xml-lang="en-US" branch="hid/start" id="bm_id3147247" localize="false"/> +<section id="basiceditor"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148647"><bookmark_value>saving;Basic code</bookmark_value> +<bookmark_value>loading;Basic code</bookmark_value> +<bookmark_value>Basic editor</bookmark_value> +<bookmark_value>navigating;in Basic projects</bookmark_value> +<bookmark_value>long lines;in Basic editor</bookmark_value> +<bookmark_value>lines of text;in Basic editor</bookmark_value> +<bookmark_value>continuation;long lines in editor</bookmark_value> +</bookmark> +<h1 id="hd_id3147264"><variable id="thebasiceditorh1"><link href="text/sbasic/shared/01030200.xhp" name="The Basic Editor">The Basic Editor</link></variable></h1> +</section> +<paragraph role="paragraph" id="par_id3145069" xml-lang="en-US">The Basic Editor provides the standard editing functions you are familiar with when working in a text document. It supports the functions of the <emph>Edit</emph> menu (Cut, Delete, Paste), the ability to select text with the Shift key, as well as cursor positioning functions (for example, moving from word to word with <switchinline select="sys"><caseinline select="MAC">Command</caseinline><defaultinline>Ctrl</defaultinline></switchinline> and the arrow keys).</paragraph> +<paragraph role="paragraph" id="par_id3154686" xml-lang="en-US">Long lines can be split into several parts by inserting a space and an underline character _ as the last two characters of a line. This connects the line with the following line to one logical line. (If "Option Compatible" is used in the same Basic module, the line continuation feature is also valid for comment lines.)</paragraph> +<paragraph role="paragraph" id="par_id3151042" xml-lang="en-US">If you press the <emph>Run BASIC</emph> icon on the <emph>Macro</emph> bar, program execution starts at the first line of the Basic editor. The program executes the first Sub or Function and then program execution stops. The "Sub Main" does not take precedence on program execution.</paragraph> +<tip id="par_id59816">Insert your Basic code between the Sub Main and End Sub lines that you see when you first open the IDE. Alternatively, delete all lines and then enter your own Basic code.</tip> +<h2 id="hd_id3125863">Navigating in a Project</h2> +<h3 id="hd_id3145785">The Library List</h3> +<paragraph role="paragraph" id="par_id3146120" xml-lang="en-US">Select a library from the <emph>Library</emph> list at the left of the toolbar to load the library in the editor. The first module of the selected library will be displayed.</paragraph> +<h3 id="hd_id3153190">The Object Catalog</h3> +<embed href="text/sbasic/shared/01020200.xhp#object_catalog"/> +<h2 id="hd_id3148647">Saving and Loading Basic Source Code</h2> +<paragraph role="paragraph" id="par_id3154320" xml-lang="en-US">You can save Basic code in a text file for saving and importing in other programming systems.</paragraph> +<warning id="par_id3149959">You cannot save Basic dialogs to a text file.</warning> +<h3 id="hd_id3149403">Saving Source Code to a Text File</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3150327" xml-lang="en-US">Select the module that you want to export as text from the object catalog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3150752" xml-lang="en-US">Click the <emph>Save Source As</emph> icon in the Macro toolbar.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3154754" xml-lang="en-US">Select a file name and click <emph>OK</emph> to save the file.</paragraph> +</listitem> +</list> +<h3 id="hd_id3159264">Loading Source Code From a Text File</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3147343" xml-lang="en-US">Select the module where you want to import the source code from the object catalog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3145230" xml-lang="en-US">Position the cursor where you want to insert the program code.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3149565" xml-lang="en-US">Click the <emph>Insert Source Text</emph> icon in the Macro toolbar.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3154020" xml-lang="en-US">Select the text file containing the source code and click <emph>OK</emph>.</paragraph> +</listitem> +</list> +<section id="relatedtopics"> +<paragraph role="paragraph" id="par_id3153198" xml-lang="en-US"><link href="text/sbasic/shared/01050000.xhp" name="Basic IDE">Basic IDE</link></paragraph> +<embed href="text/sbasic/shared/01020200.xhp#01020200"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01030300.xhp b/helpcontent2/source/text/sbasic/shared/01030300.xhp new file mode 100644 index 000000000..0345d9250 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01030300.xhp @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + + <helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01030300xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Debugging a Basic Program</title> +<filename>/text/sbasic/shared/01030300.xhp</filename> +</topic> +</meta> +<body> +<section id="basicdebugging"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153344"><bookmark_value>debugging Basic programs</bookmark_value> +<bookmark_value>variables; observing values</bookmark_value> +<bookmark_value>watching variables</bookmark_value> +<bookmark_value>run-time errors in Basic</bookmark_value> +<bookmark_value>error codes in Basic</bookmark_value> +<bookmark_value>breakpoints</bookmark_value> +<bookmark_value>Call Stack window</bookmark_value> +</bookmark><paragraph role="heading" id="hd_id3153344" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01030300.xhp">Debugging a Basic Program</link></paragraph> +</section> +<paragraph role="heading" id="hd_id3159224" xml-lang="en-US" level="2">Breakpoints and Single Step Execution</paragraph> +<paragraph role="paragraph" id="par_id3150682" xml-lang="en-US">You can check each line in your Basic program for errors using single step execution. Errors are easily traced since you can immediately see the result of each step. A pointer in the breakpoint column of the Editor indicates the current line. You can also set a breakpoint if you want to force the program to be interrupted at a specific position.</paragraph> +<paragraph role="paragraph" id="par_id3147303" xml-lang="en-US">Double-click in the <emph>breakpoint</emph> column at the left of the Editor window to toggle a breakpoint at the corresponding line. When the program reaches a breakpoint, the program execution is interrupted.</paragraph> +<paragraph role="paragraph" id="par_id3155805" xml-lang="en-US">The <emph>single step </emph>execution using the <emph>Single Step</emph> icon causes the program to branch into procedures and functions.</paragraph> +<paragraph role="paragraph" id="par_id3151110" xml-lang="en-US">The procedure step execution using the <emph>Procedure Step</emph> icon causes the program to skip over procedures and functions as a single step.</paragraph> +<paragraph role="heading" id="hd_id3153825" xml-lang="en-US" level="3">Properties of a Breakpoint</paragraph> +<paragraph role="paragraph" id="par_id3147574" xml-lang="en-US">The properties of a breakpoint are available through its context menu by right-clicking the breakpoint in the breakpoint column.</paragraph> +<paragraph role="paragraph" id="par_id3148473" xml-lang="en-US">You can <emph>activate</emph> and <emph>deactivate</emph> a breakpoint by selecting <emph>Active</emph> from its context menu. When a breakpoint is deactivated, it does not interrupt the program execution. </paragraph> +<paragraph role="paragraph" id="par_id3159413" xml-lang="en-US">Select <emph>Properties</emph> from the context menu of a breakpoint or select <emph>Breakpoints</emph> from the context menu of the breakpoint column to call the <emph>Breakpoints</emph> dialog where you can specify other breakpoint options.</paragraph> +<paragraph role="paragraph" id="par_id3156280" xml-lang="en-US">The list displays all <emph>breakpoints</emph> with the corresponding line number in the source code. You can activate or deactivate a selected breakpoint by checking or clearing the <emph>Active</emph> box.</paragraph> +<paragraph role="paragraph" id="par_id3158407" xml-lang="en-US">The <emph>Pass Count</emph> specifies the number of times the breakpoint can be passed over before the program is interrupted. If you enter 0 (default setting) the program is always interrupted as soon as a breakpoint is encountered.</paragraph> +<paragraph role="paragraph" id="par_id3153968" xml-lang="en-US">Click <emph>Delete</emph> to remove the breakpoint from the program.</paragraph> +<paragraph role="heading" id="hd_id3150439" xml-lang="en-US" level="2">Observing the Value of Variables</paragraph> +<paragraph role="paragraph" id="par_id3153368" xml-lang="en-US">You can monitor the values of a variable by adding it to the <emph>Watch</emph> window. To add a variable to the list of watched variables, type the variable name in the <emph>Watch</emph> text box and press Enter.</paragraph> +<paragraph role="paragraph" id="par_id3146986" xml-lang="en-US">The values of variables are only displayed if they are in scope. Variables that are not defined at the current source code location display ("Out of Scope") instead of a value.</paragraph> +<paragraph role="paragraph" id="par_id3145272" xml-lang="en-US">You can also include arrays in the Watch window. If you enter the name of an array variable without an index value in the Watch text box, the content of the entire array is displayed.</paragraph> +<paragraph role="tip" id="par_id3145749" xml-lang="en-US">If you rest the mouse over a predefined variable in the Editor at run-time, the content of the variable is displayed in a pop-up box.</paragraph><paragraph role="heading" id="hd_id3148618" xml-lang="en-US" level="2">The Call Stack Window</paragraph> +<paragraph role="paragraph" id="par_id3154491" xml-lang="en-US"><ahelp hid="HID_BASICIDE_STACKWINDOW_LIST">Provides an overview of the call hierarchy of procedures and functions.</ahelp> You can determine which procedures and functions called which other procedures and functions at the current point in the source code.</paragraph> +<paragraph role="heading" id="hd_id3150594" xml-lang="en-US" level="2">List of Run-Time Errors</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#allerrors"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01030400.xhp b/helpcontent2/source/text/sbasic/shared/01030400.xhp new file mode 100644 index 000000000..71a53f428 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01030400.xhp @@ -0,0 +1,211 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01030400xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Organizing Libraries and Modules</title> +<filename>/text/sbasic/shared/01030400.xhp</filename> +</topic> +</meta> +<body> +<section id="libs_modules"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148797"> +<bookmark_value>libraries;organizing</bookmark_value> +<bookmark_value>libraries;containers</bookmark_value> +<bookmark_value>modules;organizing</bookmark_value> +<bookmark_value>copying;modules</bookmark_value> +<bookmark_value>adding libraries</bookmark_value> +<bookmark_value>deleting;libraries/modules/dialogs</bookmark_value> +<bookmark_value>dialogs;organizing</bookmark_value> +<bookmark_value>moving;modules</bookmark_value> +<bookmark_value>organizing;modules/libraries/dialogs</bookmark_value> +<bookmark_value>renaming modules and dialogs</bookmark_value> +</bookmark><h1 id="hd_id3148797"><variable id="01030400"><link href="text/sbasic/shared/01030400.xhp">Organizing Libraries and Modules</link> +</variable></h1> +</section> +<h2 id="hd_id371574080559061">Basic Libraries Containers</h2> +<paragraph role="paragraph" id="par_id961574080563824">%PRODUCTNAME Basic libraries can be stored in 3 different containers:</paragraph> +<list type="unordered"> + <listitem> + <paragraph id="par_id571574079618609" role="listitem"><emph>Application Macros</emph>: libraries stored in this container are available for all users of the computer and are managed by the computer administrator. The container is located in the %PRODUCTNAME installation directory.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id151574079741214" role="listitem"><emph>My Macros</emph>: libraries stored in this container are available to all documents of your user. The container is located in the user profile area and is not accessible by another user.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id581574080384335" role="listitem"><emph>Document</emph>: libraries stored in the document container are only available for the document and are accessible only when the document is open. You cannot access macros of a document from another document.</paragraph> + </listitem> +</list> +<paragraph role="paragraph" id="par_id881574081445896">To access macros stored in libraries of <emph>Application Macros</emph> or <emph>My Macros</emph> from another container, including the document container, use the <link href="text/sbasic/shared/03131900.xhp" name="GlobalScope">GlobalScope specifier</link>.</paragraph> +<h2 id="hd_id3150868">Organizing Libraries</h2> +<h3 id="hd_id3125864">Creating a New Library</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3152576" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Macros - %PRODUCTNAME Basic</emph> and click <emph>Organizer</emph> or click the <emph>Select Module</emph> icon in the Basic IDE to open the <emph>Macro Organizer</emph> dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3153726" xml-lang="en-US">Click the <emph>Libraries</emph> tab.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3149664" xml-lang="en-US">Select to where you want to attach the library in the <emph>Location</emph> list. If you select Application Macros & Dialogs, the library will belong to the $[officename] application and will be available for all documents. If you select a document the library will be attached to this document and only available from there.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3153365" xml-lang="en-US">Click <emph>New</emph> and insert a name to create a new library.</paragraph> +</listitem> +</list> +<h3 id="hd_id3147394">Import a Library</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3153157" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Macros - %PRODUCTNAME Basic</emph> and click <emph>Organizer</emph> or click the <emph>Select Module</emph> icon in the Basic IDE to open the <emph>Macro Organizer</emph> dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3146972" xml-lang="en-US">Click the <emph>Libraries</emph> tab.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3145640" xml-lang="en-US">Select to where you want to import the library in the <emph>Location</emph> list. If you select Application Macros & Dialogs, the library will belong to the $[officename] application and will be available for all documents. If you select a document the library will be imported to this document and only available from there.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3154253" xml-lang="en-US">Click <emph>Import...</emph> and select an external library to import.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3154705" xml-lang="en-US">Select all libraries to be imported in the <emph>Import Libraries</emph> dialog. The dialog displays all libraries that are contained in the selected file.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3163807" xml-lang="en-US">If you want to insert the library as a reference only check the <emph>Insert as reference (read-only)</emph> box. Read-only libraries are fully functional but cannot be modified in the Basic IDE.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3145228" xml-lang="en-US">Check the <emph>Replace existing libraries</emph> box if you want existing libraries of the same name to be overwritten.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147004" xml-lang="en-US">Click <emph>OK</emph> to import the library.</paragraph> +</listitem> +</list> +<h3 id="hd_id3159099">Export a Library</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3147005" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Macros - %PRODUCTNAME Basic</emph> and click <emph>Organizer</emph> or click the <emph>Select Module</emph> icon in the Basic IDE to open the <emph>Macro Organizer</emph> dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147006" xml-lang="en-US">Click the <emph>Libraries</emph> tab.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147007" xml-lang="en-US">In the <emph>Location</emph> list you specify where your library is stored. Select the library that you want to export. Note that you cannot export the <emph>Standard</emph> library.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147008" xml-lang="en-US">Click <emph>Export...</emph></paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147009" xml-lang="en-US">Choose whether you want to export the library as an extension or as a BASIC library.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147010" xml-lang="en-US">Click <emph>OK</emph>.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147011" xml-lang="en-US">Select where you want your library exported.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147012" xml-lang="en-US">Click <emph>Save</emph> to export the library.</paragraph> +</listitem> +</list> +<h3 id="hd_id3159100">Deleting a Library</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3150086" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Macros - %PRODUCTNAME Basic</emph> and click <emph>Organizer</emph> or click the <emph>Select Module</emph> icon in the Basic IDE to open the <emph>Macro Organizer</emph> dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3146808" xml-lang="en-US">Click the <emph>Libraries</emph> tab.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3158212" xml-lang="en-US">Select the library to be deleted from the list.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3150361" xml-lang="en-US">Click <emph>Delete</emph>.</paragraph> +</listitem> +</list> +<list type="unordered"> +<listitem> +<paragraph role="listitem" id="par_id3152986" xml-lang="en-US">Deleting a library permanently deletes all existing modules and corresponding procedures and functions.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3148868" xml-lang="en-US">You cannot delete the default library named "Standard".</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3146869" xml-lang="en-US">If you delete a library that was inserted as reference only the reference is deleted but not the library itself.</paragraph> +</listitem> +</list> +<h2 id="hd_id3147070">Organizing Modules and Dialogs</h2> +<h3 id="hd_id3155265">Creating a New Module or Dialog</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3154537" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Macros - %PRODUCTNAME Basic</emph> and click <emph>Organizer</emph> or click the <emph>Select Module</emph> icon in the Basic IDE to open the <emph>Macro Organizer</emph> dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3146781" xml-lang="en-US">Click the <emph>Modules</emph> tab or the <emph>Dialogs</emph> tab.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3159206" xml-lang="en-US">Select the library where the module will be inserted and click <emph>New</emph>.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3152389" xml-lang="en-US">Enter a name for the module or the dialog and click <emph>OK</emph>.</paragraph> +</listitem> +</list> +<h3 id="hd_id3152872">Renaming a Module or Dialog</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3159230" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Macros - %PRODUCTNAME Basic</emph> and click <emph>Organizer</emph> or click the <emph>Select Module</emph> icon in the Basic IDE to open the <emph>Macro Organizer</emph> dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3150046" xml-lang="en-US">Click the module to be renamed twice, with a pause between the clicks. Enter the new name.</paragraph> +<paragraph role="listitem" id="par_id3153801" xml-lang="en-US">In the Basic IDE, right-click the name of the module or dialog in the tabs at the bottom of the screen, choose <emph>Rename</emph> and type in the new name.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3155526" xml-lang="en-US">Press Enter to confirm your changes.</paragraph> +</listitem> +</list> +<h3 id="hd_id3146963">Deleting a Module or Dialog</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3147547" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Macros - %PRODUCTNAME Basic</emph> and click <emph>Organizer</emph> or click the <emph>Select Module</emph> icon in the Basic IDE to open the <emph>Macro Organizer</emph> dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3150958" xml-lang="en-US">Click the <emph>Modules</emph> tab or the <emph>Dialogs</emph> tab.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3149870" xml-lang="en-US">Select the module or dialog to be deleted from the list. Double-click an entry to reveal sub-entries, if required.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3147248" xml-lang="en-US">Click <emph>Delete</emph>.</paragraph> +</listitem> +</list> +<warning id="par_id3151339">Deleting a module permanently deletes all existing procedures and functions in that module.</warning> +<h2 id="hd_id3151392">Organizing Projects among Documents or Templates</h2> +<h3 id="hd_id3156400">Moving or copying modules between documents, templates and the application.</h3> +<list type="ordered"> +<listitem> +<paragraph role="listitem" id="par_id3146819" xml-lang="en-US">Open all documents or templates among which you want to move or copy the modules or dialogs.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3149319" xml-lang="en-US">Choose <emph>Tools - Macros - Organize Macros - %PRODUCTNAME Basic</emph> and click <emph>Organizer</emph> or click the <emph>Select Module</emph> icon in the Basic IDE to open the <emph>Macro Organizer</emph> dialog.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3145637" xml-lang="en-US">To move a module or dialog to another document, click the corresponding object in the list and drag it to the desired position. A horizontal line indicates the target position of the current object while dragging. Hold the <switchinline select="sys"><caseinline select="MAC">Command</caseinline><defaultinline>Ctrl</defaultinline></switchinline> key while dragging to copy the object instead of moving it.</paragraph> +</listitem> +</list> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01040000.xhp b/helpcontent2/source/text/sbasic/shared/01040000.xhp new file mode 100644 index 000000000..942be5ce6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01040000.xhp @@ -0,0 +1,255 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="textsbasicshared01040000xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">Document Event-Driven Macros</title> + <filename>/text/sbasic/shared/01040000.xhp</filename> + </topic> + </meta> + <body> + <section id="eventmacros"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3154581"> + <bookmark_value>deleting; macro assignments to events</bookmark_value> + <bookmark_value>macros; assigning to events</bookmark_value> + <bookmark_value>assigning macros to events</bookmark_value> + <bookmark_value>documents; events</bookmark_value> + <bookmark_value>events; assigning macros</bookmark_value> + <bookmark_value>events; in documents</bookmark_value> + <bookmark_value>API; XDocumentEventListener</bookmark_value> + </bookmark> + <h1 id="hd_id3147348"><link href="text/sbasic/shared/01040000.xhp" name="Event-Driven Macros">Document Event-Driven Macros</link></h1> + <paragraph id="par_id3146120" role="paragraph">This section describes how to assign scripts to application, document or form events.</paragraph> + </section> + <paragraph id="par_id3149263" role="paragraph">You can automatically execute a macro when a specified software event occurs by assigning the desired macro to the event. The following table provides an overview of document events and at what point an assigned macro is executed.</paragraph> + + <table id="tbl_id3148646"> + <tablerow> + <tablecell><paragraph id="par_id3148455" role="tablehead">Event</paragraph></tablecell> + <tablecell><paragraph id="par_id3145799" role="tablehead">An assigned macro is executed...</paragraph></tablecell> + <tablecell><paragraph id="par_id3145809" role="tablehead">routine</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3149379" role="tablecontent">Start Application</paragraph></tablecell> + <tablecell><paragraph id="par_id3150715" role="tablecontent">...after a $[officename] application is started.</paragraph></tablecell> + <tablecell><paragraph id="par_id721599830885588" role="tablecontent" localize="false"><literal>OnStartApp</literal></paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3146914" role="tablecontent">Close Application</paragraph></tablecell> + <tablecell><paragraph id="par_id3153765" role="tablecontent">...before a $[officename] application is terminated.</paragraph></tablecell> + <tablecell><paragraph id="par_id91599830927709" role="tablecontent" localize="false"><literal>OnCloseApp</literal></paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id151599831705811" role="tablecontent">Document created</paragraph></tablecell> + <tablecell><paragraph id="par_id501599831822339" role="tablecontent">...New document created with <emph>File - New</emph> or with the <emph>New</emph> icon. Note that this event also fires when Basic IDE opens.</paragraph></tablecell> + <tablecell><paragraph id="par_id361599832753891" role="tablecontent" localize="false"><literal>OnCreate</literal></paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3145150" role="tablecontent">New Document</paragraph></tablecell> + <tablecell><paragraph id="par_id3163808" role="tablecontent">...after a new document is created with <emph>File - New</emph> or with the <emph>New</emph> icon.</paragraph></tablecell> + <tablecell><paragraph id="par_id1001599831631397" role="tablecontent" localize="false">OnNew</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id161599836960401" role="tablecontent">Document loading finished</paragraph></tablecell> + <tablecell><paragraph id="par_id721599836993145" role="tablecontent">...before a document is opened with <emph>File - Open</emph> or with the <emph>Open</emph> icon.</paragraph></tablecell> + <tablecell><paragraph id="par_id861599836995091" role="tablecontent" localize="false"><literal>OnLoadFinished</literal></paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3145790" role="tablecontent">Open Document</paragraph></tablecell> + <tablecell><paragraph id="par_id3154572" role="tablecontent">...after a document is opened with <emph>File - Open</emph> or with the <emph>Open</emph> icon.</paragraph></tablecell> + <tablecell><paragraph id="par_id561599837106931" role="tablecontent" localize="false">OnLoad</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3159171" role="tablecontent">Document is going to be closed</paragraph></tablecell> + <tablecell><paragraph id="par_id3146868" role="tablecontent">...before a document is closed.</paragraph></tablecell> + <tablecell><paragraph id="par_id991599837325474" role="tablecontent" localize="false">OnPrepareUnload</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3159097" role="tablecontent">Document closed</paragraph></tablecell> + <tablecell><paragraph id="par_id3148606" role="tablecontent">...after a document was closed. Note that the "Save Document" event may also occur when the document is saved before closing.</paragraph></tablecell> + <tablecell><paragraph id="par_id1001599837386243" role="tablecontent" localize="false">OnUnload</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id391600157320922" role="tablecontent">-no UI-</paragraph></tablecell> + <tablecell></tablecell> + <tablecell><paragraph id="par_id81600157323361" role="tablecontent" localize="false">OnLayoutFinished</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id981599837681979" role="tablecontent">View created</paragraph></tablecell> + <tablecell><paragraph id="par_id281599838210270" role="tablecontent">Document is displayed. Note that this event also happens when a document is duplicated.</paragraph></tablecell> + <tablecell><paragraph id="par_id221599838211428" role="tablecontent" localize="false">OnViewCreated</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id511599837683562" role="tablecontent">View is going to be closed</paragraph></tablecell> + <tablecell><paragraph id="par_id331599838046012" role="tablecontent">Document layout is getting removed.</paragraph></tablecell> + <tablecell><paragraph localize="false" id="par_id851599838047612" role="tablecontent">OnPrepareViewClosing</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id951599837684882" role="tablecontent">View closed</paragraph></tablecell> + <tablecell><paragraph id="par_id51599837816122" role="tablecontent">Document layout is cleared prior to the document closure.</paragraph></tablecell> + <tablecell><paragraph id="par_id131599837818052" role="tablecontent" localize="false">OnViewClosed</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3144772" role="tablecontent">Activate Document</paragraph></tablecell> + <tablecell><paragraph id="par_id3149442" role="tablecontent">...after a document is brought to the foreground.</paragraph></tablecell> + <tablecell><paragraph id="par_id401599838521395" role="tablecontent" localize="false">OnFocus</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3150888" role="tablecontent">Deactivate Document</paragraph></tablecell> + <tablecell><paragraph id="par_id3154060" role="tablecontent">...after another document is brought to the foreground.</paragraph></tablecell> + <tablecell><paragraph id="par_id311599838560117" role="tablecontent" localize="false">OnUnfocus</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3150519" role="tablecontent">Save Document</paragraph></tablecell> + <tablecell><paragraph id="par_id3155529" role="tablecontent">...before a document is saved with <emph>File - Save</emph> or the <emph>Save</emph> icon, provided that a document name has already been specified.</paragraph></tablecell> + <tablecell><paragraph id="par_id541599838897948" role="tablecontent" localize="false">OnSaveAs</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3149404" role="tablecontent">Document has been saved</paragraph></tablecell> + <tablecell><paragraph id="par_id3151332" role="tablecontent">...after a document is saved with <emph>File - Save</emph> or the <emph>Save</emph> icon, provided that a document name has already been specified.</paragraph></tablecell> + <tablecell><paragraph id="par_id931599838938268" role="tablecontent" localize="false">OnSaveDone</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id161599838976700" role="tablecontent">Saving of document failed</paragraph></tablecell> + <tablecell><paragraph id="par_id391599838979652" role="tablecontent">Document could not be saved.</paragraph></tablecell> + <tablecell><paragraph id="par_id21599838980580" role="tablecontent" localize="false">OnSaveFailed</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3153266" role="tablecontent">Save Document As</paragraph></tablecell> + <tablecell><paragraph id="par_id3150208" role="tablecontent">...before a document is saved under a specified name (with <emph>File - Save As</emph>, or with <emph>File - Save</emph> or the <emph>Save</emph> icon, if a document name has not yet been specified).</paragraph></tablecell> + <tablecell><paragraph id="par_id11599840125398" role="tablecontent" localize="false">OnSaveAs</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3158215" role="tablecontent">Document has been saved as</paragraph></tablecell> + <tablecell><paragraph id="par_id3150980" role="tablecontent">... after a document was saved under a specified name (with <emph>File - Save As</emph>, or with <emph>File - Save</emph> or with the <emph>Save</emph> icon, if a document name has not yet been specified).</paragraph></tablecell> + <tablecell><paragraph id="par_id811599840174261" role="tablecontent" localize="false">OnSaveAsDone</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id561599839702598" role="tablecontent">'Save As' has failed</paragraph></tablecell> + <tablecell><paragraph id="par_id951599840240048" role="tablecontent">Document could not be saved.</paragraph></tablecell> + <tablecell><paragraph id="par_id131599840241061" role="tablecontent" localize="false">OnSaveAsFailed</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id851599839190548" role="tablecontent">-no UI-</paragraph></tablecell> + <tablecell><paragraph id="par_id961599839198859" role="tablecontent">When the document disk location has changed, for example after a <emph>File - Save As</emph> action.</paragraph></tablecell> + <tablecell><paragraph id="par_id651599839199901" role="tablecontent" localize="false">OnStorageChanged</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id501600150804809" role="tablecontent">Storing or exporting copy of document</paragraph></tablecell> + <tablecell><paragraph id="par_id471610080505705" role="tablecontent">...before a document is saved with <menuitem>File - Save a Copy</menuitem>, <menuitem>File - Export</menuitem>, <menuitem>File - Export as PDF</menuitem> or the <menuitem>Save</menuitem> icons.</paragraph></tablecell> + <tablecell><paragraph id="par_id781617239899601" role="tablecontent" localize="false">OnCopyTo</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id502600180504809" role="tablecontent">Document copy has been created</paragraph></tablecell> + <tablecell><paragraph id="par_id471601180505705" role="tablecontent">...after a document is saved with <menuitem>File - Save a Copy</menuitem>, <menuitem>File - Export</menuitem>, <menuitem>File - Export as PDF</menuitem> or the <menuitem>Save</menuitem> icons.</paragraph></tablecell> + <tablecell><paragraph id="par_id781614179899601" role="tablecontent" localize="false">OnCopyToDone</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id501006180504809" role="tablecontent">Creating of document copy failed</paragraph></tablecell> + <tablecell><paragraph id="par_id471600081505705" role="tablecontent">Document could not be copied or exported.</paragraph></tablecell> + <tablecell><paragraph id="par_id781613179998601" role="tablecontent" localize="false">OnCopyToFailed</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id501600180504809" role="tablecontent">Print document</paragraph></tablecell> + <tablecell><paragraph id="par_id471600180505705" role="tablecontent">...after the Print dialog is closed, but before the actual print process begins. This event occurs for each copy printed.</paragraph></tablecell> + <tablecell><paragraph id="par_id781613179899601" role="tablecontent" localize="false">OnPrint</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id371600180345993" role="tablecontent">-no UI-</paragraph></tablecell> + <tablecell><paragraph id="par_id851600180346872" role="tablecontent">...after document security settings have changed.</paragraph></tablecell> + <tablecell><paragraph id="par_id785600179899601" role="tablecontent" localize="false">OnModeChanged</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id921600180238854" role="tablecontent">'Modified' status was changed</paragraph></tablecell> + <tablecell><paragraph id="par_id321600180239944" role="tablecontent">Modified state of a document has changed.</paragraph></tablecell> + <tablecell><paragraph id="par_id781600179899601" role="tablecontent" localize="false">OnModifyChanged</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id741600180121445" role="tablecontent">Document title changed</paragraph></tablecell> + <tablecell><paragraph id="par_id801600180122852" role="tablecontent">When the document title gets updated.</paragraph></tablecell> + <tablecell><paragraph id="par_id841600179842448" role="tablecontent" localize="false">OnTitleChanged</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id641600180121445" role="tablecontent">Loaded a sub component</paragraph></tablecell> + <tablecell><paragraph id="par_id701600180122852" role="tablecontent">...after a database form has been opened.</paragraph></tablecell> + <tablecell><paragraph id="par_id741600179842448" role="tablecontent" localize="false"><literal>OnSubComponentOpened</literal></paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id641700180131445" role="tablecontent">Closed a sub component</paragraph></tablecell> + <tablecell><paragraph id="par_id701600290122852" role="tablecontent">...after a database form has been closed.</paragraph></tablecell> + <tablecell><paragraph id="par_id751610179842448" role="tablecontent" localize="false"><literal>OnSubComponentClosed</literal></paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id421600097736759" role="tablecontent">Printing of form letters started</paragraph></tablecell> + <tablecell><paragraph id="par_id411600097854273" role="tablecontent">...before printing form letters using <emph>File - Print</emph> or <emph>Tools - Mail Merge Wizard</emph> menus.</paragraph></tablecell> + <tablecell><paragraph id="par_id421600097855346" role="tablecontent" localize="false">OnMailMerge</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id41600097737991" role="tablecontent">Printing of form letters finished</paragraph></tablecell> + <tablecell><paragraph id="par_id451600097862282" role="tablecontent">...after printing of form letters using <emph>File - Print</emph> or <emph>Tools - Mail Merge Wizard</emph> menus.</paragraph></tablecell> + <tablecell><paragraph id="par_id231600097863331" role="tablecontent" localize="false">OnMailMergeFinished</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id641600160655602" role="tablecontent">Printing of form fields started</paragraph></tablecell> + <tablecell><paragraph id="par_id331600160656617" role="tablecontent">...before printing form fields.</paragraph></tablecell> + <tablecell><paragraph id="par_id81600160657657" role="tablecontent" localize="false">OnFieldMerge</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id801600160725659" role="tablecontent">Printing of form fields finished</paragraph></tablecell> + <tablecell><paragraph id="par_id961600160726645" role="tablecontent">...after printing form fields.</paragraph></tablecell> + <tablecell><paragraph id="par_id551600160727188" role="tablecontent" localize="false">OnFieldMergeFinished</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id3156366" role="tablecontent">Change of the page count</paragraph></tablecell> + <tablecell><paragraph id="par_id3154627" role="tablecontent">When the page count changes.</paragraph></tablecell> + <tablecell><paragraph id="par_id931600098241318" role="tablecontent" localize="false">OnPageCountChanged</paragraph></tablecell> + </tablerow> + </table> + + <note id="par_id131600158369191">Most events relate to documents, except <literal>OnStartApp</literal>, <literal>OnCloseApp</literal>, <literal>OnCreate</literal> and <literal>OnLoadFinished</literal> that occur at application level. <literal>OnSubComponentOpened</literal>, and <literal>OnSubComponentClosed</literal> events are fired by database's forms.</note> + + <tip id="par_id321600158566782">Writer documents are triggering those specific events: <literal>OnLayoutFinished</literal>, <literal>OnMailMerge</literal>, <literal>OnMailMergeFinished</literal>, <literal>OnFieldMerge</literal>, <literal>OnFieldMergeFinished</literal> and <literal>OnPageCountChanged</literal>.</tip> + + <h2 id="hd_id3153299">Assigning a Macro to an Event</h2> + <list type="ordered"> + <listitem><paragraph id="par_id3147244" role="listitem">Choose <emph>Tools - Customize</emph> and click the <emph>Events</emph> tab.</paragraph></listitem> + <listitem><paragraph id="par_id3146098" role="listitem">Select whether you want the assignment to be globally valid or just valid in the current document in the <emph>Save In</emph> listbox.</paragraph></listitem> + <listitem><paragraph id="par_id3150431" role="listitem">Select the event from the <emph>Event</emph> list.</paragraph></listitem> + <listitem><paragraph id="par_id3148742" role="listitem">Click <emph>Macro</emph> and select the macro to be assigned to the selected event.</paragraph></listitem> + <listitem><paragraph id="par_id3146321" role="listitem">Click <emph>OK</emph> to assign the macro.</paragraph></listitem> + <listitem><paragraph id="par_id3147414" role="listitem">Click <emph>OK</emph> to close the dialog.</paragraph></listitem> + </list> + + <h2 id="hd_id3154581">Removing the Assignment of a Macro to an Event</h2> + <list type="ordered"> + <listitem><paragraph id="par_id3146883" role="listitem">Choose <emph>Tools - Customize</emph> and click the <emph>Events</emph> tab.</paragraph></listitem> + <listitem><paragraph id="par_id3155909" role="listitem">Select whether you want to remove a global assignment or an assignment that is just valid in the current document by selecting the option in the <emph>Save In</emph> listbox.</paragraph></listitem> + <listitem><paragraph id="par_id3159129" role="listitem">Select the event that contains the assignment to be removed from the <emph>Event</emph> list.</paragraph></listitem> + <listitem><paragraph id="par_id3149143" role="listitem">Click <emph>Remove</emph>.</paragraph></listitem> + <listitem><paragraph id="par_id3149351" role="listitem">Click <emph>OK</emph> to close the dialog.</paragraph></listitem> + </list> + + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id341600162682135">In addition to assigning macros to events, one can <link href="text/sbasic/python/python_document_events.xhp" name="Monitor events">monitor events</link> triggered in %PRODUCTNAME documents.</paragraph> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01050000.xhp b/helpcontent2/source/text/sbasic/shared/01050000.xhp new file mode 100644 index 000000000..d243b6102 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01050000.xhp @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01050000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">$[officename] Basic IDE</title> +<filename>/text/sbasic/shared/01050000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="IDE"> +<paragraph role="heading" id="hd_id3154422" xml-lang="en-US" level="1"><variable id="01050000"><link href="text/sbasic/shared/01050000.xhp" name="$[officename] Basic IDE">$[officename] Basic IDE</link> +</variable></paragraph> +<paragraph role="paragraph" id="par_id3153142" xml-lang="en-US">This section describes the structure of the Basic IDE.</paragraph> +<bookmark xml-lang="en-US" branch="hid/.uno:BasicIDEAppear" id="bm_id1676992" localize="false"/> +<paragraph role="paragraph" id="par_idN105C9" xml-lang="en-US"><ahelp hid="." visibility="hidden">Opens the Basic IDE where you can write and edit macros.</ahelp></paragraph> +</section> +<embed href="text/sbasic/shared/main0211.xhp#macro"/> +<embed href="text/sbasic/shared/01050100.xhp#watch"/> +<embed href="text/sbasic/shared/01050200.xhp#callstack"/> +<embed href="text/sbasic/shared/01050300.xhp#breakpoints"/> +<embed href="text/sbasic/shared/keys.xhp#keys"/> +<paragraph role="heading" id="hd_id3153188" xml-lang="en-US" level="2">Commands From the Context menu of the Module Tabs</paragraph> +<paragraph role="heading" id="hd_id3154731" xml-lang="en-US" level="3">Insert</paragraph> +<bookmark xml-lang="en-US" branch="hid/.uno:NewModule" id="bm_id3412182" localize="false"/> +<paragraph role="heading" id="hd_id3151074" xml-lang="en-US" level="4">Module</paragraph> +<paragraph role="paragraph" id="par_id3149581" xml-lang="en-US"><ahelp hid=".uno:NewModule">Inserts a new module into the current library.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/.uno:NewDialog" id="bm_id9158311" localize="false"/> +<paragraph role="heading" id="hd_id3147397" xml-lang="en-US" level="4">Dialog</paragraph> +<paragraph role="paragraph" id="par_id3144335" xml-lang="en-US"><ahelp hid=".uno:NewDialog">Inserts a new dialog into the current library.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/.uno:DeleteCurrent" id="bm_id9753230" localize="false"/> +<paragraph role="heading" id="hd_id3155602" xml-lang="en-US" level="3">Delete</paragraph> +<paragraph role="paragraph" id="par_id3155064" xml-lang="en-US"><ahelp hid=".uno:DeleteCurrent">Deletes the selected module.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/.uno:RenameCurrent" id="bm_id8105416" localize="false"/> +<paragraph role="heading" id="hd_id3149018" xml-lang="en-US" level="3">Rename</paragraph> +<paragraph role="paragraph" id="par_id3154754" xml-lang="en-US"><ahelp hid=".uno:RenameCurrent">Renames the current module in place.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/.uno:HideCurPage" id="bm_id3462342" localize="false"/> +<paragraph role="heading" id="hd_id3150043" xml-lang="en-US" level="3">Hide</paragraph> +<paragraph role="paragraph" id="par_id3145147" xml-lang="en-US"><ahelp hid=".uno:HideCurPage">Hides the current module.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3163805" xml-lang="en-US" level="3">Modules</paragraph> +<paragraph role="paragraph" id="par_id3153965" xml-lang="en-US">Opens the <link href="text/sbasic/shared/01/06130000.xhp" name="Macro Organizer"><emph>Macro Organizer</emph></link> dialog.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01050100.xhp b/helpcontent2/source/text/sbasic/shared/01050100.xhp new file mode 100644 index 000000000..572fa6619 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01050100.xhp @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01050100xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Watch Window</title> +<filename>/text/sbasic/shared/01050100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="watch"> +<paragraph role="heading" id="hd_id3149457" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01050100.xhp">Watch Window</link></paragraph> +<paragraph role="paragraph" id="par_id3154908" xml-lang="en-US">The Watch window allows you to observe the value of variables during the execution of a program. Define the variable in the Watch text box. Click on <link href="text/sbasic/shared/02/11080000.xhp">Enable Watch</link> to add the variable to the list box and to display its values.</paragraph> +</section> +<bookmark xml-lang="en-US" branch="hid/BASCTL_HID_BASICIDE_WATCHWINDOW_EDIT" id="bm_id3125865" localize="false"/> +<paragraph role="heading" id="hd_id3145173" xml-lang="en-US" level="2">Watch</paragraph> +<paragraph role="paragraph" id="par_id3155132" xml-lang="en-US"><ahelp hid="HID_BASICIDE_WATCHWINDOW_EDIT">Enter the name of the variable whose value is to be monitored.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/BASCTL_HID_BASICIDE_REMOVEWATCH" id="bm_id3163712" localize="false"/> +<paragraph role="heading" id="hd_id3148645" xml-lang="en-US" level="2">Remove Watch</paragraph> +<paragraph role="paragraph" id="par_id3148576" xml-lang="en-US"><ahelp hid="HID_BASICIDE_REMOVEWATCH">Removes the selected variable from the list of watched variables.</ahelp></paragraph> +<table id="tbl_id3145271"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147426" xml-lang="en-US"> +<image id="img_id3152460" src="res/baswatr.png" width="0.25inch" height="0.222inch"><alt id="alt_id3152460" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154012" xml-lang="en-US">Remove Watch</paragraph> +</tablecell> +</tablerow> +</table> + +<bookmark xml-lang="en-US" branch="hid/BASCTL_HID_BASICIDE_WATCHWINDOW_LIST" id="bm_id3154944" localize="false"/> +<paragraph role="heading" id="hd_id3154491" xml-lang="en-US" level="2">Editing the Value of a Watched Variable</paragraph> +<paragraph role="paragraph" id="par_id3156283" xml-lang="en-US"><ahelp hid="HID_BASICIDE_WATCHWINDOW_LIST">Displays the list of watched variables. Click twice with a short pause in between on an entry to edit its value.</ahelp> The new value will be taken as the variable's value for the program.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01050200.xhp b/helpcontent2/source/text/sbasic/shared/01050200.xhp new file mode 100644 index 000000000..ef0810332 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01050200.xhp @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01050200xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Call Stack Window (Calls)</title> +<filename>/text/sbasic/shared/01050200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="callstack"> +<bookmark xml-lang="en-US" branch="hid/BASCTL_HID_BASICIDE_STACKWINDOW_LIST" id="bm_id3150541" localize="false"/> +<paragraph role="heading" id="hd_id3146794" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01050200.xhp" name="Call Stack Window (Calls)">Call Stack Window (Calls)</link></paragraph> +<paragraph role="paragraph" id="par_id3150400" xml-lang="en-US"><ahelp hid="HID_BASICIDE_STACKWINDOW_LIST" visibility="hidden">Displays the sequence of procedures and functions during the execution of a program.</ahelp> The <emph>Call Stack</emph> allows you to monitor the sequence of procedures and functions during the execution of a program. The procedures are functions are displayed bottom to top with the most recent function or procedure call at the top of the list.</paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01050300.xhp b/helpcontent2/source/text/sbasic/shared/01050300.xhp new file mode 100644 index 000000000..15537dcce --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01050300.xhp @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01050300xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Manage Breakpoints</title> +<filename>/text/sbasic/shared/01050300.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="breakpoints"> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/breakpointmenus/manage" id="bm_id3145090" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/breakpointmenus/properties" id="bm_id3147291" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managebreakpoints/ManageBreakpointsDialog" id="bm_id3149656" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managebreakpoints/@@nowidget@@" id="bm_id3149656" localize="false"/> +<paragraph role="heading" id="hd_id3154927" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01050300.xhp" name="Manage Breakpoints">Manage Breakpoints</link></paragraph> +<paragraph role="paragraph" id="par_id3148550" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/managebreakpoints/ManageBreakpointsDialog">Specifies the options for breakpoints.</ahelp></paragraph> +</section> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managebreakpoints/entries" id="bm_id31496561" localize="false"/> +<paragraph role="heading" id="hd_id3149670" xml-lang="en-US" level="2">Breakpoints</paragraph> +<paragraph role="paragraph" id="par_id3150398" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/managebreakpoints/entries">Enter the line number for a new breakpoint, then click <emph>New</emph>.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managebreakpoints/active" id="bm_id3156422" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/breakpointmenus/active" id="bm_id3150870" localize="false"/> +<paragraph role="heading" id="hd_id3156280" xml-lang="en-US" level="2">Active</paragraph> +<paragraph role="paragraph" id="par_id3154910" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/managebreakpoints/active">Activates or deactivates the current breakpoint.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managebreakpoints/pass" id="bm_id3153768" localize="false"/> +<paragraph role="heading" id="hd_id3144500" xml-lang="en-US" level="2">Pass Count</paragraph> +<paragraph role="paragraph" id="par_id3161831" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/managebreakpoints/pass">Specify the number of loops to perform before the breakpoint takes effect.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managebreakpoints/new" id="bm_id3150012" localize="false"/> +<paragraph role="heading" id="hd_id3152579" xml-lang="en-US" level="2">New</paragraph> +<paragraph role="paragraph" id="par_id3148575" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/managebreakpoints/new">Creates a breakpoint on the line number specified.</ahelp></paragraph> +<bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/managebreakpoints/delete" id="bm_id3159156" localize="false"/> +<paragraph role="heading" id="hd_id3147319" xml-lang="en-US" level="2">Delete</paragraph> +<paragraph role="paragraph" id="par_id3153363" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/managebreakpoints/delete">Deletes the selected breakpoint.</ahelp></paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01170100.xhp b/helpcontent2/source/text/sbasic/shared/01170100.xhp new file mode 100644 index 000000000..8a532491c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01170100.xhp @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01170100xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Control and Dialog Properties</title> +<filename>/text/sbasic/shared/01170100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="control"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153379"><bookmark_value>controls; properties</bookmark_value> +<bookmark_value>properties; controls and dialogs</bookmark_value> +<bookmark_value>dialogs; properties</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3153379" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01170100.xhp" name="Control and Dialog Properties">Control and Dialog Properties</link></paragraph> +</section> +<paragraph role="paragraph" id="par_id3156280" xml-lang="en-US"><ahelp hid=".">Specifies the properties of the selected dialog or control.</ahelp> You must be in the design mode to be able to use this command.</paragraph> +<paragraph role="heading" id="hd_id3151043" xml-lang="en-US" level="2">Entering Data in the Properties Dialog</paragraph> +<paragraph role="paragraph" id="par_id3153771" xml-lang="en-US">The following key combinations apply to enter data in multiline fields or combo boxes of the <emph>Properties</emph> dialog:</paragraph> +<table id="tbl_id3152460"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3150010" xml-lang="en-US">Keys</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3147317" xml-lang="en-US">Effects</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3146121" xml-lang="en-US">Alt+Down Arrow</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3149581" xml-lang="en-US">Opens a combo box</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147394" xml-lang="en-US">Alt+Up Arrow</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3148455" xml-lang="en-US">Closes a combo box</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154511" xml-lang="en-US">Shift+Enter</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3146971" xml-lang="en-US">Inserts a line break in multiline fields.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3146914" xml-lang="en-US">(UpArrow)</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3153714" xml-lang="en-US">Goes to the previous line.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3159266" xml-lang="en-US">(DownArrow)</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3146314" xml-lang="en-US">Goes to the next line.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3149255" xml-lang="en-US">Enter</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3149566" xml-lang="en-US">Applies the changes made to a field and places the cursor into the next field.</paragraph> +</tablecell> +</tablerow> +</table> +<embed href="text/sbasic/shared/01170101.xhp#general"/> +<embed href="text/sbasic/shared/01170103.xhp#events"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01170101.xhp b/helpcontent2/source/text/sbasic/shared/01170101.xhp new file mode 100644 index 000000000..35768089c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01170101.xhp @@ -0,0 +1,440 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01170101xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">General</title> +<filename>/text/sbasic/shared/01170101.xhp</filename> +</topic> +</meta> +<body> +<section id="general"> +<h1 id="hd_id3147436"><link href="text/sbasic/shared/01170101.xhp" name="General">General</link></h1> +<paragraph role="paragraph" id="par_id3155855" xml-lang="en-US">Define the properties for the selected control or dialog. The available properties depend on the type of control selected. The following properties therefore are not available for every type of control.</paragraph> +</section> +<sort order="asc" descendant="h2"> + <section id="Section64"> +<!-- removed HID HID_PROP_IMAGE_ALIGN --><h2 id="hd_id3148647">Alignment</h2> +<paragraph role="paragraph" id="par_id3147318" xml-lang="en-US"><ahelp hid="HID_PROP_IMAGE_ALIGN">Specify the alignment option for the selected control.</ahelp></paragraph> +</section> +<section id="Section63"> +<h2 id="hd_id3153189">AutoFill</h2> +<paragraph role="paragraph" id="par_id3152460" xml-lang="en-US"><ahelp hid=".">Select "Yes" to enable the AutoFill function for the selected control. </ahelp></paragraph> +</section> +<section id="Section62"><h2 id="hd_id3155307">Background color</h2> +<paragraph role="paragraph" id="par_id3145251" xml-lang="en-US"><ahelp hid=".">Specify the background color for the current control.</ahelp></paragraph> +</section> +<section id="Section61"> +<h2 id="hd_id3151076">Large change</h2> +<paragraph role="paragraph" id="par_id3148457" xml-lang="en-US"><ahelp hid=".">Specify the number of units to scroll when a user clicks in the area between the slider and the arrows on a scrollbar.</ahelp></paragraph> +</section> +<section id="Section60"><h2 id="hd_id3153876">Border</h2> +<paragraph role="paragraph" id="par_id3154017" xml-lang="en-US"><ahelp hid=".">Specify the border type for the current control.</ahelp></paragraph> +</section> +<section id="Section59"> +<h2 id="hd_id3150749">Button type</h2> +<paragraph role="paragraph" id="par_id3155064" xml-lang="en-US"><ahelp hid=".">Select a button type. Button types determine what type of action is initiated.</ahelp></paragraph> +</section> +<section id="Section58"><h2 id="hd_id3149019">Character set</h2> +<paragraph role="paragraph" id="par_id3148406" xml-lang="en-US"><ahelp hid=".">Select the font to be used for displaying the contents of the current control.</ahelp></paragraph> +</section> +<section id="Section57"> +<h2 id="hd_id3147341">Currency symbol</h2> +<paragraph role="paragraph" id="par_id3146315" xml-lang="en-US"><ahelp hid=".">Enter the currency symbol to be used for currency controls.</ahelp></paragraph> +</section> +<section id="Section44"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_DATE" id="bm_id856349" localize="false"/><h2 id="hd_id7936643">Date</h2> +<paragraph role="paragraph" id="par_id2293771" xml-lang="en-US"><ahelp hid=".">Specify the default date to be shown in the Date control.</ahelp></paragraph> +</section> +<section id="Section56"> +<h2 id="hd_id3153965">Date format</h2> +<paragraph role="paragraph" id="par_id3155334" xml-lang="en-US"><ahelp hid=".">Specify the desired format for a date control. A date control interprets the user input depending on this format setting.</ahelp></paragraph> +</section> +<section id="Section55"> +<h2 id="hd_id3154663">Date max.</h2> +<paragraph role="paragraph" id="par_id3148485" xml-lang="en-US"><ahelp hid=".">Specify the upper limit for a date control.</ahelp></paragraph> +</section> +<section id="Section54"> +<h2 id="hd_id3152778">Date min.</h2> +<paragraph role="paragraph" id="par_id3154120" xml-lang="en-US"><ahelp hid=".">Specify the lower limit for a date control.</ahelp></paragraph> +</section> +<section id="Section53"> +<h2 id="hd_id3154573">Decimal accuracy</h2> +<paragraph role="paragraph" id="par_id3166426" xml-lang="en-US"><ahelp hid=".">Specify the number of decimal places displayed for a numerical or currency control.</ahelp></paragraph> +</section> +<section id="Section52"> +<h2 id="hd_id3159091">Default button</h2> +<paragraph role="paragraph" id="par_id3154200" xml-lang="en-US"><ahelp hid=".">Select "Yes" to make the current button control the default selection. Pressing <emph>Return</emph> in the dialog activates the default button.</ahelp></paragraph> +</section> +<section id="Section66"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_REPEAT_DELAY" id="bm_id1620227" localize="false"/><h2 id="par_idN108BA">Delay</h2> +<paragraph role="paragraph" id="par_idN108D0" xml-lang="en-US"><ahelp hid=".">Specifies the delay in milliseconds between scrollbar trigger events.</ahelp> A trigger event occurs when you click a scrollbar arrow or click the background area in a scrollbar. Repeated trigger events occur if you keep the mouse button pressed when you click a scrollbar arrow or background area in a scrollbar. If you want, you can include valid time units with the number that you enter, for example, 2 s or 500 ms.</paragraph> +</section> +<section id="Section51"><h2 id="hd_id3151278">Dropdown</h2> +<paragraph role="paragraph" id="par_id3155113" xml-lang="en-US"><ahelp hid=".">Select "Yes" to enable the dropdown option for list or combo box controls. A dropdown control field has an arrow button which you can click to open a list of the existing form entries.</ahelp></paragraph> +</section> +<section id="Section50"> +<h2 id="hd_id3151216">Enabled</h2> +<paragraph role="paragraph" id="par_id3150517" xml-lang="en-US"><ahelp hid=".">Select "Yes" to enable the control. If the control is disabled, it is grayed out in the dialog.</ahelp></paragraph> +</section> +<section id="Section49"> +<h2 id="hd_id3155379">Edit mask</h2> +<paragraph role="paragraph" id="par_id3155509" xml-lang="en-US"><ahelp hid=".">Specify the edit mask for a pattern control. This is a character code that defines the input format for the control.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id3154485" xml-lang="en-US">You need to specify a masking character for each input character of the edit mask to restrict the input to the values that are listed in the following table:</paragraph> +<table id="tbl_id3152986"> +<tablerow> +<tablecell> +<paragraph role="tablehead" id="par_id3155809" xml-lang="en-US"> Character </paragraph> +</tablecell> +<tablecell> +<paragraph role="tablehead" id="par_id3148702" xml-lang="en-US">Meaning</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3156199" localize="false" xml-lang="en-US">L</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3148869" xml-lang="en-US">A text constant. This character cannot be modified by the user. </paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3156016" localize="false" xml-lang="en-US">a</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3157983" xml-lang="en-US">The characters a-z can be entered here. If a capital letter is entered, it is automatically converted to a lowercase letter.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3148607" localize="false" xml-lang="en-US">A</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3159204" xml-lang="en-US">The characters A-Z can be entered here. If a lowercase letter is entered, it is automatically converted to a capital letter</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3149126" localize="false" xml-lang="en-US">c</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3151304" xml-lang="en-US">The characters a-z and 0-9 can be entered here. If a capital letter is entered, it is automatically converted to a lowercase letter.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3152870" localize="false" xml-lang="en-US">C</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3155071" xml-lang="en-US">The characters a-z and 0-9 can be entered here. If a lowercase letter is entered, it is automatically converted to a capital letter</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3159230" localize="false" xml-lang="en-US">N</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3154650" xml-lang="en-US">Only the characters 0-9 can be entered.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3149383" localize="false" xml-lang="en-US">x</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3153489" xml-lang="en-US">All printable characters can be entered.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3146967" localize="false" xml-lang="en-US">X</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3154707" xml-lang="en-US">All printable characters can be entered. If a lowercase letter is used, it is automatically converted to a capital letter.</paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="Section72"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_EDITABLE" id="bm_id533463" localize="false"/><h2 id="hd_id2128971">Editable</h2> +<paragraph role="paragraph" id="par_id6519974" xml-lang="en-US"><ahelp hid=".">Specifies whether the nodes of the tree control are editable.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id4591814" xml-lang="en-US">The default value is FALSE.</paragraph> +</section> +<section id="Section48"><h2 id="hd_id3149317">Graphics</h2> +<paragraph role="paragraph" id="par_id3147546" xml-lang="en-US"><ahelp hid=".">Specify the source of the graphics for a button or an image control. Click "..." to select a file.</ahelp></paragraph> +</section> +<section id="Section47"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_HEIGHT" id="bm_id8097170" localize="false"/><h2 id="hd_id3154627">Height</h2> +<paragraph role="paragraph" id="par_id3155754" xml-lang="en-US"><ahelp hid=".">Specify the height of the current control or the dialog.</ahelp></paragraph> +</section> +<section id="Section46"> +<h2 id="hd_id3153072">Help text</h2> +<paragraph role="paragraph" id="par_id3147502" xml-lang="en-US"><ahelp hid=".">Enter a help text that is displayed as a tip (bubble help) when the mouse rests over the control.</ahelp></paragraph> +</section> +<section id="Section45"> +<h2 id="hd_id3154400">Help URL</h2> +<paragraph role="paragraph" id="par_id3150431" xml-lang="en-US"><ahelp hid=".">Specify the help URL that is called when you press F1 while the focus is on a particular control. For example, use the format HID:1234 to call the Help-ID with the number 1234.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id4171269" xml-lang="en-US">Set the environment variable HELP_DEBUG to 1 to view the Help-IDs as extended help tips.</paragraph> +</section> +<section id="Section43"> +<h2 id="hd_id3159260">Incr./decrement value</h2> +<paragraph role="paragraph" id="par_id3145233" xml-lang="en-US"><ahelp hid=".">Specify the increment and decrement interval for spin button controls.</ahelp></paragraph> +</section> +<section id="Section73"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_INVOKES_STOP_NOT_EDITING" id="bm_id9407025" localize="false"/><h2 id="hd_id539262">Invokes stop mode editing</h2> +<paragraph role="paragraph" id="par_id234382" xml-lang="en-US"><ahelp hid=".">Specifies what happens when editing is interrupted by selecting another node in the tree, a change in the tree's data, or by some other means.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id6591082" xml-lang="en-US">Setting this property to TRUE causes the changes to be automatically saved when editing is interrupted. FALSE means that editing is canceled and changes are lost.</paragraph> +<paragraph role="paragraph" id="par_id9298074" xml-lang="en-US">The default value is FALSE.</paragraph> +</section> +<section id="Section42"><h2 id="hd_id3150536">Label</h2> +<paragraph role="paragraph" id="par_id3146324" xml-lang="en-US"><ahelp hid=".">Specifies the label of the current control. The label is displayed along with the control.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id3146816" xml-lang="en-US">You can create multi-line <emph>labels</emph> by inserting manual line breaks in the label using <emph>Shift+Enter</emph>.</paragraph> +</section> +<section id="Section41"> +<h2 id="hd_id3150457">Line Count</h2> +<paragraph role="paragraph" id="par_id3149143" xml-lang="en-US"><ahelp hid=".">Enter the number of lines to be displayed for a list control. For combo boxes, this setting is only active if the dropdown option is enabled. </ahelp></paragraph> +</section> +<section id="Section3"> +<h2 id="hd_id7468489">Scrollbar</h2> +<paragraph role="paragraph" id="par_id7706228" xml-lang="en-US">Adds the scrollbar type that you specify to a text box.</paragraph> +</section> +<section id="Section40"> +<h2 id="hd_id3153121">Small change</h2> +<paragraph role="paragraph" id="par_id3157875" xml-lang="en-US"><ahelp hid=".">Specify the number of units to scroll when a user clicks an arrow on a scrollbar.</ahelp></paragraph> +</section> +<section id="Section39"><h2 id="hd_id3145221">List entries</h2> +<paragraph role="paragraph" id="par_id3154580" xml-lang="en-US"><ahelp hid=".">Specify the entries for a list control. One line takes one list entry. Press <emph>Shift+Enter</emph> to insert a new line.</ahelp></paragraph> +</section> +<section id="Section38"> +<h2 id="hd_id3149723">Literal mask</h2> +<paragraph role="paragraph" id="par_id3150656" xml-lang="en-US"><ahelp hid=".">Specify the initial values to be displayed in a pattern control. This helps the user to identify which values are allowed in a pattern control. The literal mask is restricted by the format specified by the edit mask.</ahelp></paragraph> +</section> +<section id="Section37"> +<h2 id="hd_id3149015">Manual line break</h2> +<paragraph role="paragraph" id="par_id3149893" xml-lang="en-US"><ahelp hid=".">Select "Yes" to allow manual line breaks inside multiline controls.</ahelp></paragraph> +</section> +<section id="Section36"> +<h2 id="hd_id3150463">Max. text length</h2> +<paragraph role="paragraph" id="par_id3150745" xml-lang="en-US"><ahelp hid=".">Specify the maximum number of characters that the user can enter.</ahelp></paragraph> +</section> +<section id="Section35"><h2 id="hd_id3154675">Multiline Input</h2> +<paragraph role="paragraph" id="par_id3144741" xml-lang="en-US"><ahelp hid=".">Select "Yes" to allow the input of multiple lines in the control. Press Enter to insert a manual line break in the control.</ahelp></paragraph> +</section> +<section id="Section34"> +<h2 id="hd_id3154848">Multiselection</h2> +<paragraph role="paragraph" id="par_id3151235" xml-lang="en-US"><ahelp hid=".">Select "Yes" to allow the selection of multiple entries in list controls.</ahelp></paragraph> +</section> +<section id="Section33"><h2 id="hd_id3148887">Name</h2> +<paragraph role="paragraph" id="par_id3154548" xml-lang="en-US"><ahelp hid=".">Insert a name for the current control. This name is used to identify the control.</ahelp></paragraph> +</section> +<section id="Section32"><h2 id="hd_id3148739">Order</h2> +<paragraph role="paragraph" id="par_id3149252" xml-lang="en-US"><ahelp hid=".">Specify the order in which the controls receive the focus when the Tab key is pressed in the dialog.</ahelp> On entering a dialog, the control with the lowest order (0) receives the focus. Pressing the <emph>Tab</emph> key the successively focuses the other controls as specified by their order number.</paragraph> +<paragraph role="paragraph" id="par_id3155259" xml-lang="en-US">Initially, the controls receive numbers in the order they are added to the dialog. You can change the order numbers for controls. $[officename] Basic updates the order numbers automatically to avoid duplicate numbers. Controls that cannot be focused are also assigned a value but these controls are skipped when using the Tab key.</paragraph> +</section> +<section id="Section31"> +<h2 id="hd_id3149511">Orientation</h2> +<paragraph role="paragraph" id="par_id3153780" xml-lang="en-US"><ahelp hid=".">Specify the orientation for a scrollbar control.</ahelp></paragraph> +</section> +<section id="Section30"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_STEP" id="bm_id8616901" localize="false"/><h2 id="hd_id3154374">Page (step)</h2> +<paragraph role="paragraph" id="par_id3154109" xml-lang="en-US"><ahelp hid=".">Specify the number of the dialog page to which the current control is assigned or the page number of the dialog you want to edit.</ahelp> If a dialog has only one page set its <emph>Page (Step)</emph> value to <emph>0</emph>.</paragraph> +<paragraph role="paragraph" id="par_id3148580" xml-lang="en-US">Select <emph>Page (Step)</emph> = 0 to make a control visible on every dialog page.</paragraph> +<paragraph role="paragraph" id="par_id3146144" xml-lang="en-US">To switch between dialog pages at run time, you need to create a macro that changes the value of <emph>Page (Step)</emph>.</paragraph> +</section> +<section id="Section29"> +<h2 id="hd_id3154558">Password characters</h2> +<paragraph role="paragraph" id="par_id3152787" xml-lang="en-US"><ahelp hid=".">Enter a character to be displayed instead of the characters that are typed. This can be used for entering passwords in text controls.</ahelp></paragraph> +</section> +<section id="Section28"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_POSITIONX" id="bm_id8632160" localize="false"/><h2 id="hd_id3148750">PositionX</h2><paragraph role="paragraph" id="par_id3154517" xml-lang="en-US"><ahelp hid=".">Specify the distance of the current control from the left side of the dialog.</ahelp></paragraph> +</section> +<section id="Section27"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_POSITIONY" id="bm_id7651905" localize="false"/><h2 id="hd_id3152767">PositionY</h2> +<paragraph role="paragraph" id="par_id3159082" xml-lang="en-US"><ahelp hid=".">Specify the distance of the current control from the top of the dialog.</ahelp></paragraph> +</section> +<section id="Section26"> +<h2 id="hd_id3159213">Prefix symbol</h2> +<paragraph role="paragraph" id="par_id3149688" xml-lang="en-US"><ahelp hid=".">Select "Yes" to display the currency symbol prefix in currency controls when a number was entered.</ahelp></paragraph> +</section> +<section id="Section25"> +<h2 id="hd_id3149728">Print</h2> +<paragraph role="paragraph" id="par_id3150001" xml-lang="en-US"><ahelp hid=".">Select "Yes" to include the current control in a document's printout.</ahelp></paragraph> +</section> +<section id="Section24"> +<h2 id="hd_id3154671">Progress value</h2> +<paragraph role="paragraph" id="par_id3146849" xml-lang="en-US"><ahelp hid=".">Specify a progress value for a progress bar control.</ahelp></paragraph> +</section> +<section id="Section23"> +<h2 id="hd_id3153112">Progress value max.</h2> +<paragraph role="paragraph" id="par_id3145167" xml-lang="en-US"><ahelp hid=".">Specify the maximum value of a progress bar control.</ahelp></paragraph> +</section> +<section id="Section22"> +<h2 id="hd_id3153569">Progress value min.</h2> +<paragraph role="paragraph" id="par_id3154506" xml-lang="en-US"><ahelp hid=".">Specify the minimum value of a progress bar control.</ahelp></paragraph> +</section> +<section id="Section21"><h2 id="hd_id3150134">Read-only</h2> +<paragraph role="paragraph" id="par_id3155930" xml-lang="en-US"><ahelp hid=".">Select "Yes" to prevent the user from editing the value of the current control. The control is enabled and can be focused but not modified.</ahelp></paragraph> +</section> +<section id="Section65"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_REPEAT" id="bm_id2982573" localize="false"/><h2 id="par_idN11112">Repeat<comment>UFI: see spec spinbutton_form_control.sxw</comment></h2> +<paragraph role="paragraph" id="par_idN11128" xml-lang="en-US"><ahelp hid=".">Repeats trigger events when you keep the mouse button pressed on a control such as a spin button.</ahelp></paragraph> +</section> +<section id="Section71"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_ROOT_DISPLAYED" id="bm_id1578722" localize="false"/><h2 id="hd_id9579149">Root displayed<comment>see http://specs.openoffice.org/appwide/dialog_ide/New_Tree_Control_in_IDE.odt</comment></h2> +<paragraph role="paragraph" id="par_id7126987" xml-lang="en-US"><ahelp hid=".">Specifies if the root node of the tree control is displayed.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id9174779" xml-lang="en-US">If Root displayed is set to FALSE, the root node of a model is no longer a valid node for the tree control and can't be used with any method of XTreeControl.</paragraph> +<paragraph role="paragraph" id="par_id594195" xml-lang="en-US">The default value is TRUE.</paragraph> +</section> +<section id="Section74"> +<h2 id="hd_id7534409">Row height</h2> +<paragraph role="paragraph" id="par_id6471755" xml-lang="en-US"><ahelp hid=".">Specifies the height of each row of a tree control, in pixels.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id2909329" xml-lang="en-US">If the specified value is less than or equal to zero, the row height is the maximum height of all rows.</paragraph> +<paragraph role="paragraph" id="par_id4601580" xml-lang="en-US">The default value is 0.</paragraph> +</section> +<section id="Section20"> +<h2 id="hd_id3148761">Scale</h2> +<paragraph role="paragraph" id="par_id3159134" xml-lang="en-US"><ahelp hid=".">Scales the image to fit the control size.</ahelp></paragraph> +</section> +<section id="Scrollbar"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_HSCROLL" id="bm_id3149895" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_VSCROLL" id="bm_id3149517" localize="false"/> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_SHOW_SCROLLBARS" id="bm_id6053651" localize="false"/><h2 id="hd_id7597277">Scrollbar</h2> +<paragraph role="paragraph" id="par_id986968" xml-lang="en-US"><ahelp hid=".">Adds the scrollbar type that you specify to a text box.</ahelp></paragraph> +</section> +<section id="Section19"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_SCROLLVALUE" id="bm_id3150294" localize="false"/><h2 id="hd_id3147370">Scroll value</h2> +<paragraph role="paragraph" id="par_id3159622" xml-lang="en-US"><ahelp hid=".">Specify the initial value of a scrollbar control. This determines the position of the scrollbar slider.</ahelp></paragraph> +</section> +<section id="Section18"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_SCROLLVALUE_MAX" id="bm_id3148873" localize="false"/><h2 id="hd_id3155440">Scroll value max.</h2> +<paragraph role="paragraph" id="par_id3148877" xml-lang="en-US"><ahelp hid=".">Specify the maximum value of a scrollbar control.</ahelp></paragraph> +</section> +<section id="Section67"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_SCROLLVALUE_MIN" id="bm_id6626483" localize="false"/><h2 id="par_idN111E4">Scroll value min.</h2> +<paragraph role="paragraph" id="par_idN111E8" xml-lang="en-US"><ahelp hid=".">Specify the minimum value of a scrollbar control.</ahelp></paragraph> +</section> +<section id="Section69"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_SHOWS_HANDLES" id="bm_id7286904" localize="false"/><h2 id="hd_id543534">Show handles</h2> +<paragraph role="paragraph" id="par_id5060884" xml-lang="en-US"><ahelp hid=".">Specifies whether the handles of the nodes should be displayed.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id4974822" xml-lang="en-US">The handles are dotted lines that visualize the hierarchy of the tree control.</paragraph> +<paragraph role="paragraph" id="par_id7687307" xml-lang="en-US">The default value is TRUE.</paragraph> +</section> +<section id="Section70"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_SHOWS_ROOT_HANDLES" id="bm_id2047486" localize="false"/><h2 id="hd_id4062013">Show root handles</h2> +<paragraph role="paragraph" id="par_id3314004" xml-lang="en-US"><ahelp hid=".">Specifies whether the handles of the nodes should also be displayed at root level.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id2396313" xml-lang="en-US">The default value is TRUE.</paragraph> +</section> +<section id="Section17"> +<h2 id="par_idN10EC2">Selection<comment>UFI: udk.features "New property and help ID for property browser in Basic IDE"</comment></h2> +<paragraph role="paragraph" id="par_idN10ED8" xml-lang="en-US"><ahelp hid=".">Specifies the sequence of the selected items, where "0" corresponds to the first item. To select more than one item, Multiselection must be enabled.</ahelp></paragraph> +<paragraph role="paragraph" id="par_idN10EEB" xml-lang="en-US">Click the <emph>...</emph> button to open the <emph>Selection</emph> dialog.</paragraph> +<paragraph role="paragraph" id="par_idN10F0A" xml-lang="en-US"><ahelp hid=".">Click the item or items that you want to select. To select more than one item, ensure that the Multiselection option is selected.</ahelp></paragraph> +</section> +<section id="Section68"> +<bookmark xml-lang="en-US" branch="hid/EXTENSIONS_HID_PROP_SELECTION_TYPE" id="bm_id2208929" localize="false"/><h2 id="hd_id5026093">Selection type<comment>see http://specs.openoffice.org/appwide/dialog_ide/New_Tree_Control_in_IDE.odt</comment></h2> +<paragraph role="paragraph" id="par_id1134067" xml-lang="en-US"><ahelp hid=".">Specifies the selection mode that is enabled for this tree control.</ahelp></paragraph> +</section> +<section id="Section16"><h2 id="hd_id3154193">Spin Button</h2> +<paragraph role="paragraph" id="par_id3145298" xml-lang="en-US"><ahelp hid=".">Select "Yes" to add spin buttons to a numerical, currency, date, or time control to allow increasing and decreasing the input value using arrow buttons.</ahelp></paragraph> +</section> +<section id="Section15"> +<h2 id="hd_id3156267">State</h2> +<paragraph role="paragraph" id="par_id3150928" xml-lang="en-US"><ahelp hid=".">Select the selection state of the current control.</ahelp></paragraph> +</section> +<section id="Section14"> +<h2 id="hd_id3148396">Strict format</h2> +<paragraph role="paragraph" id="par_id3153042" xml-lang="en-US"><ahelp hid=".">Select "Yes" to only allow valid characters to be entered in a numerical, currency, date, or time control.</ahelp></paragraph> +</section> +<section id="Section13"><h2 id="hd_id3149538">Tabstop</h2> +<paragraph role="paragraph" id="par_id3148543" xml-lang="en-US"><ahelp hid=".">Select the focus behavior of the current control when using the <emph>Tab</emph> key.</ahelp></paragraph> +<table id="tbl_id3148388"> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3148776" xml-lang="en-US">Default</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3153547" xml-lang="en-US">Only input controls receive the focus when using the <emph>Tab</emph> key. Controls without input like caption controls are omitted.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3154632" xml-lang="en-US">No</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3150475" xml-lang="en-US">When using the tab key focusing skips the control.</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell> +<paragraph role="tablecontent" id="par_id3150690" xml-lang="en-US">Yes</paragraph> +</tablecell> +<tablecell> +<paragraph role="tablecontent" id="par_id3159106" xml-lang="en-US">The control can be selected with the Tab key.</paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="Section12"> +<h2 id="hd_id3145152">Thousands Separator</h2> +<paragraph role="paragraph" id="par_id3155085" xml-lang="en-US"><ahelp hid=".">Select "Yes" to display thousands separator characters in numerical and currency controls.</ahelp></paragraph> +</section> +<section id="Section11"> +<h2 id="hd_id3152816">Time Format</h2> +<paragraph role="paragraph" id="par_id3145263" xml-lang="en-US"><ahelp hid=".">Select the format to be used for time controls.</ahelp></paragraph> +</section> +<section id="Section10"> +<h2 id="hd_id3153920">Time max.</h2> +<paragraph role="paragraph" id="par_id3155401" xml-lang="en-US"><ahelp hid=".">Specify the maximum time value for a time control.</ahelp></paragraph> +</section> +<section id="Section9"> +<h2 id="hd_id3163818">Time min.</h2> +<paragraph role="paragraph" id="par_id3156262" xml-lang="en-US"><ahelp hid=".">Specify the minimum time value for a time control.</ahelp></paragraph> +</section> +<section id="Section8"> +<h2 id="hd_id3148638">Title</h2> +<paragraph role="paragraph" id="par_id3147169" xml-lang="en-US"><ahelp hid=".">Specify the title of the dialog. Click the border of the dialog to select the dialog.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id3153716" xml-lang="en-US"> +<emph>Titles</emph> are only used for labeling a dialog and can only contain one line. Please note that if you work with macros, controls are only called through their <emph>Name</emph> property.</paragraph> +</section> +<section id="Section7"> +<h2 id="hd_id3152594">Tristate</h2> +<paragraph role="paragraph" id="par_id3149825" xml-lang="en-US"><ahelp hid=".">Select "Yes" to allow a check box to have three states (checked, unchecked, and grayed out) instead of two (checked and unchecked).</ahelp></paragraph> +</section> +<section id="Section6"> +<h2 id="hd_id3150614">Value</h2> +<paragraph role="paragraph" id="par_id3154315" xml-lang="en-US"><ahelp hid=".">Specify the value for the current control.</ahelp></paragraph> +</section> +<section id="Section5"> +<h2 id="hd_id3152480">Value max.</h2> +<paragraph role="paragraph" id="par_id3163823" xml-lang="en-US"><ahelp hid=".">Specify the maximum value for the current control.</ahelp></paragraph> +</section> +<section id="Section4"> +<h2 id="hd_id3149276">Value min.</h2> +<paragraph role="paragraph" id="par_id3145088" xml-lang="en-US"><ahelp hid=".">Specify the minimum value for the current control.</ahelp></paragraph> +</section> +<section id="Section2"> +<h2 id="hd_id3149712">Visible size</h2> +<paragraph role="paragraph" id="par_id3149445" xml-lang="en-US"><ahelp hid=".">Specify the length of the slider of a scrollbar control.</ahelp></paragraph> +</section> +<section id="Section1"><h2 id="hd_id3152472">Width</h2> +<paragraph role="paragraph" id="par_id3157963" xml-lang="en-US"><ahelp hid=".">Specify the width of the current control or dialog.</ahelp></paragraph> +</section> +</sort></body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/01170103.xhp b/helpcontent2/source/text/sbasic/shared/01170103.xhp new file mode 100644 index 000000000..fd3d25ae8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/01170103.xhp @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared01170103xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Events</title> +<filename>/text/sbasic/shared/01170103.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="events"> +<paragraph role="heading" id="hd_id3155506" xml-lang="en-US" level="1"><link href="text/sbasic/shared/01170103.xhp" name="Events">Events</link></paragraph> +<paragraph role="paragraph" id="par_id3146114" xml-lang="en-US">Define event assignments for the selected control or dialog. The available events depend on the type of control selected.</paragraph> +</section> +<paragraph role="heading" id="hd_id3145387" xml-lang="en-US" level="2">When receiving focus</paragraph> +<paragraph role="paragraph" id="par_id3155090" xml-lang="en-US"><ahelp hid="HID_EVT_FOCUSGAINED">This event takes place if a control receives the focus.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3152892" xml-lang="en-US" level="2">When losing focus</paragraph> +<paragraph role="paragraph" id="par_id3153305" xml-lang="en-US"><ahelp hid="HID_EVT_FOCUSLOST">This event takes place if a control loses the focus.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3152896" xml-lang="en-US" level="2">Key pressed</paragraph> +<paragraph role="paragraph" id="par_id3148837" xml-lang="en-US"><ahelp hid="HID_EVT_KEYTYPED">This event occurs when the user presses any key while the control has the focus.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3146869" xml-lang="en-US" level="2">Key released</paragraph> +<paragraph role="paragraph" id="par_id3155267" xml-lang="en-US"><ahelp hid="HID_EVT_KEYUP">This event occurs when the user releases a key while the control has the focus.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3159096" xml-lang="en-US" level="2">Modified</paragraph> +<paragraph role="paragraph" id="par_id3156019" xml-lang="en-US"><ahelp hid="HID_EVT_CHANGED">This event takes place, when the control loses the focus and the contents of the control were changed since it lost the focus.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3144508" xml-lang="en-US" level="2">Text modified</paragraph> +<paragraph role="paragraph" id="par_id3148608" xml-lang="en-US"><ahelp hid="HID_EVT_TEXTCHANGED">This event takes place if you enter or modify a text in an input field.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3159207" xml-lang="en-US" level="2">Item status changed</paragraph> +<paragraph role="paragraph" id="par_id3155097" xml-lang="en-US"><ahelp hid="HID_EVT_ITEMSTATECHANGED">This event takes place if the status of the control field is changed, for example, from checked to unchecked.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3151304" xml-lang="en-US" level="2">Mouse inside</paragraph> +<paragraph role="paragraph" id="par_id3152871" xml-lang="en-US"><ahelp hid="HID_EVT_MOUSEENTERED">This event takes place when the mouse enters the control.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3146778" xml-lang="en-US" level="2">Mouse moved while key pressed</paragraph> +<paragraph role="paragraph" id="par_id3150403" xml-lang="en-US"><ahelp hid="HID_EVT_MOUSEDRAGGED">This event takes place when the mouse is dragged while a key is pressed.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3150210" xml-lang="en-US" level="2">Mouse moved</paragraph> +<paragraph role="paragraph" id="par_id3149697" xml-lang="en-US"><ahelp hid="HID_EVT_MOUSEMOVED">This event takes place when the mouse moves over the control.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3145216" xml-lang="en-US" level="2">Mouse button pressed</paragraph> +<paragraph role="paragraph" id="par_id3155914" xml-lang="en-US"><ahelp hid="HID_EVT_MOUSEPRESSED">This event takes place when the mouse button is pressed while the mouse pointer is on the control.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3148899" xml-lang="en-US" level="2">Mouse button released</paragraph> +<paragraph role="paragraph" id="par_id3153812" xml-lang="en-US"><ahelp hid="HID_EVT_MOUSERELEASED">This event takes place when the mouse button is released while the mouse pointer is on the control.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3153556" xml-lang="en-US" level="2">Mouse outside</paragraph> +<paragraph role="paragraph" id="par_id3153013" xml-lang="en-US"><ahelp hid="HID_EVT_MOUSEEXITED">This event takes place when the mouse leaves the control.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3155759" xml-lang="en-US" level="2">While adjusting</paragraph> +<paragraph role="paragraph" id="par_id3156364" xml-lang="en-US"><ahelp hid="HID_EVT_MOUSEEXITED">This event takes place when a scrollbar is being dragged.</ahelp></paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11010000.xhp b/helpcontent2/source/text/sbasic/shared/02/11010000.xhp new file mode 100644 index 000000000..ad5f0a5c1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11010000.xhp @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211010000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Library</title> +<filename>/text/sbasic/shared/02/11010000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="bibliothek"> +<bookmark branch="hid/.uno:LibSelector" xml-lang="en-US" id="bm_id3154230" localize="false"/> +<paragraph id="hd_id3151100" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/02/11010000.xhp" name="Library">Library</link></paragraph> + <paragraph role="paragraph" id="par_id3154136" xml-lang="en-US"><ahelp hid=".uno:LibSelector" visibility="visible">Select the library that you want to edit.</ahelp> The first module of the library that you select is displayed in the Basic IDE.</paragraph> + </section> + <section id="sybibliothek"> + <table id="tbl_id3156410"> + + + + <tablerow> + <tablecell> + <paragraph role="paragraph" id="par_id3149095" xml-lang="en-US"><image src="media/helpimg/feldalle.png" id="img_id3147576" localize="true"><alt xml-lang="en-US" id="alt_id3147576">List box Library</alt></image></paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id3147654" xml-lang="en-US">Library List Box</paragraph> + </tablecell> + </tablerow> + + </table> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11020000.xhp b/helpcontent2/source/text/sbasic/shared/02/11020000.xhp new file mode 100644 index 000000000..ce53ee438 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11020000.xhp @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211020000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Compile</title> +<filename>/text/sbasic/shared/02/11020000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="compile"> +<bookmark branch="hid/.uno:CompileBasic" xml-lang="en-US" id="bm_id3154230" localize="false"/> +<h1 id="hd_id3148983"><link href="text/sbasic/shared/02/11020000.xhp" name="Compile">Compile</link></h1> + <paragraph role="paragraph" id="par_id3159201" xml-lang="en-US"><ahelp hid=".uno:CompileBasic" visibility="visible">Compiles the Basic macro.</ahelp> You need to compile a macro after you make changes to it, or if the macro uses single or procedure steps.</paragraph> + </section> + <section id="sycompile"> + <table id="tbl_id3147571"> + + + + <tablerow> + <tablecell> + <paragraph role="paragraph" id="par_id3156426" xml-lang="en-US"><image src="cmd/sc_compilebasic.png" id="img_id3147576" width="1cm" height="1cm"><alt xml-lang="en-US" id="alt_id3147576">Icon Compile</alt></image></paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id3149399" xml-lang="en-US">Compile</paragraph> + </tablecell> + </tablerow> + + </table> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11030000.xhp b/helpcontent2/source/text/sbasic/shared/02/11030000.xhp new file mode 100644 index 000000000..91d2c92f4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11030000.xhp @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211030000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Run</title> +<filename>/text/sbasic/shared/02/11030000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="run"> +<bookmark xml-lang="en-US" branch="hid/.uno:RunBasic" id="bm_id3150247" localize="false"/> +<paragraph role="heading" id="hd_id3153255" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11030000.xhp" name="Run">Run</link></paragraph> +<paragraph role="paragraph" id="par_id3159201" xml-lang="en-US"><ahelp hid=".uno:RunBasic">Runs the first macro of the current module.</ahelp></paragraph> +</section> +<section id="syrun"> +<table id="tbl_id3149346"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3156410" xml-lang="en-US"> +<image id="img_id3153311" src="cmd/sc_runbasic.png" width="0.423cm" height="0.423cm"><alt id="alt_id3153311" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154750" xml-lang="en-US">Run</paragraph> +</tablecell> +</tablerow> +</table> + +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11040000.xhp b/helpcontent2/source/text/sbasic/shared/02/11040000.xhp new file mode 100644 index 000000000..a8a7aa415 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11040000.xhp @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + + <helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211040000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Stop</title> +<filename>/text/sbasic/shared/02/11040000.xhp</filename> +</topic> +</meta> +<body> +<section id="stop"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154863"><bookmark_value>macros; stopping</bookmark_value> +<bookmark_value>program stops</bookmark_value> +<bookmark_value>stopping macros</bookmark_value> +</bookmark> +<bookmark xml-lang="en-US" branch="hid/.uno:BasicStop" id="bm_id2398331" localize="false"/> +<paragraph role="heading" id="hd_id3154863" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11040000.xhp" name="Stop">Stop</link></paragraph> +<paragraph role="paragraph" id="par_id3147226" xml-lang="en-US"><ahelp hid=".uno:BasicStop">Stops running the current macro.</ahelp><switchinline select="sys"><caseinline select="MAC"> +</caseinline><defaultinline> You can also press Shift+Ctrl+Q.</defaultinline></switchinline></paragraph> +</section> +<section id="systop"> +<table id="tbl_id3147576"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3146797" xml-lang="en-US"> +<image id="img_id3148538" src="cmd/sc_basicstop.png" width="0.222inch" height="0.222inch"><alt id="alt_id3148538" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150986" xml-lang="en-US">Stop</paragraph> +</tablecell> +</tablerow> +</table> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11050000.xhp b/helpcontent2/source/text/sbasic/shared/02/11050000.xhp new file mode 100644 index 000000000..57a75a94e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11050000.xhp @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211050000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Single Step</title> +<filename>/text/sbasic/shared/02/11050000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="single_step"> +<bookmark xml-lang="en-US" branch="hid/.uno:BasicStepInto" id="bm_id3917322" localize="false"/> +<paragraph role="heading" id="hd_id3155934" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11050000.xhp" name="Single Step">Single Step</link></paragraph> +<paragraph role="paragraph" id="par_id3146117" xml-lang="en-US"><ahelp hid=".uno:BasicStepInto">Runs the macro and stops it after the next command.</ahelp></paragraph> +</section> +<paragraph role="paragraph" id="par_id3152801" xml-lang="en-US">You can use this command in conjunction with the <link href="text/sbasic/shared/02/11080000.xhp" name="Watch">Watch</link> command to troubleshoot errors.</paragraph> +<section id="sysingle_step"> +<table id="tbl_id3153527"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3157958" xml-lang="en-US"> +<image id="img_id3153345" src="cmd/sc_basicstepinto.png" width="0.222inch" height="0.222inch"><alt id="alt_id3153345" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147573" xml-lang="en-US">Single Step</paragraph> +</tablecell> +</tablerow> +</table> + +</section> +<section id="relatedtopics"> +<paragraph role="paragraph" id="par_id3149235" xml-lang="en-US"><link href="text/sbasic/shared/02/11060000.xhp" name="Procedure Step function">Procedure Step function</link></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11060000.xhp b/helpcontent2/source/text/sbasic/shared/02/11060000.xhp new file mode 100644 index 000000000..dd497d144 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11060000.xhp @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211060000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Procedure Step</title> +<filename>/text/sbasic/shared/02/11060000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="procedure_step"> +<bookmark xml-lang="en-US" branch="hid/.uno:BasicStepOver" id="bm_id3926226" localize="false"/> +<paragraph role="heading" id="hd_id3148520" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11060000.xhp" name="Procedure Step">Procedure Step</link></paragraph> +<paragraph role="paragraph" id="par_id3152363" xml-lang="en-US"><ahelp hid=".uno:BasicStepOver">Runs the macro and stops it after the next procedure.</ahelp></paragraph> +</section> +<paragraph role="paragraph" id="par_id3153394" xml-lang="en-US">You can use this command in conjunction with the <link href="text/sbasic/shared/02/11080000.xhp" name="Watch">Watch</link> command to troubleshoot errors.</paragraph> +<section id="syprocedure_step"> +<table id="tbl_id3146957"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147576" xml-lang="en-US"> +<image id="img_id3143267" src="cmd/sc_basicstepover.png" width="0.222inch" height="0.222inch"><alt id="alt_id3143267" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154307" xml-lang="en-US">Procedure Step</paragraph> +</tablecell> +</tablerow> +</table> + +</section> +<section id="relatedtopics"> +<paragraph role="paragraph" id="par_id3153562" xml-lang="en-US"><link href="text/sbasic/shared/02/11050000.xhp" name="Single Step function">Single Step function</link></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11070000.xhp b/helpcontent2/source/text/sbasic/shared/02/11070000.xhp new file mode 100644 index 000000000..8382317d2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11070000.xhp @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> + + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + + <helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211070000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Breakpoint</title> +<filename>/text/sbasic/shared/02/11070000.xhp</filename> +</topic> +</meta> +<body> +<section id="breakpoint"> +<bookmark xml-lang="en-US" branch="hid/.uno:ToggleBreakPoint" id="bm_id2767094" localize="false"/> +<paragraph role="heading" id="hd_id3154863" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11070000.xhp" name="Breakpoint">Breakpoint</link></paragraph> +<paragraph role="paragraph" id="par_id3155364" xml-lang="en-US"><ahelp hid=".uno:ToggleBreakPoint">Inserts a breakpoint in the program line.</ahelp></paragraph> +</section> +<paragraph role="paragraph" id="par_id3149346" xml-lang="en-US">The breakpoint is inserted at the cursor position. Use a breakpoint to interrupt a program just before an error occurs. You can then troubleshoot the program by running it in <link href="text/sbasic/shared/02/11050000.xhp" name="Single Step">Single Step</link> mode until the error occurs. You can also use the <link href="text/sbasic/shared/02/11080000.xhp" name="Watch">Watch</link> icon to check the content of the relevant variables.</paragraph> +<section id="sybreakpoint"> +<table id="tbl_id3149095"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3156346" xml-lang="en-US"> +<image id="img_id3152780" src="cmd/sc_togglebreakpoint.png" width="0.1665inch" height="0.1665inch"><alt id="alt_id3152780" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3149416" xml-lang="en-US">Breakpoint</paragraph> +</tablecell> +</tablerow> +</table> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11080000.xhp b/helpcontent2/source/text/sbasic/shared/02/11080000.xhp new file mode 100644 index 000000000..98643b7db --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11080000.xhp @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211080000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Enable Watch</title> +<filename>/text/sbasic/shared/02/11080000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="watch"> +<bookmark xml-lang="en-US" branch="hid/.uno:AddWatch" id="bm_id7891299" localize="false"/> +<paragraph role="heading" id="hd_id3154863" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11080000.xhp" name="Enable Watch">Enable Watch</link></paragraph> +<paragraph role="paragraph" id="par_id3093440" xml-lang="en-US"><ahelp hid=".uno:AddWatch">Click this icon to view the variables in a macro. The contents of the variable are displayed in a separate window.</ahelp></paragraph> +</section> +<paragraph role="paragraph" id="par_id3147399" xml-lang="en-US">Click the name of a variable to select it, then click the <emph>Enable Watch</emph> icon. The value that is assigned to the variable is displayed next to its name. This value is constantly updated.</paragraph> +<section id="sywatch"> +<table id="tbl_id3143267"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3155892" xml-lang="en-US"> +<image id="img_id3147209" src="cmd/sc_addwatch.png" width="0.222inch" height="0.222inch"><alt id="alt_id3147209" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150276" xml-lang="en-US">Enable Watch</paragraph> +</tablecell> +</tablerow> +</table> + +</section> +<paragraph role="paragraph" id="par_id3159158" xml-lang="en-US">To remove the variable watch, select the variable in the Watch window, and then click on the <emph>Remove Watch</emph> icon.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11090000.xhp b/helpcontent2/source/text/sbasic/shared/02/11090000.xhp new file mode 100644 index 000000000..b4f68b8a9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11090000.xhp @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211090000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Object Catalog</title> +<filename>/text/sbasic/shared/02/11090000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="ocatalog"> +<bookmark xml-lang="en-US" branch="hid/.uno:ObjectCatalog" id="bm_id8689372" localize="false"/> +<paragraph role="heading" id="hd_id3153255" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11090000.xhp" name="Object Catalog">Object Catalog</link></paragraph> +<paragraph role="paragraph" id="par_id3151384" xml-lang="en-US"><ahelp hid=".uno:ObjectCatalog">Opens the <emph>Objects</emph> pane, where you can view Basic objects.</ahelp></paragraph> +</section> +<paragraph role="paragraph" id="par_id3147576" xml-lang="en-US">Double click the name of a function or sub to load the module that contains that function or sub, and to position the cursor. Double click the name of a module or dialog to load and display that module or dialog.</paragraph> +<section id="syobjectcatalog"> +<table id="tbl_id3155892"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3148538" xml-lang="en-US"> +<image id="img_id3163803" src="cmd/sc_objectcatalog.png" width="0.1665inch" height="0.1665inch"><alt id="alt_id3163803" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154515" xml-lang="en-US">Object Catalog</paragraph> +</tablecell> +</tablerow> +</table> + +</section> + +<bookmark xml-lang="en-US" branch="hid/BASCTL_HID_BASICIDE_OBJECTCAT" id="bm_id3148664" localize="false"/> +<paragraph role="heading" id="hd_id3146794" xml-lang="en-US" level="2">Window Area</paragraph> +<paragraph role="paragraph" id="par_id3149655" xml-lang="en-US"><ahelp hid="HID_BASICIDE_OBJECTCAT">Displays a hierarchical view of the current $[officename] macro libraries, modules, and dialogs. To display the contents of an item in the window, double click its name.</ahelp></paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11100000.xhp b/helpcontent2/source/text/sbasic/shared/02/11100000.xhp new file mode 100644 index 000000000..1fe1f4955 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11100000.xhp @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211100000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Macros</title> +<filename>/text/sbasic/shared/02/11100000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="macros"> +<bookmark branch="hid/.uno:ChooseMacro" xml-lang="en-US" id="bm_id3155364" localize="false"/> +<h1 id="hd_id3156183"><link href="text/sbasic/shared/02/11100000.xhp" name="Macros">Macros</link></h1> + <paragraph role="paragraph" id="par_id3147399" xml-lang="en-US"><ahelp visibility="visible" hid=".uno:ChooseMacro">Opens the <emph>Macro</emph> dialog.</ahelp></paragraph> + </section> + <section id="symacros"> + <table id="tbl_id3146957"> + + + + <tablerow> + <tablecell> + <paragraph role="paragraph" id="par_id3148538" xml-lang="en-US"><image src="cmd/sc_choosemacro.png" id="img_id3153662" width="1cm" height="1cm"><alt xml-lang="en-US" id="alt_id3153662">Icon Macros</alt></image></paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id3153542" xml-lang="en-US">Macros</paragraph> + </tablecell> + </tablerow> + + </table> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11110000.xhp b/helpcontent2/source/text/sbasic/shared/02/11110000.xhp new file mode 100644 index 000000000..9a982589e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11110000.xhp @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211110000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Modules</title> +<filename>/text/sbasic/shared/02/11110000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="module"> +<bookmark branch="hid/.uno:ModuleDialog" xml-lang="en-US" id="bm_id3157898" localize="false"/> +<h1 id="hd_id3148520"><link href="text/sbasic/shared/02/11110000.xhp" name="Modules">Modules</link></h1> + <paragraph role="paragraph" id="par_id3156414" xml-lang="en-US"><ahelp visibility="visible" hid=".uno:ModuleDialog">Click here to open the <link href="text/sbasic/shared/01/06130000.xhp" name="Macro Organizer"><emph>Macro Organizer</emph></link> dialog.</ahelp></paragraph> + </section> + <section id="symodule"> + <table id="tbl_id3153311"> + + + + <tablerow> + <tablecell> + <paragraph role="paragraph" id="par_id3157958" xml-lang="en-US"><image src="cmd/sc_moduledialog.png" id="img_id3155535" width="1cm" height="1cm"><alt xml-lang="en-US" id="alt_id3155535">Icon Modules</alt></image></paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id3145383" xml-lang="en-US">Modules</paragraph> + </tablecell> + </tablerow> + + </table> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11120000.xhp b/helpcontent2/source/text/sbasic/shared/02/11120000.xhp new file mode 100644 index 000000000..1a9ee3c26 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11120000.xhp @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211120000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Find Parentheses</title> +<filename>/text/sbasic/shared/02/11120000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="parentheses"> +<bookmark branch="hid/.uno:MatchGroup" xml-lang="en-US" id="bm_id3148520" localize="false"/> +<h1 id="hd_id3149497"><link href="text/sbasic/shared/02/11120000.xhp" name="Find Parentheses">Find Parentheses</link></h1> + <paragraph role="paragraph" id="par_id3155150" xml-lang="en-US"><ahelp hid=".uno:MatchGroup" visibility="visible">Highlights the text that is enclosed by two corresponding brackets. Place the text cursor in front of an opening or closing bracket, and then click this icon.</ahelp></paragraph> + </section> + <section id="syparentheses"> + <table id="tbl_id3147226"> + + + + <tablerow> + <tablecell> + <paragraph role="paragraph" id="par_id3149182" xml-lang="en-US"><image src="cmd/sc_matchgroup.png" id="img_id3155892" width="1cm" height="1cm"><alt xml-lang="en-US" id="alt_id3155892">Icon Find Parentheses</alt></image></paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id3147276" xml-lang="en-US">Find Parentheses</paragraph> + </tablecell> + </tablerow> + + </table> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11140000.xhp b/helpcontent2/source/text/sbasic/shared/02/11140000.xhp new file mode 100644 index 000000000..a33237355 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11140000.xhp @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211140000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Insert Source Text</title> +<filename>/text/sbasic/shared/02/11140000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="insertsource"> +<bookmark xml-lang="en-US" branch="hid/.uno:LoadBasic" id="bm_id7976858" localize="false"/> +<paragraph role="heading" id="hd_id3154044" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11140000.xhp" name="Insert Source Text">Insert Source Text</link></paragraph> +<paragraph role="paragraph" id="par_id3150702" xml-lang="en-US"><ahelp hid=".uno:LoadBasic">Opens the Basic source text in the Basic IDE window.</ahelp></paragraph> +</section> +<paragraph role="paragraph" id="par_id3150445" xml-lang="en-US">Place the cursor in the code where you want to insert the source text, and then click the <emph>Insert source text</emph> icon. Locate the file that contains the Basic source text that you want to insert, and then click <emph>Open</emph>.</paragraph> +<section id="syinsertsource"> +<table id="tbl_id3150247"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3145136" xml-lang="en-US"> +<image id="img_id3147571" src="cmd/sc_loadbasic.png" width="0.1665inch" height="0.1665inch"><alt id="alt_id3147571" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3145346" xml-lang="en-US">Insert source text</paragraph> +</tablecell> +</tablerow> +</table> + +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11150000.xhp b/helpcontent2/source/text/sbasic/shared/02/11150000.xhp new file mode 100644 index 000000000..a08b9245b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11150000.xhp @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211150000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Save Source As</title> +<filename>/text/sbasic/shared/02/11150000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="savesource"> +<bookmark xml-lang="en-US" branch="hid/.uno:SaveBasicAs" id="bm_id4562232" localize="false"/> +<paragraph role="heading" id="hd_id3149497" xml-lang="en-US" level="1"><link href="text/sbasic/shared/02/11150000.xhp" name="Save Source As">Save Source As</link></paragraph> +<paragraph role="paragraph" id="par_id3147261" xml-lang="en-US"><ahelp hid=".uno:SaveBasicAs">Saves the source code of the selected Basic macro.</ahelp></paragraph> +</section> +<section id="sysavesource"> +<table id="tbl_id3155555"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3145071" xml-lang="en-US"> +<image id="img_id3149182" src="cmd/sc_savebasicas.png" width="0.222inch" height="0.222inch"><alt id="alt_id3149182" xml-lang="en-US">Icon</alt> + </image></paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3151110" xml-lang="en-US">Save Source As</paragraph> +</tablecell> +</tablerow> +</table> + +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11160000.xhp b/helpcontent2/source/text/sbasic/shared/02/11160000.xhp new file mode 100644 index 000000000..1345affde --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11160000.xhp @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0211160000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Step Out</title> +<filename>/text/sbasic/shared/02/11160000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="stepout"> +<bookmark branch="hid/.uno:BasicStepOut" xml-lang="en-US" id="bm_id3153089" localize="false"/> +<h1 id="hd_id3148983"><link href="text/sbasic/shared/02/11160000.xhp" name="Step Out">Step Out</link></h1> + <paragraph role="paragraph" id="par_id3157898" xml-lang="en-US"><ahelp hid=".uno:BasicStepOut" visibility="visible">Jumps back to the previous routine in the current macro.</ahelp></paragraph> + </section> + <section id="systepout"> + <table id="tbl_id3147226"> + + + + <tablerow> + <tablecell> + <paragraph role="paragraph" id="par_id3156410" xml-lang="en-US"><image src="cmd/sc_basicstepout.png" id="img_id3159233" width="1cm" height="1cm"><alt xml-lang="en-US" id="alt_id3159233">Icon Step Out</alt></image></paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id3158421" xml-lang="en-US">Step Out</paragraph> + </tablecell> + </tablerow> + + </table> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/02/11170000.xhp b/helpcontent2/source/text/sbasic/shared/02/11170000.xhp new file mode 100644 index 000000000..f944e2aba --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11170000.xhp @@ -0,0 +1,54 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + +<meta> + <topic id="textsbasicshared0211170000xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">Manage Breakpoints</title> + <filename>/text/sbasic/shared/02/11170000.xhp</filename> + </topic> + </meta> + <body> + <section id="manage_breakpoints"> +<bookmark xml-lang="en-US" branch="hid/.uno:ManageBreakPoints" id="bm_id0929200903013963" localize="false"/> +<paragraph xml-lang="en-US" id="hd_id3156183" role="heading" level="1"><link href="text/sbasic/shared/02/11170000.xhp" name="Manage Breakpoints">Manage Breakpoints</link></paragraph> + <paragraph xml-lang="en-US" id="par_id3152363" role="paragraph"><ahelp hid=".">Calls a dialog to manage breakpoints.</ahelp></paragraph> + </section> + <section id="sybreakpoints"> + <table id="tbl_id3153750"> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3143267" role="paragraph"> +<image id="img_id3155339" src="cmd/sc_managebreakpoints.png" width="0.1665in" height="0.1665in"><alt xml-lang="en-US" id="alt_id3155339">Icon</alt> + </image></paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3145383" role="paragraph">Manage Breakpoints</paragraph> + </tablecell> + </tablerow> + </table> + + </section> + <section id="relatedtopics"> + <paragraph xml-lang="en-US" id="par_id3154897" role="paragraph"><link href="text/sbasic/shared/01050300.xhp" name="Manage Breakpoints dialog"><emph>Manage Breakpoints</emph> dialog</link></paragraph> + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/02/11180000.xhp b/helpcontent2/source/text/sbasic/shared/02/11180000.xhp new file mode 100644 index 000000000..594c3cc16 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11180000.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + +<meta> + <topic id="textsbasicshared0211180000xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">Import Dialog</title> + <filename>/text/sbasic/shared/02/11180000.xhp</filename> + </topic> + </meta> + <body> + <section id="import"> +<bookmark xml-lang="en-US" branch="hid/.uno:ImportDialog" id="bm_id092920903013963" localize="false"/> +<paragraph xml-lang="en-US" id="hd_id3156183" role="heading" level="1"><link href="text/sbasic/shared/02/11180000.xhp" name="Import Dialog">Import Dialog</link></paragraph> + <paragraph xml-lang="en-US" id="par_id3152363" role="paragraph"><ahelp hid=".">Calls an "Open" dialog to import a BASIC dialog file.</ahelp></paragraph> + <paragraph xml-lang="en-US" id="par_id0929200903505211" role="paragraph">If the imported dialog has a name that already exists in the library, you see a message box where you can decide to rename the imported dialog. In this case the dialog will be renamed to the next free "automatic" name like when creating a new dialog. Or you can replace the existing dialog by the imported dialog. If you click Cancel the dialog is not imported.</paragraph> + <paragraph xml-lang="en-US" id="par_id0929200903505360" role="paragraph">Dialogs can contain localization data. When importing a dialog, a mismatch of the dialogs' localization status can occur.</paragraph> + <paragraph xml-lang="en-US" id="par_id0929200903505320" role="paragraph">If the library contains additional languages compared to the imported dialog, or if the imported dialog is not localized at all, then the additional languages will silently be added to the imported dialog using the strings of the dialog's default locale.</paragraph> + <paragraph xml-lang="en-US" id="par_id0929200903505383" role="paragraph">If the imported dialog contains additional languages compared to the library, or if the library is not localized at all, then you see a message box with Add, Omit, and Cancel buttons.</paragraph> + <list type="unordered"> + <listitem> + <paragraph xml-lang="en-US" id="par_id0929200903505340" role="paragraph">Add: The additional languages from the imported dialog will be added to the already existing dialog. The resources from the library's default language will be used for the new languages. This is the same as if you add these languages manually.</paragraph> + </listitem> + <listitem> + <paragraph xml-lang="en-US" id="par_id0929200903505367" role="paragraph">Omit: The library's language settings will stay unchanged. The imported dialog's resources for the omitted languages are not copied into the library, but they remain in the imported dialog's source files.</paragraph> + </listitem> + </list> + </section> + <section id="syimport"> + <table id="tbl_id3153750"> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3143267" role="paragraph"> +<image id="img_id3155339" src="cmd/sc_importdialog.png" width="0.1665in" height="0.1665in"><alt xml-lang="en-US" id="alt_id3155339">Icon</alt> + </image></paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3145383" role="paragraph">Import Dialog</paragraph> + </tablecell> + </tablerow> + </table> + + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/02/11190000.xhp b/helpcontent2/source/text/sbasic/shared/02/11190000.xhp new file mode 100644 index 000000000..dc39139a6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/11190000.xhp @@ -0,0 +1,51 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + +<meta> + <topic id="textsbasicshared0211190000xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">Export Dialog</title> + <filename>/text/sbasic/shared/02/11190000.xhp</filename> + </topic> + </meta> + <body> + <section id="export"> +<bookmark xml-lang="en-US" branch="hid/.uno:ExportDialog" id="bm_id099200903013963" localize="false"/> +<paragraph xml-lang="en-US" id="hd_id3156183" role="heading" level="1"><link href="text/sbasic/shared/02/11190000.xhp" name="Export Dialog">Export Dialog</link></paragraph> + <paragraph xml-lang="en-US" id="par_id3152363" role="paragraph"><ahelp hid=".">In the dialog editor, this command calls a "Save as" dialog to export the current BASIC dialog.</ahelp></paragraph> + </section> + <section id="syexport"> + <table id="tbl_id3153750"> + <tablerow> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3143267" role="paragraph"> +<image id="img_id3155339" src="cmd/sc_exportdialog.png" width="0.1665in" height="0.1665in"><alt xml-lang="en-US" id="alt_id3155339">Icon</alt> + </image></paragraph> + </tablecell> + <tablecell> + <paragraph xml-lang="en-US" id="par_id3145383" role="paragraph">Export Dialog</paragraph> + </tablecell> + </tablerow> + </table> + + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/02/20000000.xhp b/helpcontent2/source/text/sbasic/shared/02/20000000.xhp new file mode 100644 index 000000000..c6c9c97f8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/02/20000000.xhp @@ -0,0 +1,474 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared0220000000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Insert Controls</title> +<filename>/text/sbasic/shared/02/20000000.xhp</filename> +</topic> +</meta> +<body> +<section id="controls"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150402"><bookmark_value>controls; in dialog editor</bookmark_value> +<bookmark_value>push button control in dialog editor</bookmark_value> +<bookmark_value>icon control</bookmark_value> +<bookmark_value>buttons; controls</bookmark_value> +<bookmark_value>image control</bookmark_value> +<bookmark_value>check box control</bookmark_value> +<bookmark_value>radio button control</bookmark_value> +<bookmark_value>option button control</bookmark_value> +<bookmark_value>fixed text control</bookmark_value> +<bookmark_value>label field control</bookmark_value> +<bookmark_value>editing; controls</bookmark_value> +<bookmark_value>text boxes; controls</bookmark_value> +<bookmark_value>list boxes; controls</bookmark_value> +<bookmark_value>combo box control</bookmark_value> +<bookmark_value>scroll bar control</bookmark_value> +<bookmark_value>horizontal scrollbar control</bookmark_value> +<bookmark_value>vertical scrollbar control</bookmark_value> +<bookmark_value>group box control</bookmark_value> +<bookmark_value>progress bar control</bookmark_value> +<bookmark_value>fixed line control</bookmark_value> +<bookmark_value>horizontal line control</bookmark_value> +<bookmark_value>line control</bookmark_value> +<bookmark_value>vertical line control</bookmark_value> +<bookmark_value>date field control</bookmark_value> +<bookmark_value>time field control</bookmark_value> +<bookmark_value>numerical field control</bookmark_value> +<bookmark_value>currency field control</bookmark_value> +<bookmark_value>formatted field control</bookmark_value> +<bookmark_value>pattern field control</bookmark_value> +<bookmark_value>masked field control</bookmark_value> +<bookmark_value>file selection control</bookmark_value> +<bookmark_value>selection options for controls</bookmark_value> +<bookmark_value>test mode control</bookmark_value> +</bookmark> +<bookmark xml-lang="en-US" branch="hid/.uno:ChooseControls" id="bm_id393577" localize="false"/> +<h1 id="hd_id3150402"><link href="text/sbasic/shared/02/20000000.xhp" name="Insert Controls">Insert Controls</link></h1> +<paragraph role="paragraph" id="par_id3147000" xml-lang="en-US"><ahelp hid=".uno:ChooseControls">Opens the <emph>Toolbox</emph> bar.</ahelp></paragraph></section> +<section id="sycontrols"> +<table id="tbl_id3153539"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3147226" xml-lang="en-US"> +<image id="img_id3147571" src="cmd/lc_choosecontrols.svg" width="1cm" height="1cm"><alt id="alt_id3147571" xml-lang="en-US">Icon Choose Controls</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3153749" xml-lang="en-US">Insert Controls</paragraph> +</tablecell> +</tablerow> +</table> +</section> +<list type="unordered"> +<listitem> +<paragraph role="listitem" id="par_id3157958" xml-lang="en-US">In edit mode, double-click a control to open the <link href="text/sbasic/shared/01170100.xhp" name="properties dialog">properties dialog</link>.</paragraph> +</listitem> +<listitem> +<paragraph role="listitem" id="par_id3148538" xml-lang="en-US">In edit mode, you can also right-click a control and choose the cut, copy, and paste command.</paragraph> +</listitem> +</list> +<bookmark xml-lang="en-US" branch="hid/.uno:InsertPushbutton" id="bm_id6674092" localize="false"/> +<section id="pushbutton"> +<h2 id="hd_id3148473">Button</h2> +<table id="tbl_id3155628"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3153824" xml-lang="en-US"> +<image id="img_id3157909" src="cmd/sc_insertpushbutton.png" width="1cm" height="1cm"><alt id="alt_id3157909" xml-lang="en-US">Icon Button</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3147530" xml-lang="en-US"><ahelp hid=".uno:InsertPushbutton">Adds a command button.</ahelp> You can use a command button to execute a command for a defined event, such as a mouse click.</paragraph> +<paragraph role="paragraph" id="par_id3154923" xml-lang="en-US">If you want, you can add text or a graphic to the button.</paragraph> +</tablecell> +</tablerow> +</table> +</section> + +<section id="imagecontrol"> +<h2 id="hd_id3148550">Image Control</h2> +<table id="tbl_id3150541"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3154138" xml-lang="en-US"> +<image id="img_id3144760" src="cmd/sc_objectcatalog.png" width="1cm" height="1cm"><alt id="alt_id3144760" xml-lang="en-US">Icon Image Control</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3151042" xml-lang="en-US"><ahelp hid=".uno:InsertImageControl">Adds a control that displays a graphic.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="checkbox"> +<h2 id="hd_id3150447">Check Box</h2> +<table id="tbl_id3145607"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3155131" xml-lang="en-US"> +<image id="img_id3150439" src="cmd/sc_checkbox.png" width="1cm" height="1cm"><alt id="alt_id3150439" xml-lang="en-US">Icon Check Box</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3147317" xml-lang="en-US"><ahelp hid=".uno:Checkbox">Adds a check box that you can use to turn a function on or off.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="optionbutton"> +<h2 id="hd_id3150486">Option Button</h2> +<table id="tbl_id3151118"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3155856" xml-lang="en-US"> +<image id="img_id3146921" src="cmd/sc_radiobutton.png" width="1cm" height="1cm"><alt id="alt_id3146921" xml-lang="en-US">Icon Option Button</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3153575" xml-lang="en-US"><ahelp hid=".uno:Radiobutton">Adds a button that allows a user to select from a number of options.</ahelp> Grouped option buttons must have consecutive tab order. They are commonly encircled by a group box. If you have two groups of option buttons, you must insert a tab order between the tab orders of the two groups. For example, to the frame of the second group, or to any other control in the dialog, with the exception of another option button.</paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="label"> +<h2 id="hd_id3154729">Label Field</h2> +<table id="tbl_id3149417"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3149300" xml-lang="en-US"> +<image id="img_id3153415" src="cmd/sc_insertfixedtext.png" width="1cm" height="1cm"><alt id="alt_id3153415" xml-lang="en-US">Icon Label Field</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3156181" xml-lang="en-US"><ahelp hid=".uno:InsertFixedText">Adds a field for displaying text labels.</ahelp> These labels are only for displaying predefined text, and not for entering text.</paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="textbox"> +<h2 id="hd_id3149123">Text Box</h2> +<table id="tbl_id3156278"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3153766" xml-lang="en-US"> +<image id="img_id3148996" src="cmd/sc_edit.png" width="1cm" height="1cm"><alt id="alt_id3148996" xml-lang="en-US">Icon Text Box</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3153712" xml-lang="en-US"><ahelp hid=".uno:InsertEdit">Adds an input box where you can enter and edit text.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="listbox"> +<h2 id="hd_id3154253">List Box</h2> +<table id="tbl_id3149565"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3155959" xml-lang="en-US"> +<image id="img_id3163808" src="cmd/sc_listbox.png" width="1cm" height="1cm"><alt id="alt_id3163808" xml-lang="en-US">Icon List Box</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3155176" xml-lang="en-US"><ahelp hid=".uno:InsertListbox">Adds a box where you can click an entry on a list.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="combobox"> +<h2 id="hd_id3150644">Combo Box</h2> +<table id="tbl_id3155606"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3148418" xml-lang="en-US"> +<image id="img_id3153200" src="cmd/sc_combobox.png" width="1cm" height="1cm"><alt id="alt_id3153200" xml-lang="en-US">Icon Combo Box</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3154199" xml-lang="en-US"><ahelp hid=".uno:Combobox">Adds a combo box. A combo box is a one line list box that a user can click, and then choose an entry from the list.</ahelp> If you want, you can make the entries in the combo box "read only".</paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="horzbar"> +<h2 id="hd_id3154585">Horizontal Scrollbar</h2> +<table id="tbl_id3152580"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3153781" xml-lang="en-US"> +<image id="img_id3149530" src="cmd/sc_hscrollbar.png" width="1cm" height="1cm"><alt id="alt_id3149530" xml-lang="en-US">Icon Horizontal Scrollbar</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3153232" xml-lang="en-US"><ahelp hid=".uno:HScrollbar">Adds a horizontal scrollbar to the dialog.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="vertbar"> +<h2 id="hd_id3154119">Vertical Scrollbar</h2> +<table id="tbl_id3145132"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3150515" xml-lang="en-US"> +<image id="img_id3150203" src="cmd/sc_vscrollbar.png" width="1cm" height="1cm"><alt id="alt_id3150203" xml-lang="en-US">Icon Vertical Scrollbar</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3155376" xml-lang="en-US"><ahelp hid=".uno:VScrollbar">Adds a vertical scrollbar to the dialog.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="groupbox"> +<h2 id="hd_id3150313">Group Box</h2> +<table id="tbl_id3154261"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3151184" xml-lang="en-US"> +<image id="img_id3151335" src="cmd/sc_groupbox.png" width="1cm" height="1cm"><alt id="alt_id3151335" xml-lang="en-US">Icon Group Box</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3159622" xml-lang="en-US"><ahelp hid=".uno:Groupbox">Adds a frame that you can use to visually group similar controls, such as option buttons.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<note id="par_id3148820">To define two different groups of option buttons, ensure that the tab index of the group frame is between the tab indices of the two groups.</note> +<bookmark xml-lang="en-US" branch="hid/.uno:ProgressBar" id="bm_id9634998" localize="false"/> +<section id="progressbar"> +<h2 id="hd_id3149330">Progress Bar</h2> +<table id="tbl_id3148606"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3159093" xml-lang="en-US"> +<image id="img_id3150318" src="cmd/sc_progressbar.png" width="1cm" height="1cm"><alt id="alt_id3150318" xml-lang="en-US">Icon Progress Bar</alt> </image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3157979" xml-lang="en-US"><ahelp hid=".uno:ProgressBar">Adds a progress bar to the dialog.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="horzline"> +<h2 id="hd_id3145654">Horizontal Line</h2> +<table id="tbl_id3154596"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3150888" xml-lang="en-US"> +<image id="img_id3152872" src="cmd/sc_hfixedline.png" width="1cm" height="1cm"><alt id="alt_id3152872" xml-lang="en-US">Icon Horizontal Line</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3151000" xml-lang="en-US"><ahelp hid=".uno:HFixedLine">Adds a horizontal line to the dialog.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="vertline"> +<h2 id="hd_id3155095">Vertical Line</h2> +<table id="tbl_id3148970"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3154913" xml-lang="en-US"> +<image id="img_id3153249" src="cmd/sc_vfixedline.png" width="1cm" height="1cm"><alt id="alt_id3153249" xml-lang="en-US">Icon Vertical Line</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3159203" xml-lang="en-US"><ahelp hid=".uno:VFixedLine">Adds a vertical line to the dialog.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="datefield"> +<h2 id="hd_id3154540">Date Field</h2> +<table id="tbl_id3154649"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3148901" xml-lang="en-US"> +<image id="img_id3151010" src="cmd/sc_adddatefield.png" width="1cm" height="1cm"><alt id="alt_id3151010" xml-lang="en-US">Icon Date Field</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3154214" xml-lang="en-US"><ahelp hid=".uno:AddDateField">Adds a date field.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +<paragraph role="paragraph" id="par_id3150046" xml-lang="en-US">If you assign the "dropdown" property to the date field, a user can drop down a calendar to select a date.</paragraph> +</section> +<section id="timefield"> +<bookmark xml-lang="en-US" branch="hid/.uno:InsertTimeField" id="bm_id2991424" localize="false"/> +<h2 id="hd_id3151126">Time Field</h2> +<table id="tbl_id3147514"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3154338" xml-lang="en-US"> +<image id="img_id3147077" src="cmd/sc_timefield.png" width="1cm" height="1cm"><alt id="alt_id3147077" xml-lang="en-US">Icon Time Field</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3151191" xml-lang="en-US"><ahelp hid="SID_INSERT_TIMEFIELD">Adds a time field.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="numfield"> +<h2 id="hd_id3154733">Numeric Field</h2> +<table id="tbl_id3156367"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3146107" xml-lang="en-US"> +<image id="img_id3147499" src="cmd/sc_insertnumericfield.png" width="1cm" height="1cm"><alt id="alt_id3147499" xml-lang="en-US">Icon Numeric Field</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3147244" xml-lang="en-US"><ahelp hid=".uno:InsertNumericField">Adds a numeric field.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="currencyfield"> +<h2 id="hd_id3149870">Currency Field</h2> +<table id="tbl_id3153335"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3153958" xml-lang="en-US"> +<image id="img_id3150435" src="cmd/sc_currencyfield.png" width="1cm" height="1cm"><alt id="alt_id3150435" xml-lang="en-US">Icon Currency Field</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3154064" xml-lang="en-US"><ahelp hid=".uno:InsertCurrencyField">Adds a currency field.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="formattedfield"> +<h2 id="hd_id3150117">Formatted Field</h2> +<table id="tbl_id3151361"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3153162" xml-lang="en-US"> +<image id="img_id3152807" src="cmd/sc_formattedfield.png" width="1cm" height="1cm"><alt id="alt_id3152807" xml-lang="en-US">Icon Formatted Field</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3146320" xml-lang="en-US"><ahelp hid=".uno:InsertFormattedField">Adds a text box where you can define the formatting for text that is inputted or outputted as well as any limiting values.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="patternfield"> +<h2 id="hd_id3156160">Pattern Field</h2> +<table id="tbl_id3151174"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3150379" xml-lang="en-US"> +<image id="img_id3150032" src="cmd/sc_insertpatternfield.png" width="1cm" height="1cm"><alt id="alt_id3150032" xml-lang="en-US">Icon Pattern Field</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3147382" xml-lang="en-US"><ahelp hid=".uno:InsertPatternField">Adds a masked field.</ahelp> A masked field consists of an input mask and a literal mask. The input mask determines which user data can be entered. The literal mask determines the state of the masked field when the form is loaded.</paragraph> +</tablecell> +</tablerow> +</table> +</section> +<section id="fileselect"> +<h2 id="hd_id3146815">File Selection</h2> +<table id="tbl_id3149914"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3149194" xml-lang="en-US"> +<image id="img_id3149101" src="cmd/sc_filecontrol.png" width="1cm" height="1cm"><alt id="alt_id3149101" xml-lang="en-US">Icon File Selection</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3145632" xml-lang="en-US"><ahelp hid=".uno:InsertFileControl">Adds a button that opens a file selection dialog.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</section> +<h2 id="hd_id3155912">Select</h2> +<table id="tbl_id3157966"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3154903" xml-lang="en-US"> +<image id="img_id3150653" src="cmd/sc_drawselect.png" width="1cm" height="1cm"><alt id="alt_id3150653" xml-lang="en-US">Icon Select</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3148465" xml-lang="en-US"><ahelp hid=".">Activates or deactivates the Selection mode. In this mode, you can select the controls in a dialog so that you can edit them.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +<h2 id="hd_id3154055">Properties</h2> +<table id="tbl_id3156148"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3148725" xml-lang="en-US"> +<image id="img_id3146874" src="cmd/sc_controlproperties.png" width="1cm" height="1cm"><alt id="alt_id3146874" xml-lang="en-US">Icon Properties</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3151105" xml-lang="en-US"><ahelp hid=".uno:ShowPropBrowser">Opens a dialog where you can edit the <link href="text/sbasic/shared/01170100.xhp" name="properties">properties</link> of the selected control.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +<h2 id="hd_id3153746">Activate Test Mode</h2> +<table id="tbl_id3149435"> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id3147417" xml-lang="en-US"> +<image id="img_id3148883" src="cmd/sc_testmode.png" width="1cm" height="1cm"><alt id="alt_id3148883" xml-lang="en-US">Icon Activate Test Mode</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id3150699" xml-lang="en-US"><ahelp hid=".uno:TestMode">Starts test mode. Click the dialog closer icon to end test mode.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +<bookmark xml-lang="en-US" branch="hid/.uno:ManageLanguage" id="bm_id5874813" localize="false"/><h2 id="hd_id2954191">Manage Language</h2> +<table id=""> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id2320017" xml-lang="en-US"> +<image id="img_id2856837" src="cmd/sc_managelanguage.png" width="1cm" height="1cm"><alt id="alt_id2856837" xml-lang="en-US">Manage Language icon</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id1261940" xml-lang="en-US"><ahelp hid=".uno:ManageLanguage">Opens a <link href="text/sbasic/guide/translation.xhp">dialog</link> to enable or manage multiple sets of dialog resources for multiple languages.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +<bookmark xml-lang="en-US" branch="hid/.uno:InsertTreeControl" id="bm_id1552781" localize="false"/><h2 id="hd_id11902">Tree Control</h2> +<table id=""> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id7511520" xml-lang="en-US"> +<image id="Graphic2" src="cmd/sc_inserttreecontrol.png" width="1cm" height="1cm"><alt id="alt_id285634" xml-lang="en-US">Icon Tree Control</alt> </image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id9961851" xml-lang="en-US"><ahelp hid=".">Adds a tree control that can show a hierarchical list. You can populate the list by your program, using API calls (XtreeControl).</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +<bookmark xml-lang="en-US" branch="hid/.uno:InsertGridControl" id="bm_id1552784" localize="false"/> +<h2 id="hd_id11904">Table Control</h2> +<table id=""> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id7511524"> +<image id="Graphic3" src="cmd/sc_insertgridcontrol.png" width="1cm" height="1cm"><alt id="alt_id2867837" xml-lang="en-US">Table control icon</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id9961854" xml-lang="en-US"><ahelp hid=".">Adds a table control that can show a table data. You can populate the data by your program, using API calls.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +<bookmark xml-lang="en-US" branch="hid/.uno:InsertHyperlinkControl" id="bm_id1552785" localize="false"/> +<h2 id="hd_id11905">Hyperlink Control</h2> +<table id=""> +<tablerow> +<tablecell> +<paragraph role="paragraph" id="par_id7511525"> +<image id="Graphic3" src="cmd/sc_inserthyperlinkcontrol.png" width="1cm" height="1cm"><alt id="alt_id2896837" xml-lang="en-US">Insert hyperlink control icon</alt></image></paragraph> +</tablecell> +<tablecell> +<paragraph role="paragraph" id="par_id9961856" xml-lang="en-US" l10n="NEW"><ahelp hid=".">Adds a hyperlink control that can open an address in web browser.</ahelp></paragraph> +</tablecell> +</tablerow> +</table> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/avail_release.xhp b/helpcontent2/source/text/sbasic/shared/03/avail_release.xhp new file mode 100644 index 000000000..019363a95 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/avail_release.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="availablerelease" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">(Un)Available since release</title> + <filename>/text/sbasic/shared/03/avail_release.xhp</filename> + </topic> + </meta> + <body> + <section id="UnAvailBasicMethod"><note id="not_BasMeth">This method is not available in Basic.</note></section> + <section id="UnAvailBasicProperty"><note id="not_BasProp">This property is not available in Basic.</note></section> + <section id="UnAvailPythonMethod"><note id="not_PycMeth">This method is not available in Python.</note></section> + <section id="UnAvailPythonProperty"><note id="not_PycProp">This property is not available in Python.</note></section> + <comment> Tags for LibreOffice 7.3 </comment> + <section id="7.3.service"> + <note id="par_id811631775671311">This service is available from %PRODUCTNAME 7.3 onwards.</note> + </section> + <section id="7.3.method"> + <note id="par_id291613654389793">This method is available from %PRODUCTNAME 7.3 onwards.</note> + </section> + <section id="7.3.property"> + <note id="par_id201613654593537">This property is available from %PRODUCTNAME 7.3 onwards.</note> + </section> + <comment> Tags for LibreOffice 7.2 </comment> + <section id="7.2.service"> + <note id="par_id651551701041690">This service is available from %PRODUCTNAME 7.2 onwards.</note> + </section> + <section id="7.2.methods"> + <note id="par_id281613660174140">These methods are available from %PRODUCTNAME 7.2 onwards.</note> + </section> + <section id="7.2.method"> + <note id="par_id291613654389792">This method is available from %PRODUCTNAME 7.2 onwards.</note> + </section> + <section id="7.2.control"> + <note id="par_id981613655373210">This control is available from %PRODUCTNAME 7.2 onwards.</note> + </section> + <section id="7.2.events"> + <note id="par_id831613654401663">These event properties are available from %PRODUCTNAME 7.2 onwards.</note> + </section> + <section id="7.2.property"> + <note id="par_id201613654395537">This property is available from %PRODUCTNAME 7.2 onwards.</note> + </section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_ScriptForge.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_ScriptForge.xhp new file mode 100644 index 000000000..946280ba4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_ScriptForge.xhp @@ -0,0 +1,247 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- +* This file is part of the LibreOffice project. +* +* This Source Code Form is subject to the terms of the Mozilla Public +* License, v. 2.0. If a copy of the MPL was not distributed with this +* file, You can obtain one at http://mozilla.org/MPL/2.0/. +* +--> + +<meta> + <topic id="toolsbasiclibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge Libraries</title> + <filename>/text/sbasic/shared/03/lib_ScriptForge.xhp</filename> + </topic> +</meta> +<body> + <h1 id="hd_id31529004750471" xml-lang="en-US"><variable id="ScriptForge_lib"><link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="ScriptForge library">The <literal>ScriptForge</literal> Library</link></variable></h1> + <bookmark xml-lang="en-US" branch="index" id="bm_id491529070339774"> + <bookmark_value>BASIC ScriptForge library</bookmark_value> + <bookmark_value>Python scriptforge module</bookmark_value> + </bookmark> + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + </section> + <paragraph role="paragraph" id="par_id681619700336879">ScriptForge libraries build up an extensible collection of macro scripting resources for %PRODUCTNAME to be invoked from Basic macros or Python scripts.</paragraph> + <section id="importLibs"> + <note id="par_id901528999850603">• Basic macros require to load <literal>ScriptForge</literal> library using the following statement:<br/><literal>GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</literal><br/><br/>• Python scripts require an import from <literal>scriptforge</literal> module:<br/><literal>from scriptforge import CreateScriptService</literal> + </note> + </section> + <tip id="par_id1001623412767893">To learn more about how to create and execute Python scripts using the <literal>ScriptForge</literal> library, read the help page <link href="text/sbasic/shared/03/sf_intro.xhp" name="sfintro_link">Creating Python Scripts with ScriptForge</link>.</tip> + + <h2 id="hd_id781637256119733">Invoking ScriptForge services</h2> + <paragraph role="paragraph" id="par_id781606153472028">The described modules and classes are invoked from user scripts as "Services". A generic constructor of those services has been designed for that purpose for each language.</paragraph> + <paragraph role="paragraph" id="par_id871637256506167">The <literal>Dispose</literal> method is available in all services and should be called to free up resources after usage:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id901619770181787">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201606153529501">Set oSvc = CreateScriptService("servicename"[, arg0, arg1, ...])</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701637256465858">' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851637256466244">oSvc.Dispose()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id701619701322002">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id531619701322249">svc = CreateScriptService('servicename'[, arg0, arg1, ...])</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id271637256185236"># ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id501637256192213">svc.Dispose()</paragraph> + </pycode> + + <h2 id="hd_id851613836643580">Services provided by the ScriptForge library</h2> + <table id="tab_id311613838858931" class="sf_table"> + <tablehead> + <tablerow> + <tablecell> + <paragraph id="par_id131613838858931" role="tablehead">Category</paragraph> + </tablecell> + <tablecell colspan="3"> + <paragraph id="par_id441613838858931" role="tablehead">Services</paragraph> + </tablecell> + </tablerow> + </tablehead> + <tablerow> + <tablecell> + <paragraph id="par_id851613847558931" role="tablecontent">%PRODUCTNAME Basic</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="par_id581613836728425"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Array" name="Array service">Array</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Dictionary" name="Dictionary service">Dictionary</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="par_id731613840022120"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Exception" name="Exception service">Exception</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#FileSystem" name="FileSystem service">FileSystem</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701643305576028" localize="false" role="tablecontent"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#String" name="String service">String</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#TextStream" name="TextStream service">TextStream</link><br/> + </paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id131613838825831" role="tablecontent">Document Content</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" localize="false" id="par_id771613836902464"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Base" name="Base service">Base</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Calc" name="Calc service">Calc</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441543838858931" localize="false" role="tablecontent"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Chart" name="Chart service">Chart</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Database" name="Database service">Database</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701643305576137" localize="false" role="tablecontent"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Document" name="Document service">Document</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Writer" name="Writer service">Writer</link><br/> + </paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id131613947858931" role="tablecontent">User Interface</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="par_id481613837033056"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Dialog" name="Dialog service">Dialog</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#DialogControl" name="DialogControl service">DialogControl</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Form" name="Form service">Form</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441613885558931" localize="false" role="tablecontent"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#FormControl" name="FormControl service">FormControl</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Menu" name="Menu service">Menu</link><br/><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701643305576632" localize="false" role="tablecontent"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#PopupMenu" name="PopupMenu service">PopupMenu</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#UI" name="UI service">UI</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id131613866258931" role="tablecontent">Utilities</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="par_id461613837133275"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Basic" name="Basic service">Basic</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#L10N" name="L10N service">L10N</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Platform" name="Platform service">Platform</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441613723858931" localize="false" role="tablecontent"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Region" name="Region service">Region</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Services" name="Services service">Services</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Session" name="Session service">Session</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701643305572058" localize="false" role="tablecontent"> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#Timer" name="Timer service">Timer</link><br/> + <link href="text/sbasic/shared/03/lib_ScriptForge.xhp#UnitTest" name="UnitTest service">UnitTest</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + <section id="Array"> + <embed href="text/sbasic/shared/03/sf_array.xhp#abstract"/> + </section> + <section id="Base"> + <embed href="text/sbasic/shared/03/sf_base.xhp#abstract"/> + </section> + <section id="Basic"> + <embed href="text/sbasic/shared/03/sf_basic.xhp#abstract"/> + </section> + <section id="Calc"> + <embed href="text/sbasic/shared/03/sf_calc.xhp#abstract"/> + </section> + <section id="Chart"> + <embed href="text/sbasic/shared/03/sf_chart.xhp#abstract"/> + </section> + <section id="Database"> + <embed href="text/sbasic/shared/03/sf_database.xhp#abstract"/> + </section> + <section id="Dialog"> + <embed href="text/sbasic/shared/03/sf_dialog.xhp#abstract"/> + </section> + <section id="DialogControl"> + <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#abstract"/> + </section> + <section id="Dictionary"> + <embed href="text/sbasic/shared/03/sf_dictionary.xhp#abstract"/> + </section> + <section id="Document"> + <embed href="text/sbasic/shared/03/sf_document.xhp#abstract"/> + </section> + <section id="Exception"> + <embed href="text/sbasic/shared/03/sf_exception.xhp#abstract"/> + </section> + <section id="FileSystem"> + <embed href="text/sbasic/shared/03/sf_filesystem.xhp#abstract"/> + </section> + <section id="Form"> + <embed href="text/sbasic/shared/03/sf_form.xhp#abstract"/> + </section> + <section id="FormControl"> + <embed href="text/sbasic/shared/03/sf_formcontrol.xhp#abstract"/> + </section> + <section id="L10N"> + <embed href="text/sbasic/shared/03/sf_l10n.xhp#abstract"/> + </section> + <section id="Menu"> + <embed href="text/sbasic/shared/03/sf_menu.xhp#abstract"/> + </section> + <section id="Platform"> + <embed href="text/sbasic/shared/03/sf_platform.xhp#abstract"/> + </section> + <section id="PopupMenu"> + <embed href="text/sbasic/shared/03/sf_popupmenu.xhp#abstract"/> + </section> + <section id="Region"> + <embed href="text/sbasic/shared/03/sf_region.xhp#abstract"/> + </section> + <section id="Services"> + <embed href="text/sbasic/shared/03/sf_services.xhp#abstract"/> + </section> + <section id="Session"> + <embed href="text/sbasic/shared/03/sf_session.xhp#abstract"/> + </section> + <section id="String"> + <embed href="text/sbasic/shared/03/sf_string.xhp#abstract"/> + </section> + <section id="TextStream"> + <embed href="text/sbasic/shared/03/sf_textstream.xhp#abstract"/> + </section> + <section id="Timer"> + <embed href="text/sbasic/shared/03/sf_timer.xhp#abstract"/> + </section> + <section id="UI"> + <embed href="text/sbasic/shared/03/sf_ui.xhp#abstract"/> + </section> + <section id="UnitTest"> + <embed href="text/sbasic/shared/03/sf_unittest.xhp#abstract"/> + </section> + <section id="Writer"> + <embed href="text/sbasic/shared/03/sf_writer.xhp#abstract"/> + </section> + <comment>Restricted use for SF_Root, SF_Utils modules as well as internal methods</comment> + <paragraph role="paragraph" id="par_id331608220104798"><emph>Note:</emph> Other <literal>ScriptForge</literal> undescribed modules are reserved for internal use. Their content is subject to change without notice.</paragraph> + <section id="SF_InternalUse"> + <warning id="par_id851506659675843">All <literal>ScriptForge</literal> Basic routines or identifiers that are prefixed with an underscore character "_" are reserved for internal use. They are not meant be used in Basic macros or Python scripts.</warning> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_depot.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_depot.xhp new file mode 100644 index 000000000..2c4a01ba1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_depot.xhp @@ -0,0 +1,28 @@ +<?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="basicdepotlibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DEPOT Library</title> + <filename>/text/sbasic/shared/03/lib_depot.xhp</filename> + </topic> + </meta> + <body> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><variable id="depot_lib"><link href="text/sbasic/shared/03/lib_depot.xhp" name="Depot library">The <item type="literal">Depot</item> Library</link></variable></paragraph> + + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + </section> + <paragraph xml-lang="en-US" id="par_id901528999850603" localize="false" role="note"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/> + <item type="literal">GlobalScope.BasicLibraries.LoadLibrary("Depot")</item></paragraph> + <embed href="text/shared/need_help.xhp#needhelp"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_euro.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_euro.xhp new file mode 100644 index 000000000..d975c69d4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_euro.xhp @@ -0,0 +1,46 @@ +<?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="basiceurolibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">EURO Library</title> + <filename>/text/sbasic/shared/03/lib_euro.xhp</filename> + </topic> + </meta> + <body> + <h1 id="hd_id31529004750471"><variable id="euro_lib"><link href="text/sbasic/shared/03/lib_euro.xhp" name="Euro library">The <item type="literal">Euro</item> Library</link></variable></h1> + <bookmark xml-lang="en-US" branch="index" id="bm_id231529070133574"> + <bookmark_value>BASIC Euro library</bookmark_value> + </bookmark> + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + </section> + <embed href="text/shared/need_help.xhp#needhelp"/> + <h2 id="hd_id841593518085848">Description</h2> + <paragraph role="paragraph" id="par_id921593518140986">The <emph>Euro</emph> library is used by the <emph>Euro converter…</emph> wizard.</paragraph> + <paragraph role="paragraph" id="par_id481593518247400">Its entry points are:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id961593518286855" role="listitem" localize="False">Euro.AutoPilotRun.StartAutoPilot</paragraph></listitem> + <listitem><paragraph id="par_id811593518354070" role="listitem" localize="False">Euro.ConvertRun.Main</paragraph></listitem> + </list> + <paragraph role="paragraph" id="par_id381593519742529">Selecting the <emph>Euro Converter</emph> wizard loads the following libraries in memory:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id361593520109787" role="listitem" localize="False">Euro</paragraph></listitem> + <listitem><paragraph id="par_id811593520110346" role="listitem" localize="False">ImportWizard</paragraph></listitem> + <listitem><paragraph id="par_id31593520110938" role="listitem" localize="False">Tools</paragraph></listitem> + </list> + <note id="par_id691593519646426">Basic routine name conflicts may exist when multiple Basic libraries are loaded in memory.</note> + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id1001593520257636">ImportWizard and <link href="text/sbasic/shared/03/lib_tools.xhp" name="Tools library">Tools</link> Basic libraries</paragraph> + <paragraph role="paragraph" id="par_id251593518523704"><link href="text/shared/autopi/01150000.xhp" name="Euro Converter Wizard">Euro Converter Wizard</link> describes what the <emph>Euro</emph> library does.</paragraph> + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_formwizard.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_formwizard.xhp new file mode 100644 index 000000000..c3ff82a11 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_formwizard.xhp @@ -0,0 +1,28 @@ +<?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="basicdepotlibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FORMWIZARD Library</title> + <filename>/text/sbasic/shared/03/lib_formwizard.xhp</filename> + </topic> + </meta> + <body> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><variable id="formwizard_lib"><link href="text/sbasic/shared/03/lib_formwizard.xhp" name="FormWizard library">The <item type="literal">FormWizard</item> Library</link></variable></paragraph> + + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + </section> + <paragraph xml-lang="en-US" id="par_id901528999850603" localize="false" role="note"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/> + <item type="literal">GlobalScope.BasicLibraries.LoadLibrary("FormWizard")</item></paragraph> + <embed href="text/shared/need_help.xhp#needhelp"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_gimmicks.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_gimmicks.xhp new file mode 100644 index 000000000..01c7d0171 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_gimmicks.xhp @@ -0,0 +1,51 @@ +<?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="basicgimmickslibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">GIMMICKS Library</title> + <filename>/text/sbasic/shared/03/lib_gimmicks.xhp</filename> + </topic> + </meta> + <body> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><variable id="gimmicks_lib"><link href="text/sbasic/shared/03/lib_gimmicks.xhp" name="Gimmicks library">The <item type="literal">Gimmicks</item> Library</link></variable></paragraph> + <bookmark xml-lang="en-US" branch="index" id="bm_id951529070357301"> + <bookmark_value>BASIC Gimmicks library</bookmark_value> + </bookmark> + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + </section> + + <embed href="text/shared/need_help.xhp#needhelp"/> + + <paragraph xml-lang="en-US" id="par_id901528999850603" localize="false" role="note"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/> + <item type="literal">GlobalScope.BasicLibraries.LoadLibrary("Gimmicks")</item></paragraph> + + <h2 id="hd_id841593518085848">Description</h2> + <paragraph role="paragraph" id="par_id921593518140986">The <emph>Gimmicks</emph> library is used by the <emph>AutoText</emph> wizard.</paragraph> + <paragraph role="paragraph" id="par_id481593518247400">Its entry points are:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id961593518286855" role="listitem" localize="False">Gimmicks.AutoText.Main</paragraph></listitem> + <listitem><paragraph id="par_id961593815286855" role="listitem" localize="False">Gimmicks.GetTexts.Main</paragraph></listitem> + </list> + + <paragraph role="paragraph" id="par_id381593519742529">Selecting <menuitem>Tools - AutoText</menuitem> loads the following library in memory:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id31593520110938" role="listitem" localize="False">Tools</paragraph></listitem> + </list> + <note id="par_id691593519646426">Basic routine name conflicts may exist when multiple Basic libraries are loaded in memory.</note> + + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id1001593520257636"><link href="text/sbasic/shared/03/lib_tools.xhp" name="Tools library">Tools</link> Basic library</paragraph> + <paragraph role="paragraph" id="par_id251593518523704"><link href="text/swriter/guide/autotext.xhp" name="Using AutoText">Using AutoText</link> explains what the <emph>Gimmicks</emph> library does.</paragraph> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_importwiz.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_importwiz.xhp new file mode 100644 index 000000000..20669ec99 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_importwiz.xhp @@ -0,0 +1,44 @@ +<?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="basicimportwizardlibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ImportWizard Library</title> + <filename>/text/sbasic/shared/03/lib_importwiz.xhp</filename> + </topic> + </meta> + <body> + <h1 id="hd_id31529004750471"><variable id="importwiz_lib"><link href="text/sbasic/shared/03/lib_importwiz.xhp" name="ImportWizard library">The <item type="literal">ImportWizard</item> Library</link></variable></h1> + <bookmark xml-lang="en-US" branch="index" id="bm_id231529070133574"> + <bookmark_value>BASIC ImportWizard library</bookmark_value> + </bookmark> + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + <embed href="text/sbasic/shared/00000003.xhp#dialoglibhowtoget"/> + </section> + <embed href="text/shared/need_help.xhp#needhelp"/> + <h2 id="hd_id841593518085848">Description</h2> + <paragraph role="paragraph" id="par_id921593518140986">The <emph>ImportWizard</emph> library is used by the <emph>Document Converter</emph> wizard.</paragraph> + <paragraph role="paragraph" id="par_id481593518247400">Its entry point is:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id961593518286855" role="listitem" localize="False">ImportWizard.Main.Main</paragraph></listitem> + </list> + <paragraph role="paragraph" id="par_id381593519742529">Selecting the <emph>Document Converter</emph> wizard loads the following libraries in memory:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id811593520110346" role="listitem" localize="False">ImportWizard</paragraph></listitem> + <listitem><paragraph id="par_id31593520110938" role="listitem" localize="False">Tools</paragraph></listitem> + </list> + <note id="par_id691593519646426">Basic routine name conflicts may exist when multiple Basic libraries are loaded in memory.</note> + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id1001593520257636"><link href="text/sbasic/shared/03/lib_tools.xhp" name="Tools library">Tools</link> Basic library</paragraph> + <paragraph role="paragraph" id="par_id251593518523704"><link href="text/shared/autopi/01130000.xhp" name="Document Converter">Document Converter</link> describes what the <emph>ImportWizard</emph> library does.</paragraph> + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_schedule.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_schedule.xhp new file mode 100644 index 000000000..00cf3dcc8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_schedule.xhp @@ -0,0 +1,30 @@ +<?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="basicschedulelibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SCHEDULE Library</title> + <filename>/text/sbasic/shared/03/lib_schedule.xhp</filename> + </topic> + </meta> + <body> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><variable id="schedule_lib"><link href="text/sbasic/shared/03/lib_schedule.xhp" name="Schedule library">The <item type="literal">Schedule</item> Library</link></variable></paragraph> + <bookmark xml-lang="en-US" branch="index" id="bm_id671529070099646"> + <bookmark_value>BASIC Schedule library</bookmark_value> + </bookmark> + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + </section> + <paragraph xml-lang="en-US" id="par_id901528999850603" localize="false" role="note"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/> + <item type="literal">GlobalScope.BasicLibraries.LoadLibrary("Schedule")</item></paragraph> + <embed href="text/shared/need_help.xhp#needhelp"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_script.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_script.xhp new file mode 100644 index 000000000..c2ef92b9b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_script.xhp @@ -0,0 +1,35 @@ +<?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="basicscriptlibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SCRIPTBINDINGLIBRARY Library</title> + <filename>/text/sbasic/shared/03/lib_script.xhp</filename> + </topic> + </meta> + <body> + <h1 id="hd_id31529004750471"><variable id="script_lib"><link href="text/sbasic/shared/03/lib_script.xhp" name="ScriptBindingLibrary library">The <item type="literal">ScriptBindingLibrary</item> Library</link></variable></h1> + <bookmark xml-lang="en-US" branch="index" id="bm_id851529070366056"> + <bookmark_value>BASIC ScriptBindingLibrary library</bookmark_value> + </bookmark> + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#dialoglibhowtoget"/> + </section> + <h2 id="hd_id841593518085848">Description</h2> + <paragraph role="paragraph" id="par_id921593518140986">The <emph>ScriptBindingLibrary</emph> library only contains dialogs, it is used by <emph>Highlight</emph> %PRODUCTNAME example scripts. Its dialogs are shared by Beanshell, Java and JavaScript example scripts.</paragraph> + <paragraph role="paragraph" id="par_id381593519742529">Running any <emph>Highlight</emph> example script loads the <emph>ScriptBindingLibrary</emph> library in memory.</paragraph> + <note id="par_id131593538122154">This library is not used by %PRODUCTNAME Basic.</note> + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id251593524531077"><link href="text/shared/01/06130020.xhp" name="Basic macro selector">Basic macro selector</link></paragraph> + <paragraph role="paragraph" id="par_id721593525163663">Beanshell, Java and JavaScript <link href="text/shared/01/06130030.xhp" name="Scripts">Scripts</link></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_template.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_template.xhp new file mode 100644 index 000000000..f7e093fa0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_template.xhp @@ -0,0 +1,28 @@ +<?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="basictemplatelibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">TEMPLATE Library</title> + <filename>/text/sbasic/shared/03/lib_template.xhp</filename> + </topic> + </meta> + <body> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><variable id="template_lib"><link href="text/sbasic/shared/03/lib_template.xhp" name="Template library">The <item type="literal">Template</item> Library</link></variable></paragraph> + + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + </section> + <paragraph xml-lang="en-US" id="par_id901528999850603" localize="false" role="note"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/> + <item type="literal">GlobalScope.BasicLibraries.LoadLibrary("Template")</item></paragraph> + <embed href="text/shared/need_help.xhp#needhelp"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_tools.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_tools.xhp new file mode 100644 index 000000000..2ed625b5a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_tools.xhp @@ -0,0 +1,842 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> + <!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + --> + + <meta> + <topic id="toolsbasiclibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Tools Library</title> + <filename>/text/sbasic/shared/03/lib_tools.xhp</filename> + </topic> + </meta> + <body> + <paragraph role="heading" id="hd_id31529004750471" level="1" xml-lang="en-US"><variable id="tools_lib"><link href="text/sbasic/shared/03/lib_tools.xhp" name="Tools library">The <item type="literal">Tools</item> Library</link></variable></paragraph> + <bookmark xml-lang="en-US" branch="index" id="bm_id491529070339774"> + <bookmark_value>BASIC Tools library</bookmark_value> + </bookmark> + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/> + </section> + <paragraph xml-lang="en-US" id="par_id901528999850603" localize="false" role="note"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/> + <item type="literal">GlobalScope.BasicLibraries.LoadLibrary("Tools")</item></paragraph> + <paragraph role="paragraph" id="par_id161529001339405" xml-lang="en-US"><link href="text/sbasic/shared/03/lib_tools.xhp#debug_module" name="debug module"><item type="literal">Debug</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id41529001348561" xml-lang="en-US"><link href="text/sbasic/shared/03/lib_tools.xhp#listbox_module" name="listbox module"><item type="literal">ListBox</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id341529001354451" xml-lang="en-US"><link href="text/sbasic/shared/03/lib_tools.xhp#misc_module" name="misc module"><item type="literal">Misc</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id311529001362049" xml-lang="en-US"><link href="text/sbasic/shared/03/lib_tools.xhp#modulecontrols_module" name="module controls module"><item type="literal">ModuleControls</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id701529001368064" xml-lang="en-US"><link href="text/sbasic/shared/03/lib_tools.xhp#strings_module" name="strings module"><item type="literal">Strings</item> Module</link></paragraph> + <paragraph role="paragraph" id="par_id251529001373426" xml-lang="en-US"><link href="text/sbasic/shared/03/lib_tools.xhp#ucb_module" name="ucb module"><item type="literal">UCB</item> Module</link></paragraph> + <bookmark xml-lang="en-US" branch="index" id="bm_id271529062442803"> + <bookmark_value>BASIC Tools library;Debug module</bookmark_value> + </bookmark> + <section id="debug_module"> + <paragraph role="heading" id="hd_id371529000826947" level="2" xml-lang="en-US"><item type="literal">Debug</item> Module</paragraph> + <paragraph role="paragraph" id="par_id441529064369519" xml-lang="en-US">Functions and subroutines for debugging Basic macros.</paragraph> + <h3 id="hd_id711529001004857" xml-lang="en-US" localize="false">ActivateReadOnlyFlag</h3> + <bascode> + <paragraph id="par_id251529001003857" role="bascode" xml-lang="en-US" localize="false">Sub ActivateReadOnlyFlag()</paragraph> + </bascode> + <h3 id="hd_id71529001663903" xml-lang="en-US" localize="false">DeactivateReadOnlyFlag</h3> + <bascode> + <paragraph id="par_id951529001706210" role="bascode" xml-lang="en-US" localize="false">Sub DeactivateReadOnlyFlag()</paragraph> + </bascode> + <h3 id="hd_id421529001727178" xml-lang="en-US" localize="false">SetBasicReadOnlyFlag</h3> + <bascode> + <paragraph id="par_id771529001755355" role="bascode" xml-lang="en-US" localize="false">Sub SetBasicReadOnlyFlag(bReadOnly as Boolean)</paragraph> + </bascode> + <h3 id="hd_id651529001954868" xml-lang="en-US" localize="false">WritedbgInfo</h3> + <bascode> + <paragraph id="par_id581529001865055" role="bascode" xml-lang="en-US" localize="false">Sub WritedbgInfo(LocObject as Object)</paragraph> + </bascode> + <h3 id="hd_id841529001994821" xml-lang="en-US" localize="false">WriteDbgString</h3> + <bascode> + <paragraph id="par_id171529002013434" role="bascode" xml-lang="en-US" localize="false">Sub WriteDbgString(LocString as String)</paragraph> + </bascode> + <h3 id="hd_id741529002099962" xml-lang="en-US" localize="false">ShowArray</h3> + <bascode> + <paragraph id="par_id261529002118559" role="bascode" xml-lang="en-US" localize="false">Sub ShowArray(LocArray())</paragraph> + </bascode> + <h3 id="hd_id321529002327444" xml-lang="en-US" localize="false">ShowPropertyValues</h3> + <bascode> + <paragraph id="par_id501529002327444" role="bascode" xml-lang="en-US" localize="false">Sub ShowPropertyValues(oLocObject as Object)</paragraph> + </bascode> + <h3 id="hd_id451529002368600" xml-lang="en-US" localize="false">ShowNameValuePair</h3> + <bascode> + <paragraph id="par_id321529002368600" role="bascode" xml-lang="en-US" localize="false">Sub ShowNameValuePair(Pair())</paragraph> + </bascode> + <h3 id="hd_id551529002415495" xml-lang="en-US" localize="false">ShowElementNames</h3> + <paragraph id="par_id111529003255859" role="paragraph" xml-lang="en-US" localize="false">' Retrieves all the Elements of aSequence of an object, with the</paragraph> + <paragraph id="par_id41529003238747" role="paragraph" xml-lang="en-US" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> + <bascode> + <paragraph role="bascode" id="par_id41529003225918" xml-lang="en-US" localize="false">Sub ShowElementNames(</paragraph> + <paragraph role="bascode" id="par_id321529005373289" xml-lang="en-US" localize="false">oLocElements() as Object,</paragraph> + <paragraph role="bascode" id="par_id1001529005296415" xml-lang="en-US" localize="false">Optional sFiltername as String)</paragraph> + </bascode> + <h3 id="hd_id581529003295045" xml-lang="en-US" localize="false">ShowSupportedServiceNames</h3> + <paragraph id="par_id851529003295045" role="paragraph" xml-lang="en-US" localize="false">' Retrieves all the supported servicenames of an object, with the </paragraph> + <paragraph id="par_id301529003401893" role="paragraph" xml-lang="en-US" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> + <bascode> + <paragraph role="bascode" id="par_id801529003393056" xml-lang="en-US" localize="false">Sub ShowSupportedServiceNames(</paragraph> + <paragraph role="bascode" id="par_id101529005392934" xml-lang="en-US" localize="false">oLocObject as Object,</paragraph> + <paragraph role="bascode" id="par_id661529005271095" xml-lang="en-US" localize="false">Optional sFilterName as String)</paragraph> + </bascode> + <h3 id="hd_id831529003429502" xml-lang="en-US" localize="false">ShowAvailableServiceNames</h3> + <paragraph id="par_id401529003494638" role="paragraph" xml-lang="en-US" localize="false">' Retrieves all the available Servicenames of an object, with the</paragraph> + <paragraph id="par_id801529003504707" role="paragraph" xml-lang="en-US" localize="false">' possibility to define a filter(sfilter <> "")</paragraph> + <bascode> + <paragraph role="bascode" id="par_id981529005231465" xml-lang="en-US" localize="false">Sub ShowAvailableServiceNames(</paragraph> + <paragraph role="bascode" id="par_id251529005237648" xml-lang="en-US" localize="false">oLocObject as Object, </paragraph> + <paragraph role="bascode" id="par_id721529005247098" xml-lang="en-US" localize="false">Optional sFilterName as String)</paragraph> + </bascode> + <h3 id="hd_id591529003562090" xml-lang="en-US" localize="false">ShowCommands</h3> + <bascode> + <paragraph id="par_id791529003562091" role="bascode" xml-lang="en-US" localize="false">Sub ShowCommands(oLocObject as Object)</paragraph> + </bascode> + <h3 id="hd_id881529003602892" xml-lang="en-US" localize="false">ProtectCurrentSheets</h3> + <bascode> + <paragraph id="par_id531529003602892" role="bascode" xml-lang="en-US" localize="false">Sub ProtectCurrentSheets()</paragraph> + </bascode> + <h3 id="hd_id691529003635074" xml-lang="en-US" localize="false">FillDocument</h3> + <bascode> + <paragraph id="par_id371529003635074" role="bascode" xml-lang="en-US" localize="false">Sub FillDocument()</paragraph> + </bascode> + </section> + <bookmark xml-lang="en-US" branch="index" id="bm_id131529062501888"> + <bookmark_value>BASIC Tools library;ListBox module</bookmark_value> + </bookmark> + <section id="listbox_module"> + <paragraph role="heading" id="hd_id11529005753099" level="2" xml-lang="en-US"><item type="literal">ListBox</item> Module</paragraph> + <paragraph role="paragraph" id="par_id381529064415052" xml-lang="en-US">Functions and subroutines for handling ListBox elements.</paragraph> + <embed href="text/shared/need_help.xhp#needhelp"/> + </section> + <bookmark xml-lang="en-US" branch="index" id="bm_id571529062538621"> + <bookmark_value>BASIC Tools library;Misc module</bookmark_value> + </bookmark> + <section id="misc_module"> + <paragraph role="heading" id="hd_id341529005758494" level="2" xml-lang="en-US"><item type="literal">Misc</item> Module</paragraph> + <paragraph role="paragraph" id="par_id681529064596175" xml-lang="en-US">Miscellaneous functions and subroutines.</paragraph> + <h3 id="hd_id801529006604779" xml-lang="en-US" localize="false">RegisterNewDataSource</h3> + <bascode> + <paragraph role="bascode" id="par_id851529006689297" xml-lang="en-US" localize="false">Function RegisterNewDataSource(</paragraph> + <paragraph role="bascode" id="par_id471529006695330" xml-lang="en-US" localize="false">DSName as String, </paragraph> + <paragraph role="bascode" id="par_id671529006700462" xml-lang="en-US" localize="false">PropertyList(), </paragraph> + <paragraph role="bascode" id="par_id821529006705849" xml-lang="en-US" localize="false">Optional DriverProperties() </paragraph> + <paragraph role="bascode" id="par_id321529061768930" xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> + </bascode> + <h3 id="hd_id501529006725521" xml-lang="en-US" localize="false">ConnecttoDatabase</h3> + <bascode> + <paragraph role="bascode" id="par_id771529006782954" xml-lang="en-US" localize="false">Function ConnecttoDatabase(</paragraph> + <paragraph role="bascode" id="par_id31529006789644" xml-lang="en-US" localize="false">DSName as String, </paragraph> + <paragraph role="bascode" id="par_id421529006794640" xml-lang="en-US" localize="false">UserID as String, </paragraph> + <paragraph role="bascode" id="par_id381529006799623" xml-lang="en-US" localize="false">Password as String, </paragraph> + <paragraph role="bascode" id="par_id641529006805066" xml-lang="en-US" localize="false">Optional Propertylist(), </paragraph> + <paragraph role="bascode" id="par_id201529006810077" xml-lang="en-US" localize="false">Optional DriverProperties() </paragraph> + <paragraph role="bascode" id="par_id11529061810188" xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> + </bascode> + <h3 id="hd_id411529006832985" xml-lang="en-US" localize="false">GetStarOfficeLocale</h3> + <bascode> + <paragraph id="par_id451529006832985" role="bascode" xml-lang="en-US" localize="false">Function GetStarOfficeLocale() </paragraph> + <paragraph role="bascode" id="par_id761529061825013" xml-lang="en-US" localize="false">as New com.sun.star.lang.Locale</paragraph> + </bascode> + <h3 id="hd_id361529006902547" xml-lang="en-US" localize="false">GetRegistryKeyContent</h3> + <bascode> + <paragraph role="bascode" id="par_id391529006938605" xml-lang="en-US" localize="false">Function GetRegistryKeyContent(</paragraph> + <paragraph role="bascode" id="par_id881529006944515" xml-lang="en-US" localize="false">sKeyName as string, </paragraph> + <paragraph role="bascode" id="par_id711529006950283" xml-lang="en-US" localize="false">Optional bforUpdate as Boolean)</paragraph> + </bascode> + <h3 id="hd_id851529006965105" xml-lang="en-US" localize="false">GetProductname</h3> + <bascode> + <paragraph id="par_id451529006965105" role="bascode" xml-lang="en-US" localize="false">Function GetProductname() as String</paragraph> + </bascode> + <h3 id="hd_id771529007007439" xml-lang="en-US" localize="false">OpenDocument</h3> + <paragraph id="par_id821529007072253" role="paragraph" localize="false" xml-lang="en-US">' Opens a Document, checks beforehand, whether it has to be loaded or whether it is already on the desktop. If the parameter bDisposable is set to False then the returned document should not be disposed afterwards, because it is already opened.</paragraph> + <bascode> + <paragraph role="bascode" id="par_id991529007104165" xml-lang="en-US" localize="false">Function OpenDocument(</paragraph> + <paragraph role="bascode" id="par_id191529007110562" xml-lang="en-US" localize="false">DocPath as String, </paragraph> + <paragraph role="bascode" id="par_id851529007118783" xml-lang="en-US" localize="false">Args(), </paragraph> + <paragraph role="bascode" id="par_id691529007123485" xml-lang="en-US" localize="false">Optional bDisposable as Boolean)</paragraph> + </bascode> + <h3 id="hd_id481529007130534" xml-lang="en-US" localize="false">TaskonDesktop</h3> + <bascode> + <paragraph id="par_id911529007130534" role="bascode" xml-lang="en-US" localize="false">Function TaskonDesktop(DocPath as String) as Boolean</paragraph> + </bascode> + <h3 id="hd_id201529007205755" xml-lang="en-US" localize="false">RetrieveFileName</h3> + <paragraph id="par_id81529007245965" role="paragraph" localize="false" xml-lang="en-US">' Retrieves a FileName out of a StarOffice-Document.</paragraph> + <bascode> + <paragraph role="bascode" id="par_id881529007259806" xml-lang="en-US" localize="false">Function RetrieveFileName(LocDoc as Object)</paragraph> + </bascode> + <h3 id="hd_id121529007269721" xml-lang="en-US" localize="false">GetPathSettings</h3> + <paragraph id="par_id801529007338550" role="paragraph" localize="false" xml-lang="en-US">' Gets a special configured PathSetting.</paragraph> + <bascode> + <paragraph role="bascode" id="par_id971529007353940" xml-lang="en-US" localize="false">Function GetPathSettings(</paragraph> + <paragraph role="bascode" id="par_id401529007360579" xml-lang="en-US" localize="false">sPathType as String,</paragraph> + <paragraph role="bascode" id="par_id741529007366892" xml-lang="en-US" localize="false">Optional bshowall as Boolean, </paragraph> + <paragraph role="bascode" id="par_id841529007371792" xml-lang="en-US" localize="false">Optional ListIndex as integer) as String</paragraph> + </bascode> + <h3 id="hd_id571529007381828" xml-lang="en-US" localize="false">GetOfficeSubPath</h3> + <paragraph id="par_id761529007616982" role="paragraph" localize="false" xml-lang="en-US">' Gets the fully qualified path to a subdirectory of the Template Directory, e. g. with the parameter "wizard/bitmap". The parameter must be passed over in Url-scription. The return-Value is in Urlscription.</paragraph> + <bascode> + <paragraph role="bascode" id="par_id981529007639916" xml-lang="en-US" localize="false">Function GetOfficeSubPath(</paragraph> + <paragraph role="bascode" id="par_id21529007645780" xml-lang="en-US" localize="false">sOfficePath as String, </paragraph> + <paragraph role="bascode" id="par_id201529007651880" xml-lang="en-US" localize="false">ByVal sSubDir as String)</paragraph> + </bascode> + <h3 id="hd_id591529007658281" xml-lang="en-US" localize="false">ShowNoOfficePathError</h3> + <bascode> + <paragraph id="par_id511529007658281" role="bascode" xml-lang="en-US" localize="false">Sub ShowNoOfficePathError() </paragraph> + </bascode> + <h3 id="hd_id431529007692356" xml-lang="en-US" localize="false">InitResources</h3> + <bascode> + <paragraph id="par_id991529007692356" role="bascode" xml-lang="en-US" localize="false">Function InitResources(</paragraph> + <paragraph role="bascode" id="par_id651529007767824" xml-lang="en-US" localize="false">Description, </paragraph> + <paragraph role="bascode" id="par_id401529007773380" xml-lang="en-US" localize="false">ShortDescription as String) as boolean</paragraph> + </bascode> + <h3 id="hd_id611529007790857" xml-lang="en-US" localize="false">GetResText</h3> + <bascode> + <paragraph id="par_id331529007790857" role="bascode" xml-lang="en-US" localize="false">Function GetResText( nID as integer ) As string</paragraph> + </bascode> + <h3 id="hd_id971529007839780" xml-lang="en-US" localize="false">CutPathView</h3> + <bascode> + <paragraph role="bascode" id="par_id91529007882196" xml-lang="en-US" localize="false">Function CutPathView(</paragraph> + <paragraph role="bascode" id="par_id211529007888525" xml-lang="en-US" localize="false">sDocUrl as String, </paragraph> + <paragraph role="bascode" id="par_id361529007894202" xml-lang="en-US" localize="false">Optional PathLen as Integer)</paragraph> + </bascode> + <h3 id="hd_id51529007902118" xml-lang="en-US" localize="false">DeleteInputCells</h3> + <paragraph id="par_id311529007997114" role="paragraph" localize="false" xml-lang="en-US">' Deletes the content of all cells that are softformatted according to the 'InputStyleName'.</paragraph> + <bascode> + <paragraph role="bascode" id="par_id111529008013953" xml-lang="en-US" localize="false">Sub DeleteInputCells(</paragraph> + <paragraph role="bascode" id="par_id731529008019208" xml-lang="en-US" localize="false">oSheet as Object, </paragraph> + <paragraph role="bascode" id="par_id881529008025944" xml-lang="en-US" localize="false">InputStyleName as String)</paragraph> + </bascode> + <h3 id="hd_id881529008035409" xml-lang="en-US" localize="false">ChangeValueofRange</h3> + <paragraph id="par_id261529008090521" role="paragraph" xml-lang="en-US" localize="false">' Inserts a certain String to all cells of a Range that is passed over either as an object or as the RangeName.</paragraph> + <bascode> + <paragraph role="bascode" id="par_id231529008110214" xml-lang="en-US" localize="false">Sub ChangeValueofRange(</paragraph> + <paragraph role="bascode" id="par_id401529008116727" xml-lang="en-US" localize="false">oSheet as Object, </paragraph> + <paragraph role="bascode" id="par_id211529008122524" xml-lang="en-US" localize="false">Range, </paragraph> + <paragraph role="bascode" id="par_id91529008128202" xml-lang="en-US" localize="false">ReplaceValue, </paragraph> + <paragraph role="bascode" id="par_id671529008133554" xml-lang="en-US" localize="false">Optional StyleName as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547275154" xml-lang="en-US" localize="false">ReplaceRangeValues</h3> + <bascode> + <paragraph id="par_id061420180547275639" role="bascode" localize="false" xml-lang="en-US">Sub ReplaceRangeValues(</paragraph> + <paragraph id="par_id061420180547279527" role="bascode" localize="false" xml-lang="en-US">oRange as Object, </paragraph> + <paragraph id="par_id061420180547277" role="bascode" localize="false" xml-lang="en-US">ReplaceValue)</paragraph> + </bascode> + <h3 id="hd_id06142018054727953" xml-lang="en-US" localize="false">GetValueofCellbyName</h3> + <paragraph id="par_id061420180547271480" role="paragraph" xml-lang="en-US" localize="false">' Returns the Value of the first cell of a Range.</paragraph> + <bascode> + <paragraph id="par_id061420180547275293" role="bascode" localize="false" xml-lang="en-US">Function GetValueofCellbyName(</paragraph> + <paragraph id="par_id061420180547274365" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547272143" role="bascode" localize="false" xml-lang="en-US">sCellName as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547273177" xml-lang="en-US" localize="false">DuplicateRow</h3> + <bascode> + <paragraph id="par_id061420180547278695" role="bascode" localize="false" xml-lang="en-US">Function DuplicateRow(</paragraph> + <paragraph id="par_id061420180547271430" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547271882" role="bascode" localize="false" xml-lang="en-US">RangeName as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547271951" xml-lang="en-US" localize="false">GetStringofCellbyName</h3> + <paragraph id="par_id061420180547275159" role="paragraph" xml-lang="en-US" localize="false">' Returns the String of the first cell of a Range.</paragraph> + <bascode> + <paragraph id="par_id061420180547277611" role="bascode" localize="false" xml-lang="en-US">Function GetStringofCellbyName(</paragraph> + <paragraph id="par_id061420180547271853" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547277036" role="bascode" localize="false" xml-lang="en-US">sCellName as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547271528" xml-lang="en-US" localize="false">GetCellByName</h3> + <paragraph id="par_id061420180547271588" role="paragraph" xml-lang="en-US" localize="false">' Returns a named Cell</paragraph> + <bascode> + <paragraph id="par_id061420180547278497" role="bascode" localize="false" xml-lang="en-US">Function GetCellByName(</paragraph> + <paragraph id="par_id061420180547284593" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547285667" role="bascode" localize="false" xml-lang="en-US">sCellName as String) as Object</paragraph> + </bascode> + <h3 id="hd_id061420180547288062" xml-lang="en-US" localize="false">ChangeCellValue</h3> + <paragraph id="par_id061420180547288384" role="paragraph" xml-lang="en-US" localize="false">' Changes the numeric Value of a cell by transmitting the String of the numeric Value.</paragraph> + <bascode> + <paragraph id="par_id061420180547287291" role="bascode" localize="false" xml-lang="en-US">Sub ChangeCellValue(</paragraph> + <paragraph id="par_id061420180547287421" role="bascode" localize="false" xml-lang="en-US">oCell as Object, </paragraph> + <paragraph id="par_id061420180547283866" role="bascode" localize="false" xml-lang="en-US">ValueString as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547283259" xml-lang="en-US" localize="false">GetDocumentType</h3> + <bascode> + <paragraph id="par_id061420180547286797" role="bascode" localize="false" xml-lang="en-US">Function GetDocumentType(oDocument)</paragraph> + </bascode> + <h3 id="hd_id061420180547288146" xml-lang="en-US" localize="false">GetNumberFormatType</h3> + <bascode> + <paragraph id="par_id061420180547285276" role="bascode" localize="false" xml-lang="en-US">Function GetNumberFormatType(</paragraph> + <paragraph id="par_id061420180547282526" role="bascode" localize="false" xml-lang="en-US">oDocFormats, </paragraph> + <paragraph id="par_id061420180547285804" role="bascode" localize="false" xml-lang="en-US">oFormatObject as Object) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180547282335" xml-lang="en-US" localize="false">ProtectSheets</h3> + <bascode> + <paragraph id="par_id061420180547283563" role="bascode" localize="false" xml-lang="en-US">Sub ProtectSheets(Optional oSheets as Object)</paragraph> + </bascode> + <h3 id="hd_id061420180547285130" xml-lang="en-US" localize="false">UnprotectSheets</h3> + <bascode> + <paragraph id="par_id061420180547289761" role="bascode" localize="false" xml-lang="en-US">Sub UnprotectSheets(Optional oSheets as Object)</paragraph> + </bascode> + <h3 id="hd_id061420180547284142" xml-lang="en-US" localize="false">GetRowIndex</h3> + <bascode> + <paragraph id="par_id061420180547284432" role="bascode" localize="false" xml-lang="en-US">Function GetRowIndex(</paragraph> + <paragraph id="par_id061420180547284492" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547288316" role="bascode" localize="false" xml-lang="en-US">RowName as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547284556" xml-lang="en-US" localize="false">GetColumnIndex</h3> + <bascode> + <paragraph id="par_id061420180547285812" role="bascode" localize="false" xml-lang="en-US">Function GetColumnIndex(</paragraph> + <paragraph id="par_id061420180547287653" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> + <paragraph id="par_id061420180547285010" role="bascode" localize="false" xml-lang="en-US">ColName as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547285141" xml-lang="en-US" localize="false">CopySheetbyName</h3> + <bascode> + <paragraph id="par_id061420180547284524" role="bascode" localize="false" xml-lang="en-US">Function CopySheetbyName(</paragraph> + <paragraph id="par_id061420180547286144" role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph> + <paragraph id="par_id061420180547289148" role="bascode" localize="false" xml-lang="en-US">OldName as String, </paragraph> + <paragraph id="par_id061420180547287225" role="bascode" localize="false" xml-lang="en-US">NewName as String, </paragraph> + <paragraph id="par_id061420180547299943" role="bascode" localize="false" xml-lang="en-US">DestPos as Integer) as Object</paragraph> + </bascode> + <h3 id="hd_id0614201805472944" xml-lang="en-US" localize="false">ToggleWindow</h3> + <paragraph id="par_id061420180547292068" role="paragraph" xml-lang="en-US" localize="false">' Dis-or enables a Window and adjusts the mousepointer accordingly</paragraph> + <bascode> + <paragraph id="par_id061420180547296555" role="bascode" localize="false" xml-lang="en-US">Sub ToggleWindow(bDoEnable as Boolean)</paragraph> + </bascode> + <h3 id="hd_id061420180547294361" xml-lang="en-US" localize="false">CheckNewSheetname</h3> + <bascode> + <paragraph id="par_id061420180547292565" role="bascode" localize="false" xml-lang="en-US">Function CheckNewSheetname(</paragraph> + <paragraph id="par_id061420180547293242" role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph> + <paragraph id="par_id061420180547297240" role="bascode" localize="false" xml-lang="en-US">Sheetname as String, </paragraph> + <paragraph id="par_id061420180547294328" role="bascode" localize="false" xml-lang="en-US">Optional oLocale) as String</paragraph> + </bascode> + <h3 id="hd_id061420180547298278" xml-lang="en-US" localize="false">AddNewSheetName</h3> + <bascode> + <paragraph id="par_id061420180547299974" role="bascode" localize="false" xml-lang="en-US">Sub AddNewSheetName(</paragraph> + <paragraph id="par_id061420180547292009" role="bascode" localize="false" xml-lang="en-US">oSheets as Object, </paragraph> + <paragraph id="par_id061420180547293223" role="bascode" localize="false" xml-lang="en-US">ByVal SheetName as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547293964" xml-lang="en-US" localize="false">GetSheetIndex</h3> + <bascode> + <paragraph id="par_id06142018054729713" role="bascode" localize="false" xml-lang="en-US">Function GetSheetIndex(oSheets, sName) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180547298034" xml-lang="en-US" localize="false">GetLastUsedRow</h3> + <bascode> + <paragraph id="par_id061420180547299520" role="bascode" localize="false" xml-lang="en-US">Function GetLastUsedRow(oSheet as Object) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180547294665" xml-lang="en-US" localize="false">ModifyBorderLineWidth</h3> + <paragraph id="par_id061420180547295117" role="paragraph" xml-lang="en-US" localize="false">' Note To set a one lined frame you have to set the inner width to 0 In the API all Units that refer to pt-Heights are "1/100mm" The convert factor from 1pt to 1/100 mm is approximately 35 </paragraph> + <bascode> + <paragraph id="par_id061420180547295225" role="bascode" localize="false" xml-lang="en-US">Function ModifyBorderLineWidth(</paragraph> + <paragraph id="par_id061420180547292084" role="bascode" localize="false" xml-lang="en-US">ByVal oStyleBorder, </paragraph> + <paragraph id="par_id061420180547292560" role="bascode" localize="false" xml-lang="en-US">iInnerLineWidth as Integer, </paragraph> + <paragraph id="par_id061420180547295476" role="bascode" localize="false" xml-lang="en-US">iOuterLineWidth as Integer)</paragraph> + </bascode> + <h3 id="hd_id06142018054729303" xml-lang="en-US" localize="false">AttachBasicMacroToEvent</h3> + <bascode> + <paragraph id="par_id061420180547296417" role="bascode" localize="false" xml-lang="en-US">Sub AttachBasicMacroToEvent(</paragraph> + <paragraph id="par_id061420180547292774" role="bascode" localize="false" xml-lang="en-US">oDocument as Object, </paragraph> + <paragraph id="par_id061420180547291074" role="bascode" localize="false" xml-lang="en-US">EventName as String, </paragraph> + <paragraph id="par_id061420180547293426" role="bascode" localize="false" xml-lang="en-US">SubPath as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547308735" xml-lang="en-US" localize="false">ModifyPropertyValue</h3> + <bascode> + <paragraph id="par_id061420180547306755" role="bascode" localize="false" xml-lang="en-US">Function ModifyPropertyValue(</paragraph> + <paragraph id="par_id061420180547304617" role="bascode" localize="false" xml-lang="en-US">oContent() as New com.sun.star.beans.PropertyValue, </paragraph> + <paragraph id="par_id061420180547301558" role="bascode" localize="false" xml-lang="en-US">TargetProperties() </paragraph> + <paragraph role="bascode" id="par_id941529062083471" xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue)</paragraph> + </bascode> + <h3 id="hd_id06142018054730528" xml-lang="en-US" localize="false">GetPropertyValueIndex</h3> + <bascode> + <paragraph id="par_id061420180547304668" role="bascode" localize="false" xml-lang="en-US">Function GetPropertyValueIndex(</paragraph> + <paragraph id="par_id061420180547302428" role="bascode" localize="false" xml-lang="en-US">SearchName as String, </paragraph> + <paragraph id="par_id061420180547306561" role="bascode" localize="false" xml-lang="en-US">TargetProperties() </paragraph> + <paragraph role="bascode" id="par_id971529062111510" xml-lang="en-US" localize="false">as New com.sun.star.beans.PropertyValue ) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180547305379" xml-lang="en-US" localize="false">DispatchSlot</h3> + <bascode> + <paragraph id="par_id061420180547302087" role="bascode" localize="false" xml-lang="en-US">Sub DispatchSlot(SlotID as Integer)</paragraph> + </bascode> + <h3 id="hd_id061420180547308065" xml-lang="en-US" localize="false">IsFatOffice</h3> + <paragraph id="par_id061420180547306757" role="paragraph" xml-lang="en-US" localize="false">'returns the type of the office application FatOffice = 0, WebTop = 1 This routine has to be changed if the Product Name is being changed! </paragraph> + <bascode> + <paragraph id="par_id061420180547302561" role="bascode" localize="false" xml-lang="en-US">Function IsFatOffice() As Boolean</paragraph> + </bascode> + <h3 id="hd_id06142018054730408" xml-lang="en-US" localize="false">GetLocale</h3> + <bascode> + <paragraph id="par_id061420180547306751" role="bascode" localize="false" xml-lang="en-US">Function GetLocale(</paragraph> + <paragraph id="par_id061420180547302792" role="bascode" localize="false" xml-lang="en-US">sLanguage as String, </paragraph> + <paragraph id="par_id061420180547307976" role="bascode" localize="false" xml-lang="en-US">sCountry as String)</paragraph> + </bascode> + <h3 id="hd_id061420180547305357" xml-lang="en-US" localize="false">ToggleDesignMode</h3> + <bascode> + <paragraph id="par_id061420180547301559" role="bascode" localize="false" xml-lang="en-US">Sub ToggleDesignMode(oDocument as Object)</paragraph> + </bascode> + <h3 id="hd_id061420180547301521" xml-lang="en-US" localize="false">isHighContrast</h3> + <bascode> + <paragraph id="par_id061420180547302307" role="bascode" localize="false" xml-lang="en-US">Function isHighContrast(oPeer as Object)</paragraph> + </bascode> + <h3 id="hd_id061420180547302524" xml-lang="en-US" localize="false">CreateNewDocument</h3> + <bascode> + <paragraph id="par_id061420180547302408" role="bascode" localize="false" xml-lang="en-US">Function CreateNewDocument(</paragraph> + <paragraph id="par_id061420180547306406" role="bascode" localize="false" xml-lang="en-US">sType as String, </paragraph> + <paragraph id="par_id061420180547302638" role="bascode" localize="false" xml-lang="en-US">Optional sAddMsg as String) as Object</paragraph> + </bascode> + <h3 id="hd_id061420180547306821" xml-lang="en-US" localize="false">DisposeDocument</h3> + <paragraph id="par_id061420180547308844" role="paragraph" localize="false" xml-lang="en-US">' This Sub has been used in order to ensure that after disposing a document from the backing window it is returned to the backing window, so the office won't be closed</paragraph> + <bascode> + <paragraph id="par_id061420180547301077" role="bascode" localize="false" xml-lang="en-US">Sub DisposeDocument(oDocument as Object)</paragraph> + </bascode> + <h3 id="hd_id061420180547316190" xml-lang="en-US" localize="false">CalIsLeapYear</h3> + <paragraph id="par_id061420180547311590" role="paragraph" xml-lang="en-US" localize="false">'Function to calculate if the year is a leap year</paragraph> + <bascode> + <paragraph id="par_id061420180547311314" role="bascode" localize="false" xml-lang="en-US">Function CalIsLeapYear(</paragraph> + <paragraph role="bascode" id="par_id401529062200648" xml-lang="en-US" localize="false">ByVal iYear as Integer) as Boolean</paragraph> + </bascode> + </section> + <bookmark xml-lang="en-US" branch="index" id="bm_id21529062611375"> + <bookmark_value>BASIC Tools library;ModuleControl module</bookmark_value> + </bookmark> + <section id="modulecontrols_module"> + <paragraph role="heading" id="hd_id451529005764422" level="2" xml-lang="en-US"><item type="literal">ModuleControls</item> Module</paragraph> + <paragraph role="paragraph" id="par_id841529064645990" xml-lang="en-US">Functions and subroutines for module control.</paragraph> + <h3 id="hd_id061520180728405758" xml-lang="en-US" localize="false">GetControlShape</h3> + <paragraph id="par_id061520180728404186" role="paragraph" localize="false" xml-lang="en-US">' Gets the Shape of a Control( e. g. to reset the size or Position of the control</paragraph> + <paragraph id="par_id061520180728405899" role="paragraph" localize="false" xml-lang="en-US">' Parameters:</paragraph> + <paragraph id="par_id061520180728401929" role="paragraph" localize="false" xml-lang="en-US">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> + <paragraph id="par_id061520180728406561" role="paragraph" localize="false" xml-lang="en-US">' 'CName' is the Name of the Control</paragraph> + <bascode> + <paragraph id="par_id061520180728403658" role="bascode" localize="false" xml-lang="en-US">Function GetControlShape(</paragraph> + <paragraph role="bascode" id="par_id731529060754496" xml-lang="en-US" localize="false">oContainer as Object,</paragraph> + <paragraph role="bascode" id="par_id571529060764136" xml-lang="en-US" localize="false">CName as String)</paragraph> + </bascode> + <h3 id="hd_id061520180728402154" xml-lang="en-US" localize="false">getControlView</h3> + <paragraph id="par_id061520180728406447" role="paragraph" localize="false" xml-lang="en-US">' Returns the View of a Control</paragraph> + <paragraph id="par_id061520180728405250" role="paragraph" localize="false" xml-lang="en-US">' Parameters:</paragraph> + <paragraph id="par_id061520180728407354" role="paragraph" localize="false" xml-lang="en-US">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> + <paragraph id="par_id061520180728407546" role="paragraph" localize="false" xml-lang="en-US">' The 'oController' is always directly attached to the Document</paragraph> + <paragraph id="par_id061520180728401894" role="paragraph" localize="false" xml-lang="en-US">' 'CName' is the Name of the Control</paragraph> + <bascode> + <paragraph id="par_id061520180728405914" role="bascode" localize="false" xml-lang="en-US">Function getControlView(</paragraph> + <paragraph role="bascode" id="par_id431529060800677" xml-lang="en-US" localize="false">oContainer , </paragraph> + <paragraph role="bascode" id="par_id471529060805433" xml-lang="en-US" localize="false">oController as Object, </paragraph> + <paragraph role="bascode" id="par_id501529060820866" xml-lang="en-US" localize="false">CName as String) as Object</paragraph> + </bascode> + <h3 id="hd_id061520180728409398" xml-lang="en-US" localize="false">DisposeControl</h3> + <paragraph id="par_id061520180728406445" role="paragraph" localize="false" xml-lang="en-US">' Parameters:</paragraph> + <paragraph id="par_id061520180728405024" role="paragraph" localize="false" xml-lang="en-US">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> + <paragraph id="par_id061520180728403834" role="paragraph" localize="false" xml-lang="en-US">' 'CName' is the Name of the Control</paragraph> + <bascode> + <paragraph id="par_id061520180728406007" role="bascode" localize="false" xml-lang="en-US">Function DisposeControl(</paragraph> + <paragraph role="bascode" id="par_id161529060860526" xml-lang="en-US" localize="false">oContainer as Object, </paragraph> + <paragraph role="bascode" id="par_id311529060865820" xml-lang="en-US" localize="false">CName as String) as Boolean</paragraph> + </bascode> + <h3 id="hd_id061520180728401986" xml-lang="en-US" localize="false">GetControlGroupModel</h3> + <paragraph id="par_id061520180728404727" role="paragraph" localize="false" xml-lang="en-US">' Returns a sequence of a group of controls like option buttons or checkboxes</paragraph> + <paragraph id="par_id061520180728404702" role="paragraph" localize="false" xml-lang="en-US">' The 'oContainer' is the Document or a specific sheet of a Calc - Document</paragraph> + <paragraph id="par_id061520180728402498" role="paragraph" localize="false" xml-lang="en-US">' 'sGroupName' is the Name of the Controlgroup</paragraph> + <bascode> + <paragraph id="par_id061520180728405097" role="bascode" localize="false" xml-lang="en-US">Function GetControlGroupModel(</paragraph> + <paragraph role="bascode" id="par_id271529060883844" xml-lang="en-US" localize="false">oContainer as Object, </paragraph> + <paragraph role="bascode" id="par_id131529060888366" xml-lang="en-US" localize="false">sGroupName as String )</paragraph> + </bascode> + <h3 id="hd_id061520180728404995" xml-lang="en-US" localize="false">GetRefValue</h3> + <paragraph id="par_id06152018072840427" role="paragraph" localize="false" xml-lang="en-US">' Returns the Referencevalue of a group of e.g. option buttons or check boxes</paragraph> + <paragraph id="par_id061520180728401645" role="paragraph" localize="false" xml-lang="en-US">' 'oControlGroup' is a sequence of the Control objects</paragraph> + <bascode> + <paragraph id="par_id061520180728405216" role="bascode" localize="false" xml-lang="en-US">Function GetRefValue(</paragraph> + <paragraph role="bascode" id="par_id311529060906785" xml-lang="en-US" localize="false">oControlGroup() as Object)</paragraph> + </bascode> + <h3 id="hd_id06152018072841458" xml-lang="en-US" localize="false">GetRefValueOfControlGroup</h3> + <bascode> + <paragraph id="par_id061520180728415365" role="bascode" localize="false" xml-lang="en-US">Function GetRefValueOfControlGroup(</paragraph> + <paragraph id="par_id061520180728416461" role="bascode" localize="false" xml-lang="en-US">oContainer as Object, </paragraph> + <paragraph id="par_id061520180728413768" role="bascode" localize="false" xml-lang="en-US">GroupName as String)</paragraph> + </bascode> + <h3 id="hd_id061520180728416653" xml-lang="en-US" localize="false">GetOptionGroupValue</h3> + <bascode> + <paragraph id="par_id061520180728411484" role="bascode" localize="false" xml-lang="en-US">Function GetOptionGroupValue(</paragraph> + <paragraph id="par_id061520180728412653" role="bascode" localize="false" xml-lang="en-US">oContainer as Object, </paragraph> + <paragraph id="par_id061520180728413045" role="bascode" localize="false" xml-lang="en-US">OptGroupName as String) as Boolean</paragraph> + </bascode> + <h3 id="hd_id061520180728419761" xml-lang="en-US" localize="false">WriteOptValueToCell</h3> + <bascode> + <paragraph id="par_id061520180728414297" role="bascode" localize="false" xml-lang="en-US">Function WriteOptValueToCell(</paragraph> + <paragraph id="par_id061520180728414871" role="bascode" localize="false" xml-lang="en-US">oSheet as Object, </paragraph> + <paragraph id="par_id061520180728416273" role="bascode" localize="false" xml-lang="en-US">OptGroupName as String, </paragraph> + <paragraph id="par_id061520180728411892" role="bascode" localize="false" xml-lang="en-US">iCol as Integer, </paragraph> + <paragraph id="par_id061520180728411133" role="bascode" localize="false" xml-lang="en-US">iRow as Integer) as Boolean</paragraph> + </bascode> + <h3 id="hd_id061520180728411084" xml-lang="en-US" localize="false">LoadDialog</h3> + <bascode> + <paragraph id="par_id061520180728416215" role="bascode" localize="false" xml-lang="en-US">Function LoadDialog(</paragraph> + <paragraph id="par_id061520180728415374" role="bascode" localize="false" xml-lang="en-US">Libname as String, </paragraph> + <paragraph id="par_id061520180728411337" role="bascode" localize="false" xml-lang="en-US">DialogName as String, </paragraph> + <paragraph id="par_id061520180728412212" role="bascode" localize="false" xml-lang="en-US">Optional oLibContainer)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id261558858921700">Refer to <link href="text/sbasic/guide/show_dialog.xhp#show_dialog" name="Opening a Dialog with Basic">Opening a Dialog with Basic</link> for an example of LoadDialog function.</paragraph> + <h3 id="hd_id061520180728417528" xml-lang="en-US" localize="false">GetFolderName</h3> + <bascode> + <paragraph id="par_id061520180728414273" role="bascode" localize="false" xml-lang="en-US">Sub GetFolderName(oRefModel as Object)</paragraph> + </bascode> + <h3 id="hd_id061520180728412942" xml-lang="en-US" localize="false">GetFileName</h3> + <bascode> + <paragraph id="par_id061520180728416696" role="bascode" localize="false" xml-lang="en-US">Sub GetFileName(</paragraph> + <paragraph id="par_id061520180728417082" role="bascode" localize="false" xml-lang="en-US">oRefModel as Object, </paragraph> + <paragraph id="par_id061520180728418718" role="bascode" localize="false" xml-lang="en-US">Filternames())</paragraph> + </bascode> + <h3 id="hd_id061520180728414394" xml-lang="en-US" localize="false">StoreDocument</h3> + <bascode> + <paragraph id="par_id061520180728415594" role="bascode" localize="false" xml-lang="en-US">Function StoreDocument(</paragraph> + <paragraph id="par_id061520180728417685" role="bascode" localize="false" xml-lang="en-US">oDocument as Object, </paragraph> + <paragraph id="par_id061520180728416184" role="bascode" localize="false" xml-lang="en-US">FilterNames() as String, </paragraph> + <paragraph id="par_id061520180728414290" role="bascode" localize="false" xml-lang="en-US">DefaultName as String, </paragraph> + <paragraph id="par_id061520180728419279" role="bascode" localize="false" xml-lang="en-US">DisplayDirectory as String, </paragraph> + <paragraph id="par_id061520180728421914" role="bascode" localize="false" xml-lang="en-US">Optional iAddProcedure as Integer) as String</paragraph> + </bascode> + <h3 id="hd_id061520180728424363" xml-lang="en-US" localize="false">AddFiltersToDialog</h3> + <bascode> + <paragraph id="par_id061520180728429017" role="bascode" localize="false" xml-lang="en-US">Sub AddFiltersToDialog(</paragraph> + <paragraph id="par_id061520180728424454" role="bascode" localize="false" xml-lang="en-US">FilterNames() as String, </paragraph> + <paragraph id="par_id061520180728422747" role="bascode" localize="false" xml-lang="en-US">oDialog as Object)</paragraph> + </bascode> + <h3 id="hd_id061520180728422388" xml-lang="en-US" localize="false">SwitchMousePointer</h3> + <bascode> + <paragraph id="par_id0615201807284277" role="bascode" localize="false" xml-lang="en-US">Sub SwitchMousePointer(</paragraph> + <paragraph id="par_id061520180728421877" role="bascode" localize="false" xml-lang="en-US">oWindowPeer as Object, </paragraph> + <paragraph id="par_id061520180728429500" role="bascode" localize="false" xml-lang="en-US">bDoEnable as Boolean)</paragraph> + </bascode> + <h3 id="hd_id061520180728428854" xml-lang="en-US" localize="false">ShowOverwriteAllDialog</h3> + <bascode> + <paragraph id="par_id061520180728427224" role="bascode" localize="false" xml-lang="en-US">Sub ShowOverwriteAllDialog(</paragraph> + <paragraph id="par_id06152018072842792" role="bascode" localize="false" xml-lang="en-US">FilePath as String, </paragraph> + <paragraph id="par_id061520180728429393" role="bascode" localize="false" xml-lang="en-US">sTitle as String)</paragraph> + </bascode> + <h3 id="hd_id061520180728429649" xml-lang="en-US" localize="false">SetOVERWRITEToQuery</h3> + <bascode> + <paragraph id="par_id061520180728429597" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToQuery()</paragraph> + </bascode> + <h3 id="hd_id061520180728428255" xml-lang="en-US" localize="false">SetOVERWRITEToAlways</h3> + <bascode> + <paragraph id="par_id061520180728424733" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToAlways()</paragraph> + </bascode> + <h3 id="hd_id06152018072842702" xml-lang="en-US" localize="false">SetOVERWRITEToNever</h3> + <bascode> + <paragraph id="par_id061520180728429250" role="bascode" localize="false" xml-lang="en-US">Sub SetOVERWRITEToNever()</paragraph> + </bascode> + </section> + <bookmark xml-lang="en-US" branch="index" id="bm_id271529062660965"> + <bookmark_value>BASIC Tools library;Strings module</bookmark_value> + </bookmark> + <section id="strings_module"> + <paragraph role="heading" id="hd_id461529005770576" level="2" xml-lang="en-US"><item type="literal">Strings</item> Module</paragraph> + <paragraph role="paragraph" id="par_id631529064722315" xml-lang="en-US">Advanced functions and subroutines for string manipulation.</paragraph> + <h3 id="hd_id061420180708276674" xml-lang="en-US" localize="false">ElimChar</h3> + <bascode> + <paragraph id="par_id061420180708276186" role="bascode" localize="false" xml-lang="en-US">Function ElimChar(</paragraph> + <paragraph role="bascode" id="par_id551529060984480" xml-lang="en-US" localize="false">ByVal BigString as String, </paragraph> + <paragraph role="bascode" id="par_id871529060990727" xml-lang="en-US" localize="false">ElimArray() as String)</paragraph> + </bascode> + <h3 id="hd_id061420180708279224" xml-lang="en-US" localize="false">DeleteStr</h3> + <paragraph id="par_id061420180708275363" role="paragraph" localize="false" xml-lang="en-US">' Deletes out of a String 'BigString' a possible Partstring 'CompString'</paragraph> + <bascode> + <paragraph id="par_id061420180708303146" role="bascode" localize="false" xml-lang="en-US">Function DeleteStr(</paragraph> + <paragraph id="par_id061420180708306296" role="bascode" localize="false" xml-lang="en-US">ByVal BigString,</paragraph> + <paragraph id="par_id061420180708301803" role="bascode" localize="false" xml-lang="en-US">CompString as String) as String</paragraph> + </bascode> + <h3 id="hd_id061420180708308611" xml-lang="en-US" localize="false">FindPartString</h3> + <paragraph id="par_id061420180708308479" role="paragraph" localize="false" xml-lang="en-US">' Finds a PartString, that is framed by the Strings 'Prestring' and 'PostString'</paragraph> + <bascode> + <paragraph id="par_id061420180708305815" role="bascode" localize="false" xml-lang="en-US">Function FindPartString(</paragraph> + <paragraph id="par_id061420180708307045" role="bascode" localize="false" xml-lang="en-US">BigString, </paragraph> + <paragraph id="par_id061420180708308079" role="bascode" localize="false" xml-lang="en-US">PreString, </paragraph> + <paragraph id="par_id061420180708302996" role="bascode" localize="false" xml-lang="en-US">PostString as String, </paragraph> + <paragraph id="par_id061420180708308715" role="bascode" localize="false" xml-lang="en-US">SearchPos as Integer) as String</paragraph> + </bascode> + <h3 id="hd_id06142018070830220" xml-lang="en-US" localize="false">PartStringInArray</h3> + <paragraph id="par_id061420180708302715" role="paragraph" localize="false" xml-lang="en-US">' Note iCompare = 0 (Binary comparison)</paragraph> + <paragraph id="par_id06142018070830615" role="paragraph" localize="false" xml-lang="en-US">' iCompare = 1 (Text comparison)</paragraph> + <bascode> + <paragraph id="par_id061420180708303506" role="bascode" localize="false" xml-lang="en-US">Function PartStringInArray(</paragraph> + <paragraph id="par_id06142018070830513" role="bascode" localize="false" xml-lang="en-US">BigArray(), </paragraph> + <paragraph id="par_id06142018070830983" role="bascode" localize="false" xml-lang="en-US">SearchString as String, </paragraph> + <paragraph id="par_id061420180708309182" role="bascode" localize="false" xml-lang="en-US">iCompare as Integer) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180708307208" xml-lang="en-US" localize="false">RTrimStr</h3> + <paragraph id="par_id061420180708304034" role="paragraph" localize="false" xml-lang="en-US">' Deletes the String 'SmallString' out of the String 'BigString'</paragraph> + <paragraph id="par_id06142018070830656" role="paragraph" localize="false" xml-lang="en-US">' in case SmallString's Position in BigString is right at the end</paragraph> + <bascode> + <paragraph id="par_id061420180708301129" role="bascode" localize="false" xml-lang="en-US">Function RtrimStr(</paragraph> + <paragraph id="par_id061420180708311705" role="bascode" localize="false" xml-lang="en-US">ByVal BigString, </paragraph> + <paragraph id="par_id061420180708312600" role="bascode" localize="false" xml-lang="en-US">SmallString as String) as String</paragraph> + </bascode> + <h3 id="hd_id061420180708314304" xml-lang="en-US" localize="false">LTRimChar</h3> + <paragraph id="par_id061420180708318862" role="paragraph" localize="false" xml-lang="en-US">' Deletes the Char 'CompChar' out of the String 'BigString'</paragraph> + <paragraph id="par_id061420180708319364" role="paragraph" localize="false" xml-lang="en-US">' in case CompChar's Position in BigString is right at the beginning</paragraph> + <bascode> + <paragraph id="par_id061420180708313231" role="bascode" localize="false" xml-lang="en-US">Function LTRimChar(</paragraph> + <paragraph id="par_id061420180708311887" role="bascode" localize="false" xml-lang="en-US">ByVal BigString as String,</paragraph> + <paragraph id="par_id061420180708313838" role="bascode" localize="false" xml-lang="en-US">CompChar as String) as String</paragraph> + </bascode> + <h3 id="hd_id061420180708314113" xml-lang="en-US" localize="false">ArrayOutOfString</h3> + <paragraph id="par_id061420180708315726" role="paragraph" localize="false" xml-lang="en-US">' Retrieves an Array out of a String.</paragraph> + <paragraph id="par_id061420180708316680" role="paragraph" localize="false" xml-lang="en-US">' The fields of the Array are separated by the parameter 'Separator', that is contained</paragraph> + <paragraph id="par_id06142018070831860" role="paragraph" localize="false" xml-lang="en-US">' in the Array</paragraph> + <paragraph id="par_id061420180708318872" role="paragraph" localize="false" xml-lang="en-US">' The Array MaxIndex delivers the highest Index of this Array</paragraph> + <bascode> + <paragraph id="par_id061420180708313417" role="bascode" localize="false" xml-lang="en-US">Function ArrayOutOfString(</paragraph> + <paragraph id="par_id061420180708317368" role="bascode" localize="false" xml-lang="en-US">BigString, </paragraph> + <paragraph id="par_id061420180708314602" role="bascode" localize="false" xml-lang="en-US">Separator as String, </paragraph> + <paragraph id="par_id061420180708311676" role="bascode" localize="false" xml-lang="en-US">Optional MaxIndex as Integer)</paragraph> + </bascode> + <h3 id="hd_id061420180708313207" xml-lang="en-US" localize="false">ClearArray</h3> + <paragraph id="par_id06142018070831823" role="paragraph" localize="false" xml-lang="en-US">' Deletes all fieldvalues in one-dimensional Array</paragraph> + <bascode> + <paragraph id="par_id061420180708315325" role="bascode" localize="false" xml-lang="en-US">Sub ClearArray(BigArray)</paragraph> + </bascode> + <h3 id="hd_id061420180708315939" xml-lang="en-US" localize="false">ClearMultiDimArray</h3> + <paragraph id="par_id061420180708319653" role="paragraph" localize="false" xml-lang="en-US">' Deletes all fieldvalues in a multidimensional Array</paragraph> + <bascode> + <paragraph id="par_id061420180708314941" role="bascode" localize="false" xml-lang="en-US">Sub ClearMultiDimArray(</paragraph> + <paragraph role="bascode" id="par_id681529061123165" xml-lang="en-US" localize="false">BigArray,</paragraph> + <paragraph role="bascode" id="par_id981529061129190" xml-lang="en-US" localize="false">DimCount as integer)</paragraph> + </bascode> + <h3 id="hd_id0614201807083186" xml-lang="en-US" localize="false">FieldinArray</h3> + <paragraph id="par_id061420180708316541" role="paragraph" localize="false" xml-lang="en-US">' Checks if a Field (LocField) is already defined in an Array</paragraph> + <paragraph id="par_id061420180708319616" role="paragraph" localize="false" xml-lang="en-US">' Returns 'True' or 'False'</paragraph> + <bascode> + <paragraph id="par_id061420180708314166" role="bascode" localize="false" xml-lang="en-US">Function FieldinArray(</paragraph> + <paragraph id="par_id061420180708312267" role="bascode" localize="false" xml-lang="en-US">LocArray(), </paragraph> + <paragraph id="par_id061420180708312072" role="bascode" localize="false" xml-lang="en-US">MaxIndex as integer, </paragraph> + <paragraph id="par_id061420180708316376" role="bascode" localize="false" xml-lang="en-US">LocField as String) As Boolean</paragraph> + </bascode> + <h3 id="hd_id061420180708311512" xml-lang="en-US" localize="false">FieldinList</h3> + <paragraph id="par_id061420180708322561" role="paragraph" localize="false" xml-lang="en-US">' Checks if a Field (LocField) is already defined in an Array</paragraph> + <paragraph id="par_id061420180708329146" role="paragraph" localize="false" xml-lang="en-US">' Returns 'True' or 'False'</paragraph> + <bascode> + <paragraph id="par_id061420180708323174" role="bascode" localize="false" xml-lang="en-US">Function FieldinList(</paragraph> + <paragraph id="par_id061420180708323053" role="bascode" localize="false" xml-lang="en-US">LocField, </paragraph> + <paragraph id="par_id06142018070832420" role="bascode" localize="false" xml-lang="en-US">BigList()) As Boolean</paragraph> + </bascode> + <h3 id="hd_id061420180708323374" xml-lang="en-US" localize="false">IndexinArray</h3> + <paragraph id="par_id061420180708321488" role="paragraph" localize="false" xml-lang="en-US">' Retrieves the Index of the delivered String 'SearchString' in</paragraph> + <paragraph id="par_id061420180708323577" role="paragraph" localize="false" xml-lang="en-US">' the Array LocList()'</paragraph> + <bascode> + <paragraph id="par_id061420180708322202" role="bascode" localize="false" xml-lang="en-US">Function IndexinArray(</paragraph> + <paragraph id="par_id061420180708321376" role="bascode" localize="false" xml-lang="en-US">SearchString as String, </paragraph> + <paragraph id="par_id061420180708321330" role="bascode" localize="false" xml-lang="en-US">LocList()) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180708324642" xml-lang="en-US" localize="false">MultiArrayInListbox</h3> + <bascode> + <paragraph id="par_id061420180708326283" role="bascode" localize="false" xml-lang="en-US">Sub MultiArrayInListbox(</paragraph> + <paragraph id="par_id061420180708323785" role="bascode" localize="false" xml-lang="en-US">oDialog as Object, </paragraph> + <paragraph id="par_id061420180708325943" role="bascode" localize="false" xml-lang="en-US">ListboxName as String, </paragraph> + <paragraph id="par_id061420180708321048" role="bascode" localize="false" xml-lang="en-US">ValList(), </paragraph> + <paragraph id="par_id061420180708326030" role="bascode" localize="false" xml-lang="en-US">iDim as Integer)</paragraph> + </bascode> + <h3 id="hd_id061420180708325766" xml-lang="en-US" localize="false">StringInMultiArray</h3> + <paragraph id="par_id061420180708328772" role="paragraph" localize="false" xml-lang="en-US">' Searches for a String in a two-dimensional Array by querying all Searchindexes of the second dimension </paragraph> + <paragraph id="par_id061420180708324136" role="paragraph" localize="false" xml-lang="en-US">' and delivers the specific String of the ReturnIndex in the second dimension of the Searchlist()</paragraph> + <bascode> + <paragraph id="par_id061420180708326799" role="bascode" localize="false" xml-lang="en-US">Function StringInMultiArray(</paragraph> + <paragraph id="par_id061420180708324098" role="bascode" localize="false" xml-lang="en-US">SearchList(), </paragraph> + <paragraph id="par_id061420180708325264" role="bascode" localize="false" xml-lang="en-US">SearchString as String, </paragraph> + <paragraph id="par_id06142018070832793" role="bascode" localize="false" xml-lang="en-US">SearchIndex as Integer, </paragraph> + <paragraph id="par_id06142018070832221" role="bascode" localize="false" xml-lang="en-US">ReturnIndex as Integer, </paragraph> + <paragraph id="par_id061420180708329795" role="bascode" localize="false" xml-lang="en-US">Optional MaxIndex as Integer) as String</paragraph> + </bascode> + <h3 id="hd_id061420180708327934" xml-lang="en-US" localize="false">GetIndexInMultiArray</h3> + <paragraph id="par_id06142018070832514" role="paragraph" localize="false" xml-lang="en-US">' Searches for a Value in multidimensial Array by querying all Searchindices of the passed dimension </paragraph> + <paragraph id="par_id061420180708329496" role="paragraph" localize="false" xml-lang="en-US">' and delivers the Index where it is found.</paragraph> + <bascode> + <paragraph id="par_id061420180708321937" role="bascode" localize="false" xml-lang="en-US">Function GetIndexInMultiArray(</paragraph> + <paragraph id="par_id061420180708323473" role="bascode" localize="false" xml-lang="en-US">SearchList(), </paragraph> + <paragraph id="par_id061420180708329899" role="bascode" localize="false" xml-lang="en-US">SearchValue, </paragraph> + <paragraph id="par_id061420180708339789" role="bascode" localize="false" xml-lang="en-US">SearchIndex as Integer) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180708336858" xml-lang="en-US" localize="false">GetIndexForPartString_</h3> + <paragraph role="bascode" id="par_id971529015773531" xml-lang="en-US" localize="false">inMultiArray</paragraph> + <paragraph id="par_id061420180708337261" role="paragraph" localize="false" xml-lang="en-US">' Searches for a Value in multidimensial Array by querying all Searchindices of the passed dimension </paragraph> + <paragraph id="par_id061420180708334301" role="paragraph" localize="false" xml-lang="en-US">' and delivers the Index where the Searchvalue is found as a part string</paragraph> + <bascode> + <paragraph id="par_id061420180708339583" role="bascode" localize="false" xml-lang="en-US">Function GetIndexForPartStringinMultiArray(</paragraph> + <paragraph id="par_id061420180708339052" role="bascode" localize="false" xml-lang="en-US">SearchList(), </paragraph> + <paragraph id="par_id061420180708338642" role="bascode" localize="false" xml-lang="en-US">SearchValue, </paragraph> + <paragraph id="par_id061420180708335373" role="bascode" localize="false" xml-lang="en-US">SearchIndex as Integer) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180708331666" xml-lang="en-US" localize="false">ArrayfromMultiArray</h3> + <bascode> + <paragraph id="par_id061420180708331057" role="bascode" localize="false" xml-lang="en-US">Function ArrayfromMultiArray(</paragraph> + <paragraph id="par_id061420180708333679" role="bascode" localize="false" xml-lang="en-US">MultiArray as String, </paragraph> + <paragraph id="par_id061420180708337806" role="bascode" localize="false" xml-lang="en-US">iDim as Integer)</paragraph> + </bascode> + <h3 id="hd_id061420180708335847" xml-lang="en-US" localize="false">ReplaceString</h3> + <paragraph id="par_id061420180708332382" role="paragraph" localize="false" xml-lang="en-US">' Replaces the string "OldReplace" through the String "NewReplace" in the String</paragraph> + <paragraph id="par_id061420180708334998" role="paragraph" localize="false" xml-lang="en-US">' 'BigString'</paragraph> + <bascode> + <paragraph id="par_id061420180708336799" role="bascode" localize="false" xml-lang="en-US">Function ReplaceString(</paragraph> + <paragraph id="par_id061420180708337582" role="bascode" localize="false" xml-lang="en-US">ByVal Bigstring, </paragraph> + <paragraph id="par_id0614201807083370" role="bascode" localize="false" xml-lang="en-US">NewReplace, </paragraph> + <paragraph id="par_id061420180708334572" role="bascode" localize="false" xml-lang="en-US">OldReplace as String) as String</paragraph> + </bascode> + <h3 id="hd_id061420180708336841" xml-lang="en-US" localize="false">FindSecondValue</h3> + <paragraph id="par_id061420180708337504" role="paragraph" localize="false" xml-lang="en-US">' Retrieves the second value for a next to 'SearchString' in</paragraph> + <paragraph id="par_id061420180708335341" role="paragraph" localize="false" xml-lang="en-US">' a two-dimensional string-Array</paragraph> + <bascode> + <paragraph id="par_id061420180708337932" role="bascode" localize="false" xml-lang="en-US">Function FindSecondValue(</paragraph> + <paragraph role="bascode" id="par_id771529061274912" xml-lang="en-US" localize="false">SearchString as String, </paragraph> + <paragraph role="bascode" id="par_id91529061281985" xml-lang="en-US" localize="false">TwoDimList() as String ) as String</paragraph> + </bascode> + <h3 id="hd_id061420180708339122" xml-lang="en-US" localize="false">Power</h3> + <paragraph id="par_id061420180708332948" role="paragraph" localize="false" xml-lang="en-US">' raises a base to a certain power</paragraph> + <bascode> + <paragraph id="par_id061420180708337053" role="bascode" localize="false" xml-lang="en-US">Function Power(</paragraph> + <paragraph id="par_id061420180708337160" role="bascode" localize="false" xml-lang="en-US">Basis as Double, </paragraph> + <paragraph id="par_id061420180708335666" role="bascode" localize="false" xml-lang="en-US">Exponent as Double) as Double</paragraph> + </bascode> + <h3 id="hd_id0614201807083362" xml-lang="en-US" localize="false">Round</h3> + <paragraph id="par_id061420180708349543" role="paragraph" localize="false" xml-lang="en-US">' rounds a Real to a given Number of Decimals</paragraph> + <bascode> + <paragraph id="par_id061420180708342039" role="bascode" localize="false" xml-lang="en-US">Function Round(</paragraph> + <paragraph id="par_id061420180708348729" role="bascode" localize="false" xml-lang="en-US">BaseValue as Double, </paragraph> + <paragraph id="par_id061420180708341926" role="bascode" localize="false" xml-lang="en-US">Decimals as Integer) as Double</paragraph> + </bascode> + <h3 id="hd_id061420180708344826" xml-lang="en-US" localize="false">FileNameoutofPath</h3> + <paragraph id="par_id061420180708348505" role="paragraph" localize="false" xml-lang="en-US">'Retrieves the mere filename out of a whole path</paragraph> + <bascode> + <paragraph id="par_id061420180708348090" role="bascode" localize="false" xml-lang="en-US">Function FileNameoutofPath(</paragraph> + <paragraph id="par_id06142018070834403" role="bascode" localize="false" xml-lang="en-US">ByVal Path as String, </paragraph> + <paragraph id="par_id061420180708347244" role="bascode" localize="false" xml-lang="en-US">Optional Separator as String) as String</paragraph> + </bascode> + <h3 id="hd_id06142018070834616" xml-lang="en-US" localize="false">GetFileNameExtension</h3> + <bascode> + <paragraph id="par_id061420180708342063" role="bascode" localize="false" xml-lang="en-US">Function GetFileNameExtension(</paragraph> + <paragraph id="par_id06142018070834483" role="bascode" localize="false" xml-lang="en-US">ByVal FileName as String)</paragraph> + </bascode> + <h3 id="hd_id061420180708342472" xml-lang="en-US" localize="false">GetFileNameWithoutExtension</h3> + <bascode> + <paragraph id="par_id061420180708347863" role="bascode" localize="false" xml-lang="en-US">Function GetFileNameWithoutExtension(</paragraph> + <paragraph id="par_id061420180708347793" role="bascode" localize="false" xml-lang="en-US">ByVal FileName as String, </paragraph> + <paragraph id="par_id061420180708341627" role="bascode" localize="false" xml-lang="en-US">Optional Separator as String)</paragraph> + </bascode> + <h3 id="hd_id061420180708347642" xml-lang="en-US" localize="false">DirectoryNameoutofPath</h3> + <bascode> + <paragraph id="par_id061420180708343404" role="bascode" localize="false" xml-lang="en-US">Function DirectoryNameoutofPath(</paragraph> + <paragraph id="par_id061420180708348454" role="bascode" localize="false" xml-lang="en-US">sPath as String, </paragraph> + <paragraph id="par_id061420180708344267" role="bascode" localize="false" xml-lang="en-US">Separator as String) as String</paragraph> + </bascode> + <h3 id="hd_id061420180708348485" xml-lang="en-US" localize="false">CountCharsinString</h3> + <bascode> + <paragraph id="par_id061420180708348315" role="bascode" localize="false" xml-lang="en-US">Function CountCharsinString(</paragraph> + <paragraph id="par_id061420180708343699" role="bascode" localize="false" xml-lang="en-US">BigString, </paragraph> + <paragraph id="par_id061420180708348022" role="bascode" localize="false" xml-lang="en-US">LocChar as String, </paragraph> + <paragraph id="par_id061420180708344991" role="bascode" localize="false" xml-lang="en-US">ByVal StartPos as Integer) as Integer</paragraph> + </bascode> + <h3 id="hd_id061420180708344129" xml-lang="en-US" localize="false">BubbleSortList</h3> + <bascode> + <paragraph id="par_id061420180708343944" role="bascode" localize="false" xml-lang="en-US">Function BubbleSortList(</paragraph> + <paragraph id="par_id061420180708347334" role="bascode" localize="false" xml-lang="en-US">ByVal SortList(),</paragraph> + <paragraph id="par_id061420180708352791" role="bascode" localize="false" xml-lang="en-US">optional sort2ndValue as Boolean)</paragraph> + </bascode> + <paragraph id="par_id061420180708355329" role="paragraph" localize="false" xml-lang="en-US">'This function bubble sorts an array of maximum 2 dimensions.</paragraph> + <paragraph id="par_id061420180708351446" role="paragraph" localize="false" xml-lang="en-US">'The default sorting order is the first dimension</paragraph> + <paragraph id="par_id061420180708359513" role="paragraph" localize="false" xml-lang="en-US">'Only if sort2ndValue is True the second dimension is the relevant for the sorting order</paragraph> + <h3 id="hd_id061420180708356687" xml-lang="en-US" localize="false">GetValueoutofList</h3> + <bascode> + <paragraph id="par_id061420180708359326" role="bascode" localize="false" xml-lang="en-US">Function GetValueoutofList(</paragraph> + <paragraph id="par_id061420180708358651" role="bascode" localize="false" xml-lang="en-US">SearchValue, </paragraph> + <paragraph id="par_id061420180708355610" role="bascode" localize="false" xml-lang="en-US">BigList(), </paragraph> + <paragraph id="par_id061420180708357288" role="bascode" localize="false" xml-lang="en-US">iDim as Integer, </paragraph> + <paragraph id="par_id061420180708353372" role="bascode" localize="false" xml-lang="en-US">Optional ValueIndex)</paragraph> + </bascode> + <h3 id="hd_id06142018070835957" xml-lang="en-US" localize="false">AddListtoList</h3> + <bascode> + <paragraph id="par_id061420180708359239" role="bascode" localize="false" xml-lang="en-US">Function AddListtoList(</paragraph> + <paragraph id="par_id061420180708356836" role="bascode" localize="false" xml-lang="en-US">ByVal FirstArray(), </paragraph> + <paragraph id="par_id061420180708353284" role="bascode" localize="false" xml-lang="en-US">ByVal SecondArray(), </paragraph> + <paragraph id="par_id061420180708352829" role="bascode" localize="false" xml-lang="en-US">Optional StartIndex)</paragraph> + </bascode> + <h3 id="hd_id06142018070835769" xml-lang="en-US" localize="false">CheckDouble</h3> + <bascode> + <paragraph id="par_id061420180708359797" role="bascode" localize="false" xml-lang="en-US">Function CheckDouble(DoubleString as String)</paragraph> + </bascode> + </section> + <bookmark xml-lang="en-US" branch="index" id="bm_id731529062695476"> + <bookmark_value>BASIC Tools library;UCB module</bookmark_value> + </bookmark> + <section id="ucb_module"> + <paragraph role="heading" id="hd_id461529005780299" level="2" xml-lang="en-US"><item type="literal">UCB</item> Module</paragraph> + <paragraph role="paragraph" id="par_id131529064870824" xml-lang="en-US"><emph>Universal Content Broker</emph> functions and subroutines.</paragraph> + <h3 id="hd_id061420180727434845" xml-lang="en-US" localize="false">ReadDirectories</h3> + <bascode> + <paragraph id="par_id061420180727437288" role="bascode" localize="false" xml-lang="en-US">Function ReadDirectories(</paragraph> + <paragraph id="par_id061420180727433237" role="bascode" localize="false" xml-lang="en-US">ByVal AnchorDir As String, </paragraph> + <paragraph id="par_id061420180727439074" role="bascode" localize="false" xml-lang="en-US">bRecursive as Boolean, </paragraph> + <paragraph id="par_id061420180727435295" role="bascode" localize="false" xml-lang="en-US">bcheckFileType as Boolean, </paragraph> + <paragraph id="par_id061420180727438646" role="bascode" localize="false" xml-lang="en-US">bGetByTitle as Boolean, </paragraph> + <paragraph id="par_id061420180727432828" role="bascode" localize="false" xml-lang="en-US">Optional sFileContent(), </paragraph> + <paragraph role="bascode" id="par_id641529061341375" xml-lang="en-US" localize="false">Optional sExtension as String)</paragraph> + </bascode> + <h3 id="hd_id061420180727437838" xml-lang="en-US" localize="false">AddFoldertoList</h3> + <bascode> + <paragraph id="par_id061420180727438938" role="bascode" localize="false" xml-lang="en-US">Sub AddFoldertoList(</paragraph> + <paragraph id="par_id061420180727439505" role="bascode" localize="false" xml-lang="en-US">sDirURL as String, </paragraph> + <paragraph id="par_id061420180727431203" role="bascode" localize="false" xml-lang="en-US">iDirIndex)</paragraph> + </bascode> + <h3 id="hd_id061420180727432439" xml-lang="en-US" localize="false">AddFileNameToList</h3> + <bascode> + <paragraph id="par_id061420180727436964" role="bascode" localize="false" xml-lang="en-US">Sub AddFileNameToList(</paragraph> + <paragraph id="par_id06142018072743660" role="bascode" localize="false" xml-lang="en-US">sFileArray(), </paragraph> + <paragraph id="par_id061420180727437595" role="bascode" localize="false" xml-lang="en-US">FileName as String, </paragraph> + <paragraph id="par_id061420180727438361" role="bascode" localize="false" xml-lang="en-US">FileContent as String, </paragraph> + <paragraph id="par_id061420180727438606" role="bascode" localize="false" xml-lang="en-US">bGetByTitle as Boolean, </paragraph> + <paragraph id="par_id061420180727443630" role="bascode" localize="false" xml-lang="en-US">CurIndex)</paragraph> + </bascode> + <h3 id="hd_id061420180727448222" xml-lang="en-US" localize="false">RetrieveDocTitle</h3> + <bascode> + <paragraph id="par_id061420180727449206" role="bascode" localize="false" xml-lang="en-US">Function RetrieveDocTitle(</paragraph> + <paragraph id="par_id061420180727449481" role="bascode" localize="false" xml-lang="en-US">oDocProps as Object, </paragraph> + <paragraph id="par_id061420180727442037" role="bascode" localize="false" xml-lang="en-US">sFileName as String) As String</paragraph> + </bascode> + <h3 id="hd_id061420180727441588" xml-lang="en-US" localize="false">GetRealFileContent</h3> + <paragraph id="par_id061420180727444743" role="paragraph" localize="false" xml-lang="en-US">' Retrieves The Filecontent of a Document by extracting the content</paragraph> + <paragraph id="par_id061420180727441850" role="paragraph" localize="false" xml-lang="en-US">' from the Header of the document</paragraph> + <bascode> + <paragraph id="par_id061420180727442427" role="bascode" localize="false" xml-lang="en-US">Function GetRealFileContent(</paragraph> + <paragraph role="bascode" id="par_id31529061382662" xml-lang="en-US" localize="false">FileName as String) As String</paragraph> + </bascode> + <h3 id="hd_id061420180727441712" xml-lang="en-US" localize="false">CopyRecursively</h3> + <bascode> + <paragraph id="par_id061420180727442141" role="bascode" localize="false" xml-lang="en-US">Function CopyRecursively(</paragraph> + <paragraph id="par_id061420180727444075" role="bascode" localize="false" xml-lang="en-US">SourceFilePath as String, </paragraph> + <paragraph id="par_id061420180727447821" role="bascode" localize="false" xml-lang="en-US">SourceStemDir as String, </paragraph> + <paragraph id="par_id061420180727449128" role="bascode" localize="false" xml-lang="en-US">TargetStemDir as String)</paragraph> + </bascode> + <h3 id="hd_id061420180727445345" xml-lang="en-US" localize="false">ShowHelperDialog</h3> + <paragraph id="par_id061420180727445226" role="paragraph" localize="false" xml-lang="en-US">' Opens a help url referenced by a Help ID that is retrieved from the calling button tag</paragraph> + <bascode> + <paragraph id="par_id061420180727444009" role="bascode" localize="false" xml-lang="en-US">Sub ShowHelperDialog(aEvent)</paragraph> + </bascode> + <h3 id="hd_id061420180727442283" xml-lang="en-US" localize="false">SaveDataToFile</h3> + <bascode> + <paragraph id="par_id06142018072744822" role="bascode" localize="false" xml-lang="en-US">Sub SaveDataToFile(</paragraph> + <paragraph id="par_id061420180727446132" role="bascode" localize="false" xml-lang="en-US">FilePath as String, </paragraph> + <paragraph id="par_id0614201807274429" role="bascode" localize="false" xml-lang="en-US">DataList())</paragraph> + </bascode> + <h3 id="hd_id061420180727442501" xml-lang="en-US" localize="false">LoadDataFromFile</h3> + <bascode> + <paragraph id="par_id061420180727441903" role="bascode" localize="false" xml-lang="en-US">Function LoadDataFromFile(</paragraph> + <paragraph id="par_id061420180727448904" role="bascode" localize="false" xml-lang="en-US">FilePath as String, </paragraph> + <paragraph id="par_id061420180727448778" role="bascode" localize="false" xml-lang="en-US">DataList()) as Boolean</paragraph> + </bascode> + <h3 id="hd_id06142018072744521" xml-lang="en-US" localize="false">CreateFolder</h3> + <bascode> + <paragraph id="par_id061420180727443924" role="bascode" localize="false" xml-lang="en-US">Function CreateFolder(sNewFolder) as Boolean</paragraph> + </bascode> + </section> + <section id="relatedTopics"> + <embed href="text/sbasic/python/python_platform.xhp#pythonplatform"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/lib_wikieditor.xhp b/helpcontent2/source/text/sbasic/shared/03/lib_wikieditor.xhp new file mode 100644 index 000000000..2bf31fc1a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/lib_wikieditor.xhp @@ -0,0 +1,30 @@ +<?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="basicwikieditorlibrary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">WikiEditor Library</title> + <filename>/text/sbasic/shared/03/lib_wikieditor.xhp</filename> + </topic> + </meta> + <body> + <h1 id="hd_id31529004750471"><variable id="wikieditor_lib"><link href="text/sbasic/shared/03/lib_wikieditor.xhp" name="WikiEditor library">The <item type="literal">WikiEditor</item> Library</link></variable></h1> + <bookmark xml-lang="en-US" branch="index" id="bm_id231529070133574"> + <bookmark_value>BASIC WikiEditor library</bookmark_value> + </bookmark> + <section id="howtoget"> + <embed href="text/sbasic/shared/00000003.xhp#dialoglibhowtoget"/> + </section> + <embed href="text/shared/need_help.xhp#needhelp"/> + <h2 id="hd_id841593518085848">Description</h2> + <paragraph role="paragraph" id="par_id921593518140986">The <emph>WikiEditor</emph> library only contains dialogs, it is used by <emph>Wiki Publisher</emph> bundled Java extension.</paragraph> + <note id="par_id131593538122154">This library is not used by %PRODUCTNAME Basic.</note> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_array.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_array.xhp new file mode 100644 index 000000000..241bbd408 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_array.xhp @@ -0,0 +1,968 @@ +<?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_Array" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.Array service (SF_Array)</title> + <filename>/text/sbasic/shared/03/sf_array.xhp</filename> + </topic> + </meta> +<body> + +<section id="abstract"> + <bookmark xml-lang="en-US" branch="index" id="bm_id281613039222756"> + <bookmark_value>Array service</bookmark_value> + </bookmark> + + <h1 id="bm_id781582391760253"><variable id="ArrayService"><link href="text/sbasic/shared/03/sf_array.xhp" name="ScriptForge.Array Service"><literal>ScriptForge</literal>.<literal>Array</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id991582454416549">Provides a collection of methods for manipulating and transforming arrays of one dimension (vectors) and arrays of two dimensions (matrices). This includes set operations, sorting, importing from and exporting to text files.</paragraph> + <paragraph role="paragraph" id="par_id681609955015503">Arrays with more than two dimensions cannot be used with the methods in this service, the only exception being the <literal>CountDims</literal> method that accepts Arrays with any number of dimensions.</paragraph> +</section> + + <paragraph role="paragraph" id="par_id651582454426538">Array items may contain any type of value, including (sub)arrays.</paragraph> + + <h2 id="hd_id981586595097630">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Array</literal> service the <literal>ScriptForge</literal> library needs to be loaded using:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id871608192694632">GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id461609955633383">Loading the library will create the <literal>SF_Array</literal> object that can be used to call the methods in the <literal>Array</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id63158659509728">The following code snippets show the various ways to call methods in the <literal>Array</literal> service (the <literal>Append</literal> method is used as an example):</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id211626911224256">Dim arr : arr = Array(1, 2, 3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311586595097510">arr = SF_Array.Append(arr, 4)</paragraph> + </bascode> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id211626911224167">Dim arr : arr = Array(1, 2, 3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811586595097328">Dim svc : svc = SF_Array</paragraph> + <paragraph role="bascode" localize="false" id="bas_id761586595097825">arr = svc.Append(arr, 4)</paragraph> + </bascode> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id211626911224417">Dim arr : arr = Array(1, 2, 3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821586595097892">Dim svc : svc = CreateScriptService("Array")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81586595097173">arr = svc.Append(arr, 4)</paragraph> + </bascode> + <warning id="par_id571609956486468">Because Python has built-in list and tuple support, most of the methods in the <literal>Array</literal> service are available for Basic scripts only. The only exception is <literal>ImportFromCSVFile</literal> which is supported in both Basic and Python.</warning> + <table id="tab_id221606235233835"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Array Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id361606235233835" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_array.xhp#Append" name="Append method">Append</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#AppendColumn" name="AppendColumn method">AppendColumn</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#AppendRow" name="AppendRow method">AppendRow</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Contains" name="Contains method">Contains</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ConvertToDictionary" name="ConvertToDictionary method">ConvertToDictionary</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Copy" name="Copy method">Copy</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#CountDims" name="CountDims method">CountDims</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Difference" name="Difference method">Difference</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ExportToTextFile" name="ExportToTextFile method">ExportToTextFile</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ExtractColumn" name="ExtractColumn">ExtractColumn</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ExtractRow" name="ExtractRow method">ExtractRow</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id231606235233835" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_array.xhp#Flatten" name="Flatten method">Flatten</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#ImportFromCSVFile" name="ImportFromCSVFile method">ImportFromCSVFile</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#IndexOf" name="IndexOf method">IndexOf</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Insert" name="Insert method">Insert</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#InsertSorted" name="InsertSorted method">InsertSorted</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Intersection" name="Intersection">Intersection</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Join2D" name="Join2D method">Join2D</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Prepend" name="Prepend method">Prepend</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#PrependColumn" name="PrependColumn method">PrependColumn</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#PrependRow" name="PrependRow method">PrependRow</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#RangeInit" name="RangeInit method">RangeInit</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id831606235233835" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_array.xhp#Reverse" name="Reverse method">Reverse</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Shuffle" name="Shuffle method">Shuffle</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Slice" name="Slice method">Slice</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Sort" name="Sort method">Sort</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#SortColumns" name="SortColumns method">SortColumns</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#SortRows" name="SortRows method">SortRows</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Transpose" name="Transpose method">Transpose</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#TrimArray" name="TrimArray method">TrimArray</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Union" name="Union method">Union</link><br/> + <link href="text/sbasic/shared/03/sf_array.xhp#Unique" name="Unique method">Unique</link><br/><br/> + </paragraph></tablecell> + </tablerow> + </table> + <tip id="par_id191582454485250">The first argument of most methods is the array object to be considered. It is always passed by reference and left unchanged. Methods such as Append, Prepend, etc return a new array object after their execution.</tip> + +<section id="Append"> + <comment> Append --------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id251582548992953"> + <bookmark_value>Array service;Append</bookmark_value> + </bookmark> + <h2 id="hd_id151582548992953" localize="false">Append</h2> + <paragraph role="paragraph" id="par_id931582548992953">Appends the items listed as arguments to the end of the input array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id921626975382809"> + <input>svc.Append(array_1d: any[0..*], arg0: any, [arg1: any] ...): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id471582548992953"><emph>array_1d</emph>: The pre-existing array, may be empty.</paragraph> + <paragraph role="paragraph" id="par_id531582548992953"><emph>arg0, arg1, ...</emph>: Items that will be appended to <literal>array_1d</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id101582548992954">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561582548992954">a = SF_Array.Append(Array(1, 2, 3), 4, 5)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541582548992954"> ' (1, 2, 3, 4, 5)</paragraph> + </bascode> +</section> + +<section id="AppendColumn"> + <comment> AppendColumn --------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id591582549679172"> + <bookmark_value>Array service;AppendColumn</bookmark_value> + </bookmark> + <h2 id="hd_id291582549679173" localize="false">AppendColumn</h2> + <paragraph role="paragraph" id="par_id241582549679173">Appends a new column to the right side of a two dimensional array. The resulting array has the same lower bounds as the initial two dimensional array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id231626975799102"> + <input>svc.AppendColumn(array_2d: any[0..*, 0..*], column: any[0..*]): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id461582549679175"><emph>array_2d</emph>: The pre-existing array, may be empty. If that array has only one dimension, it is considered as the first column of the resulting two-dimensional array.</paragraph> + <paragraph role="paragraph" id="par_id991582549679175"><emph>column</emph>: A 1-dimensional array with as many items as there are rows in <literal>array_2d</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id341582549679177">Dim a As Variant, b As variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681582549679177">a = SF_Array.AppendColumn(Array(1, 2, 3), Array(4, 5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151582549679177"> ' ((1, 4), (2, 5), (3, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991609959313410">b = SF_Array.AppendColumn(a, Array(7, 8, 9))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681609959354695"> ' ((1, 4, 7), (2, 5, 8), (3, 6, 9))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961582550242823">c = SF_Array.AppendColumn(Array(), Array(1, 2, 3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381582550413514"> ' ∀ i ∈ {0 ≤ i ≤ 2} : b(0, i) ≡ i</paragraph> + </bascode> +</section> + +<section id="AppendRow"> + <comment> AppendRow ------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id451582551311490"> + <bookmark_value>Array service;AppendRow</bookmark_value> + </bookmark> + <h2 id="hd_id751582551333335" localize="false">AppendRow</h2> + <paragraph role="paragraph" id="par_id941582551396374">Append to the bottom of a two dimension array a new row. The resulting array has the same lower bounds as the initial two dimension array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id371626976443125"> + <input>svc.AppendRow(array_2d: any[0..*, 0..*], row: any[0..*]): any[0..*, 0..*])</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id631582551461984"><emph>array_2d</emph>: The pre-existing array, may be empty. If that array has 1 dimension, it is considered as the first row of the resulting 2 dimension array.</paragraph> + <paragraph role="paragraph" id="par_id101582551483685"><emph>row</emph>: A 1-dimensional array with as many items as there are columns in <literal>array_2d</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id521582551530025">Dim a As Variant, b As variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id951582551538465">a = SF_Array.AppendRow(Array(1, 2, 3), Array(4, 5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id521582551545445"> ' ((1, 2, 3), (4, 5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431582551552206">b = SF_Array..AppendRow(Array(), Array(1, 2, 3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851582551572028"> ' ∀ i ∈ {0 ≤ i ≤ 2} : b(i, 0) ≡ i</paragraph> + </bascode> +</section> + +<section id="Contains"> + <comment> Contains ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id521582552517869"> + <bookmark_value>Array service;Contains</bookmark_value> + </bookmark> + <h2 id="hd_id21582552517870" localize="false">Contains</h2> + <paragraph role="paragraph" id="par_id391582552517870">Check if a one dimension array contains a certain number, text or date. Text comparison can be case-sensitive or not. + <br/>Sorted input arrays must be filled homogeneously, meaning all items must be scalars of the same type (<literal>Empty</literal> and <literal>Null</literal> items are forbidden). + <br/>The result of the method is unpredictable when the array is announced as sorted and is in reality not. + <br/>A binary search is done when the array is sorted, otherwise, it is simply scanned from top to bottom and <literal>Empty</literal> and <literal>Null</literal> items are ignored.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id641626976688897"> + <input>svc.Contains(array_1d: any[0..*], tofind: any, casesensitive: bool = False, sortorder: str = ""): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id451582552517871"><emph>array_1d</emph>: The array to scan.</paragraph> + <paragraph role="paragraph" id="par_id221582552517872"><emph>tofind</emph>: A number, a date or a string to find.</paragraph> + <paragraph role="paragraph" id="par_id981582552517872"><emph>casesensitive</emph>: Only for string comparisons (Default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id641582553128490"><emph>sortorder</emph>: It can be either "ASC", "DESC" or "" (not sorted). The default value is "".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id651582552517872">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id111582552517872">a = SF_Array.Contains(Array("A","B","c","D"), "C", SortOrder := "ASC") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681582552517872">SF_Array.Contains(Array("A","B","c","D"), "C", CaseSensitive := True) ' False</paragraph> + </bascode> +</section> + +<section id="ConvertToDictionary"> + <comment> ConvertToDictionary ------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id441582557214489"> + <bookmark_value>Array service;ConvertToDictionary</bookmark_value> + </bookmark> + <h2 id="hd_id541582557214489" localize="false">ConvertToDictionary</h2> + <paragraph role="paragraph" id="par_id71582557214489">Store the content of a 2-columns array into a <link href="text/sbasic/shared/03/sf_dictionary.xhp" name="dictionary">ScriptForge.Dictionary</link> object. + <br/>The key will be extracted from the first column, the item from the second.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id291626977283235"> + <input>svc.ConvertToDictionary(array_2d: any[0..*, 0..1]): obj</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id561582557214489"><emph>array_2d</emph>: Data to be converted into a <literal>ScriptForge.Dictionary</literal> object.</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id781626977460310" role="listitem">The first column must contain exclusively strings with a length greater than zero, in any order. These values will be used as labels in the dictionary.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id511626977461127" role="listitem">The second column contains the data that will be associated to the corresponding label in the dictionary.</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id921582557214490">Dim a As Variant, b As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261582557214490">a = SF_Array.AppendColumn(Array("a", "b", "c"), Array(1, 2, 3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931582557802907">b = SF_Array.ConvertToDictionary(a)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421582557214490">MsgBox b.Item("c") ' 3</paragraph> + </bascode> +</section> + +<section id="Copy"> + <comment> Copy --------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id251582558126024"> + <bookmark_value>Array service;Copy</bookmark_value> + </bookmark> + <h2 id="hd_id991627154151529" localize="false">Copy</h2> + <paragraph role="paragraph" id="par_id571627154604275">Creates a copy of a 1D or 2D array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id901627155659667"> + <input>svc.Copy(array_nd: any[0..*]): any[0..*]</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id901627155659568"> + <input>svc.Copy(array_nd: any[0..*, 0..*]): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id191627155816815"><emph>array_nd</emph>: The 1D or 2D array to be copied.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id451627155478940">A simple assignment of an <literal>Array</literal> object will copy its reference instead of creating a copy of the object's contents. See the example below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id881627155939064">Dim a as Variant, b as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71627155939296">a = Array(1, 2, 3)</paragraph> + <paragraph role="bascode" id="bas_id801627155939671">' The assignment below is made by reference</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461627155939477">b = a</paragraph> + <paragraph role="bascode" id="bas_id291627156013810">' Hence changing values in "b" will also change "a"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771627155939894">b(0) = 10</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531627155940118">MsgBox a(0) ' 10</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id701627155874259">By using the <literal>Copy</literal> method, a copy of the whole <literal>Array</literal> object is made. In the example below, <literal>a</literal> and <literal>b</literal> are different objects and changing values in <literal>b</literal> will not affect values in <literal>a</literal>.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id551627156150612">Dim a as Variant, b as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781627156150904">a = Array(1, 2, 3)</paragraph> + <paragraph role="bascode" id="bas_id141627156152196">' Creates a copy of "a" using the "Copy" method</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391627156151116">b = SF_Array.Copy(a)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661627156151494">b(0) = 10</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311627156151972">MsgBox a(0) ' 1</paragraph> + </bascode> +</section> + +<section id="CountDims"> + <comment> CountDims ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id251582558126024"> + <bookmark_value>Array service;CountDims</bookmark_value> + </bookmark> + <h2 id="hd_id761582558126025" localize="false">CountDims</h2> + <paragraph role="paragraph" id="par_id671582558126025">Count the number of dimensions of an array. The result can be greater than two. + <br/>If the argument is not an array, returns -1 + <br/>If the array is not initialized, returns 0.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591626977644227"> + <input>svc.CountDims(array_nd: any): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id771582558126027"><emph>array_nd</emph>: The array to examine.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id661582558126028">Dim a(1 To 10, -3 To 12, 5)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291582558126028">MsgBox SF_Array.CountDims(a) ' 3</paragraph> + </bascode> +</section> + +<section id="Difference"> + <comment> Difference --------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id941582558644286"> + <bookmark_value>Array service;Difference</bookmark_value> + </bookmark> + <h2 id="hd_id21582558644287" localize="false">Difference</h2> + <paragraph role="paragraph" id="par_id91582558644287">Build a set, as a zero-based array, by applying the difference operator on the two input arrays. Resulting items originate from the first array and not from the second. + <br/>The resulting array is sorted in ascending order. + <br/>Both input arrays must be filled homogeneously, their items must be scalars of the same type. <literal>Empty</literal> and <literal>Null</literal> items are forbidden. + <br/>Text comparison can be case sensitive or not.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id311626977822374"> + <input>svc.Difference(array1_1d: any[0..*], array2_1d: any[0..*], casesensitive: bool = False): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id271582558644287"><emph>array1_1d</emph>: A 1-dimensional reference array, whose items are examined for removal.</paragraph> + <paragraph role="paragraph" id="par_id141582558644287"><emph>array2_1d</emph>: A 1-dimensional array, whose items are subtracted from the first input array.</paragraph> + <paragraph role="paragraph" id="par_id291582559651473"><emph>casesensitive</emph>: This argument is only applicable if the arrays are populated with strings (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id141582558644288">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971582560754091">a = SF_Array.Difference(Array("A", "C", "A", "b", "B"), Array("C", "Z", "b"), True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281582560766794"> ' ("A", "B")</paragraph> + </bascode> +</section> + +<section id="ExportToTextFile"> + <comment> ExportToTextFile --------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_iid101582629162107"> + <bookmark_value>Array service;ExportToTextFile</bookmark_value> + </bookmark> + <h2 id="hd_id231586179707778" localize="false">ExportToTextFile</h2> + <paragraph role="paragraph" id="par_id941586179707156">Write all items of the array sequentially to a text file. If the file exists already, it will be overwritten without warning.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701626978046046"> + <input>svc.ExportToTextFile(array_1d: any[0..*], filename: str, [encoding: str]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id100158617970719"><emph>array_1d</emph>: The array to export. It must contain only strings.</paragraph> + <paragraph role="paragraph" id="par_id101586179707232"><emph>filename</emph>: The name of the text file where the data will be written to. The name must be expressed according to the current <literal>FileNaming</literal> property of the <literal>SF_FileSystem</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id70158617970791"><emph>encoding</emph>: The character set that should be used. Use one of the names listed in <link href="https://www.iana.org/assignments/character-sets/character-sets.xhtml" name="IANA character sets">IANA character sets</link>. Note that %PRODUCTNAME may not implement all existing character sets (Default is "UTF-8").</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id551586179707687">SF_Array.ExportToTextFile(Array("A","B","C","D"), "C:\Temp\A short file.txt")</paragraph> + </bascode> +</section> + +<section id="ExtractColumn"> + <comment> ExtractColumn ------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id891582560281081"> + <bookmark_value>Array service;ExtractColumn</bookmark_value> + </bookmark> + <h2 id="hd_id721582560281081" localize="false">ExtractColumn</h2> + <paragraph role="paragraph" id="par_id171582560281082">Extract from a two dimension array a specific column as a new array. + <br/>Its lower <literal>LBound</literal> and upper <literal>UBound</literal> boundaries are identical to that of the first dimension of the input array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id251626978426782"> + <input>svc.ExtractColumn(array_2d: any[0..*, 0..*], columnindex: int): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id301582560281083"><emph>array_2d</emph>: The array from which to extract.</paragraph> + <paragraph role="paragraph" id="par_id421582560281084"><emph>columnindex</emph>: The column number to extract - must be in the interval <literal>[LBound, UBound]</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="bas_id861609975902708">'Creates a 3x3 matrix: |1, 2, 3|</paragraph> + <paragraph role="bascode" localize="false" id="par_id921609975924606">' |4, 5, 6|</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891609975939001">' |7, 8, 9|</paragraph> + <paragraph role="bascode" localize="false" id="par_id511609975955899">Dim mat as Variant, col as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831582560741676">mat = SF_Array.AppendRow(Array(), Array(1, 2, 3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661582560281085">mat = SF_Array.AppendRow(mat, Array(4, 5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941609976001528">mat = SF_Array.AppendRow(mat, Array(7, 8, 9))</paragraph> + <paragraph role="bascode" id="bas_id431609976009994">'Extracts the third column: |3, 6, 9|</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71609976022964">col = SF_Array.ExtractColumn(mat, 2)</paragraph> + </bascode> +</section> + +<section id="ExtractRow"> + <comment> ExtractRow --------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id891582561395261"> + <bookmark_value>Array service;ExtractRow</bookmark_value> + </bookmark> + <h2 id="hd_id921582561457245" localize="false">ExtractRow</h2> + <paragraph role="paragraph" id="par_id211582561467219">Extract from a two dimension array a specific row as a new array. + <br/>Its lower <literal>LBound</literal> and upper <literal>UBound</literal> boundaries are identical to that of the second dimension of the input array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id391626978560113"> + <input>svc.ExtractRow(array_2d: any[0..*, 0..*], rowindex: int): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id911582561542889"><emph>array_2d</emph>: The array from which to extract.</paragraph> + <paragraph role="paragraph" id="par_id441582561551202"><emph>rowindex</emph>: The row number to extract - must be in the interval <literal>[LBound, UBound]</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="bas_id301582561604167">'Creates a 3x3 matrix: |1, 2, 3|</paragraph> + <paragraph role="bascode" localize="false" id="bas_id100158256161206">' |4, 5, 6|</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91609976515742">' |7, 8, 9|</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911609976539433">Dim mat as Variant, row as Variant</paragraph> + <paragraph role="bascode" localize="false" id="par_id921609976603577">mat = SF_Array.AppendRow(Array(), Array(1, 2, 3))</paragraph> + <paragraph role="bascode" localize="false" id="par_id281609976618980">mat = SF_Array.AppendRow(mat, Array(4, 5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="par_id591609976629882">mat = SF_Array.AppendRow(mat, Array(7, 8, 9))</paragraph> + <paragraph role="bascode" id="bas_id431609976648017">'Extracts the first row: |1, 2, 3|</paragraph> + <paragraph role="bascode" localize="false" id="par_id781609976663979">row = SF_Array.ExtractRow(mat, 0)</paragraph> + </bascode> +</section> + +<section id="Flatten"> + <comment> Flatten ------------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id261585757822682"> + <bookmark_value>Array service;Flatten</bookmark_value> + </bookmark> + <h2 id="hd_id351585757822637" localize="false">Flatten</h2> + <paragraph role="paragraph" id="par_id431585757822181">Stack all single items of an array and all items in its subarrays into one new array without subarrays. Empty subarrays are ignored and subarrays with a number of dimensions greater than one are not flattened.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id551626978750851"> + <input>svc.Flatten(array_1d: any[0..*]): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id431585757822869"><emph>array_1d</emph>: The pre-existing array, may be empty.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id231585757822493">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id131585757822885">a = SF_Array.Flatten(Array(Array(1, 2, 3), 4, 5))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631585757822119"> ' (1, 2, 3, 4, 5)</paragraph> + </bascode> + <tip id="par_id291610040786530">You can use the <literal>Flatten</literal> method along with other methods such as <literal>Append</literal> or <literal>Prepend</literal> to concatenate a set of 1D arrays into a single 1D array.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id941610040961148">Next is an example of how the methods <literal>Flatten</literal> and <literal>Append</literal> can be combined to concatenate three arrays.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id841610041372527">'Creates three arrays for this example</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711610041389170">Dim a as Variant, b as Variant, c as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231610041401412">a = Array(1, 2, 3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281610041413482">b = Array(4, 5)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651610041429583">c = Array(6, 7, 8, 9)</paragraph> + <paragraph role="bascode" id="bas_id171610041440657">'Concatenates the three arrays into a single 1D array</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331610041455317">Dim arr as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121610041468254">arr = SF_Array.Flatten(SF_Array.Append(a, b, c))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981610041490008">'(1, 2, 3, 4, 5, 6, 7, 8, 9)</paragraph> + </bascode> +</section> + +<section id="ImportFromCSVFile"> + <comment> ImportFromCSVFile -------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_iid101582629162107"> + <bookmark_value>Array service;ImportFromCSVFile</bookmark_value> + </bookmark> + <h2 id="hd_id581585561482142" localize="false">ImportFromCSVFile</h2> + <paragraph role="paragraph" id="par_id611585561482373">Import the data contained in a comma-separated values (CSV) file. The comma may be replaced by any character.</paragraph> + <paragraph role="paragraph" id="par_id41585562158392">The applicable CSV format is described in <link href="https://tools.ietf.org/html/rfc4180" name="CSV formats">IETF Common Format and MIME Type for CSV Files</link>.</paragraph> + <paragraph role="paragraph" id="par_id641585562341028">Each line in the file contains a full record (line splitting is not allowed). + <br/>However sequences like <literal>\n</literal>, <literal>\t</literal>, ... are left unchanged. Use <literal>SF_String</literal>.Unescape() method to manage them.</paragraph> + <paragraph role="paragraph" id="par_id231585562475026">The method returns a two dimension array whose rows correspond to a single record read in the file and whose columns correspond to a field of the record. No check is made about the coherence of the field types across columns. A best guess will be made to identify numeric and date types.</paragraph> + <paragraph role="paragraph" id="par_id101585562548245">If a line contains less or more fields than the first line in the file, an exception will be raised. Empty lines however are simply ignored. If the size of the file exceeds the number of items limit (see inside the code), a warning is raised and the array is truncated.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id121626979017138"> + <input>svc.ImportFromCSVFile(filename: str, delimiter: str = ',', dateformat: str = ''): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441585561482121"><emph>filename</emph>: The name of the text file containing the data. The name must be expressed according to the current <literal>FileNaming</literal> property of the <literal>SF_FileSystem</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id251585561482929"><emph>delimiter</emph>: A single character, usually, a comma, a semicolon or a TAB character (Default = ",").</paragraph> + <paragraph role="paragraph" id="par_id631585563491559"><emph>dateformat</emph>: A special mechanism handles dates when <literal>dateformat</literal> is either "YYYY-MM-DD", "DD-MM-YYYY" or "MM-DD-YYYY". The dash (-) may be replaced by a dot (.), a slash (/) or a space. Other date formats will be ignored. Dates defaulting to an empty string "" are considered as normal text.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id61585564516409">Consider the CSV file "myFile.csv" with the following contents:</paragraph> + <paragraph role="paragraph" id="par_id281626980354105"><input>Name,DateOfBirth,Address,City</input></paragraph> + <paragraph role="paragraph" id="par_id301626980648833"><input>Anna,2002/03/31,"Rue de l'église, 21",Toulouse</input></paragraph> + <paragraph role="paragraph" id="par_id881626980658900"><input>Fred,1998/05/04,"Rue Albert Einstein, 113A",Carcassonne</input></paragraph> + <paragraph role="paragraph" id="par_id181626979812772">The examples below in Basic and Python read the contents of the CSV file into an <literal>Array</literal> object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id391585561482567">Dim arr As Variant</paragraph> + <paragraph role="bascode" id="bas_id531585561482408">arr = SF_Array.ImportFromCSVFile("C:\Temp\myFile.csv", DateFormat := "YYYY/MM/DD")</paragraph> + <paragraph role="bascode" id="bas_id621585561482783">MsgBox arr(0, 3) ' City</paragraph> + <paragraph role="bascode" id="bas_id21585564425349">MsgBox arr(1, 2) ' Rue de l'église, 21</paragraph> + <paragraph role="bascode" id="bas_id831585564433851">MsgBox arr(1, 3) ' Toulouse</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id851626979992344">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id571626979992587">svc = CreateScriptService("Array")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id821626979992775">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" id="pyc_id511626979992999">arr = svc.ImportFromCSVFile(r"C:\Temp\myFile.csv", dateformat = "YYYY/MM/DD")</paragraph> + <paragraph role="pycode" id="pyc_id211626979993191">bas.MsgBox(arr[0][3]) # City</paragraph> + <paragraph role="pycode" id="pyc_id671626979993408">bas.MsgBox(arr[1][2]) # Rue de l'église, 21</paragraph> + <paragraph role="pycode" id="pyc_id481626979993648">bas.MsgBox(arr[1][3]) # Toulouse</paragraph> + </pycode> +</section> + +<section id="IndexOf"> + <comment> IndexOf ------------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id361582562709465"> + <bookmark_value>Array service;IndexOf</bookmark_value> + </bookmark> + <h2 id="hd_id741582562715741" localize="false">IndexOf</h2> + <paragraph role="paragraph" id="par_id211582562721860">Look in a one dimension array for a number, a string or a date. Text comparison can be case-sensitive or not. + <br/>If the array is sorted it must be filled homogeneously, which means that all items must be scalars of the same type (<literal>Empty</literal> and <literal>Null</literal> items are forbidden). + <br/>The result of the method is unpredictable when the array is announced as sorted and actually is not. + <br/>A binary search is performed on sorted arrays. Otherwise, arrays are simply scanned from top to bottom and <literal>Empty</literal> and <literal>Null</literal> items are ignored. + <br/> + <br/>The method returns <literal>LBound(input array) - 1</literal> if the search was not successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id741626980743030"> + <input>svc.IndexOf(array_1d: any[0..*], tofind: any, casesensitive: bool = False, sortorder: str = ''): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id315825627687760"><emph>array_1d</emph>: The array to scan.</paragraph> + <paragraph role="paragraph" id="par_id511582562775516"><emph>tofind</emph>: A number, a date or a string to find.</paragraph> + <paragraph role="paragraph" id="par_id311582562787187"><emph>casesensitive</emph>: Only for string comparisons (Default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id421582562794501"><emph>sortorder</emph>: It can be either "ASC", "DESC" or "" (not sorted). The default value is "".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id291582562917140">MsgBox SF_Array.IndexOf(Array("A","B","c","D"), "C", SortOrder := "ASC") ' 2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id100158256292397">MsgBox SF_Array.IndexOf(Array("A","B","c","D"), "C", CaseSensitive := True) ' -1</paragraph> + </bascode> +</section> + +<section id="Insert"> + <comment> Insert ------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id371582626951108"> + <bookmark_value>Array service;Insert</bookmark_value> + </bookmark> + <h2 id="hd_id101582626951109" localize="false">Insert</h2> + <paragraph role="paragraph" id="par_id911582626951109">Insert before a given index of the input array the items listed as arguments. + <br/>Arguments are inserted blindly. Each of them might be either a scalar of any type or a subarray.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701626981031599"> + <input>svc.Insert(array_1d: any[0..*], before: int, arg0: any, [arg1: any] ...): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id251582626951111"><emph>array_1d</emph>: The pre-existing array, may be empty.</paragraph> + <paragraph role="paragraph" id="par_id361582626951111"><emph>before</emph>: The index before which to insert; must be in the interval <literal>[LBound, UBound + 1]</literal>.</paragraph> + <paragraph role="paragraph" id="par_id41582626951111"><emph>arg0, arg1, ...</emph>: Items that will be inserted into <literal>array_1d</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id11582626951112">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231582626951113">a = SF_Array.Insert(Array(1, 2, 3), 2, "a", "b")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841582626951113"> ' (1, 2, "a", "b", 3)</paragraph> + </bascode> +</section> + +<section id="InsertSorted"> + <comment> InsertSorted ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id311582627664147"> + <bookmark_value>Array service;InsertSorted</bookmark_value> + </bookmark> + <h2 id="hd_id981582627664147" localize="false">InsertSorted</h2> + <paragraph role="paragraph" id="par_id441582627664147">Inserts into a sorted array a new item on its place. + <br/>The array must be filled homogeneously, meaning that all items must be scalars of the same type. + <br/><literal>Empty</literal> and <literal>Null</literal> items are forbidden.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id561626981419647"> + <input>svc.InsertSorted(array_1d: any[0..*], item: any, sortorder: str = 'ASC', casesensitive: bool = False): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id121582627664147"><emph>array_1d</emph>: The array into which the value will be inserted.</paragraph> + <paragraph role="paragraph" id="par_id315826276641480"><emph>item</emph>: The scalar value to insert, of the same type as the existing array items.</paragraph> + <paragraph role="paragraph" id="par_id415826279771170"><emph>sortorder</emph>: It can be either "ASC" (default) or "DESC".</paragraph> + <paragraph role="paragraph" id="par_id701582627970037"><emph>casesensitive</emph>: Only for string comparisons (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id91582627664148">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31582627664148">a = SF_Array.InsertSorted(Array("A", "C", "a", "b"), "B", CaseSensitive := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831582627664148"> ' ("A", "B", "C", "a", "b")</paragraph> + </bascode> +</section> + +<section id="Intersection"> + <comment> Intersection ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_iid101582629162107"> + <bookmark_value>Array service;Intersection</bookmark_value> + </bookmark> + <h2 id="hd_id841582629169550" localize="false">Intersection</h2> + <paragraph role="paragraph" id="par_id71582629177169">Build a set, as a zero-based array, by applying the intersection set operator on the two input arrays. Resulting items are contained in both arrays. + <br/>The resulting array is sorted in ascending order. + <br/>Both input arrays must be filled homogeneously, in other words all items must be scalars of the same type. <literal>Empty</literal> and <literal>Null</literal> items are forbidden. + <br/>Text comparison can be case sensitive or not.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id91626981727462"> + <input>svc.Intersection(array1_1d: any[0..*], array2_1d: any[0..*], casesensitive: bool = False): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id881582629216169"><emph>array1_1d</emph>: The first input array.</paragraph> + <paragraph role="paragraph" id="par_id191582629223038"><emph>array2_1d</emph>: The second input array.</paragraph> + <paragraph role="paragraph" id="par_id71582629230275"><emph>casesensitive</emph>: Applies to arrays populated with text items (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id331582629257228">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811582629266094">a = SF_Array.Intersection(Array("A", "C", "A", "b", "B"), Array("C", "Z", "b"), True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171582629275916"> ' ("C", "b")</paragraph> + </bascode> +</section> + +<section id="Join2D"> + <comment> Join2D ------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id231583064481294"> + <bookmark_value>Array service;Join2D</bookmark_value> + </bookmark> + <h2 id="hd_id641583064481282" localize="false">Join2D</h2> + <paragraph role="paragraph" id="par_id431583064481679">Join a two-dimensional array with two delimiters, one for the columns, one for the rows.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id421626982116561"> + <input>svc.Join2D(array_2d: any [0..*, 0..*], [columndelimiter: str], [rowdelimiter: str], [quote: str]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821583064481534"><emph>array_2d</emph>: Each item must be either text, a number, a date or a boolean. + <br/>Dates are transformed into the YYYY-MM-DD hh:mm:ss format. + <br/>Invalid items are replaced by a zero-length string.</paragraph> + <paragraph role="paragraph" id="par_id171583066989446"><emph>columndelimiter</emph>: Delimits each column (default = Tab/Chr(9)).</paragraph> + <paragraph role="paragraph" id="par_id431583067008842"><emph>rowdelimiter</emph>: Delimits each row (default = LineFeed/Chr(10))</paragraph> + <paragraph role="paragraph" id="par_id541583067456273"><emph>quote</emph>: If <literal>True</literal>, protect strings with double quotes. The default is <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id991583064481860">' arr = | 1, 2, "A", [2020-02-29], 51, 2, "A", [2020-02-29], 5 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981583064481420">' | 6, 7, "this is a string", 9, 106, 7, "this is a string", 9, 10 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881583064481455">Dim arr as Variant : arr = Array()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id515830644818749">arr = SF_Array.AppendRow(arr, Array(1, 2, "A", [2020-02-29], 51, 2, "A", [2020-02-29], 5))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891583064481120">arr = SF_Array.AppendRow(arr, Array(6, 7, "this is a string", 9, 106, 7, "this is a string", 9, 10))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821626983495205">Dim arrText as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151626983442821">arrText = SF_Array.Join2D(arr, ",", "/", False)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661626982983761">' 1,2,A,,51,2,A,,5/6,7,this is a string,9,106,7,this is a string,9,10</paragraph> + </bascode> +</section> + +<section id="Prepend"> + <comment> Prepend -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id701582629972724"> + <bookmark_value>Array service;Prepend</bookmark_value> + </bookmark> + <h2 id="hd_id931582629986047" localize="false">Prepend</h2> + <paragraph role="paragraph" id="par_id731582630075045">Prepend at the beginning of the input array the items listed as arguments.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id281626997292148"> + <input>svc.Prepend(array_1d: any[0..*], arg0: any, [arg1: any] ...): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id321582630107068"><emph>array_1d</emph>: The pre-existing array, may be empty.</paragraph> + <paragraph role="paragraph" id="par_id915826301138550"><emph>arg0, arg1, ...</emph>: A list of items to prepend to <literal>array_1d</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id321582630131988">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851582630138380">a = SF_Array.Prepend(Array(1, 2, 3), 4, 5)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681582630144971"> ' (4, 5, 1, 2, 3)</paragraph> + </bascode> +</section> + +<section id="PrependColumn"> + <comment> PrependColumn -------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id211582643223924"> + <bookmark_value>Array service;PrependColumn</bookmark_value> + </bookmark> + <h2 id="hd_id25158264322311" localize="false">PrependColumn</h2> + <paragraph role="paragraph" id="par_id91582643223166">Prepend to the left side of a two dimension array a new column. The resulting array has the same lower boundaries as the initial two dimension array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id601626997478388"> + <input>svc.PrependColumn(array_2d: any[0..*, 0..*], column: any[0..*]): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id621582643223545"><emph>array_2d</emph>: The pre-existing array, may be empty. If that array has 1 dimension, it is considered as the last column of the resulting 2 dimension array.</paragraph> + <paragraph role="paragraph" id="par_id381582643223870"><emph>column</emph>: A 1-dimensional array with as many items as there are rows in <literal>array_2d</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id601582643223931">Dim a As Variant, b As variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id28158264322323">a = SF_Array.PrependColumn(Array(1, 2, 3), Array(4, 5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id901582643223295"> ' ((4, 1), (5, 2), (6, 3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361582643223747">b = SF_Array.PrependColumn(Array(), Array(1, 2, 3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821582643223417"> ' ∀ i ∈ {0 ≤ i ≤ 2} : b(0, i) ≡ i</paragraph> + </bascode> +</section> + +<section id="PrependRow"> + <comment> PrependRow ----------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id321582643611165"> + <bookmark_value>Array service;PrependRow</bookmark_value> + </bookmark> + <h2 id="hd_id921582643611272" localize="false">PrependRow</h2> + <paragraph role="paragraph" id="par_id851582643611291">Prepend a new row at the beginning of a 2-dimensional array. The resulting array has the same lower boundaries as the initial 2-dimensional array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id791626997749524"> + <input>svc.PrependRow(array_2d: any[0..*, 0..*], row: any[0..*]): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id991582643611645"><emph>array_2d</emph>: The pre-existing array, may be empty. If that array has 1 dimension, it is considered as the last row of the resulting 2-dimensional array.</paragraph> + <paragraph role="paragraph" id="par_id321582643611415"><emph>row</emph>: A 1-dimensional array containing as many items as there are columns in <literal>array_2d</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id611582643611408">Dim a As Variant, b As variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941582643611530">a = SF_Array.PrependRow(Array(1, 2, 3), Array(4, 5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621582643611876"> ' ((4, 5, 6), (1, 2, 3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791582643611123">b = SF_Array.PrependRow(Array(), Array(1, 2, 3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621582643611263"> ' ∀ i ∈ {0 ≤ i ≤ 2} : b(i, 0) ≡ i</paragraph> + </bascode> +</section> + +<section id="RangeInit"> + <comment> RangeInit ------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id321582648204011"> + <bookmark_value>Array service;RangeInit</bookmark_value> + </bookmark> + <h2 id="hd_id61582648204011" localize="false">RangeInit</h2> + <paragraph role="paragraph" id="par_id441582648204012">Initialize a new zero-based array with numeric values.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id851626997928653"> + <input>svc.RangeInit(from: num, upto: num, [bystep: num]): num[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id591582648204013"><emph>from</emph>: Value of the first item.</paragraph> + <paragraph role="paragraph" id="par_id31582648204013"><emph>upto</emph>: The last item should not exceed <literal>UpTo</literal>.</paragraph> + <paragraph role="paragraph" id="par_id581582648204014"><emph>bystep</emph>: The difference between two successive items (Default = 1).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id341582648204015">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id901582648204015">a = SF_Array.RangeInit(10, 1, -1)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171582648204015"> ' (10, 9, 8, 7, 6, 5, 4, 3, 2, 1)</paragraph> + </bascode> +</section> + +<section id="Reverse"> + <comment> Reverse -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id31582648806764"> + <bookmark_value>Array service;Reverse</bookmark_value> + </bookmark> + <h2 id="hd_id111582648806764" localize="false">Reverse</h2> + <paragraph role="paragraph" id="par_id451582648806764">Return the reversed one dimension input array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id71626998176865"> + <input>svc.Reverse(array_1d: any[0..*]): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id31582648806765"><emph>array_1d</emph>: The array to reverse.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id251582648806765">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31582648806765">a = SF_Array.Reverse(Array("a", 2, 3, 4))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431582648806765"> ' (4, 3, 2, "a")</paragraph> + </bascode> +</section> + +<section id="Shuffle"> + <comment> Shuffle -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id531582649200087"> + <bookmark_value>Array service;Shuffle</bookmark_value> + </bookmark> + <h2 id="hd_id731582649200088" localize="false">Shuffle</h2> + <paragraph role="paragraph" id="par_id151582649200088">Returns a random permutation of a one-dimensional array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id191626998317797"> + <input>svc.Shuffle(array_1d: any[0..*]): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id11582649200088"><emph>array_1d</emph>: The array to shuffle.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id561582649200088">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831582649200088">a = SF_Array.Shuffle(Array(1, 2, 3, 4))</paragraph> + <paragraph role="bascode" id="bas_id611582649200089"> ' Array "a" is now in random order, f.i. (2, 3, 1, 4)</paragraph> + </bascode> +</section> + +<section id="Slice"> + <comment> Slice ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id20158618418514"> + <bookmark_value>Array service;Slice</bookmark_value> + </bookmark> + <h2 id="hd_id281586184185623" localize="false">Slice</h2> + <paragraph role="paragraph" id="par_id111586184185502">Returns a subset of a one-dimensional array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id801626998508832"> + <input>svc.Slice(array_1d: any[0..*], from: int, [upto: int]): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id201586184185438"><emph>array_1d</emph>: The array to slice.</paragraph> + <paragraph role="paragraph" id="par_id921586184482370"><emph>from</emph>: The lower index in <literal>array_1d</literal> of the subarray to extract (<literal>from</literal> included)</paragraph> + <paragraph role="paragraph" id="par_id211586184471488"><emph>upto</emph>: The upper index in <literal>array_1d</literal> of the subarray to extract (<literal>upto</literal> included). The default value is the upper bound of <literal>array_1d</literal>. If <literal>upto</literal> < <literal>from</literal> then the returned array is empty.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id951586184185679">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151586184185884">a = SF_Array.Slice(Array(1, 2, 3, 4, 5), 1, 3) ' (2, 3, 4)</paragraph> + </bascode> +</section> + +<section id="Sort"> + <comment> Sort ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id561582649483854"> + <bookmark_value>Array service;Sort</bookmark_value> + </bookmark> + <h2 id="hd_id65158264948384" localize="false">Sort</h2> + <paragraph role="paragraph" id="par_id171582649483675">Sort a one dimension array in ascending or descending order. Text comparisons can be case-sensitive or not. + <br/>The array must be filled homogeneously, which means that items must be scalars of the same type. + <br/><literal>Empty</literal> and <literal>Null</literal> items are allowed. Conventionally <literal>Empty</literal> < <literal>Null</literal> < any other scalar value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711626998747838"> + <input>svc.Sort(array_1d: any[0..*], sortorder: str, casesensitive: bool = False): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id71158264948346"><emph>array_1d</emph>: The array to sort.</paragraph> + <paragraph role="paragraph" id="par_id21582649483175"><emph>sortorder</emph>: It can be either "ASC" (default) or "DESC".</paragraph> + <paragraph role="paragraph" id="par_id301582649483187"><emph>casesensitive</emph>: Only for string comparisons (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id661582649483468">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391582649483752">a = SF_Array.Sort(Array("a", "A", "b", "B", "C"), CaseSensitive := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711582649483987"> ' ("A", "B", "C", "a", "b")</paragraph> + </bascode> +</section> + +<section id="SortColumns"> + <comment> SortColumns ---------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id51582650186361"> + <bookmark_value>Array service;SortColumns</bookmark_value> + </bookmark> + <h2 id="hd_id20158265018616" localize="false">SortColumns</h2> + <paragraph role="paragraph" id="par_id801582650186957">Return a permutation of the columns of a two dimension array, sorted on the values of a given row. + <br/>The row must be filled homogeneously, which means that all items must be scalars of the same type. + <br/><literal>Empty</literal> and <literal>Null</literal> items are allowed. Conventionally <literal>Empty</literal> < <literal>Null</literal> < any other scalar value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id301626998975171"> + <input>svc.SortColumns(array_2d: any[0..*, 0..*], rowindex: int, sortorder: str, casesensitive: bool = False): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id921582650186869"><emph>array_2d</emph>: The 2-dimensional array to sort.</paragraph> + <paragraph role="paragraph" id="par_id311582650186221"><emph>rowindex</emph>: The index of the row that will be used as reference to sort the columns.</paragraph> + <paragraph role="paragraph" id="par_id34158265018698"><emph>sortorder</emph>: It can be either "ASC" (default) or "DESC".</paragraph> + <paragraph role="paragraph" id="par_id91158265018699"><emph>casesensitive</emph>: Only for string comparisons (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671582650186608">' arr = | 5, 7, 3 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461626999366253">' | 1, 9, 5 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841626999366663">' | 6, 1, 8 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561582650186620">Dim arr as Variant : arr = Array(5, 7, 3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81626999261871">arr = SF_Array.AppendRow(arr, Array(1, 9, 5))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81626999261909">arr = SF_Array.AppendRow(arr, Array(6, 1, 8))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251582650186630">arr = SF_Array.SortColumns(arr, 2, "ASC")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671582650186588">' arr = | 7, 5, 3 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461626999366287">' | 9, 1, 5 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841626999366147">' | 1, 6, 8 |</paragraph> + </bascode> +</section> + +<section id="SortRows"> + <comment> SortRows ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id301582650954674"> + <bookmark_value>Array service;SortRows</bookmark_value> + </bookmark> + <h2 id="hd_id951582650954980" localize="false">SortRows</h2> + <paragraph role="paragraph" id="par_id751582650954576">Return a permutation of the rows of a two dimension array, sorted on the values of a given column. + <br/>The column must be filled homogeneously, therefore all items must be scalars of the same type. + <br/><literal>Empty</literal> and <literal>Null</literal> items are allowed. Conventionally <literal>Empty</literal> < <literal>Null</literal> < any other scalar value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id681626999672323"> + <input>svc.SortRows(array_2d: any[0..*, 0..*], columnindex: int, sortorder: str, casesensitive: bool = False): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id621582650954370"><emph>array_2d</emph>: The array to sort.</paragraph> + <paragraph role="paragraph" id="par_id361582650954796"><emph>columnindex</emph>: The index of the column that will be used as reference to sort the rows.</paragraph> + <paragraph role="paragraph" id="par_id471582650954416"><emph>sortorder</emph>: It can be either "ASC" (default) or "DESC".</paragraph> + <paragraph role="paragraph" id="par_id111582650954690"><emph>casesensitive</emph>: Only for string comparisons (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671582650186902">' arr = | 5, 7, 3 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461626999366144">' | 1, 9, 5 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841626999366532">' | 6, 1, 8 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561582650186071">Dim arr as Variant : arr = Array(5, 7, 3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81626999264376">arr = SF_Array.AppendRow(arr, Array(1, 9, 5))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81626999260021">arr = SF_Array.AppendRow(arr, Array(6, 1, 8))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251582650186954">arr = SF_Array.SortRows(arr, 0, "ASC")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671582650186887">' arr = | 1, 9, 5 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461626999366241">' | 5, 7, 3 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841626999366088">' | 6, 1, 8 |</paragraph> + </bascode> +</section> + +<section id="Transpose"> + <comment> Transpose ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id591582651575793"> + <bookmark_value>Array service;Transpose</bookmark_value> + </bookmark> + <h2 id="hd_id671582651575799" localize="false">Transpose</h2> + <paragraph role="paragraph" id="par_id611582651575637">Swaps rows and columns in a two-dimensional array.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id561627065272658"> + <input>svc.Transpose(array_2d: any[0..*, 0..*]): any[0..*, 0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id61582651575188"><emph>array_2d</emph>: The 2-dimensional array to transpose.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id811582651575482">' arr1 = | 1, 2 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101582651575876">' | 3, 4 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211582651575535">' | 5, 6 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id45158265157597">arr1 = Array(1, 2)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id11627066239364">arr1 = SF_Array.AppendRow(arr1, Array(3, 4))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871627066239592">arr1 = SF_Array.AppendRow(arr1, Array(5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311627066239769">arr2 = SF_Array.Transpose(arr1)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261627066239952">' arr2 = | 1, 3, 5 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661627066240113">' | 2, 4, 6 |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121627066240377">MsgBox arr2(0, 2) ' 5</paragraph> + </bascode> +</section> + +<section id="TrimArray"> + <comment> TrimArray ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id501582652996740"> + <bookmark_value>Array service;TrimArray</bookmark_value> + </bookmark> + <h2 id="hd_id27158265299667" localize="false">TrimArray</h2> + <paragraph role="paragraph" id="par_id181582652996483">Remove from a one dimension array all <literal>Null</literal>, <literal>Empty</literal> and zero-length entries. + <br/>String items are trimmed with %PRODUCTNAME Basic <literal>Trim()</literal> function.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id151627066407801"> + <input>svc.TrimArray(array_1d: any[0..*]): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id111582652996147"><emph>array_1d</emph>: The array to trim.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id471582652996471">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351582652996622">a = SF_Array.TrimArray(Array("A", "B", Null, " D "))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811582652996224"> ' ("A", "B", "D")</paragraph> + </bascode> +</section> + +<section id="Union"> + <comment> Union -------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_iid101582629162107"> + <bookmark_value>Array service;Union</bookmark_value> + </bookmark> + <h2 id="hd_id341582653148202" localize="false">Union</h2> + <paragraph role="paragraph" id="par_id461582653148663">Builds a set, as a zero-based array, by applying the union operator on the two input arrays. Resulting items originate from any of both arrays. + <br/>The resulting array is sorted in ascending order. + <br/>Both input arrays must be filled homogeneously, their items must be scalars of the same type. <literal>Empty</literal> and <literal>Null</literal> items are forbidden. + <br/>Text comparison can be case sensitive or not.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id631627066696377"> + <input>svc.Union(array1_1d: any[0..*], array2_1d: any[0..*], casesensitive: bool = False): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id4715826531488"><emph>array1_1d</emph>: The first input array.</paragraph> + <paragraph role="paragraph" id="par_id51158265314898"><emph>array2_1d</emph>: The second input array.</paragraph> + <paragraph role="paragraph" id="par_id821582653148126"><emph>casesensitive</emph>: Applicable only if the arrays are populated with strings (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id121582653148214">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id341582653148520">a = SF_Array.Union(Array("A", "C", "A", "b", "B"), Array("C", "Z", "b"), True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781582653148659"> ' ("A", "B", "C", "Z", "b")</paragraph> + </bascode> +</section> + +<section id="Unique"> + <comment> Unique ------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_iid101582629162107"> + <bookmark_value>Array service;Unique</bookmark_value> + </bookmark> + <h2 id="hd_id141582653464997" localize="false">Unique</h2> + <paragraph role="paragraph" id="par_id221582653464565">Build a set of unique values derived from the input array. + <br/>The input array must be filled homogeneously, its items must be scalars of the same type. <literal>Empty</literal> and <literal>Null</literal> items are forbidden. + <br/>Text comparison can be case sensitive or not.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id781627066899997"> + <input>svc.Unique(array_1d: any[0..*], casesensitive: bool = False): any[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id521582653464553"><emph>array_1d</emph>: The input array.</paragraph> + <paragraph role="paragraph" id="par_id41158265346441"><emph>casesensitive</emph>: Applicable only if the array is populated with strings (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id991582653464938">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441582653464779">a = SF_Array.Unique(Array("A", "C", "A", "b", "B"), CaseSensitive := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881582653464236"> ' ("A", "B", "C", "b")</paragraph> + </bascode> +</section> + +<embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + +<section id="relatedtopics"> + <embed href="text/scalc/01/04060107.xhp#arrayfunctit"/> + <embed href="text/sbasic/shared/calc_functions.xhp#CallingCalcFunctionsh1"/> + <embed href="text/sbasic/shared/03/sf_dictionary.xhp#SFDictionary"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_base.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_base.xhp new file mode 100644 index 000000000..ee0f5b2e8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_base.xhp @@ -0,0 +1,372 @@ +<?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_FormControl" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDocuments.Base service</title> + <filename>/text/sbasic/shared/03/sf_base.xhp</filename> + </topic> +</meta> + +<body> +<section id="abstract"> + <bookmark localize="false" branch="index" id="bm_id41582391760252"> + <bookmark_value>Base service</bookmark_value> + </bookmark> + <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="ctrls_h1"><link href="text/sbasic/shared/03/sf_base.xhp" name="SFDocuments.Base service"><literal>SFDocuments</literal>.<literal>Base</literal> service</link></variable></h1> + + <paragraph role="paragraph" id="par_id901619031958273">The <literal>Base</literal> service provides a number of methods and properties to facilitate the management and handling of %PRODUCTNAME Base documents.</paragraph> + <paragraph role="paragraph" id="par_id961619032060880">This service is closely related to the <literal>Document</literal> service, which provides generic methods for handling %PRODUCTNAME documents, including Base documents. Hence, the <literal>Base</literal> service extends the <literal>Document</literal> service and provides additional methods that are specific for Base documents, enabling users to:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id241619032289964" role="listitem">Get access to the database contained in a Base document.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id291619032292829" role="listitem">Open form documents stored in a Base document.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id421619032296454" role="listitem">Check if a form document from a Base document is currently loaded.</paragraph> + </listitem> +</list> +</section> + + <tip id="par_id241619032941497">Refer to the <link href="text/sbasic/shared/03/sf_document.xhp" name="Document Service"><literal>Document</literal> service</link> to learn more about methods and properties that can be used to manage %PRODUCTNAME documents.</tip> + + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Base</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id311619033224680">The Base service can be invoked in a variety of ways. The code snippet below uses the method <literal>CreateBaseDocument</literal> from the <literal>UI</literal> service to create a new Base file.</paragraph> + <paragraph role="paragraph" id="par_id101619033666470">Note that in all examples the object <literal>oDoc</literal> is an instance of the <literal>Base</literal> service.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id791619033406225">Dim ui As Object, oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321619033409042">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101619033409330">Set oDoc = ui.CreateBaseDocument("C:\Documents\MyFile.odb")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id281619033570656">The <literal>Base</literal> service can also be instantiated while opening an existing Base file, as shown below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id941619033409619">Set oDoc = ui.OpenBaseDocument("C:\Documents\MyFile.odb")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id331619033713781">If a Base document is already open, it is possible to instantiate the <literal>Base</literal> service directly:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id401619033791704">Dim oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21619033791983">Set oDoc = CreateScriptService("SFDocuments.Document", "MyFile.odb")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id871623102536956">The examples above can be translated to Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id401623102395018">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id311623102395289">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id561623102422597">doc = ui.CreateBaseDocument(r"C:\Documents\MyFile.odb")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id971623102443669">doc = ui.OpenBaseDocument(r"C:\Documents\MyFile.odb")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731623102477036">doc = CreateScriptService("SFDocuments.Document", "MyFile.odb")</paragraph> + </pycode> + <note id="par_id281619619980185">The use of the <emph>"SFDocuments."</emph> substring in the previous example is optional.</note> + +<table id="tab_id101619034669263"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id451619034669263" role="tablehead">List of Methods in the Base Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id981619034669263" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_base.xhp#CloseFormDocument" name="CloseFormDocument method">CloseFormDocument</link><br/> + <link href="text/sbasic/shared/03/sf_base.xhp#FormDocuments" name="FormDocuments method">FormDocuments</link><br/> + <link href="text/sbasic/shared/03/sf_base.xhp#Forms" name="Forms method">Forms</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721619034669263" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_base.xhp#GetDatabase" name="GetDatabase method">GetDatabase</link><br/> + <link href="text/sbasic/shared/03/sf_base.xhp#IsLoaded" name="IsLoaded method">IsLoaded</link><br/> + <link href="text/sbasic/shared/03/sf_base.xhp#OpenFormDocument" name="OpenFormDocument method">OpenFormDocument</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711619034669263" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_base.xhp#PrintOut" name="PrintOut method">PrintOut</link><br/> + <link href="text/sbasic/shared/03/sf_base.xhp#SetPrinter" name="SetPrinter method">SetPrinter</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> +</table> + +<section id="CloseFormDocument"> + <comment> CloseFormDocument ------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id341609135528912" localize="false"> + <bookmark_value>Base service;CloseFormDocument</bookmark_value> + </bookmark> + <h2 id="hd_id61161309632927" localize="false">CloseFormDocument</h2> + <paragraph role="paragraph" id="par_id801916099743199">Closes the given form document. Returns <literal>True</literal> if closure is successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id71613205516650"> + <input>svc.CloseFormDocument(formdocument: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id941619079997810"><emph>formdocument:</emph> The name of the <literal>FormDocument</literal> to be closed, as a case-sensitive string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id351619100723505">If form documents are organized in folders, it is necessary to include the folder name to specify the form document to be opened, as illustrated in the following examples:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id461619100382712">oDoc.CloseFormDocument("Folder1/myFormDocument")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id361623165059717">doc.CloseFormDocument('Folder1/myFormDocument')</paragraph> + </pycode> +</section> + +<section id="FormDocuments"> + <comment> FormDocuments --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id401619035409457" localize="false"> + <bookmark_value>Base service;FormDocuments</bookmark_value> + </bookmark> + <h2 id="hd_id841619035592745" localize="false">FormDocuments</h2> + <paragraph role="paragraph" id="par_id481619036833610">Returns an array with the full names (path/name) of all form documents in the Base document as a zero-based Array of strings.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id401623103182304"> + <input>svc.FormDocuments(): str[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id431619037334440">The code snippet below prints the names of all form documents in the current Base document.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id121619036825329">Dim oDoc as Object, myForms as Object, formName as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371619037281873">Set oDoc = CreateScriptService("Document", ThisDataBaseDocument)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801619037282145">Set myForms = oDoc.FormDocuments()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851619037282401">For Each formName In myForms</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531619037282633"> MsgBox formName</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851619037282890">Next formName</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id691623103639534">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id101623103639206">doc = CreateScriptService("Document", bas.ThisDataBaseDocument)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id901623103639390">myForms = doc.FormDocuments()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id791623103639701">for formName in myForms:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id741623103639861"> bas.MsgBox(formName)</paragraph> + </pycode> + <tip id="par_id921619036922844">To learn more about form documents, refer to the <link href="text/sbasic/shared/03/sf_form.xhp" name="Form service"><literal>Form</literal> service help page</link>.</tip> +</section> + +<section id="Forms"> + <comment> Forms ---------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id861619035438484" localize="false"> + <bookmark_value>Base service;Forms</bookmark_value> + </bookmark> + <h2 id="hd_id291619035603979" localize="false">Forms</h2> + <paragraph role="paragraph" id="par_id191619037523467">Depending on the parameters provided this method will return:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id781619037575043" role="listitem">A zero-based Array with the names of all the forms contained in a form document (if the <literal>Form</literal> argument is absent)</paragraph> + </listitem> + <listitem> + <paragraph id="par_id111619037577804" role="listitem">A <literal>SFDocuments.Form</literal> object representing the form specified in the <literal>Form</literal> argument.</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id851623104561457"> + <input>svc.Forms(formdocument: str): str[0..*]</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id851623104560857"> + <input>svc.Forms(formdocument: str, form: str = ''): svc</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id851623104562213"> + <input>svc.Forms(formdocument: str, form: int): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id861619037838260"><emph>formdocument:</emph> The name of a valid form document as a case-sensitive string.</paragraph> + <paragraph role="paragraph" id="par_id281619037857187"><emph>form:</emph> The name or index number of the form stored in the form document. If this argument is absent, the method will return a list with the names of all forms available in the form document.</paragraph> + <note id="par_id921619437863617">Although it is possible to use index numbers to refer to forms, this is only recommended when there is just one form in the form document. If there are two or more forms, it is preferable to use the form name instead.</note> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id21623104676805">The first line of the example below returns a list of all forms in the form document "myFormDocument". The second line returns an instance of the Form service representing the form "myForm".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id741619200190900">Dim formsList as Object : formsList = oDoc.Forms("myFormDocument")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491619200288742">Dim oForm as Object : oForm = oDoc.Forms("myFormDocument", "myForm")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id431623104770698">formsList = doc.Forms("myFormDocument")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id271623104770978">form = doc.Forms("myFormDocument", "myForm")</paragraph> + </pycode> +</section> + +<section id="GetDatabase"> + <comment> GetDatabase ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id301619035470065" localize="false"> + <bookmark_value>Base service;GetDatabase</bookmark_value> + </bookmark> + <h2 id="hd_id111619035612996" localize="false">GetDatabase</h2> + <paragraph role="paragraph" id="par_id371619098340303">Returns an instance of the <link href="text/sbasic/shared/03/sf_database.xhp" name="Database service"><literal>Database</literal> service</link> that allows the execution of SQL commands on the database defined and/or stored in the current Base document</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id431623105245851"> + <input>svc.GetDatabase(user: str = '', password: str = ''): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id731619098073221"><emph>user, password:</emph> Optional login parameters as strings. The default value for both parameters is an empty string "".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id1001599408773502">Dim myDoc As Object, myDatabase As Object, ui As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631599408779968">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801599408784337">Set myDoc = ui.OpenBaseDocument("C:\Documents\myDb.odb")</paragraph> + <paragraph role="bascode" id="bas_id631615147843278">' User and password are supplied below, if needed</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741599408788321">Set myDatabase = myDoc.GetDatabase()</paragraph> + <paragraph role="bascode" id="bas_id921599408791887">' ... Run queries, SQL statements, ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id...">myDatabase.CloseDatabase()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251599408799447">myDoc.CloseDocument()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id851623104860711">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391623104860891">myDoc = ui.OpenBaseDocument(r"C:\Documents\myDb.odb")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871623104861054">myDatabase = myDoc.GetDatabase()</paragraph> + <paragraph role="pycode" id="pyc_id351623104861223"># ... Run queries, SQL statements, ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id581623104861438">myDatabase.CloseDatabase()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id751623104861711">myDoc.CloseDocument()</paragraph> + </pycode> +</section> + +<section id="IsLoaded"> + <comment> IsLoaded -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id351619035498660" localize="false"> + <bookmark_value>Base service;IsLoaded</bookmark_value> + </bookmark> + <h2 id="hd_id621619035622085" localize="false">IsLoaded</h2> + <paragraph role="paragraph" id="par_id871619098478513">Returns <literal>True</literal> if the specified <literal>FormDocument</literal> is currently open.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id831623105309694"> + <input>svc.IsLoaded(formdocument: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id981619098545701"><emph>formdocument:</emph> The name of a <literal>FormDocument</literal> to be checked, as a case-sensitive string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id271619098642739">If Not oDoc.IsLoaded("myFormDocument") Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271619099499790"> oDoc.OpenFormDocument("myFormDocument")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id301619099500376">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id871623105432127">if not doc.IsLoaded("myFormDocument"):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id401623105432534"> doc.OpenFormDocument("myFormDocument")</paragraph> + </pycode> +</section> + +<section id="OpenFormDocument"> + <comment> OpenFormDocument ------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id341619035528912" localize="false"> + <bookmark_value>Base service;OpenFormDocument</bookmark_value> + </bookmark> + <h2 id="hd_id611619035632927" localize="false">OpenFormDocument</h2> + <paragraph role="paragraph" id="par_id801619099743199">Opens the specified <literal>FormDocument</literal> either in normal or in design mode.</paragraph> + <paragraph role="paragraph" id="par_id451619100075330">If the form document is already open, it is activated without changing its mode. The method returns <literal>True</literal> if the form document could be opened.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id71623105516650"> + <input>svc.OpenFormDocument(formdocument: str, designmode: bool = False): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id941619099797810"><emph>formDocument:</emph> The name of the <literal>FormDocument</literal> to be opened, as a case-sensitive string.</paragraph> + <paragraph role="paragraph" id="par_id981619099816849"><emph>designmode:</emph> If this argument is <literal>True</literal> the <literal>FormDocument</literal> will be opened in design mode.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id251619100191992">Most form documents are stored in the root of the Base document and they can be opened simply using their names, as in the example below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id461619100283210">oDoc.OpenFormDocument("myFormDocument")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id351619100327505">If form documents are organized in folders, it becomes necessary to include the folder name to specify the form document to be opened, as illustrated in the following example:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id461619100283712">oDoc.OpenFormDocument("myFolder/myFormDocument")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id361623105659717">doc.OpenFormDocument("myFormDocument")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id361623105659616">doc.OpenFormDocument("myFolder/myFormDocument")</paragraph> + </pycode> +</section> + +<section id="PrintOut"> + <comment> PrintOut ---------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721985200121249"> + <bookmark_value>Base service;PrintOut</bookmark_value> + </bookmark> + <h2 id="hd_id261589202101415" localize="false">PrintOut</h2> + <paragraph role="paragraph" id="par_id156589200121138">This method sends the content of the given form document to a default printer or a printer defined by the <literal>SetPrinter()</literal> method.</paragraph> + <paragraph role="paragraph" id="par_id981611169416934">Returns <literal>True</literal> if the document was successfully printed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001622827822169"> + <input>svc.PrintOut(opt formdocument: str, pages: str = "", copies: num = 1): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id368519200121646"><emph>formdocument</emph>: A valid document form name as a case-sensitive string. The form document must be open. It is activated by the method.</paragraph> + <paragraph role="paragraph" id="par_id211635436910093"><emph>pages</emph>: The pages to print as a string, like in the user interface. Example: "1-4;10;15-18". Default is all pages.</paragraph> + <paragraph role="paragraph" id="par_id141635436912146"><emph>copies</emph>: The number of copies. Default is 1.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891589200121516">If oDoc.PrintOut("myForm", "1-4;10;15-18", Copies := 2) Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id515892500606125"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751682227903730">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731622728946898">if doc.PrintOut('myForm', copies=3, pages='45-88'):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221628227947414"> # ...</paragraph> + </pycode> +</section> + +<section id="SetPrinter"> + <comment> SetPrinter ------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id71158921504765"> + <bookmark_value>Base service;SetPrinter</bookmark_value> + </bookmark> + <h2 id="hd_id811589502147824" localize="false">SetPrinter</h2> + <paragraph role="paragraph" id="par_id911298505147502">Define the printer options for a form document. The form document must be open.</paragraph> + <paragraph role="paragraph" id="par_id381651114800685">Returns <literal>True</literal> when successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id261652828596855"> + <input>svc.SetPrinter(opt formdocument: str, opt printer: str, opt orientation: str, paperformat: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id961635950394507"><emph>formdocument</emph>: A valid document form name as a case-sensitive string.</paragraph> + <embed href="text/sbasic/shared/03/sf_document.xhp#setPrinterArgs"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id431589204157164">oDoc.SetPrinter("myForm", Orientation := "PORTRAIT")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941628229095519">doc.SetPrinter('myForm', paperformat='TABLOID')</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_database.xhp#DatabaseService"/> + <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> + <embed href="text/sbasic/shared/03/sf_form.xhp#FormService"/> + <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_basic.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_basic.xhp new file mode 100644 index 000000000..300838e7b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_basic.xhp @@ -0,0 +1,659 @@ +<?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_Document" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.Basic service</title> + <filename>/text/sbasic/shared/03/sf_basic.xhp</filename> + </topic> +</meta> +<body> +<section id="ScriptForge-sf_basic"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id261582733781987"> + <bookmark_value>Basic service</bookmark_value> + </bookmark> +</section> +<section id="abstract"> + <h1 id="hd_id731582733781114" xml-lang="en-US"><variable id="BasicService"><link href="text/sbasic/shared/03/sf_basic.xhp" name="Basic service"><literal>ScriptForge</literal>.<literal>Basic</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id381589189355849" xml-lang="en-US">The <literal>ScriptForge.Basic</literal> service proposes a collection of %PRODUCTNAME Basic methods to be executed in a Python context. <literal>Basic</literal> service methods reproduce the exact syntax and behaviour of Basic builtin functions. +</paragraph> +</section> + <paragraph role="paragraph" id="par_id591589189364267" xml-lang="en-US">Typical example:</paragraph> + <pycode> + <paragraph role="pycode" id="pyc_id971618493778666">bas.MsgBox('Display this text in a message box from a Python script')</paragraph> + </pycode> + <warning id="par_id151618849022977"><literal>ScriptForge</literal>.<literal>Basic</literal> service is limited to Python scripts.</warning> + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <note id="par_id141610734722352">Before using the <literal>Basic</literal> service, import the <literal>CreateScriptService()</literal> method from the <literal>scriptforge</literal> module:</note> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id551610734764343">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121618496552817">bas = CreateScriptService("Basic")</paragraph> + </pycode> + <h2 id="hd_id201618922972557">Properties</h2> + <table id="tab_id991618922991909"> + <tablerow> + <tablecell><paragraph id="par_id401618922991909" role="tablehead">Name</paragraph></tablecell> + <tablecell><paragraph id="par_id591618922991909" role="tablehead">ReadOnly</paragraph></tablecell> + <tablecell><paragraph id="par_id211618922991909" role="tablehead">Type</paragraph></tablecell> + <tablecell><paragraph id="par_id971618923022846" role="tablehead">Description</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id541619003984227" localize="false" role="tablecontent">MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21619004009875" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111619004011627" localize="false" role="tablecontent">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id791619004012484" role="tablecontent">Values: 0, 1, 5, 4, 3</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161619003998035" localize="false" role="tablecontent">MB_ICONEXCLAMATION, MB_ICONINFORMATION, MB_ICONQUESTION, MB_ICONSTOP</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201619004097755" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981619004098700" localize="false" role="tablecontent">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311619004099683" role="tablecontent">Values: 48, 64, 32, 16<br/></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831618922991909" localize="false" role="tablecontent">MB_ABORTRETRYIGNORE, MB_DEFBUTTON1, MB_DEFBUTTON2, MB_DEFBUTTON3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581618922991909" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161618922991910" localize="false" role="tablecontent">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211618923312141" role="tablecontent">Values: 2, 128, 256, 512</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471618924470655" localize="false" role="tablecontent">IDABORT, IDCANCEL, IDIGNORE, IDNO, IDOK, IDRETRY, IDYES</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961618924503848" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571618924505303" localize="false" role="tablecontent">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id871618924506654" role="tablecontent">Values: 3, 2, 5, 7, 1, 4, 6<br/>Constants indicating <literal>MsgBox</literal> selected button.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id421619006246768" localize="false" role="tablecontent">StarDesktop</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619006254384" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711619006255184" role="tablecontent">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541619006255653" role="tablecontent"><link href="text/sbasic/shared/stardesktop.xhp" name="StarDesktop"><literal>StarDesktop</literal></link> object represents %PRODUCTNAME Start Center.</paragraph> + </tablecell> + </tablerow> + </table> + <table id="tab_id901611086279902"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Basic Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_basic.xhp#CDate" name="CDate method">CDate</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#CDateFromUnoDateTime" name="CDateFromUnoDateTime method">CDateFromUnoDateTime</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#CDateToUnoDateTime" name="CDateToUnoDateTime method">CDateToUnoDateTime</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#ConvertFromUrl" name="ConvertFromUrl method">ConvertFromUrl</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#ConvertToUrl" name="ConvertToUrl method">ConvertToUrl</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#CreateUnoService" name="CreateUnoService method">CreateUnoService</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#DateAdd" name="DateAdd method">DateAdd</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#DateDiff" name="DateDiff method">DateDiff</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#DatePart" name="DatePart method">DatePart</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_basic.xhp#DateValue" name="DateValue method">DateValue</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#Format" name="Format method">Format</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#GetDefaultContext" name="GetDefaultContext method">GetDefaultContext</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#GetGuiType" name="GetGuiType method">GetGuiType</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#GetPathSeparator" name="GetPathSeparator method">GetPathSeparator</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#GetSystemTicks" name="GetSystemTicks method">GetSystemTicks</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#BasicLibraries" name="BasicLibraries method">GlobalScope.BasicLibraries</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#DialogLibraries" name="DialogLibraries method">GlobalScope.DialogLibraries</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#InputBox" name="InputBox method">InputBox</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086279903" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_basic.xhp#MsgBox" name="MsgBox method">MsgBox</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#Now" name="Now method">Now</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#RGB" name="RGB method">RGB</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#ThisComponent" name="ThisComponent method">ThisComponent</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#ThisDatabaseDocument" name="ThisDatabaseDocument method">ThisDatabaseDocument</link><br/> + <link href="text/sbasic/shared/03/sf_basic.xhp#Xray" name="Xray method">Xray</link><br/><br/><br/><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + +<section id="CDate"> + <comment> CDate ------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969187"> + <bookmark_value>Basic service;CDate</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698020" localize="false">CDate</h2> + <paragraph role="paragraph" id="par_id71621894830071">Converts a numeric expression or a string to a <literal>datetime</literal>.<literal>datetime</literal> Python native object.</paragraph> + <note id="par_id431621896441258">This method exposes the Basic builtin function <link href="text/sbasic/shared/03100300.xhp" name="CDate_Basic">CDate</link> to Python scripts.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897208785"> + <input>svc.CDate(expression: any): obj</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401621896675880"><emph>expression</emph>: a numeric expression or a string representing a date.</paragraph> + <embed href="text/sbasic/shared/03100300.xhp#CDate_str_date"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761621898860952">d = bas.CDate(1000.25)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id861621898933001">bas.MsgBox(str(d)) # 1902-09-26 06:00:00</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871621898933281">bas.MsgBox(d.year) # 1902</paragraph> + </pycode> +</section> + +<section id="CDateFromUnoDateTime"> + <comment> CDateFromUnoDateTime ------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969335"> + <bookmark_value>Basic service;CDateFromUnoDateTime</bookmark_value> + </bookmark> + <h2 id="hd_id201589199691468" localize="false">CDateFromUnoDateTime</h2> + <paragraph role="paragraph" id="par_id481621950748686">Converts a UNO date/time representation to a <literal>datetime.datetime</literal> Python native object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id691621950580345"> + <input>svc.CDateFromUnoDateTime(unodate: uno): obj</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id41621950816227"><emph>unodate</emph>: A UNO date/time object of one of the following types: <literal>com.sun.star.util.DateTime</literal>, <literal>com.sun.star.util.Date</literal> or <literal>com.sun.star.util.Time</literal></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id281621952224847">The following example creates a <literal>com.sun.star.util.DateTime</literal> object and converts it to a <literal>datetime.datetime</literal> Python object.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id651621951946709">import uno</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id931621951947749">uno_date = uno.createUnoStruct('com.sun.star.util.DateTime')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id711621951947956">uno_date.Year = 1983</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id1001621951948124">uno_date.Month = 2</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id201621951948284">uno_date.Day = 23</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id911621952103058">new_date = bas.CDateFromUnoDateTime(uno_date)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id951621952103813">bas.MsgBox(str(new_date)) # 1983-02-23 00:00:00</paragraph> + </pycode> +</section> + +<section id="CDateToUnoDateTime"> + <comment> CDateToUnoDateTime ------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919967133"> + <bookmark_value>Basic service;CDateToUnoDateTime</bookmark_value> + </bookmark> + <h2 id="hd_id201589199690087" localize="false">CDateToUnoDateTime</h2> + <paragraph role="paragraph" id="par_id741621952469980">Converts a date representation into a <literal>com.sun.star.util.DateTime</literal> object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id691621950580116"> + <input>svc.CDateToUnoDateTime(date: obj): uno</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id511621952524000"><emph>date</emph>: A Python date/time object of one of the following types: <literal>datetime.datetime</literal>, <literal>datetime.date</literal>, <literal>datetime.time</literal>, <literal>float (time.time)</literal> or <literal>time.struct_time</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id131621952700723">from datetime import datetime</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391621952700963">current_datetime = datetime.now()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941621952701150">uno_date = bas.CDateToUnoDateTime(current_datetime)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id191621952701458">bas.MsgBox(str(uno_date.Year) + "-" + str(uno_date.Month) + "-" + str(uno_date.Day))</paragraph> + </pycode> +</section> + +<section id="ConvertFromUrl"> + <comment> ConvertFromUrl ------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969883"> + <bookmark_value>Basic service;ConvertFromUrl</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698251" localize="false">ConvertFromUrl</h2> + <paragraph role="paragraph" id="par_id93158919969864">Returns a system path file name for the given <literal>file:</literal> URL.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id201618496409224"><input>svc.ConvertFromUrl(url: str): str</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id321618502481706"> <emph>url</emph>: An absolute <literal>file:</literal> URL.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id81618502493505">A system path file name.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id41158919969836">filename = bas.ConvertFromUrl( "file:///C:/Program%20Files%20(x86)/LibreOffice/News.txt")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id881611147617212">bas.MsgBox(filename)</paragraph> + </pycode> +</section> + +<section id="ConvertToUrl"> + <comment> ConvertToUrl --------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721589200121249"> + <bookmark_value>Basic service;ConvertToUrl</bookmark_value> + </bookmark> + <h2 id="hd_id261589210021415" localize="false">ConvertToUrl</h2> + <paragraph role="paragraph" id="par_id658519200121138">Returns a <literal>file:</literal> URL for the given system path.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id761618501052294" localize="false"><input>svc.ConvertToUrl(systempath: str): str</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401618521015903"><emph>systempath</emph>: A system file name as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id61658101307414">A <literal>file:</literal> URL as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id891985200121516">url = bas.ConvertToUrl( 'C:\Program Files(x86)\LibreOffice\News.txt')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id51589200605125">bas.MsgBox(url)</paragraph> + </pycode> +</section> + +<section id="CreateUnoService"> + <comment> CreateUnoService ----------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721589200121249"> + <bookmark_value>Basic service;CreateUnoService</bookmark_value> + </bookmark> + <h2 id="hd_id261589200121415" localize="false">CreateUnoService</h2> + <paragraph role="paragraph" id="par_id651589200121138">Instantiates a UNO service with the <literal>ProcessServiceManager</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id221618556258876" localize="false"><input>svc.CreateUnoService(servicename: str): uno</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id361589200121646"><emph>servicename</emph>: A fully qualified service name such as <literal>com.sun.star.ui.dialogs.FilePicker</literal> or <literal>com.sun.star.sheet.FunctionAccess</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="bascode" localize="false" id="pyc_id891589200121516">dsk = bas.CreateUnoService('com.sun.star.frame.Desktop')</paragraph> + </pycode> +</section> + +<section id="DateAdd"> + <comment> DateAdd -------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id311599410266448"> + <bookmark_value>Basic service;DateAdd</bookmark_value> + </bookmark> + <h2 id="hd_id91599410266599" localize="false">DateAdd</h2> + <paragraph role="paragraph" id="par_id901599410483300" xml-lang="en-US">Adds a date or time interval to a given date/time a number of times and returns the resulting date.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id771618557939013" localize="false"><input>svc.DateAdd(interval: str, number: num, date: datetime): datetime</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id581618562143601"> <emph>interval</emph>: A string expression from the following table, specifying the date or time interval.</paragraph> + <embed href="text/sbasic/shared/03030110.xhp#datetable"/> + <paragraph role="paragraph" id="par_id281618562144897"><emph>number</emph>: A numerical expression specifying how often the <literal>interval</literal> value will be added when positive or subtracted when negative.</paragraph> + <paragraph role="paragraph" id="par_id811618561843272"><emph>date</emph>: A given <literal>datetime.datetime</literal> value, the <literal>interval</literal> value will be added <literal>number</literal> times to this <literal>datetime.datetime</literal> value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id181618561778320">A <literal>datetime.datetime</literal> value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id961618558341526">dt = datetime.datetime(2004, 1, 31)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id891599410846998">dt = bas.DateAdd("m", 1, dt)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id621599410266932">print(dt)</paragraph> + </pycode> +</section> + +<section id="DateDiff"> + <comment> DateDiff ------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id601589202413561"> + <bookmark_value>Basic service;DateDiff</bookmark_value> + </bookmark> + <h2 id="hd_id611589202413141" localize="false">DateDiff</h2> + <paragraph role="paragraph" id="par_id991589202413257">Returns the number of date or time intervals between two given date/time values.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id441618562866810" localize="false"><input>svc.DateDiff(interval: str, date1: datetime, date2: datetime, firstdayofweek = 1, firstweekofyear = 1): int</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481618563770490"><emph>interval</emph>: A string expression specifying the date interval, as detailed in above <literal>DateAdd</literal> method.</paragraph> + <paragraph role="paragraph" id="par_id121618563772932"><emph>date1</emph>, <emph>date2</emph>: The two <literal>datetime.datetime</literal> values to be compared.</paragraph> + <embed href="text/sbasic/shared/03030120.xhp#weekyear"/> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id121618563454738">A number.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id401611153339973">date1 = datetime.datetime(2005,1, 1)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121589202413630">date2 = datetime.datetime(2005,12,31)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id641618564383315">diffDays = bas.DateDiff('d', date1, date2)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151618564392035">print(diffDays)</paragraph> + </pycode> +</section> + +<section id="DatePart"> + <comment> DatePart ------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id691589202925124"> + <bookmark_value>Basic service;DatePart</bookmark_value> + </bookmark> + <h2 id="hd_id3615892029256" localize="false">DatePart</h2> + <paragraph role="paragraph" id="par_id81589202925519">The <literal>DatePart</literal> function returns a specified part of a date.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id761618670376341"><input>svc.DatePart(interval: str, date: datetime, firstdayofweek = 1, firstweekofyear = 1): int</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id761618672192231"><emph>interval</emph>: A string expression specifying the date interval, as detailed in above <literal>DateAdd</literal> method.</paragraph> + <paragraph role="paragraph" id="par_id61618672313838"><emph>date</emph>: The date/time from which the result is calculated.</paragraph> + <paragraph role="paragraph" id="par_id511619445271897"><emph>firstdayofweek, firstweekofyear</emph>: optional parameters that respectively specify the starting day of a week and the starting week of a year, as detailed in above <literal>DateDiff</literal> method.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id791618672371743">The extracted part for the given date/time.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="bascode" localize="false" id="pyc_id31589202925376">print(bas.DatePart("ww", datetime.datetime(2005,12,31)</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id821589203188905">print(bas.DatePart('q', datetime.datetime(1999,12,30)</paragraph> + </pycode> +</section> + +<section id="DateValue"> + <comment> DateValue ------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141589203370367"> + <bookmark_value>Basic service;DateValue</bookmark_value> + </bookmark> + <h2 id="hd_id161589203370594" localize="false">DateValue</h2> + <paragraph role="paragraph" id="par_id121589203370778">Computes a date value from a date string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id721618673403017"><input>svc.DateValue(date: str): datetime</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <embed href="text/sbasic/shared/03030102.xhp#parm1"/> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id441618674018955">The computed date.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id81589203370943">dt = bas.DateValue("23-02-2011")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id931618674563379">print(dt)</paragraph> + </pycode> +</section> + +<section id="Format"> + <comment> Format --------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id71158920514765"> + <bookmark_value>Basic service;Format</bookmark_value> + </bookmark> + <h2 id="hd_id811529844547824" localize="false">Format</h2> + <paragraph role="paragraph" id="par_id458161678389887">Converts a number to a string, and then formats it according to the format that you specify.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id901618678405855" localize="false"><input>svc.Format(expression: any, format = ''): str</input></paragraph> + <embed href="text/sbasic/shared/03120301.xhp#ValueParms"/> + <h3 id="hd_id751618825527776">Formatting Codes</h3> + <embed href="text/sbasic/shared/03120301.xhp#codes"/> + <h3 id="hd_id681618825574599">Predefined Formats</h3> + <embed href="text/sbasic/shared/03120301.xhp#formats"/> + <embed href="text/sbasic/shared/00000003.xhp#languageformat"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id431589205147164">txt = bas.Format(6328.2, '##.##0.00')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231618679147769">print(txt)</paragraph> + </pycode> +</section> + +<section id="GetDefaultContext"> + <comment> GetDefaultContext ---------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id71158950214765"> + <bookmark_value>Basic service;GetDefaultContext</bookmark_value> + </bookmark> + <h2 id="hd_id811589205147428" localize="false">GetDefaultContext</h2> + <paragraph role="paragraph" id="par_id451618876389887">Returns the default context of the process service factory, if existent, else returns a null reference.</paragraph> + <paragraph role="paragraph" id="par_id881618848030897"><literal>GetDefaultContext</literal> is an alternative to the <link href="text/sbasic/python/python_programming.xhp" name="getComponentContext method">getComponentContext()</link> method available from <literal>XSCRIPTCONTEXT</literal> global variable or from <link href="text/sbasic/python/python_programming.xhp" name="uno.py module">uno.py</link> module.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id901668178405855" localize="false"><input>svc.GetDefaultContext(): uno</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id381618831451271">The default component context is used, when instantiating services via <literal>XMultiServiceFactory</literal>. See the <literal>Professional UNO</literal> chapter in the Developer's Guide on <link href="https://api.libreoffice.org/" name="API Developer's Guide">api.libreoffice.org</link> for more information.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id451389205147164">ctx = bas.GetDefaultContext()</paragraph> + </pycode> +</section> + +<section id="GetGuiType"> + <comment> GetGuiType ----------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id11758950214765"> + <bookmark_value>Basic service;GetGuiType</bookmark_value> + </bookmark> + <h2 id="hd_id118589205147428" localize="false">GetGuiType</h2> + <paragraph role="paragraph" id="par_id154618876389887">Returns a numerical value that specifies the graphical user interface. This function is only provided for backward compatibility with previous versions.</paragraph> + <paragraph role="paragraph" id="par_id341618848532640">Refer to <literal>system()</literal> method from <literal>platform</literal> Python module to <link href="text/sbasic/python/python_platform.xhp" name="identify the operating system">identify the operating system</link>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id109668178405855" localize="false"><input>svc.GetGuiType(): int</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id154389205147164">n = bas.GetGuiType()</paragraph> + </pycode> +</section> + +<section id="GetPathSeparator"> + <comment> GetPathSeparator ---------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id71158950214567"> + <bookmark_value>Basic service;GetPathSeparator</bookmark_value> + </bookmark> + <h2 id="hd_id811589205147824" localize="false">GetPathSeparator</h2> + <paragraph role="paragraph" id="par_id451618876389788">Returns the operating system-dependent directory separator used to specify file paths.</paragraph> + <paragraph role="paragraph" id="par_id341618848562340">Use <literal>os.pathsep</literal> from <literal>os</literal> Python module to <link href="text/sbasic/python/python_platform.xhp" name="path delimiter">identify the path separator</link>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id901668178405558" localize="false"><input>svc.GetPathSeparator(): str</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id451389205147461">sep = bas.GetPathSeparator()</paragraph> + </pycode> +</section> + +<section id="GetSystemTicks"> + <comment> GetSystemTicks ------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id71155980214765"> + <bookmark_value>Basic service;GetSystemTicks</bookmark_value> + </bookmark> + <h2 id="hd_id811589503147428" localize="false">GetSystemTicks</h2> + <paragraph role="paragraph" id="par_id451618678389887">Returns the number of system ticks provided by the operating system. You can use this function to optimize certain processes. Use this method to estimate time in milliseconds:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id901667188405855" localize="false"><input>svc.GetSystemTicks(): int</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id251619448108905">ticks_ini = bas.GetSystemTicks()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181619448111210">time.sleep(1)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id301619448111744">ticks_end = bas.GetSystemTicks()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651619448112320">bas.MsgBox("{} - {} = {}".format(ticks_end, ticks_ini,ticks_end - ticks_ini))</paragraph> + </pycode> +</section> + +<section id="BasicLibraries"> + <comment> InputBox ------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id61618905161499"> + <bookmark_value>Basic service;GlobalScope.BasicLibraries</bookmark_value> + </bookmark> + <h2 id="hd_id311618905373414" localize="false">GlobalScope.BasicLibraries</h2> + <paragraph role="paragraph" id="par_id741622396277528">Returns the UNO object containing all shared Basic libraries and modules.</paragraph> + <paragraph role="paragraph" id="par_id911622396571584">This method is the Python equivalent to <literal>GlobalScope</literal>.<literal>BasicLibraries</literal> in Basic scripts.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id511622395511116"> + <input>svc.GlobalScope.BasicLibraries(): uno</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" localize="false" id="par_id641622396435583"><link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1script_1_1XLibraryContainer.html" name="LibraryContainer_API"><literal>com.sun.star.script.XLibraryContainer</literal></link></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id281622398076950">The following example loads the Gimmicks Basic library if it has not been loaded yet.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id301622397623041">libs = bas.GlobalScope.BasicLibraries()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841622397623202">if not libs.isLibraryLoaded("Gimmicks"):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id621622397623352"> libs.loadLibrary("Gimmicks")</paragraph> + </pycode> +</section> + +<section id="DialogLibraries"> + <comment> InputBox ------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id61618905163671"> + <bookmark_value>Basic service;GlobalScope.DialogLibraries</bookmark_value> + </bookmark> + <h2 id="hd_id311618905376155" localize="false">GlobalScope.DialogLibraries</h2> + <paragraph role="paragraph" id="par_id381622397863419">Returns the UNO object containing all shared dialog libraries.</paragraph> + <paragraph role="paragraph" id="par_id491622397863810">This method is the Python equivalent to <literal>GlobalScope</literal>.<literal>DialogLibraries</literal> in Basic scripts.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id181622395563705"> + <input>svc.GlobalScope.DialogLibraries(): uno</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" localize="false" id="par_id641622396435133"><link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1script_1_1XLibraryContainer.html" name="LibraryContainer_API"><literal>com.sun.star.comp.sfx2.DialogLibraryContainer</literal></link></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id811622398234384">The following example shows a message box with the names of all available dialog libraries.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id561622398178727">dlg_libs = bas.GlobalScope.DialogLibraries()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181622398179079">lib_names = dlg_libs.getElementNames()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id461622398179232">bas.MsgBox("\n".join(lib_names))</paragraph> + </pycode> +</section> + +<section id="InputBox"> + <comment> InputBox ------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id61618905164342"> + <bookmark_value>Basic service;InputBox</bookmark_value> + </bookmark> + <h2 id="hd_id311618905372258" localize="false">InputBox</h2> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id91619007097426" localize="false"><input>svc.InputBox(prompt: str, [title: str], [default: str], [xpostwips: int, ypostwips: int]): str</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <embed href="text/sbasic/shared/03010201.xhp#parameters"/> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" localize="false" id="par_id21619008398677">String</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <section id="ui"> + <pycode> + <paragraph role="pycode" id="pyc_id751619081201175" xml-lang="en-US">txt = s.InputBox('Please enter a phrase:', "Dear user")</paragraph> + <paragraph role="pycode" id="pyc_id261619081319555" xml-lang="en-US">s.MsgBox(txt, s.MB_ICONINFORMATION, "Confirmation of phrase")</paragraph> + </pycode> + <note id="par_id651618921455396">For in-depth information please refer to <link href="https://wiki.documentfoundation.org/Macros/General/IO_to_Screen" name="Input/Output to Screen with Python">Input/Output to Screen with Python</link> on the Wiki.</note> + </section> +</section> + +<section id="MsgBox"> + <comment> MsgBox -------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id681618905411293"> + <bookmark_value>Basic service;MsgBox</bookmark_value> + </bookmark> + <h2 id="hd_id181618br/905397758" localize="false">MsgBox</h2> + <paragraph role="paragraph" id="par_id231618922407948">Displays a dialog box containing a message and returns an optional value.<br/>MB_xx constants help specify the dialog type, the number and type of buttons to display, plus the icon type. By adding their respective values they form bit patterns, that define the <literal>MsgBox</literal> dialog appearance.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id71618922431508" localize="false"><input>bas.MsgBox(prompt: str, [buttons: int], [title: str])[: int]</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <embed href="text/sbasic/shared/03010101.xhp#parameters"/> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id711619082902143">An optional integer as detailed in above <literal>IDxx</literal> properties.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/03/sf_basic.xhp#ui"/> +</section> + +<section id="Now"> + <comment> Now ------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id791618906935711"> + <bookmark_value>Basic service;Now</bookmark_value> + </bookmark> + <h2 id="hd_id231618906957248" localize="false">Now</h2> + <paragraph role="paragraph" id="par_id191619084216660">Returns the current system date and time as a <literal>datetime</literal>.<literal>datetime</literal> Python native object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id631619084685488" localize="false"><input>svc.Now(): datetime</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id411619084749448">bas.MsgBox(bas.Now(), bas.MB_OK, "Now")</paragraph> + </pycode> +</section> + +<section id="RGB"> + <comment> RGB ------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id831618907521168"> + <bookmark_value>Basic service;RGB</bookmark_value> + </bookmark> + <h2 id="hd_id871618907784332" localize="false">RGB</h2> + <paragraph role="paragraph" id="par_id621619448293385">Returns an integer color value consisting of red, green, and blue components.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id201619096429785"><input>svc.RGB(red:int, green: int, blue: int): int</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <embed href="text/sbasic/shared/03010305.xhp#parameters"/> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" localize="false" id="par_id381619096830033">Integer</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321619096903721">YELLOW = bas.RGB(255,255,0)</paragraph> + </pycode> +</section> + +<section id="ThisComponent"> + <comment> ThisComponent -------------------------------------------------- </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id81618907850447"> + <bookmark_value>Basic service;ThisComponent</bookmark_value> + </bookmark> + <h2 id="hd_id211618907871087" localize="false">ThisComponent</h2> + <paragraph role="paragraph" id="par_id141622840830978">If the current component refers to a %PRODUCTNAME document, this method returns the UNO object representing the document.</paragraph> + <paragraph role="paragraph" id="par_id961622841287976">The method will return <literal>None</literal> when the current component does not correspond to a document.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id671622840735153"> + <input>svc.ThisComponent(): uno</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id21622841338969">comp = bas.ThisComponent</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id781622841643538">bas.MsgBox("\n".join(comp.getSupportedServiceNames()))</paragraph> + </pycode> +</section> + +<section id="ThisDatabaseDocument"> + <comment> ThisDatabaseDocument ------------------------------------------ </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id81618907858201"> + <bookmark_value>Basic service;ThisDatabaseDocument</bookmark_value> + </bookmark> + <h2 id="hd_id211618907879635" localize="false">ThisDatabaseDocument</h2> + <paragraph role="paragraph" id="par_id271622912644859">If the script is being executed from a Base document or any of its subcomponents this method returns the main component of the Base instance.</paragraph> + <paragraph role="paragraph" id="par_id811622912819443">This method returns <literal>None</literal> otherwise.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711622840776224"> + <input>svc.ThisDatabaseDocument(): uno</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761622913418091">db_doc = bas.ThisDatabaseDocument</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id201622913418646">table_names = db_doc.DataSource.getTables().getElementNames()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id711622913418917">bas.MsgBox("\n".join(table_names))</paragraph> + </pycode> + <tip id="par_id201623153844931">Visit the <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sdb_1_1OfficeDatabaseDocument.html" name="OfficeDatabaseDocument">OfficeDatabaseDocument</link> API page to learn more about Base's main component structure.</tip> +</section> + +<section id="Xray"> + <comment> Xray ------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" branch="index" id="bm_id81618907851793"> + <bookmark_value>Basic service;Xray</bookmark_value> + </bookmark> + <h2 id="hd_id211618907871281" localize="false">Xray</h2> + <paragraph role="paragraph" id="par_id451619094057178">Inspect Uno objects or variables.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id301619094111856" localize="false"><input>svc.Xray(obj: any)</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id21619094660345"><emph>obj</emph>: A variable or UNO object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id751619095024401">bas.Xray(bas.StarDesktop)</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03131900.xhp#GlobalScope_h1"/> + <embed href="text/sbasic/python/python_programming.xhp#pythonprogrammingheading"/> + <paragraph role="paragraph" localize="false" id="par_id901618486941514"><link href="text/sbasic/python/python_programming.xhp" name="uno.fileUrlToSystemPath() method">uno.fileUrlToSystemPath()</link></paragraph> + <paragraph role="paragraph" localize="false" id="par_id901618496841514"><link href="text/sbasic/python/python_programming.xhp" name="uno.systemPathToFileUrl() method">uno.systemPathToFileUrl()</link></paragraph> + <paragraph role="paragraph" id="par_id951618554355538"><link href="https://wiki.documentfoundation.org/Macros/General/IO_to_Screen" name="Input/Output to Screen with Python">Input/Output to Screen with Python</link> on the wiki</paragraph> + <paragraph role="paragraph" localize="false" id="par_id610918486941514"><link href="text/sbasic/python/python_programming.xhp" name="XSCRIPTCONTEXT.getComponentContext() method">XSCRIPTCONTEXT.getComponentContext()</link></paragraph> + <paragraph role="paragraph" localize="false" id="par_id901618484961514"><link href="text/sbasic/python/python_programming.xhp" name="uno.getComponentContext() method">uno.getComponentContext()</link></paragraph> + <paragraph role="paragraph" localize="false" id="par_id901648186941514"><link href="text/sbasic/python/python_platform.xhp" name="platform.system() method">platform.system()</link></paragraph> + <paragraph role="paragraph" localize="false" id="par_id901816486941514"><link href="text/sbasic/python/python_platform.xhp" name="os.pathsep() method">os.pathsep()</link></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_calc.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_calc.xhp new file mode 100644 index 000000000..6b75f86dd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_calc.xhp @@ -0,0 +1,2031 @@ +<?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_calc" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDocuments.Calc service</title> + <filename>/text/sbasic/shared/03/sf_calc.xhp</filename> + </topic> +</meta> + +<body> +<section id="SFDocuments-sf_calc"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id261582733781987"> + <bookmark_value>Calc service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="hd_id731582733781114" xml-lang="en-US"><variable id="CalcService"><link href="text/sbasic/shared/03/sf_calc.xhp" name="Calc service"><literal>SFDocuments</literal>.<literal>Calc</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id381589189355849" xml-lang="en-US">The <literal>SFDocuments</literal> shared library provides a number of methods and properties to facilitate the management and handling of %PRODUCTNAME documents.</paragraph> + <paragraph role="paragraph" id="par_id351591014177269" xml-lang="en-US">The <literal>SFDocuments.Calc</literal> service is a subclass of the <link href="text/sbasic/shared/03/sf_document.xhp" name="SF_Document_link"><literal>SFDocuments.Document</literal></link> service. All methods and properties defined for the <literal>Document</literal> service can also be accessed using a <literal>Calc</literal> service instance.</paragraph> + <paragraph role="paragraph" id="par_id591589189364267" xml-lang="en-US">The <literal>Calc</literal> service is focused on:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id891589189452545" role="listitem" xml-lang="en-US">Handling sheets within a Calc document (copy, insert, move, etc)</paragraph> + </listitem> + <listitem> + <paragraph id="par_id811589189463041" role="listitem" xml-lang="en-US">Exchanging data between Basic data structures and Calc ranges</paragraph> + </listitem> + <listitem> + <paragraph id="par_id141599569935662" role="listitem" xml-lang="en-US">Copying and importing massive amounts of data</paragraph> + </listitem> + </list> +</section> + <note id="par_id851638217526844">This help page describes methods and properties that are applicable only to Calc documents.</note> + + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Calc</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id591589191059889" xml-lang="en-US">The <literal>Calc</literal> service is closely related to the <literal>UI</literal> service of the <literal>ScriptForge</literal> library. Below are a few examples of how the <literal>Calc</literal> service can be invoked.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id551621623999947">The code snippet below creates a <literal>Calc</literal> service instance that corresponds to the currently active Calc document.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id431621624078370">Set oDoc = CreateScriptService("Calc")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id341621467500466">Another way to create an instance of the <literal>Calc</literal> service is using the <literal>UI</literal> service. In the following example, a new Calc document is created and <literal>oDoc</literal> is a <literal>Calc</literal> service instance:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id371582885621964">Dim ui As Object, oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201582885621287">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561589191748697">Set oDoc = ui.CreateDocument("Calc")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id921621467621019">Or using the <literal>OpenDocument</literal> method from the <literal>UI</literal> service:</paragraph> + <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> + <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_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> + </bascode> + <paragraph role="paragraph" id="par_id231611610666018">However, if the document was closed using the <literal>CloseDocument</literal> method, it becomes unnecessary to free resources using the command described above.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id911621624242302">myDoc = CreateScriptService("Calc")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id201621531742824">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id661621531772444">myDoc = ui.CreateDocument("Calc")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id401621531828705">myDoc = ui.OpenDocument(r"C:\Documents\MyFile.ods")</paragraph> + </pycode> + <pycode> + <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> + <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> + <paragraph role="paragraph" id="par_id511591016999246" xml-lang="en-US">Many methods require a "<emph>Sheet</emph>" or a "<emph>Range</emph>" as argument. Single cells are considered a special case of a <literal>Range</literal>.</paragraph> + <paragraph role="paragraph" id="par_id511591019278671" xml-lang="en-US">Both may be expressed either as a string or as a reference (= object) depending on the situation:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id571591019367284" role="listitem" xml-lang="en-US">Within a <emph>specific</emph> <literal>Calc</literal> <emph>instance</emph>, sheets and ranges are given as strings such as "Sheet1" and "D2:F6".</paragraph> + </listitem> + <listitem> + <paragraph id="par_id121591019432157" role="listitem" xml-lang="en-US">Additionally, the <literal>.Sheet</literal> and <literal>.Range</literal> properties return a reference that may be used as argument of a method called from <emph>another instance</emph> of the <literal>Calc</literal> service.</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id421591017227464" xml-lang="en-US">The example below copies data from document A (opened as read-only and hidden) to document B.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id581591017295549">Dim oDocA As Object, oDocB As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441611611293627">Set oDocA = ui.OpenDocument("C:\Documents\FileA.ods", Hidden := True, ReadOnly := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391591017309023">Set oDocB = ui.OpenDocument("C:\Documents\FileB.ods")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941591017325429">oDocB.CopyToRange(oDocA.Range("SheetX.D4:F8"), "D2:F6") 'CopyToRange(source, target)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id561621533543160">docA = ui.OpenDocument(r"C:\Documents\FileA.ods", hidden = True, readonly = True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id61621533637980">docB = ui.OpenDocument(r"C:\Documents\FileB.ods")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941621533638353">docB.CopyToRange(docA.Range("SheetX.D4:F8"), "D2:F6")</paragraph> + </pycode> + + <h3 id="hd_id941591020321580" localize="false" xml-lang="en-US">SheetName</h3> + <paragraph role="paragraph" id="par_id341591020333849" xml-lang="en-US">Either the sheet name as a <literal>string</literal> or an <literal>object</literal> produced by the <literal>.Sheet</literal> property.</paragraph> + <paragraph role="paragraph" id="par_id651591020343023" xml-lang="en-US">The shortcut "~" (tilde) represents the current sheet.</paragraph> + <h3 id="hd_id101591020737697" localize="false" xml-lang="en-US">RangeName</h3> + <paragraph role="paragraph" id="par_id291591020728110" xml-lang="en-US">Either a string designating a set of contiguous cells located in a sheet of the current instance or an <literal>object</literal> produced by the <literal>.Range</literal> property.</paragraph> + <paragraph role="paragraph" id="par_id691591020711395" xml-lang="en-US">The shortcut "~" (tilde) represents the current selection or the first selected range if multiple ranges are selected.</paragraph> + <paragraph role="paragraph" id="par_id701592230700986" xml-lang="en-US">The shortcut "*" represents all used cells.</paragraph> + <paragraph role="paragraph" id="par_id641591021597701" xml-lang="en-US">The sheet name is optional when defining a range. If no sheet name is provided, then the active sheet is used. Surrounding single quotes and $ signs are allowed but ignored.</paragraph> + <paragraph role="paragraph" id="par_id231655754032310">When specifying a <literal>SheetName</literal> as a string, the use of single quotes to enclose the sheet name are required if the name contains blank spaces " " or periods ".". </paragraph> + <paragraph role="paragraph" id="par_id931655906591984">The examples below illustrate in which cases the use of single quotes is mandatory:</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id971655754336388">' The use of single quotes is optional</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891655754336707">oDoc.clearAll("SheetA.A1:B10")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381655754337100">oDoc.clearAll("'SheetA'.A1:B10")</paragraph> + <paragraph role="bascode" id="bas_id711655754337420">' The use of single quotes is required</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311655754674294">oDoc.clearAll("'Sheet.A'.A1:B10")</paragraph> + </bascode> + <tip id="par_id371592406978640" xml-lang="en-US">Except for the <literal>CurrentSelection</literal> property, the <literal>Calc</literal> service considers only single ranges of cells.</tip> + <table id="tab_id101591024652566"> + <tablerow> + <tablecell colspan="2"> + <paragraph id="par_id91591025127496" role="tablehead" xml-lang="en-US">Examples of valid ranges</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id481591024294524" role="tablecontent" xml-lang="en-US">1) $'SheetX'.D2<br/>2) $D$2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721591024294894" role="tablecontent" xml-lang="en-US">A single cell</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id21591024294492" role="tablecontent" xml-lang="en-US">1) $'SheetX'.D2:F6<br/>2) D2:D10</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id9159102429464" role="tablecontent" xml-lang="en-US">Single range with multiple cells</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161592230749179" role="tablecontent" xml-lang="en-US">$'SheetX'.*</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581592230749243" role="tablecontent" xml-lang="en-US">All used cells in the given sheet</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id641591024294318" role="tablecontent" xml-lang="en-US">1) $'SheetX'.A:A (column A)<br/>2) 3:5 (rows 3 to 5)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id431591024294723" role="tablecontent" xml-lang="en-US">All cells in contiguous columns or rows up to the last used cell</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id871591024294202" role="tablecontent" xml-lang="en-US">myRange</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721591024294721" role="tablecontent" xml-lang="en-US">A range named "myRange" at spreadsheet level</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181591024294534" role="tablecontent" xml-lang="en-US">1) ~.someRange<br/>2) SheetX.someRange</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911591024294816" role="tablecontent" xml-lang="en-US">A range name at sheet level</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id781591024294621" role="tablecontent" xml-lang="en-US">myDoc.Range("SheetX.D2:F6") </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id681591024294568" role="tablecontent" xml-lang="en-US">A range within the sheet SheetX in file associated with the myDoc Calc instance</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id101591024294151" role="tablecontent" xml-lang="en-US">~.~ or ~</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id22159102429479" role="tablecontent" xml-lang="en-US">The current selection in the active sheet</paragraph> + </tablecell> + </tablerow> + </table> + + <h2 id="hd_id351582885195476" xml-lang="en-US">Properties</h2> + <paragraph role="paragraph" id="par_id151591018231905" xml-lang="en-US">All the properties generic to any document are implicitly applicable also to Calc documents. For more information, read the <link href="text/sbasic/shared/03/sf_document.xhp" name="Document service">Document service Help page</link>.</paragraph> + <paragraph role="paragraph" id="par_id911591018242565" xml-lang="en-US">The properties specifically available for Calc documents are:</paragraph> + <table id="tab_id971582885195582"> + <tablerow> + <tablecell> + <paragraph id="par_id41582885195836" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31582885195372" role="tablehead" xml-lang="en-US">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221591018408168" role="tablehead" xml-lang="en-US">Argument</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31582885195238" role="tablehead" xml-lang="en-US">Return type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id931582885195131" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681592407165508" role="tablecontent" xml-lang="en-US" localize="false">CurrentSelection</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301592407165942" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81592407165611" role="tablecontent" xml-lang="en-US">None</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id59159240716522" role="tablecontent" xml-lang="en-US">String or array of strings</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id85159240716560" role="tablecontent" xml-lang="en-US">The single selected range as a string or the list of selected ranges as an array.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681592407165201" localize="false" role="tablecontent">FirstCell</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301592407165606" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81592407165545" role="tablecontent">SheetName or RangeName as String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id59159240716378" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id85159240716828" role="tablecontent">Returns the first used cell in a given range or sheet.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681592407166918" localize="false" role="tablecontent">FirstColumn</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301592407166642" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81592407165145" role="tablecontent">SheetName or RangeName as String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id59159240716125" localize="false" role="tablecontent">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id85159240716225" role="tablecontent">Returns the leftmost column number in a given range or sheet.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681592407169888" localize="false" role="tablecontent">FirstRow</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301592407167972" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81592407165695" role="tablecontent">SheetName or RangeName as String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id59159240716663" localize="false" role="tablecontent">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id85159240716128" role="tablecontent">Returns the topmost row number in a given range or sheet.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id521593094953943" role="tablecontent" xml-lang="en-US" localize="false">Height</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id101593094953259" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741593094953790" role="tablecontent" xml-lang="en-US">RangeName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581593094953195" role="tablecontent" xml-lang="en-US" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311593094953330" role="tablecontent" xml-lang="en-US">The number of rows (>= 1) in the given range.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id97158288519551" localize="false" role="tablecontent">LastCell</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221582885195686" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501591018870619" role="tablecontent">SheetName or RangeName as String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371582885195525" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881582885195976" role="tablecontent">Returns the last used cell in a given range or sheet.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id261592315106411" localize="false" role="tablecontent">LastColumn</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601592315106598" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831592315106202" role="tablecontent">SheetName or RangeName as String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591592315106615" localize="false" role="tablecontent">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id791592315106790" role="tablecontent">The last used column in a given range or sheet.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801591025591570" localize="false" role="tablecontent">LastRow</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981591025591597" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81591025591696" role="tablecontent">SheetName or RangeName as String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id61591025591572" localize="false" role="tablecontent">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421591025591509" role="tablecontent">The last used row in a given range or sheet.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id52159102559144" role="tablecontent" xml-lang="en-US" localize="false">Range</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81591025591672" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561591025591239" role="tablecontent" xml-lang="en-US">RangeName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311591025591598" role="tablecontent" xml-lang="en-US" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571591025591367" role="tablecontent" xml-lang="en-US">A range reference that can be used as argument of methods like <literal>CopyToRange</literal>.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id52159102559323" role="tablecontent" xml-lang="en-US" localize="false">Region</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81591025591007" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561591025592149" role="tablecontent" xml-lang="en-US">RangeName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311591025591078" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571591025599937" role="tablecontent" xml-lang="en-US">Returns the address of the smallest area that contains the specified range so that the area is surrounded by empty cells or sheet edges. This is equivalent to applying the <switchinline select="sys"><caseinline select="MAC"><keycode>Command + *</keycode></caseinline><defaultinline><keycode>Ctrl + *</keycode></defaultinline></switchinline> shortcut to the given range.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id17159102559142" role="tablecontent" xml-lang="en-US" localize="false">Sheet</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541591025591511" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661591025591903" role="tablecontent" xml-lang="en-US">SheetName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id101591025591982" role="tablecontent" xml-lang="en-US" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731591025591753" role="tablecontent" xml-lang="en-US">A sheet reference that can be used as argument of methods like <literal>CopySheet</literal>.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id171591025595653" role="tablecontent" xml-lang="en-US" localize="false">SheetName</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541591025591322" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661591025591188" role="tablecontent" xml-lang="en-US">RangeName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id101591025591289" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731591025591006" role="tablecontent" xml-lang="en-US">Returns the sheet name of a given range address.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591591025591635" role="tablecontent" xml-lang="en-US" localize="false">Sheets</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581591025591579" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751591025591667" role="tablecontent" xml-lang="en-US">None</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861591025591250" role="tablecontent" xml-lang="en-US">Array of strings</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491591025591370" role="tablecontent" xml-lang="en-US">The list with the names of all existing sheets.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731593095062923" role="tablecontent" xml-lang="en-US" localize="false">Width</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711593095062771" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311593095062171" role="tablecontent" xml-lang="en-US">RangeName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761593095062827" role="tablecontent" xml-lang="en-US" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id681593095062358" role="tablecontent" xml-lang="en-US">The number of columns (>= 1) in the given range.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id691592315404547" role="tablecontent" xml-lang="en-US" localize="false">XCellRange</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391592315404944" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001592315404525" role="tablecontent" xml-lang="en-US">RangeName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id7715923154041" role="tablecontent" xml-lang="en-US" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321592315404430" role="tablecontent" xml-lang="en-US">A <literal>com.sun.star.Table.XCellRange</literal> UNO object.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id961592315565332" role="tablecontent" localize="false">XSheetCellCursor</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501592315567199" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411592315560025" role="tablecontent">RangeName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521592315565365" role="tablecontent" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id41592315565185" role="tablecontent">A <literal>com.sun.star.sheet.XSheetCellCursor</literal> UNO object. After moving the cursor, the resulting range address can be accessed through the <literal>AbsoluteName</literal> UNO property of the cursor object, which returns a string value that can be used as argument for properties and methods of the Calc service.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id961592315565156" role="tablecontent" xml-lang="en-US" localize="false">XSpreadsheet</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501592315565569" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411592315565235" role="tablecontent" xml-lang="en-US">SheetName As String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521592315565269" role="tablecontent" xml-lang="en-US" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id41592315560095" role="tablecontent" xml-lang="en-US">A <literal>com.sun.star.sheet.XSpreadsheet</literal> UNO object.</paragraph> + </tablecell> + </tablerow> +</table> + + <tip id="par_id321611613059105">Visit %PRODUCTNAME API Documentation's website to learn more about <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1table_1_1XCellRange.html" name="XCellRange API">XCellRange</link>, <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sheet_1_1XSheetCellCursor.html" name="XSheetCellCursor API">XSheetCellCursor</link> and <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sheet_1_1XSpreadsheet.html" name="XSpreadsheet API">XSpreadsheet</link> UNO objects.</tip> + + <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Calc Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_calc.xhp#A1Style" name="A1Style method">A1Style</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#Activate" name="Activate method">Activate</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#Charts" name="Charts method">Charts</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ClearAll" name="ClearAll method">ClearAll</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ClearFormats" name="ClearFormats method">ClearFormats</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ClearValues" name="ClearValues method">ClearValues</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#CompactLeft" name="CompactLeft method">CompactLeft</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#CompactUp" name="CompactUp method">CompactUp</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#CopySheet" name="CopySheet method">CopySheet</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#CopySheetFromFile" name="CopySheetFromFile method">CopySheetFromFile</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#CopyToCell" name="CopyToCell method">CopyToCell</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#CopyToRange" name="CopyToRange method">CopyToRange</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#CreateChart" name="CreateChart method">CreateChart</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#CreatePivotTable" name="CreatePivotTable method">CreatePivotTable</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#DAvg" name="DAvg method">DAvg</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_calc.xhp#DAvg" name="DCount method">DCount</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#DAvg" name="DMax method">DMax</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#DAvg" name="DMin method">DMin</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#DAvg" name="DSum method">DSum</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ExportRangeToFile" name="ExportRangeToFile method">ExportRangeToFile</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#Forms" name="Forms method">Forms</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#GetColumnName" name="GetColumnName method">GetColumnName</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#GetFormula" name="GetFormula method">GetFormula</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#GetValue" name="GetValue method">GetValue</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ImportFromCSVFile" name="ImportFromCSVFile method">ImportFromCSVFile</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ImportFromDatabase" name="ImportFromDatabase method">ImportFromDatabase</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#InsertSheet" name="InsertSheet method">InsertSheet</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#MoveRange" name="MoveRange method">MoveRange</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#MoveSheet" name="MoveSheet method">MoveSheet</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#Offset" name="Offset method">Offset</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_calc.xhp#OpenRangeSelector" name="OpenRangeSelector method">OpenRangeSelector</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#PrintOut" name="PrintOut method">PrintOut</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#Printf" name="Printf method">Printf</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#RemoveSheet" name="RemoveSheet method">RemoveSheet</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#RenameSheet" name="RenameSheet method">RenameSheet</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#SetArray" name="SetArray method">SetArray</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#SetValue" name="SetValue method">SetValue</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#SetCellStyle" name="SetCellStyle method">SetCellStyle</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#SetFormula" name="SetFormula method">SetFormula</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ShiftDown" name="ShiftDown method">ShiftDown</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ShiftLeft" name="ShiftLeft method">ShiftLeft</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ShiftRight" name="ShiftRight method">ShiftRight</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#ShiftUp" name="ShiftUp method">ShiftUp</link><br/> + <link href="text/sbasic/shared/03/sf_calc.xhp#SortRange" name="SortRange method">SortRange</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> +</table> + +<section id="A1Style"> + <comment> A1Style ----------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969104"> + <bookmark_value>Calc service;A1Style</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698251" localize="false">A1Style</h2> + <paragraph role="paragraph" id="par_id93158919969228">Returns a range address as a string based on sheet coordinates, i.e. row and column numbers.</paragraph> + <paragraph role="paragraph" id="par_id21635434153216">If only a pair of coordinates is given, then an address to a single cell is returned. Additional arguments can specify the bottom-right cell of a rectangular range.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534014334"> + <input>svc.A1Style(row1: int, column1: int, row2: int = 0; column2: int = 0; sheetname: str = "~"): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203080"><emph>row1, column1</emph>: Specify the row and column numbers of the top-left cell in the range to be considered. Row and column numbers start at 1.</paragraph> + <paragraph role="paragraph" id="par_id821591631203212"><emph>row2, column2</emph>: Specify the row and column numbers of the bottom-right cell in the range to be considered. If these arguments are not provided, or if values smaller than <literal>row1</literal> and <literal>column1</literal> are given, then the address of the single cell range represented by <literal>row1</literal> and <literal>column1</literal> is returned.</paragraph> + <paragraph role="paragraph" id="par_id821591631203336"><emph>sheetname</emph>: The name of the sheet to be appended to the returned range address. The sheet must exist. The default value is "~" corresponding to the currently active sheet.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id131611616623705">The examples below in Basic and Python consider that "Sheet1" is the currently active sheet.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id411589199698360">Set oDoc = CreateScriptService("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651611616531723">addr1 = oDoc.A1Style(1, 1) ' '$Sheet1'.$A$1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711611616532319">addr2 = oDoc.A1Style(2, 2, 3, 6) ' '$Sheet1'.$B$2:$F$3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181611616544988">addr3 = oDoc.A1Style(2, 2, 0, 6) ' '$Sheet1'.$B$2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181611616544911">addr4 = oDoc.A1Style(3, 4, 3, 8, "Sheet2") ' '$Sheet2'.$D$3:$H$3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181611616544104">addr5 = oDoc.A1Style(5, 1, SheetName := "Sheet3") ' '$Sheet3'.$A$5</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534175228">doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id971621534192369">addr1 = doc.A1Style(1, 1) # '$Sheet1'.$A$1</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id216215342375255">addr2 = doc.A1Style(2, 2, 3, 6) # '$Sheet1'.$B$2:$F$3</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id281635437557107">addr3 = doc.A1Style(2, 2, 0, 6) # '$Sheet1'.$B$2</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801635437557005">addr4 = doc.A1Style(3, 4, 3, 8, "Sheet2") # '$Sheet2'.$D$3:$H$3</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id501635437602129">addr5 = doc.A1Style(5, 1, sheetname="Sheet3") # '$Sheet3'.$A$5</paragraph> + </pycode> + <tip id="par_id501611617808112">The method <literal>A1Style</literal> can be combined with any of the many properties and methods of the Calc service that require a range as argument, such as <literal>GetValue</literal>, <literal>GetFormula</literal>, <literal>ClearAll</literal>, etc.</tip> +</section> + +<section id="Activate"> + <comment> Activate -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969883"> + <bookmark_value>Calc service;Activate</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698099" localize="false">Activate</h2> + <paragraph role="paragraph" id="par_id93158919969864">If the argument <literal>sheetname</literal> is provided, the given sheet is activated and it becomes the currently selected sheet. If the argument is absent, then the document window is activated.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534014732"> + <input>svc.Activate(sheetname: str = ""): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203996"><emph>sheetname</emph>: The name of the sheet to be activated in the document. The default value is an empty string, meaning that the document window will be activated without changing the active sheet.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id131611616623714">The example below activates the sheet named "Sheet4" in the currently active document.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41158919969836">Dim ui as Variant, oDoc as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651611616531736">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711611616532302">Set oDoc = ui.GetDocument(ui.ActiveWindow)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181611616544947">oDoc.Activate("Sheet4")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534175071">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id971621534192346">myDoc = ui.GetDocument(ui.ActiveWindow)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id21621534237588">myDoc.Activate("Sheet4")</paragraph> + </pycode> + <tip id="par_id501611617808220">Activating a sheet makes sense only if it is performed on a Calc document. To make sure you have a Calc document at hand you can use the <literal>isCalc</literal> property of the document object, which returns <literal>True</literal> if it is a Calc document and <literal>False</literal> otherwise.</tip> +</section> + +<section id="Charts"> + <comment> Charts ------------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158915960183"> + <bookmark_value>Calc service;Charts</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698104" localize="false">Charts</h2> + <paragraph role="paragraph" id="par_id93158919969856">Returns either the list with the names of all chart objects in a given sheet or a single <literal>Chart</literal> service instance.</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id371635438503202" role="listitem">If only <literal>sheetname</literal> is specified, a zero-based array of strings containing the names of all charts is returned.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id371635438509045" role="listitem">If a <literal>chartname</literal> is provided, then a single object corresponding to the desired chart is returned. The specified chart must exist.</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534028832"> + <input>svc.Charts(sheetname: str, chartname: str = ""): obj</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631205026"><emph>sheetname</emph>: The name of the sheet from which the list of charts is to be retrieved or where the specified chart is located.</paragraph> + <paragraph role="paragraph" id="par_id821591631203566"><emph>chartname</emph>: The user-defined name of the chart object to be returned. If the chart does not have a user-defined name, then the internal object name can be used. If this argument is absent, then the list of chart names in the specified sheet is returned.</paragraph> + <tip id="par_id431635438771588">Use the <menuitem>Navigator</menuitem> sidebar to check the names assigned to charts under the <menuitem>OLE objects</menuitem> category.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id41635439328174">The example below shows the number of chart objects in "Sheet1".</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id411589199698246">Dim arrNames as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651611616531639">arrNames = oDoc.Charts("Sheet1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711611616532310">MsgBox "There are " & UBound(arrNames) + 1 & " charts in Sheet1"</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id571635439417400">The following example accesses the chart named "MyChart" in "Sheet1" and prints its type.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id461635439551325">Dim oChart as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id716354395513277">oChart = oDoc.Charts("Sheet1", "MyChart")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661635439551933">MsgBox oChart.ChartType</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id971621534192214">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id321621534175387">chart_names = doc.Charts("Sheet1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id216215342375296">bas.MsgBox(f"There are {len(chart_names)} charts in Sheet1")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id421635439765634">chart = doc.Charts("Sheet1", "MyChart")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id161635439765873">bas.MsgBox(chart.ChartType)</paragraph> + </pycode> +</section> + +<section id="ClearAll"> + <comment> ClearAll -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231592919577434"> + <bookmark_value>Calc service;ClearAll</bookmark_value> + </bookmark> + <h2 id="hd_id921592919577158" localize="false">ClearAll</h2> + <paragraph role="paragraph" id="par_id31592919577984">Clears all the contents and formats of the given range.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id441621534763020"> + <input>svc.ClearAll(range: str)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441592919577809"><emph>range</emph>: The range to be cleared, as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id521592919577626">oDoc.ClearAll("SheetX.A1:F10")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id211621536212144">myDoc.ClearAll("SheetX.A1:F10")</paragraph> + </pycode> +</section> + +<section id="ClearFormats"> + <comment> ClearFormats -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id591592919864362"> + <bookmark_value>Calc service;ClearFormats</bookmark_value> + </bookmark> + <h2 id="hd_id871592919864356" localize="false">ClearFormats</h2> + <paragraph role="paragraph" id="par_id211592919864118">Clears the formats and styles in the given range.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id381621536397094"> + <input>svc.ClearFormats(range: str)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id611592919864268"><emph>range</emph>: The range whose formats and styles are to be cleared, as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id541592919864670">oDoc.ClearFormats("SheetX.*")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id501621536545590">myDoc.ClearFormats("SheetX.*")</paragraph> + </pycode> +</section> + +<section id="ClearValues"> + <comment> ClearValues -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id781592919928644"> + <bookmark_value>Calc service;ClearValues</bookmark_value> + </bookmark> + <h2 id="hd_id111592919928265" localize="false">ClearValues</h2> + <paragraph role="paragraph" id="par_id841592919928169">Clears the values and formulas in the given range.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id951621536609302"> + <input>svc.ClearValues(range: str)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id771592919928320"><emph>range</emph>: The range whose values and formulas are to be cleared, as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id371592919928100">oDoc.ClearValues("SheetX.A1:F10")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id451621536678434">myDoc.ClearValues("SheetX.A1:F10")</paragraph> + </pycode> +</section> + +<section id="CompactLeft"> + <comment> CompactLeft ------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id781592919922589"> + <bookmark_value>Calc service;CompactLeft</bookmark_value> + </bookmark> + <h2 id="hd_id111592919923294" localize="false">CompactLeft</h2> + <paragraph role="paragraph" id="par_id841592919903025">Deletes the columns of a specified range that match a filter expressed as a Calc formula. The filter is applied to each column to decide whether it will be deleted or not.</paragraph> + <paragraph role="paragraph" id="par_id601652269911029">The deleted column can be limited to the height of the specified range or span to the height of the entire sheet, thus deleting whole columns.</paragraph> + <paragraph role="paragraph" id="par_id701652271281106">This method returns a string with the range address of the compacted range. If all columns are deleted, then an empty string is returned.</paragraph> + <note id="par_id191652271892064">If a range of cells is selected, calling this method will not impact the selection.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id951621536600632"> + <input>svc.CompactLeft(range: str, wholecolumn: bool = False, opt filterformula: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id771592919922181"><emph>range</emph>: The range from which columns will be deleted, as a string.</paragraph> + <paragraph role="paragraph" id="par_id771592919932260"><emph>wholecolumn</emph>: If this option is set to <literal>True</literal> the entire column will be deleted from the sheet. The default value is <literal>False</literal>, which means that the deleted column will be limited to the height of the specified <literal>range</literal>.</paragraph> + <paragraph role="paragraph" id="par_id771592919915974"><emph>filterformula</emph>: The filter to be applied to each column to determine whether or not it will be deleted. The filter is expressed as a Calc formula that should be applied to the first column. When the formula returns <emph>True</emph> for a column, that column will be deleted. The default filter deletes all empty columns.</paragraph> + <paragraph role="paragraph" id="par_id361652271022647">For example, suppose range <emph>A1:J200</emph> is selected (height = 200), so the default formula is <emph>=(COUNTBLANK(A1:A200)=200)</emph>. This means that if all 200 cells are empty in the first column (Column A), then the column is deleted. Note that the formula is expressed with respect to the first column only. Internally the <literal>CompactLeft</literal> method will generalize this formula for all the remaining columns.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id941652271391005">' Delete all empty columns in the range G1:L10 from Sheet1</paragraph> + <paragraph role="bascode" id="bas_id691652271390762">newrange = oDoc.CompactLeft("Sheet1.G1:L10")</paragraph> + <paragraph role="bascode" id="bas_id921652271392627">' The example below is similar, but the entire column is deleted from the sheet</paragraph> + <paragraph role="bascode" id="bas_id941652271392873">newrange = oDoc.CompactLeft("Sheet1.G1:L10", WholeColumn := True)</paragraph> + <paragraph role="bascode" id="bas_id751652271393226">' Deletes all columns where the first row is marked with an "X"</paragraph> + <paragraph role="bascode" id="bas_id761652271393514">newrange = oDoc.CompactLeft("Sheet1.G1:L10", FilterFormula := "=(G1=""X"")")</paragraph> + <paragraph role="bascode" id="bas_id241652271725676">' Deletes all columns where the sum of values in the column is odd</paragraph> + <paragraph role="bascode" id="bas_id531652271726131">newrange = oDoc.CompactLeft("Sheet1.G1:L10", FilterFormula := "=(MOD(SUM(G1:G10);2)=1)")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id451621536612334">newrange = myDoc.CompactLeft("Sheet1.G1:L10")</paragraph> + <paragraph role="pycode" id="pyc_id201652272121176">newrange = myDoc.CompactLeft("Sheet1.G1:L10", wholecolumn = True)</paragraph> + <paragraph role="pycode" id="pyc_id781652272122794">newrange = myDoc.CompactLeft("Sheet1.G1:L10", filterformula = '=(G1="X")')</paragraph> + <paragraph role="pycode" id="pyc_id731652272123209">newrange = myDoc.CompactLeft("Sheet1.G1:L10", filterformula = '=(MOD(SUM(G1:G10);2)=1)')</paragraph> + </pycode> +</section> + +<section id="CompactUp"> + <comment> CompactUp --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id781592919928589"> + <bookmark_value>Calc service;CompactUp</bookmark_value> + </bookmark> + <h2 id="hd_id111592919923065" localize="false">CompactUp</h2> + <paragraph role="paragraph" id="par_id841592919903699">Deletes the rows of a specified range that match a filter expressed as a Calc formula. The filter is applied to each row to decide whether it will be deleted or not.</paragraph> + <paragraph role="paragraph" id="par_id601652269910091">The deleted rows can be limited to the width of the specified range or span to the width of the entire sheet, thus deleting whole rows.</paragraph> + <paragraph role="paragraph" id="par_id701652271283456">This method returns a string with the range address of the compacted range. If all rows are deleted, then an empty string is returned.</paragraph> + <note id="par_id191652271893913">If a range of cells is selected, calling this method will not impact the selection.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id951621536605642"> + <input>svc.CompactUp(range: str, wholerow: bool = False, opt filterformula: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id771592919922080"><emph>range</emph>: The range from which rows will be deleted, as a string.</paragraph> + <paragraph role="paragraph" id="par_id771592919921160"><emph>wholerow</emph>: If this option is set to <literal>True</literal> the entire row will be deleted from the sheet. The default value is <literal>False</literal>, which means that the deleted row will be limited to the width of the specified <literal>range</literal>.</paragraph> + <paragraph role="paragraph" id="par_id771592919926374"><emph>filterformula</emph>: The filter to be applied to each row to determine whether or not it will be deleted. The filter is expressed as a Calc formula that should be applied to the first row. When the formula returns <emph>True</emph> for a row, that row will be deleted. The default filter deletes all empty rows.</paragraph> + <paragraph role="paragraph" id="par_id361652271022681">For example, suppose range <emph>A1:J200</emph> is selected (width = 10), so the default formula is <emph>=(COUNTBLANK(A1:J1)=10)</emph>. This means that if all 10 cells are empty in the first row (Row 1), then the row is deleted. Note that the formula is expressed with respect to the first row only. Internally the <literal>CompactUp</literal> method will generalize this formula for all the remaining rows.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id941652271391554">' Delete all empty rows in the range G1:L10 from Sheet1</paragraph> + <paragraph role="bascode" id="bas_id691652271390789">newrange = oDoc.CompactUp("Sheet1.G1:L10")</paragraph> + <paragraph role="bascode" id="bas_id921652271392567">' The example below is similar, but the entire row is deleted from the sheet</paragraph> + <paragraph role="bascode" id="bas_id941652271392553">newrange = oDoc.CompactUp("Sheet1.G1:L10", WholeRow := True)</paragraph> + <paragraph role="bascode" id="bas_id751652271393117">' Deletes all rows where the first column is marked with an "X"</paragraph> + <paragraph role="bascode" id="bas_id761652271393034">newrange = oDoc.CompactUp("Sheet1.G1:L10", FilterFormula := "=(G1=""X"")")</paragraph> + <paragraph role="bascode" id="bas_id241652271725065">' Deletes all rows where the sum of values in the row is odd</paragraph> + <paragraph role="bascode" id="bas_id531652271726010">newrange = oDoc.CompactUp("Sheet1.G1:L10", FilterFormula := "=(MOD(SUM(G1:L1);2)=1)")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id451621536612227">newrange = myDoc.CompactUp("Sheet1.G1:L10")</paragraph> + <paragraph role="pycode" id="pyc_id201652272121288">newrange = myDoc.CompactUp("Sheet1.G1:L10", wholerow = True)</paragraph> + <paragraph role="pycode" id="pyc_id781652272122931">newrange = myDoc.CompactUp("Sheet1.G1:L10", filterformula = '=(G1="X")')</paragraph> + <paragraph role="pycode" id="pyc_id731652272123109">newrange = myDoc.CompactUp("Sheet1.G1:L10", filterformula = '=(MOD(SUM(G1:L1);2)=1)')</paragraph> + </pycode> +</section> + +<section id="CopySheet"> + <comment> CopySheet -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id901591631693213"> + <bookmark_value>Calc service;CopySheet</bookmark_value> + </bookmark> + <h2 id="hd_id51591631693461" localize="false">CopySheet</h2> + <paragraph role="paragraph" id="par_id591591631693816">Copies a specified sheet before an existing sheet or at the end of the list of sheets. The sheet to be copied may be contained inside any <emph>open</emph> Calc document. Returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id411621536777187"> + <input>svc.CopySheet(sheetname: any, newname: str, [beforesheet: any]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id871591631693741"><emph>sheetname</emph>: The name of the sheet to be copied as a string or its reference as an object.</paragraph> + <paragraph role="paragraph" id="par_id351591632126180" xml-lang="en-US"><emph>newname</emph>: The name of the sheet to insert. The name must not be in use in the document.</paragraph> + <paragraph role="paragraph" id="par_id211591632192379" xml-lang="en-US"><emph>beforesheet</emph>: The name (string) or index (numeric, starting from 1) of the sheet before which to insert the copied sheet. This argument is optional and the default behavior is to add the copied sheet at the last position.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id961591632309410" xml-lang="en-US">The following example makes a copy of the sheet "SheetX" and places it as the last sheet in the current document. The name of the copied sheet is "SheetY".</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id731591631693493">Dim oDoc as Object</paragraph> + <paragraph role="bascode" id="bas_id231611706034607">'Gets the Document object of the active window</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981611706030262">Set oDoc = CreateScriptService("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281611706033725">oDoc.CopySheet("SheetX", "SheetY")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id461591632297415" xml-lang="en-US">The example below copies "SheetX" from "FileA.ods" and pastes it at the last position of "FileB.ods" with the name "SheetY":</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id631591632407615">Dim oDocA As Object : Set oDocA = ui.OpenDocument("C:\Documents\FileA.ods", Hidden := True, ReadOnly := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id731591632415653">Dim oDocB As Object : Set oDocB = ui.OpenDocument("C:\Documents\FileB.ods")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651591632422603">oDocB.CopySheet(oDocA.Sheet("SheetX"), "SheetY")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id741621537296168">myDoc.CopySheet("SheetX", "SheetY")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761621537335378">docA = ui.OpenDocument(r"C:\Documents\FileA.ods", hidden = True, readonly = True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801621537405452">docB = ui.OpenDocument(r"C:\Documents\FileB.ods")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361621537425882">docB.CopySheet(docA.Sheet("SheetX"), "SheetY")</paragraph> + </pycode> + <tip id="par_id801595695285478" xml-lang="en-US">To copy sheets between <emph>open</emph> documents, use <literal>CopySheet</literal>. To copy sheets from documents that are <emph>closed</emph>, use <literal>CopySheetFromFile</literal>.</tip> +</section> + +<section id="CopySheetFromFile"> + <comment> CopySheetFromFile -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id101591714614827"> + <bookmark_value>Calc service;CopySheetFromFile</bookmark_value> + </bookmark> + <h2 id="hd_id301591714614286" localize="false">CopySheetFromFile</h2> + <paragraph role="paragraph" id="par_id931591714614755">Copies a specified sheet from a <emph>closed</emph> Calc document and pastes it before an existing sheet or at the end of the list of sheets of the file referred to by a <literal>Document</literal> object.</paragraph> + <paragraph role="paragraph" id="par_id271611706609445">If the file does not exist, an error is raised. If the file is not a valid Calc file, a blank sheet is inserted. If the source sheet does not exist in the input file, an error message is inserted at the top of the newly pasted sheet.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id721621537513995"> + <input>svc.CopySheetFromFile(filename: str, sheetname: str, newname: str, [beforesheet: any]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id471591714947181" xml-lang="en-US"><emph>filename</emph>: Identifies the file to open. It must follow the <literal>SF_FileSystem.FileNaming</literal> notation. The file must not be protected with a password.</paragraph> + <paragraph role="paragraph" id="par_id9915917146142"><emph>sheetname</emph>: The name of the sheet to be copied as a string.</paragraph> + <paragraph role="paragraph" id="par_id71591714614904" xml-lang="en-US"><emph>newname</emph>: The name of the copied sheet to be inserted in the document. The name must not be in use in the document.</paragraph> + <paragraph role="paragraph" id="par_id601591714614407" xml-lang="en-US"><emph>beforesheet</emph>: The name (string) or index (numeric, starting from 1) of the sheet before which to insert the copied sheet. This argument is optional and the default behavior is to add the copied sheet at the last position.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id981611707192039">The following example copies "SheetX" from "myFile.ods" and pastes it into the document referred to by "oDoc" as "SheetY" at the first position.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id561591714614817">oDoc.CopySheetFromFile("C:\Documents\myFile.ods", "SheetX", "SheetY", 1)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id171621537641434">myDoc.CopySheetFromFile(r"C:\Documents\myFile.ods", "SheetX", "SheetY", 1)</paragraph> + </pycode> +</section> + +<section id="CopyToCell"> + <comment> CopyToCell -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id481592558768560"> + <bookmark_value>Calc service;CopyToCell</bookmark_value> + </bookmark> + <h2 id="hd_id261592558768660" localize="false">CopyToCell</h2> + <paragraph role="paragraph" id="par_id91592558768804">Copies a specified source range (values, formulas and formats) to a destination range or cell. The method reproduces the behaviour of a Copy/Paste operation from a range to a single cell.</paragraph> + <paragraph role="paragraph" id="par_id831611707431984">It returns a string representing the modified range of cells. The size of the modified area is fully determined by the size of the source area.</paragraph> + <paragraph role="paragraph" id="par_id681592558768463" xml-lang="en-US">The source range may belong to another <emph>open</emph> document.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id431621537972303"> + <input>svc.CopyToCell(sourcerange: any, destinationcell: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id761592558768578"><emph>sourcerange</emph>: The source range as a string when it belongs to the same document or as a reference when it belongs to another open Calc document.</paragraph> + <paragraph role="paragraph" id="par_id711592558768466" xml-lang="en-US"><emph>destinationcell</emph>: The destination cell where the copied range of cells will be pasted, as a string. If a range is given, only its top-left cell is considered.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id431592904964362" xml-lang="en-US">Next is an example where the source and destination are in the same file:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id531592559464178">oDoc.CopyToCell("SheetX.A1:F10", "SheetY.C5")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id751592905035452" xml-lang="en-US">The example below illustrates how to copy a range from another open Calc document:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id971592558768687">Dim ui as Variant : ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401592558768991">Dim oDocSource As Object, oDocDestination As Object</paragraph> + <paragraph role="bascode" id="bas_id351592558768880">'Open the source document in the background (hidden)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751611708500322">Set oDocSource = ui.OpenDocument("C:\SourceFile.ods", Hidden := True, ReadOnly := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211611708507503">Set oDocDestination = CreateScriptService("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661611708507984">oDocDestination.CopyToCell(oDocSource.Range("Sheet1.C2:C4"), "SheetT.A5")</paragraph> + <paragraph role="bascode" id="bas_id1001611708508251">'Do not forget to close the source document because it was opened as hidden</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21611708536742">oDocSource.CloseDocument()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id531621538188012">docSource = ui.OpenDocument(r"C:\Documents\SourceFile.ods", hidden = True, readonly = True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id741621538288187">docDestination = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id691621538280854">docDestination.CopyToCell(docSource.Range("Sheet1.C2:C4"), "SheetT.A5")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361621538357798">docSource.CloseDocument()</paragraph> + </pycode> + <tip id="par_id61592905442071" xml-lang="en-US">To simulate a Copy/Paste from a range to a single cell, use <literal>CopyToCell</literal>. To simulate a Copy/Paste from a range to a larger range (with the same cells being replicated several times), use <literal>CopyToRange</literal>.</tip> +</section> + +<section id="CopyToRange"> + <comment> CopyToRange -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id171592903121677"> + <bookmark_value>Calc service;CopyToRange</bookmark_value> + </bookmark> + <h2 id="hd_id67159290312183" localize="false">CopyToRange</h2> + <paragraph role="paragraph" id="par_id1615929031212">Copies downwards and/or rightwards a specified source range (values, formulas and formats) to a destination range. The method imitates the behaviour of a Copy/Paste operation from a source range to a larger destination range.</paragraph> + <list type="unordered"> + <listitem> + <paragraph role="paragraph" id="par_id271592904084534" xml-lang="en-US">If the height (or width) of the destination area is > 1 row (or column) then the height (or width) of the source must be <= the height (or width) of the destination. Otherwise nothing happens.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id131592904286834" xml-lang="en-US">If the height (or width) of the destination is = 1 then the destination is expanded downwards (or rightwards) up to the height (or width) of the source range.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id661592904348877" xml-lang="en-US">The method returns a string representing the modified range of cells.</paragraph> + <paragraph role="paragraph" id="par_id41592903121807" xml-lang="en-US">The source range may belong to another <emph>open</emph> document.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id981621538491567"> + <input>svc.CopyToRange(sourcerange: any, destinationrange: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id841592903121145"><emph>sourcerange</emph>: The source range as a string when it belongs to the same document or as a reference when it belongs to another open Calc document.</paragraph> + <paragraph role="paragraph" id="par_id5515929031211000" xml-lang="en-US"><emph>destinationrange</emph>: The destination of the copied range of cells, as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id461592905128991" xml-lang="en-US">Copy within the same document:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id81592903121951">oDoc.CopyToRange("SheetX.A1:F10", "SheetY.C5:J5")</paragraph> + <paragraph role="bascode" id="bas_id601592904507182">' Returns a range string: "$SheetY.$C$5:$J$14"</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id1001592905195364" xml-lang="en-US">Copy from one file to another:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id121592903121767">Dim oDocA As Object : Set oDocA = ui.OpenDocument("C:\Documents\FileA.ods", Hidden := True, ReadOnly := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311592903121390">Dim oDocB As Object : Set oDocB = ui.OpenDocument("C:\Documents\FileB.ods")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id14159290312172">oDocB.CopyToRange(oDocA.Range("SheetX.A1:F10"), "SheetY.C5:J5")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761621538667290">doc.CopyToRange("SheetX.A1:F10", "SheetY.C5:J5")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id531621538188957">docA = ui.OpenDocument(r"C:\Documents\FileA.ods", hidden = True, readonly = True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id741621538288785">docB = ui.OpenDocument(r"C:\Documents\FileB.ods")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id691621538288954">docB.CopyToRange(docA.Range("SheetX.A1:F10"), "SheetY.C5:J5")</paragraph> + </pycode> +</section> + +<section id="CreateChart"> + <comment> CreateChart ------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id171592903123257"> + <bookmark_value>Calc service;CreateChart</bookmark_value> + </bookmark> + <h2 id="hd_id67159290312287" localize="false">CreateChart</h2> + <paragraph role="paragraph" id="par_id1615929033642">Creates a new chart object showing the data in the specified range. The returned chart object can be further manipulated using the <literal>Chart</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id981621538499667"> + <input>svc.CreateChart(chartname: str, sheetname: str, range: str, columnheader: bool = False, rowheader: bool = False): obj</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id841592903121025"><emph>chartname:</emph> The user-defined name of the chart to be created. The name must be unique in the same sheet.</paragraph> + <paragraph role="paragraph" id="par_id5515929031213680"><emph>sheetname:</emph> The name of the sheet where the chart will be placed.</paragraph> + <paragraph role="paragraph" id="par_id5515929031211522"><emph>range:</emph> The range to be used as the data source for the chart. The range may refer to any sheet of the Calc document.</paragraph> + <paragraph role="paragraph" id="par_id5515929031216390"><emph>columnheader:</emph> When <literal>True</literal>, the topmost row of the range is used as labels for the category axis or the legend (Default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id5515929031211633"><emph>rowheader:</emph> When <literal>True</literal>, the leftmost column of the range is used as labels for the category axis or the legend. (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id61635441176547">The examples below in Basic and Python create a chart using the data contained in the range "A1:B5" of "Sheet1" and place the chart in "Sheet2".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id81592903121217">Set oChart = oDoc.CreateChart("MyChart", "Sheet2", "Sheet1.A1:B5", RowHeader := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81592903121158">oChart.ChartType = "Donut"</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761621538667188">chart = doc.CreateChart("MyChart", "Sheet2", "Sheet1.A1:B5", rowheader=True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id761621538664592">chart.ChartType = "Donut"</paragraph> + </pycode> + <tip id="par_id231635441342180">Refer to the help page about ScriptForge's <link href="text/sbasic/shared/03/sf_chart.xhp" name="Chart service">Chart service</link> to learn more how to further manipulate chart objects. It is possible to change properties as the chart type, chart and axes titles and chart position.</tip> +</section> + +<section id="CreatePivotTable"> + <comment> CreatePivotTable ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id171592903120147"> + <bookmark_value>Calc service;CreatePivotTable</bookmark_value> + </bookmark> + <h2 id="hd_id67159290319647" localize="false">CreatePivotTable</h2> + <paragraph role="paragraph" id="par_id1615929033065">Creates a new pivot table with the properties defined by the arguments passed to the method.</paragraph> + <paragraph role="paragraph" id="par_id1001652794922144">A name must be provided for the pivot table. If a pivot table with the same name already exists in the targeted sheet, it will be replaced without warning.</paragraph> + <paragraph role="paragraph" id="par_id751652795324382">This method returns a string containing the range where the new pivot table was placed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id981621538467457"> + <input>svc.CreatePivotTable(pivottablename: str, sourcerange: str, targetcell: str, datafields: str[0..*], rowfields: str[0..*], columnfields: str[0..*], filterbutton: bool = true, rowtotals: bool = true, columntotals: bool = true): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id841592903128525"><emph>pivottablename:</emph> The user-defined name of the new pivot table.</paragraph> + <paragraph role="paragraph" id="par_id5515929031203640"><emph>sourcerange:</emph> The range containing the raw data, as a string. It is assumed that the first row contains the field names that are used by the pivot table.</paragraph> + <paragraph role="paragraph" id="par_id5515929031210400"><emph>targetcell:</emph> The top-left cell where the new pivot table will be placed. If a range is specified, only its top-left cell is considered.</paragraph> + <paragraph role="paragraph" id="par_id5515929031951290"><emph>datafields:</emph> It can be either a single string or an array containing strings that define field names and functions to be applied. When an array is specified, it must follow the syntax <input>Array("FieldName[;Function]", ...)</input>.</paragraph> + <paragraph role="paragraph" id="par_id361652795942348">The allowed functions are: <literal>Sum</literal>, <literal>Count</literal>, <literal>Average</literal>, <literal>Max</literal>, <literal>Min</literal>, <literal>Product</literal>, <literal>CountNums</literal>, <literal>StDev</literal>, <literal>StDevP</literal>, <literal>Var</literal>, <literal>VarP</literal> and <literal>Median</literal>. Function names must be provided in English. When all values are numerical, <literal>Sum</literal> is the default function, otherwise the default function is <literal>Count</literal>.</paragraph> + <paragraph role="paragraph" id="par_id5515929031211003"><emph>rowfields:</emph> A single string or an array with the field names that will be used as the pivot table rows.</paragraph> + <paragraph role="paragraph" id="par_id5515929031211114"><emph>columnfields:</emph> A single string or an array with the field names that will be used as the pivot table columns.</paragraph> + <paragraph role="paragraph" id="par_id361652796141240"><emph>filterbutton:</emph> Determines whether a filter button will be displayed above the pivot table (Default = <literal>True</literal>).</paragraph> + <paragraph role="paragraph" id="par_id661652796200051"><emph>rowtotals:</emph> Specifies if a separate column for row totals will be added to the pivot table (Default = <literal>True</literal>).</paragraph> + <paragraph role="paragraph" id="par_id671652796274304"><emph>columntotals</emph> Specifies if a separate row for column totals will be added to the pivot table (Default = <literal>True</literal>)</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id211652797038002">Dim vData As Variant, oDoc As Object, ui As Object, sTable As String, sPivot As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401652797037306">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781652797037626">Set oDoc = ui.CreateDocument("Calc")</paragraph> + <paragraph role="bascode" id="bas_id201652797038370">vData = Array(Array("Item", "State", "Team", "2002", "2003", "2004"), _</paragraph> + <paragraph role="bascode" id="bas_id171652797038762"> Array("Books", "Michigan", "Jean", 14788, 30222, 23490), _</paragraph> + <paragraph role="bascode" id="bas_id331652797039146"> Array("Candy", "Michigan", "Jean", 26388, 15641, 32849), _</paragraph> + <paragraph role="bascode" id="bas_id911652797039570"> Array("Pens", "Michigan", "Jean", 16569, 32675, 25396), _</paragraph> + <paragraph role="bascode" id="bas_id471652797039963"> Array("Books", "Michigan", "Volker", 21961, 21242, 29009), _</paragraph> + <paragraph role="bascode" id="bas_id681652797040338"> Array("Candy", "Michigan", "Volker", 26142, 22407, 32841))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581652797040723">sTable = oDoc.SetArray("A1", vData)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321652797041090">sPivot = oDoc.CreatePivotTable("PT1", sTable, "H1", _</paragraph> + <paragraph role="bascode" id="bas_id851652797041450"> Array("2002", "2003;count", "2004;average"), _ ' Three data fields</paragraph> + <paragraph role="bascode" id="bas_id791652797306993"> "Item", _ ' A single row field</paragraph> + <paragraph role="bascode" id="bas_id731652797041866"> Array("State", "Team"), False) ' Two column fields</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761652797473541">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id716527974738130">doc = ui.CreateDocument("Calc")</paragraph> + <paragraph role="pycode" id="pyc_id971652797474132">vData = [["Item", "State", "Team", "2002", "2003", "2004"],</paragraph> + <paragraph role="pycode" id="pyc_id921652797555153"> ["Books", "Michigan", "Jean", 14788, 30222, 23490],</paragraph> + <paragraph role="pycode" id="pyc_id891652797555537"> ["Candy", "Michigan", "Jean", 26388, 15641, 32849],</paragraph> + <paragraph role="pycode" id="pyc_id321652797555864"> ["Pens", "Michigan", "Jean", 16569, 32675, 25396)],</paragraph> + <paragraph role="pycode" id="pyc_id121652797556264"> ["Books", "Michigan", "Volker", 21961, 21242, 29009],</paragraph> + <paragraph role="pycode" id="pyc_id881652797556680"> ["Candy", "Michigan", "Volker", 26142, 22407, 32841]]</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441652797991546">sTable = doc.SetArray("A1", vData)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id791652797991834">sPivot = doc.CreatePivotTable("PT1", sTable, "H1",</paragraph> + <paragraph role="pycode" id="pyc_id941652797992017"> ["2002", "2003;count", "2004;average"],</paragraph> + <paragraph role="pycode" id="pyc_id471652797992561"> "Item",</paragraph> + <paragraph role="pycode" id="pyc_id561652797992185"> ["State", "Team"], False)</paragraph> + </pycode> + <tip id="par_id231635441342284">To learn more about Pivot Tables in %PRODUCTNAME Calc, read the <link href="text/scalc/guide/datapilot.xhp" name="Pivot table">Pivot Table</link> help page.</tip> +</section> + + +<section id="DAvg"> + <comment> DAvg, DCount, DMax, DMin, DSum -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id791595777001863"> + <bookmark_value>Calc service;DAvg</bookmark_value> + <bookmark_value>Calc service;DCount</bookmark_value> + <bookmark_value>Calc service;DMax</bookmark_value> + <bookmark_value>Calc service;DMin</bookmark_value> + <bookmark_value>Calc service;DSum</bookmark_value> + </bookmark> + <h2 id="hd_id471595777001777" localize="false">DAvg, DCount, DMax, DMin and DSum</h2> + <paragraph role="paragraph" id="par_id601595777001498">Apply the functions Average, Count, Max, Min and Sum, respectively, to all the cells containing numeric values on a given range.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id471621539319385"> + <input>svc.DAvg(range: str): float</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="bas_id331595777279484"> + <input>svc.DCount(range: str): float</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="bas_id911595777285935"> + <input>svc.DMax(range: str): float</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="bas_id471595777292407"> + <input>svc.DMin(range: str): float</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="bas_id41595777298840"> + <input>svc.DSum(range: str): float</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id741595777001537"><emph>range</emph>: The range to which the function will be applied, as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id121611752704572">The example below applies the <literal>Sum</literal> function to the range "A1:A1000" of the currently selected sheet:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id98159577700195">result = oDoc.DSum("~.A1:A1000")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id651621539472141">result = myDoc.DSum("~.A1:A1000")</paragraph> + </pycode> + <note id="par_id31611752782288">Cells in the given range that contain text will be ignored by all of these functions. For example, the <literal>DCount</literal> method will not count cells with text, only numerical cells.</note> +</section> + +<section id="ExportRangeToFile"> + <comment> ExportRangeToFile --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id271591632729478"> + <bookmark_value>Calc service;ExportRangeToFile</bookmark_value> + </bookmark> + <h2 id="hd_id331591632723258" localize="false">ExportRangeToFile</h2> + <paragraph role="paragraph" id="par_id501623063693113">Exports the specified range as an image or PDF file.</paragraph> + <paragraph role="paragraph" id="par_id401655654738754">This method returns <literal>True</literal> if the destination file was successfully saved.</paragraph> + <note id="par_id871655655302952">Hidden rows or columns in the specified range are not exported to the destination file.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id371623063577228"> + <input>svc.ExportRangeToFile(range: str, filename: str, imagetype: str = "pdf", overwrite: bool = False): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441623090896470"><emph>range</emph>: A sheet name or a cell range to be exported, as a string.</paragraph> + <paragraph role="paragraph" id="par_id451623063452651"><emph>filename</emph>: The name of the file to be saved. It must follow the <literal>SF_FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id441623090895310"><emph>imagetype</emph>: Identifies the destination file type. Possible values are "jpeg", "pdf" (default) and "png".</paragraph> + <paragraph role="paragraph" id="par_id441623090896317"><emph>overwrite</emph>: When set to <literal>True</literal>, the destination file may be overwritten (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id561655655121456">' Exports the entire sheet as a PDF file</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691623063398621">oDoc.ExportRangeToFile("SheetX", "C:\Temp\image.pdf")</paragraph> + <paragraph role="bascode" id="bas_id991655655060661">' Exports the range as a PNG file and overwrites the destination file if it exists</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191623063399539">oDoc.ExportRangeToFile("SheetX.A1:D10", "C:\Temp\image.png", "png", Overwrite := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id271623063215113">doc.ExportRangeToFile("SheetX", r"C:\Temp\image.pdf")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id961623063234881">doc.ExportRangeToFile("SheetX.A1:D10", r"C:\Temp\image.png", "png", overwrite = True)</paragraph> + </pycode> +</section> + +<section id="Forms"> + <comment> Forms ------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id271591632726788"> + <bookmark_value>Calc service;Forms</bookmark_value> + </bookmark> + <h2 id="hd_id331591632724120" localize="false">Forms</h2> + <paragraph role="paragraph" id="par_id501623063693649">Depending on the parameters provided this method will return:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id611623063742045" role="listitem">A zero-based Array (or a tuple in Python) with the names of all the forms contained in a given sheet (if the <literal>form</literal> argument is absent)</paragraph> + </listitem> + <listitem> + <paragraph id="par_id641623063744536" role="listitem">A <literal>SFDocuments.Form</literal> service instance representing the form specified as argument.</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id371623063588128"> + <input>svc.Forms(sheetname: str): str[0..*]</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id371623063588699"> + <input>svc.Forms(sheetname: str, form: str = ''): svc</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id751623151751397"> + <input>svc.Forms(sheetname: str, form: int): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441623090893210"><emph>sheetname</emph>: The name of the sheet, as a string, from which the form will be retrieved.</paragraph> + <paragraph role="paragraph" id="par_id451623063459286"><emph>form</emph>: The name or index corresponding to a form stored in the specified sheet. If this argument is absent, the method will return a list with the names of all forms available in the sheet.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id251623063305557">In the following examples, the first line gets the names of all forms stored in "Sheet1" and the second line retrieves the <literal>Form</literal> object of the form named "Form_A" which is stored in "Sheet1".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id191623063399519">Set FormNames = oDoc.Forms("Sheet1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691623063399711">Set FormA = oDoc.Forms("Sheet1", "Form_A")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id271623063215023">form_names = doc.Forms("Sheet1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id961623063234990">form_A = doc.Forms("Sheet1", "Form_A")</paragraph> + </pycode> +</section> + +<section id="GetColumnName"> + <comment> GetColumnName -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id271591632726624"> + <bookmark_value>Calc service;GetColumnName</bookmark_value> + </bookmark> + <h2 id="hd_id331591632726750" localize="false">GetColumnName</h2> + <paragraph role="paragraph" id="par_id401591632726431">Converts a column number ranging between 1 and 1024 into its corresponding letter (column 'A', 'B', ..., 'AMJ'). If the given column number is outside the allowed range, a zero-length string is returned.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id781621539718872"> + <input>svc.GetColumnName(columnnumber: int): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id83159163272628"><emph>columnnumber</emph>: The column number as an integer value in the interval 1 ... 1024.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id11621539831303">Displays a message box with the name of the third column, which by default is "C".</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id301591632726262">MsgBox oDoc.GetColumnName(3)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id661621539873908">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id901621540022229">bas.MsgBox(myDoc.GetColumnName(3))</paragraph> + </pycode> + <note id="par_id451611753568778">The maximum number of columns allowed on a Calc sheet is 1024.</note> +</section> + +<section id="GetFormula"> + <comment> GetFormula -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141593880142749"> + <bookmark_value>Calc service;GetFormula</bookmark_value> + </bookmark> + <h2 id="hd_id88159388014220" localize="false">GetFormula</h2> + <paragraph role="paragraph" id="par_id921593880142573">Get the formula(s) stored in the given range of cells as a single string, a 1D or a 2D array of strings.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id301621540291513"> + <input>svc.GetFormula(range: str): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id891593880142588"><emph>range</emph>: The range where to get the formulas from, as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id461611755257141">The following example returns a 3 by 2 array with the formulas in the range "A1:B3" (3 rows by 2 columns):</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id701593880142992">arrFormula = oDoc.GetFormula("~.A1:B3")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id191621540254086">arrFormula = myDoc.GetFormula("~.A1:B3")</paragraph> + </pycode> +</section> + +<section id="GetValue"> + <comment> GetValue -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id571592231156848"> + <bookmark_value>Calc service;GetValue</bookmark_value> + </bookmark> + <h2 id="hd_id471592231156242" localize="false">GetValue</h2> + <paragraph role="paragraph" id="par_id331592231156425">Get the value(s) stored in the given range of cells as a single value, a 1D array or a 2D array. All values are either doubles or strings.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id51621540380926"> + <input>svc.GetValue(range: str): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id91592231156434"><emph>range</emph>: The range where to get the values from, as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id701592231156881">arrValues = oDoc.GetValue("~.B1:C100")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id931621540443237">arrValues = myDoc.GetValue("~.B1:C100")</paragraph> + </pycode> + <note id="par_id991611756492772">If a cell contains a date, the number corresponding to that date will be returned. To convert numeric values to dates in Basic scripts, use the Basic <link href="text/sbasic/shared/03100300.xhp" name="CDate Basic"><literal>CDate</literal> builtin function</link>. In Python scripts, use the <link href="text/sbasic/shared/03/sf_basic.xhp#CDate" name="CDate Python"><literal>CDate</literal> function from the <literal>Basic</literal> service.</link></note> +</section> + +<section id="ImportFromCSVFile"> + <comment> ImportFromCSVFile -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id381593685490638"> + <bookmark_value>Calc service;ImportFromCSVFile</bookmark_value> + </bookmark> + <h2 id="hd_id151593685490480" localize="false">ImportFromCSVFile</h2> + <paragraph role="paragraph" id="par_id771593685490395">Imports the contents of a CSV-formatted text file and places it on a given destination cell.</paragraph> + <paragraph role="paragraph" id="par_id751611756909199">The destination area is cleared of all contents and formats before inserting the contents of the CSV file. The size of the modified area is fully determined by the contents of the input file.</paragraph> + <paragraph role="paragraph" id="par_id911593685490873" xml-lang="en-US">The method returns a string representing the modified range of cells.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id661621540542882"> + <input>svc.ImportFromCSVFile(filename: str, destinationcell: str, [filteroptions: str]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id851593685490824"><emph>filename</emph>: Identifies the file to open. It must follow the <literal>SF_FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id641593685490936" xml-lang="en-US"><emph>destinationcell</emph>: The destination cell to insert the imported data, as a string. If instead a range is given, only its top-left cell is considered.</paragraph> + <paragraph role="paragraph" id="par_id641593685863838" xml-lang="en-US"><emph>filteroptions</emph>: The arguments for the CSV input filter. The default filter makes following assumptions:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id661593686250471" role="listitem" xml-lang="en-US">The input file encoding is UTF8.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id161593686260876" role="listitem" xml-lang="en-US">The field separator is a comma, a semi-colon or a Tab character.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id711593686274293" role="listitem" xml-lang="en-US">The string delimiter is the double quote (").</paragraph> + </listitem> + <listitem> + <paragraph id="par_id171593686280838" role="listitem" xml-lang="en-US">All lines are included.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id881593686287161" role="listitem" xml-lang="en-US">Quoted strings are formatted as text.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id161593686293473" role="listitem" xml-lang="en-US">Special numbers are detected.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id791593686300499" role="listitem" xml-lang="en-US">All columns are presumed to be texts, except if recognized as valid numbers.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id381593686307406" role="listitem" xml-lang="en-US">The language is English/US, which implies that the decimal separator is "." and the thousands separator is ",".</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id181593685490526">oDoc.ImportFromCSVFile("C:\Temp\myCSVFile.csv", "SheetY.C5")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id401621541021415">myDoc.ImportFromCSVFile(r"C:\Temp\myCSVFile.csv", "SheetY.C5")</paragraph> + </pycode> + <tip id="par_id531611757154931">To learn more about the CSV Filter Options, refer to the <link href="text/shared/guide/csv_params.xhp" name="CSV Filter Options">CSV Filter Options help page</link>.</tip> +</section> + +<section id="ImportFromDatabase"> + <comment> ImportFromDatabase -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id281599568986735"> + <bookmark_value>Calc service;ImportFromDatabase</bookmark_value> + </bookmark> + <h2 id="hd_id1001599568986535" localize="false">ImportFromDatabase</h2> + <paragraph role="paragraph" id="par_id881599568986824">Imports the contents of a database table, query or resultset, i.e. the result of a SELECT SQL command, inserting it on a destination cell.</paragraph> + <paragraph role="paragraph" id="par_id81611763957509">The destination area is cleared of all contents and formats before inserting the imported contents. The size of the modified area is fully determined by the contents in the table or query.</paragraph> + <paragraph role="paragraph" id="par_id51599568986387" xml-lang="en-US">The method returns <literal>True</literal> when the import was successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id451621542093265"> + <input>svc.ImportFromDatabase(filename: str = "", registrationname: str = "", destinationcell: str = "", sqlcommand: str = "", directsql: bool): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id311599568986784"><emph>filename</emph>: Identifies the file to open. It must follow the <literal>SF_FileSystem.FileNaming</literal> notation.</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. This argument is ignored if a <literal>filename</literal> is provided.</paragraph> + <paragraph role="paragraph" id="par_id211599568986329" xml-lang="en-US"><emph>destinationcell</emph>: The destination of the imported data, as a string. If a range is given, only its top-left cell is considered.</paragraph> + <paragraph role="paragraph" id="par_id451599489278429"><emph>sqlcommand</emph>: A table or query name (without surrounding quotes or square brackets) or a SELECT SQL statement in which table and field names may be surrounded by square brackets or quotes to improve its readability.</paragraph> + <paragraph role="paragraph" id="par_id271599489278141" xml-lang="en-US"><emph>directsql</emph>: When <literal>True</literal>, the SQL command is sent to the database engine without pre-analysis. Default is <literal>False</literal>. The argument is ignored for tables. For queries, the applied option is the one set when the query was defined.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id801599568986870">oDoc.ImportFromDatabase("C:\Temp\myDbFile.odb", , "SheetY.C5", "SELECT * FROM [Employees] ORDER BY [LastName]")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id701621542319336">myDoc.ImportFromDatabase(r"C:\Temp\myDbFile.odb", , "SheetY.C5", "SELECT * FROM [Employees] ORDER BY [LastName]")</paragraph> + </pycode> +</section> + +<section id="InsertSheet"> + <comment> InsertSheet -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id511591698472720"> + <bookmark_value>Calc service;InsertSheet</bookmark_value> + </bookmark> + <h2 id="hd_id661591698472897" localize="false">InsertSheet</h2> + <paragraph role="paragraph" id="par_id121591698472929">Inserts a new empty sheet before an existing sheet or at the end of the list of sheets.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id531621619656738"> + <input>svc.InsertSheet(sheetname: str, [beforesheet: any]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id941591698472748"><emph>sheetname</emph>: The name of the new sheet.</paragraph> + <paragraph role="paragraph" id="par_id84159169847269" xml-lang="en-US"><emph>beforesheet</emph>: The name (string) or index (numeric, starting from 1) of the sheet before which to insert the new sheet. This argument is optional and the default behavior is to insert the sheet at the last position.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id241611764359510">The following example inserts a new empty sheet named "SheetX" and places it before "SheetY":</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id851591698472747">oDoc.InsertSheet("SheetX", "SheetY")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id21621619930373">myDoc.InsertSheet("SheetX", "SheetY")</paragraph> + </pycode> +</section> + +<section id="MoveRange"> + <comment> MoveRange -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id381592569476239"> + <bookmark_value>Calc service;MoveRange</bookmark_value> + </bookmark> + <h2 id="hd_id721592569476510" localize="false">MoveRange</h2> + <paragraph role="paragraph" id="par_id6415925694762">Moves a specified source range to a destination range of cells. The method returns a string representing the modified range of cells. The dimension of the modified area is fully determined by the size of the source area.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + + <paragraph role="paragraph" localize="false" id="par_id211621620062306"> + <input>svc.MoveRange(source: str, destination: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id571592569476332"><emph>source</emph>: The source range of cells, as a string.</paragraph> + <paragraph role="paragraph" id="par_id891592569476362" xml-lang="en-US"><emph>destination</emph>: The destination cell, as a string. If a range is given, its top-left cell is considered as the destination.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id651592569476254">oDoc.MoveRange("SheetX.A1:F10", "SheetY.C5")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="par_id171621619974289">myDoc.MoveRange("SheetX.A1:F10", "SheetY.C5")</paragraph> + </pycode> +</section> + +<section id="MoveSheet"> + <comment> MoveSheet -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id561591698903617"> + <bookmark_value>Calc service;MoveSheet</bookmark_value> + </bookmark> + <h2 id="hd_id761591698903271" localize="false">MoveSheet</h2> + <paragraph role="paragraph" id="par_id831591698903829">Moves an existing sheet and places it before a specified sheet or at the end of the list of sheets.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001621620119732"> + <input>svc.MoveSheet(sheetname: str, [beforesheet: any]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id351591698903911"><emph>sheetname</emph>: The name of the sheet to move. The sheet must exist or an exception is raised.</paragraph> + <paragraph role="paragraph" id="par_id9159169890334" xml-lang="en-US"><emph>beforesheet</emph>: The name (string) or index (numeric, starting from 1) of the sheet before which the original sheet will be placed. This argument is optional and the default behavior is to move the sheet to the last position.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id951611766058734">The example below moves the existing sheet "SheetX" and places it before "SheetY":</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id271591698903687">oDoc.MoveSheet("SheetX", "SheetY")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id561621620208625">myDoc.MoveSheet("SheetX", "SheetY")</paragraph> + </pycode> +</section> + +<section id="Offset"> + <comment> Offset ------------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id29159223350681"> + <bookmark_value>Calc service;Offset</bookmark_value> + </bookmark> + <h2 id="hd_id61592233506228" localize="false">Offset</h2> + <paragraph role="paragraph" id="par_id51592233506371">Returns a new range (as a string) offset by a certain number of rows and columns from a given range.</paragraph> + <paragraph role="paragraph" id="par_id61611768400376">This method has the same behavior as the homonymous Calc's <link href="text/scalc/01/04060109.xhp" name="Offset function">Offset function</link>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id301621620394077"> + <input>svc.Offset(reference: str, rows: int = 0, columns: int = 0, [height: int], [width: int]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id901592233506293"><emph>reference</emph>: The range, as a string, that the method will use as reference to perform the offset operation.</paragraph> + <paragraph role="paragraph" id="par_id781592234124856" xml-lang="en-US"><emph>rows</emph>: The number of rows by which the initial range is offset upwards (negative value) or downwards (positive value). Use 0 (default) to stay in the same row.</paragraph> + <paragraph role="paragraph" id="par_id971592234138769" xml-lang="en-US"><emph>columns</emph>: The number of columns by which the initial range is offset to the left (negative value) or to the right (positive value). Use 0 (default) to stay in the same column.</paragraph> + <paragraph role="paragraph" id="par_id321592234150061" xml-lang="en-US"><emph>height</emph>: The vertical height for an area that starts at the new range position. Omit this argument when no vertical resizing is needed.</paragraph> + <paragraph role="paragraph" id="par_id271592234165247" xml-lang="en-US"><emph>width</emph>: The horizontal width for an area that starts at the new range position. Omit this argument when no horizontal resizing is needed.</paragraph> + <paragraph role="paragraph" id="par_id871592234172652" xml-lang="en-US">Arguments <literal>rows</literal> and <literal>columns</literal> must not lead to zero or negative start row or column.</paragraph> + <paragraph role="paragraph" id="par_id211592234180073" xml-lang="en-US">Arguments <literal>height</literal> and <literal>width</literal> must not lead to zero or negative count of rows or columns.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id341592234459577">oDoc.Offset("A1", 2, 2)</paragraph> + <paragraph role="bascode" id="bas_id651592234465732">'SheetX.$C$3 (A1 moved by two rows and two columns down)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51592234472632">oDoc.Offset("A1", 2, 2, 5, 6)</paragraph> + <paragraph role="bascode" id="bas_id521592234478848">'SheetX.$C$3:$H$7 (A1 offset by two rows and columns with width of 5 rows and 6 columns)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id181621620341176">myDoc.Offset("A1", 2, 2)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id991621620345183">myDoc.Offset("A1", 2, 2, 5, 6)</paragraph> + </pycode> +</section> + +<section id="OpenRangeSelector"> + <comment> OpenRangeSelector ------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id29159223350681"> + <bookmark_value>Calc service;OpenRangeSelector</bookmark_value> + </bookmark> + <h2 id="hd_id61592233506804" localize="false">OpenRangeSelector</h2> + <paragraph role="paragraph" id="par_id51592233506021">Opens a non-modal dialog that can be used to select a range in the document and returns a string containing the selected range.</paragraph> + <note id="par_id301637936295380">This method opens the same dialog that is used by %PRODUCTNAME when the Shrink button is pressed. For example, the <menuitem>Tools - Goal Seek</menuitem> dialog has a Shrink button to the right of the <menuitem>Formula cell</menuitem> field.</note> + <paragraph role="paragraph" id="par_id551637936545121">This method does not change the current selection.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id301621620394202"> + <input>svc.OpenRangeSelector(opt title: str, opt selection: str, singlecell: bool = False, closeafterselect: bool = True): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id901592233506001"><emph>title</emph>: The title of the dialog, as a string.</paragraph> + <paragraph role="paragraph" id="par_id781592234124502"><emph>selection</emph>: An optional range that is initially selected when the dialog is displayed.</paragraph> + <paragraph role="paragraph" id="par_id971592234138989"><emph>singlecell</emph>: When <literal>True</literal> (default) only single-cell selection is allowed. When <literal>False</literal> range selection is allowed.</paragraph> + <paragraph role="paragraph" id="par_id321592234150345"><emph>closeafterselect</emph>: When <literal>True</literal> (default) the dialog is closed immediately after the selection is made. When <literal>False</literal> the user can change the selection as many times as needed and then manually close the dialog.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id131637937486802">Dim sRange as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331637937487031">sRange = oDoc.OpenRangeSelector(Title := "Select a range")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id181621620341364">sRange = myDoc.OpenRangeSelector(title = "Select a range")</paragraph> + </pycode> +</section> + +<section id="Printf"> + <comment> Printf ------------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id29159223356581"> + <bookmark_value>Calc service;Printf</bookmark_value> + </bookmark> + <h2 id="hd_id61592233503364" localize="false">Printf</h2> + <paragraph role="paragraph" id="par_id51592233503441">Returns the input string after substituting its token characters by their values in a given range.</paragraph> + <paragraph role="paragraph" id="par_id551637936596521">This method does not change the current selection.</paragraph> + <tip id="par_id171637938442558">This method can be used to quickly extract specific parts of a range name, such as the sheet name or first cell column and row, and use them to compose a new range address.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id301621620394154"> + <input>svc.Printf(inputstr: str, range: str, tokencharacter: str = "%"): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id901592233506232"><emph>inputstr</emph>: The string containing the tokens that will be replaced by the corresponding values in <literal>range</literal>.</paragraph> + <paragraph role="paragraph" id="par_id781592234161102"><emph>range</emph>: A <literal>RangeName</literal> from which values will be extracted. If it contains a sheet name, the sheet must exist.</paragraph> + <paragraph role="paragraph" id="par_id971592234102889"><emph>tokencharacter</emph>: Character used to identify tokens. By default "%" is the token character. The following tokens are accepted:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id261637943912156" role="listitem"><emph>%S</emph> - The sheet name containing the range, including single quotes when necessary.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id441637943912380" role="listitem"><emph>%R1</emph> - The row number of the top left cell of the range.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id521637943912620" role="listitem"><emph>%C1</emph> - The column letter of the top left cell of the range.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id371637943912860" role="listitem"><emph>%R2</emph> - The row number of the bottom right cell of the range.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id291637943913116" role="listitem"><emph>%C2</emph> - The column letter of the bottom right cell of the range.</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id941637943467476">The example below extracts each element of the <literal>RangeName</literal> defined in <literal>sRange</literal> and uses them to compose a message.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id491637943243426">Dim sRange as String, sInputStr as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921637943243610">sRange = "Sheet1.A1:E10"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991637943243818">sInputStr = "Sheet name: %S" & Chr(10) & _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id516379432447042"> "First row: %R1" & Chr(10) & _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851637943244258"> "First column %C1" & Chr(10) & _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911637943244486"> "Last row %R2" & Chr(10) & _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121637943244706"> "Last column %C2"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821637943244894">MsgBox oDoc.Printf(sInputStr, sRange)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id241637944350648">The <literal>Printf</literal> method can be combined with <literal>SetFormula</literal> to create formulas over multiple cells. For instance, consider a table with numeric values in the range "A1:E10" from which formulas are to be created to sum the values in each row and place the results in the range "F1:F10":</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id631637944876589">Dim sFormula as String, sRange as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281637944876820">sRange = "A1:E10"</paragraph> + <paragraph role="bascode" id="bas_id371637944971921">' Note the use of the "$" character</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711637944876998">sFormula = "=SUM($%C1%R1:$%C2%R1)"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931637944877188">oDoc.SetFormula("F1:F10", oDoc.Printf(sFormula, sRange))</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id161637943523364">sRange = "Sheet1.A1:E10"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id951637943523582">sInputStr = "Sheet name: %S\n" \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id301637943523764"> "First row: %R1\n" \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id631637943523987"> "First column %C1\n" \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id731637943524196"> "Last row %R2\n" \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id516379435243888"> "Last column %C2"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id511637943524613">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id216379435248836">bas.MsgBox(myDoc.Printf(sInputStr, sRange))</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id681637944943446">sRange = "A1:E10</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id851637944943797">sFormula = "=SUM($%C1%R1:$%C2%R1)"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id911637944944046">myDoc.SetFormula("F1:F10", myDoc.Printf(sFormula, sRange))</paragraph> + </pycode> +</section> + +<section id="PrintOut"> + <comment> PrintOut ---------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721985200121249"> + <bookmark_value>Calc service;PrintOut</bookmark_value> + </bookmark> + <h2 id="hd_id261589202101415" localize="false">PrintOut</h2> + <paragraph role="paragraph" id="par_id156589200121138">This method sends the contents of the given sheet to the default printer or to the printer defined by the <literal>SetPrinter</literal> method of the <literal>Document</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id981611169416934">Returns <literal>True</literal> if the sheet was successfully printed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001622827822169"> + <input>svc.PrintOut(opt sheetname: str, pages: str = "", copies: num = 1): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id368519200121646"><emph>sheetname</emph>: The sheet to print, default is the active sheet.</paragraph> + <paragraph role="paragraph" id="par_id211635436910093"><emph>pages</emph>: The pages to print as a string, like in the user interface. Example: "1-4;10;15-18". Default is all pages.</paragraph> + <paragraph role="paragraph" id="par_id141635436912146"><emph>copies</emph>: The number of copies. Default is 1.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891589200121516">If oDoc.PrintOut("SheetX", "1-4;10;15-18", Copies := 2) Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id515892500606125"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751682227903730">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731622728946898">if doc.PrintOut('SheetX', copies=3, pages='45-88'):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221628227947414"> # ...</paragraph> + </pycode> +</section> + +<section id="RemoveSheet"> + <comment> RemoveSheet -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id821591699085559"> + <bookmark_value>Calc service;RemoveSheet</bookmark_value> + </bookmark> + <h2 id="hd_id311591699085933" localize="false">RemoveSheet</h2> + <paragraph role="paragraph" id="par_id661591699085351">Removes an existing sheet from the document.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id991621620588147"> + <input>svc.RemoveSheet(sheetname: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id331591699085330"><emph>sheetname</emph>: The name of the sheet to remove.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id81591699085870">oDoc.RemoveSheet("SheetY")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id891621620636884">myDoc.RemoveSheet("SheetY")</paragraph> + </pycode> +</section> + +<section id="RenameSheet"> + <comment> RenameSheet -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id781591704316677"> + <bookmark_value>Calc service;RenameSheet</bookmark_value> + </bookmark> + <h2 id="hd_id171591704316197" localize="false">RenameSheet</h2> + <paragraph role="paragraph" id="par_id971591704316873">Renames the given sheet and returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id301621620709359"> + <input>svc.RenameSheet(sheetname: str, newname: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id161591704316337"><emph>sheetname</emph>: The name of the sheet to rename.</paragraph> + <paragraph role="paragraph" id="par_id931591704316998" xml-lang="en-US"><emph>newname</emph>: the new name of the sheet. It must not exist yet.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id351611775260443">This example renames the active sheet to "SheetY":</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id291591704316891">oDoc.RenameSheet("~", "SheetY")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id521621620764138">mydoc.RenameSheet("~", "SheetY")</paragraph> + </pycode> +</section> + +<section id="SetArray"> + <comment> SetArray -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id221592745582441"> + <bookmark_value>Calc service;SetArray</bookmark_value> + </bookmark> + <h2 id="hd_id831592745582224" localize="false">SetArray</h2> + <paragraph role="paragraph" id="par_id191592745582983">Stores the given value starting from a specified target cell. The updated area expands itself from the target cell or from the top-left corner of the given range to accommodate the size of the input <literal>value</literal> argument. Vectors are always expanded vertically.</paragraph> + <paragraph role="paragraph" id="par_id671592745582573" xml-lang="en-US">The method returns a string representing the modified area as a range of cells.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id401621620954121"> + <input>svc.SetArray(targetcell: str, value: any): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id801592745582116"><emph>targetcell</emph>: The cell or a range as a string from where to start to store the given value.</paragraph> + <paragraph role="paragraph" id="par_id321592745582192" xml-lang="en-US"><emph>value</emph>: A scalar, a vector or an array (in Python, one or two-dimensional lists and tuples) with the new values to be stored from the target cell or from the top-left corner of the range if <literal>targetcell</literal> is a range. The new values must be strings, numeric values or dates. Other types will cause the corresponding cells to be emptied.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id331611776151376">The following example uses the builtin <link href="text/sbasic/shared/03104300.xhp" name="DimArray function">DimArray function</link> to create an array and then store it in cell "A1":</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id691611776204011">Dim arrData as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641611776236071">arrData = DimArray(2, 1)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701611776237365">arrData(0, 0) = 1 : arrData(1, 0) = 2 : arrData(2, 0) = 3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id901611776237759">arrData(0, 1) = "One" : arrData(1, 1) = "Two" : arrData(2, 1) = "Three"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711611776238030">oDoc.SetArray("Sheet1.A1", arrData)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id601611775600983">This example uses the <literal>RangeInit</literal> method of the <link href="text/sbasic/shared/03/sf_array.xhp#RangeInit" name="CHANGE ME">ScriptForge Array service</link> to create an array with values that are then stored from cell "A1" and downwards.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id251592745582536">'Fill 1st column with values from 1 to 1000</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51592745582822">oDoc.SetArray("Sheet1.A1", SF_Array.RangeInit(1, 1000))</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id611621621144146">arrData = ((1, "One"), (2, "Two"), (3, "Three"))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id451621621144554">myDoc.SetArray("Sheet1.A1", arrData)</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id861621621596623">myDoc.SetArray("Sheet1.A1", tuple(i + 1 for i in range(1000)))</paragraph> + </pycode> + <tip id="par_id291592905671530" xml-lang="en-US">To dump the full contents of an array in a sheet, use <emph>SetArray</emph>. To dump the contents of an array only within the boundaries of the targeted range of cells, use <emph>SetValue</emph>.</tip> +</section> + +<section id="SetValue"> + <comment> SetValue -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id901592231799526"> + <bookmark_value>Calc service;SetValue</bookmark_value> + </bookmark> + <h2 id="hd_id681592231799943" localize="false">SetValue</h2> + <paragraph role="paragraph" id="par_id601592231799489">Stores the given value in the specified range. The size of the modified area is equal to the size of the target range.</paragraph> + <paragraph role="paragraph" id="par_id1001592233389953" xml-lang="en-US">The method returns a string representing the modified area as a range of cells.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id961621622582995"> + <input>svc.SetValue(targetrange: str, value: any): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id361592231799255"><emph>targetrange</emph>: The range where to store the given value, as a string.</paragraph> + <paragraph role="paragraph" id="par_id461592232081985" xml-lang="en-US"><emph>value</emph>: A scalar, a vector or an array with the new values for each cell of the range. The new values must be strings, numeric values or dates. Other types will cause the corresponding cells to be emptied.</paragraph> + <paragraph role="paragraph" id="par_id841592745785192" xml-lang="en-US">The full range is updated and the remainder of the sheet is left unchanged. If the size of <literal>value</literal> is smaller than the size of <literal>targetrange</literal>, then the remaining cells will be emptied.</paragraph> + <paragraph role="paragraph" id="par_id191611776838396">If the size of <literal>value</literal> is larger than the size of <literal>targetrange</literal>, then <literal>value</literal> is only partially copied until it fills the size of <literal>targetrange</literal>.</paragraph> + <paragraph role="paragraph" id="par_id71611776941663">Vectors are expanded vertically, except if <literal>targetrange</literal> has a height of exactly 1 row.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id2715922317995">oDoc.SetValue("A1", 2)</paragraph> + <paragraph role="bascode" id="bas_id541592232948567">'Below the Value array is smaller than the TargetRange (remaining cells are emptied)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701592232940773">oDoc.SetValue("A1:F1", Array(1, 2, 3))</paragraph> + <paragraph role="bascode" id="bas_id541592232948825">'Below the Value and TargetRange have the same size</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981592232966698">oDoc.SetValue("A1:D2", SF_Array.AppendRow(Array(1, 2, 3, 4), Array(5, 6, 7, 8)))</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id731621689592755">If you want to fill a single row with values, you can use the <literal>Offset</literal> function. In the example below, consider that <literal>arrData</literal> is a one-dimensional array:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id21621689635263">Dim firstCell As String : firstCell = "A1"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881621689635592">Dim lenArray As Integer : lenArray = UBound(arrData) - LBound(arrData) + 1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71621689635887">Dim newRange As String : newRange = oDoc.Offset(firstCell, width = lenArray)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831621689898866">oDoc.SetValue(newRange, arrData)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id861621622679043">myDoc.SetValue("A1", 2)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id881621622724608">myDoc.SetValue("A1:F1", (1, 2, 3))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id51621622725754">myDoc.SetValue("A1:D2", ((1, 2, 3, 4), (5, 6, 7, 8)))</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id891621689922925">firstCell = "A1"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id61621689923184">newRange = doc.Offset(firstCell, width = len(arrData))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id771621689923430">doc.SetValue(newRange, arrData)</paragraph> + </pycode> +</section> + +<section id="SetCellStyle"> + <comment> SetCellStyle -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id21595767687885"> + <bookmark_value>Calc service;SetCellStyle</bookmark_value> + </bookmark> + <h2 id="hd_id201595767687377" localize="false">SetCellStyle</h2> + <paragraph role="paragraph" id="par_id521595767687154">Applies the specified cell style to the given target range. The full range is updated and the remainder of the sheet is left untouched. If the cell style does not exist, an error is raised.</paragraph> + <paragraph role="paragraph" id="par_id70159576768715" xml-lang="en-US">The method returns a string representing the modified area as a range of cells.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id731621622877726"> + <input>svc.SetCellStyle(targetrange: str, style: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id22159576768782"><emph>targetrange</emph>: The range to which the style will be applied, as a string.</paragraph> + <paragraph role="paragraph" id="par_id181595767687247" xml-lang="en-US"><emph>style</emph>: The name of the cell style to apply.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id661595767687880">oDoc.SetCellStyle("A1:J1", "Heading 1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541595767687904">oDoc.SetCellStyle("A2:J100", "Neutral")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731621622966995">myDoc.SetCellStyle("A1:J1", "Heading 1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id931621622967434">myDoc.SetCellStyle("A2:J100", "Neutral")</paragraph> + </pycode> +</section> + +<section id="SetFormula"> + <comment> SetFormula -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231593880376363"> + <bookmark_value>Calc service;SetFormula</bookmark_value> + </bookmark> + <h2 id="hd_id191593880376344" localize="false">SetFormula</h2> + <paragraph role="paragraph" id="par_id481593880376480">Inserts the given (array of) formula(s) in the specified range. The size of the modified area is equal to the size of the range.</paragraph> + <paragraph role="paragraph" id="par_id711593880376106" xml-lang="en-US">The method returns a string representing the modified area as a range of cells.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701621623027410"> + <input>svc.SetFormula(targetrange: str, formula: any): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id891593880376776"><emph>targetrange</emph>: The range to insert the formulas, as a string.</paragraph> + <paragraph role="paragraph" id="par_id941593880376500"><emph>formula</emph>: A string, a vector or an array of strings with the new formulas for each cell in the target range.</paragraph> + <paragraph role="paragraph" id="par_id551593880376513">The full range is updated and the remainder of the sheet is left unchanged.</paragraph> + <paragraph role="paragraph" id="par_id811593880756356">If the given formula is a string, the unique formula is pasted along the whole range with adjustment of the relative references.</paragraph> + <paragraph role="paragraph" id="par_id491593880857823">If the size of <literal>formula</literal> is smaller than the size of <literal>targetrange</literal>, then the remaining cells are emptied.</paragraph> + <paragraph role="paragraph" id="par_id701611778103306">If the size of <literal>formula</literal> is larger than the size of <literal>targetrange</literal>, then the formulas are only partially copied until it fills the size of <literal>targetrange</literal>.</paragraph> + <paragraph role="paragraph" id="par_id761611777946581">Vectors are always expanded vertically, except if <literal>targetrange</literal> has a height of exactly 1 row.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id441593880376307">oDoc.SetFormula("A1", "=A2")</paragraph> + <paragraph role="bascode" id="bas_id681593880376489">'Horizontal vector, partially empty</paragraph> + <paragraph role="bascode" localize="false" id="bas_id951593880376376">oDoc.SetFormula("A1:F1", Array("=A2", "=B2", "=C2+10"))</paragraph> + <paragraph role="bascode" id="bas_id961593881331390">'D2 contains the formula "=H2"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id951593880376571">oDoc.SetFormula("A1:D2", "=E1")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941621623159044">myDoc.SetFormula("A1", "=A2")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151621623174150">myDoc.SetFormula("A1:F1", ("=A2", "=B2", "=C2+10"))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651621623174759">myDoc.SetFormula("A1:D2", "=E1")</paragraph> + </pycode> +</section> + +<section id="ShiftDown"> + <comment> ShiftDown --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231593880376104"> + <bookmark_value>Calc service;ShiftDown</bookmark_value> + </bookmark> + <h2 id="hd_id191593880376667" localize="false">ShiftDown</h2> + <paragraph role="paragraph" id="par_id481593880373070">Moves a given range of cells downwards by inserting empty rows. The current selection is not affected.</paragraph> + <paragraph role="paragraph" id="par_id801637929435655">Depending on the value of the <literal>wholerow</literal> argument the inserted rows can either span the width of the specified range or span all columns in the row.</paragraph> + <paragraph role="paragraph" id="par_id711593880370247" xml-lang="en-US">This method returns a string representing the new location of the initial range.</paragraph> + <note id="par_id811637929284110">If the shifted range exceeds the sheet edges, then nothing happens.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701621623022250"> + <input>svc.ShiftDown(range: str, wholerow: bool = False, opt rows: int): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id891593880376123"><emph>range</emph>: The range above which rows will be inserted, as a string.</paragraph> + <paragraph role="paragraph" id="par_id941593880376566"><emph>wholerow</emph>: If set to <literal>False</literal> (default), then the width of the inserted rows will be the same as the width of the specified <literal>range</literal>. Otherwise, the inserted row will span all columns in the sheet.</paragraph> + <paragraph role="paragraph" id="par_id551593880373045"><emph>rows</emph>: The number of rows to be inserted. The default value is the height of the original <literal>range</literal>. The number of rows must be a positive number.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id881637931053547">' Moves the range "A3:D3" down by one row; affects only columns A to D</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791637931053747">oDoc.ShiftDown("A3:D3")</paragraph> + <paragraph role="bascode" id="bas_id661637931232893">' The inserted row spans all columns in the sheet</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741637931233093">oDoc.ShiftDown("A3:D3", WholeRow := True)</paragraph> + <paragraph role="bascode" id="bas_id291637931053897">' Moves the range "A3:D3" down by five rows</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91637931054041">oDoc.ShiftDown("A3:D3", Rows := 5)</paragraph> + <paragraph role="bascode" id="bas_id501638218784265">' Moves the range "A3:D10" down by two rows and shows the new location of the original range</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391638218784528">Dim sNewRange as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id761638218784697">sNewRange = oDoc.ShiftDown("A3:D10", Rows := 2)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291638218784864">MsgBox sNewRange ' $Sheet1.$A$5:$D$12</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941621623159122">myDoc.ShiftDown("A3:D3")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651621623174886">myDoc.ShiftDown("A3:D3", wholerow = True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151621623174257">myDoc.ShiftDown("A3:D3", rows = 5)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651621623174060">sNewRange = myDoc.ShiftDown("A3:D10", rows = 2)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id621638218996706">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151638218996938">bas.MsgBox(sNewRange)</paragraph> + </pycode> +</section> + +<section id="ShiftLeft"> + <comment> ShiftLeft --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231593880376547"> + <bookmark_value>Calc service;ShiftLeft</bookmark_value> + </bookmark> + <h2 id="hd_id191593880373026" localize="false">ShiftLeft</h2> + <paragraph role="paragraph" id="par_id481593880376255">Deletes the leftmost columns of a given range and moves to the left all cells to the right of the affected range. The current selection is not affected.</paragraph> + <paragraph role="paragraph" id="par_id801637929460261">Depending on the value of the <literal>wholecolumn</literal> argument the deleted columns can either span the height of the specified range or span all rows in the column.</paragraph> + <paragraph role="paragraph" id="par_id711593880371259" xml-lang="en-US">This method returns a string representing the location of the remaining portion of the initial range. If all cells in the original range have been deleted, then an empty string is returned.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701621623026330"> + <input>svc.ShiftLeft(range: str, wholecolumn: bool = False, opt columns: int): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id891593880376205"><emph>range</emph>: The range from which cells will be deleted, as a string.</paragraph> + <paragraph role="paragraph" id="par_id941593880356026"><emph>wholecolumn</emph>: If set to <literal>False</literal> (default), then the height of the deleted columns will be the same as the height of the specified <literal>range</literal>. Otherwise, the deleted columns will span all rows in the sheet.</paragraph> + <paragraph role="paragraph" id="par_id551593880373306"><emph>columns</emph>: The number of columns to be deleted from the specified <literal>range</literal>. The default value is the width of the original <literal>range</literal>, which is also the maximum value of this argument.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id881637931064919">' Deletes the range "B3:B6"; moves left all cells to the right</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791637931033877">oDoc.ShiftLeft("B3:B6")</paragraph> + <paragraph role="bascode" id="bas_id291637931056991">' Deletes the first column in the range "A3:D6"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id916379310515507">oDoc.ShiftLeft("A3:D6", Columns := 1)</paragraph> + <paragraph role="bascode" id="bas_id661637931232569">' The deleted columns (A to D) spans all rows in the sheet</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741637931230274">oDoc.ShiftLeft("A3:D6", WholeColumn := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941621623156582">myDoc.ShiftLeft("B3:B6")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151621623155447">myDoc.ShiftLeft("A3:D6", Columns = 1)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651621623172116">myDoc.ShiftLeft("A3:D6", WholeColumn = True)</paragraph> + </pycode> +</section> + +<section id="ShiftUp"> + <comment> ShiftUp ----------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231593880376104"> + <bookmark_value>Calc service;ShiftUp</bookmark_value> + </bookmark> + <h2 id="hd_id191593880370547" localize="false">ShiftUp</h2> + <paragraph role="paragraph" id="par_id481593880373529">Deletes the topmost rows of a given range and moves upwards all cells below the affected range. The current selection is not affected.</paragraph> + <paragraph role="paragraph" id="par_id801637929435361">Depending on the value of the <literal>wholerow</literal> argument the deleted rows can either span the width of the specified range or span all columns in the row.</paragraph> + <paragraph role="paragraph" id="par_id711593880370299" xml-lang="en-US">This method returns a string representing the location of the remaining portion of the initial range. If all cells in the original range have been deleted, then an empty string is returned.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701621623026380"> + <input>svc.ShiftUp(range: str, wholerow: bool = False, opt rows: int): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id891593880376583"><emph>range</emph>: The range from which cells will be deleted, as a string.</paragraph> + <paragraph role="paragraph" id="par_id941593880300966"><emph>wholerow</emph>: If set to <literal>False</literal> (default), then the width of the deleted rows will be the same as the width of the specified <literal>range</literal>. Otherwise, the deleted row will span all columns in the sheet.</paragraph> + <paragraph role="paragraph" id="par_id551593880373265"><emph>rows</emph>: The number of rows to be deleted from the specified <literal>range</literal>. The default value is the height of the original <literal>range</literal>, which is also the maximum value of this argument.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id881637931064667">' Deletes the range "A3:D3"; moves all cells below it by one row up</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791637931056477">oDoc.ShiftUp("A3:D3")</paragraph> + <paragraph role="bascode" id="bas_id291637931056647">' Deletes the first row in the range "A3:D6"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91637931054337">oDoc.ShiftUp("A3:D6", Rows := 1)</paragraph> + <paragraph role="bascode" id="bas_id661637931232493">' The deleted rows spans all columns in the sheet</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741637931233634">oDoc.ShiftUp("A3:D6", WholeRow := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941621623150252">myDoc.ShiftUp("A3:D3")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151621623176647">myDoc.ShiftUp("A3:D6", rows = 1)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651621623174036">myDoc.ShiftUp("A3:D6", wholerow = True)</paragraph> + </pycode> +</section> + +<section id="ShiftRight"> + <comment> ShiftRight --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231593880376025"> + <bookmark_value>Calc service;ShiftRight</bookmark_value> + </bookmark> + <h2 id="hd_id191593880376547" localize="false">ShiftRight</h2> + <paragraph role="paragraph" id="par_id481593880372568">Moves a given range of cells to the right by inserting empty columns. The current selection is not affected.</paragraph> + <paragraph role="paragraph" id="par_id801637929335255">Depending on the value of the <literal>wholecolumn</literal> argument the inserted columns can either span the height of the specified range or span all rows in the column.</paragraph> + <paragraph role="paragraph" id="par_id711593880372560" xml-lang="en-US">This method returns a string representing the new location of the initial range.</paragraph> + <note id="par_id811637929283210">If the shifted range exceeds the sheet edges, then nothing happens.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701621623022269"> + <input>svc.ShiftRight(range: str, wholecolumn: bool = False, opt columns: int): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id891593880370543"><emph>range</emph>: The range which will have empty columns inserted to its left, as a string.</paragraph> + <paragraph role="paragraph" id="par_id941593880373316"><emph>wholecolumn</emph>: If set to <literal>False</literal> (default), then the height of the inserted columns will be the same as the height of the specified <literal>range</literal>. Otherwise, the inserted columns will span all rows in the sheet.</paragraph> + <paragraph role="paragraph" id="par_id5515938803791960"><emph>columns</emph>: The number of columns to be inserted. The default value is the width of the original <literal>range</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id881637931052587">' Moves the range "A3:A6" right by one column; affects only rows 3 to 6</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791637931053646">oDoc.ShiftRight("A3:A6")</paragraph> + <paragraph role="bascode" id="bas_id291637931053225">' Moves the range "A3:A6" right by five columns</paragraph> + <paragraph role="bascode" localize="false" id="bas_id916379310503221">oDoc.ShiftRight("A3:A6", Columns := 5)</paragraph> + <paragraph role="bascode" id="bas_id661637931232548">' The inserted column spans all rows in the sheet</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741637931330323">oDoc.ShiftRight("A3:A6", WholeColumn := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941621623155669">myDoc.ShiftRight("A3:A6")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151621623174603">myDoc.ShiftRight("A3:A6", columns = 5)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651621623174751">myDoc.ShiftRight("A3:A6", wholecolumn = True)</paragraph> + </pycode> +</section> + +<section id="SortRange"> + <comment> SortRange -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id531595692394747"> + <bookmark_value>Calc service;SortRange</bookmark_value> + </bookmark> + <h2 id="hd_id71595692394823" localize="false">SortRange</h2> + <paragraph role="paragraph" id="par_id141595692394382">Sorts the given range based on up to 3 columns/rows. The sorting order may vary by column/row. It returns a string representing the modified range of cells. The size of the modified area is fully determined by the size of the source area.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id871621623279253"> + <input>svc.SortRange(range: str, sortkeys: any, sortorder: any = "ASC", destinationcell: str = "", containsheader: bool = False, casesensitive: bool = False, sortcolumns: bool = False): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id171595692394598"><emph>range</emph>: The range to be sorted, as a string.</paragraph> + <paragraph role="paragraph" id="par_id171595692814163"><emph>sortkeys</emph>: A scalar (if 1 column/row) or an array of column/row numbers starting from 1. The maximum number of keys is 3.</paragraph> + <paragraph role="paragraph" id="par_id421595692962095"><emph>sortorder</emph>: A scalar or an array of strings containing the values "ASC" (ascending), "DESC" (descending) or "" (which defaults to ascending). Each item is paired with the corresponding item in <literal>sortkeys</literal>. If the <literal>sortorder</literal> array is shorter than <literal>sortkeys</literal>, the remaining keys are sorted in ascending order.</paragraph> + <paragraph role="paragraph" id="par_id361595692394604"><emph>destinationcell</emph>: The destination cell of the sorted range of cells, as a string. If a range is given, only its top-left cell is considered. By default the source Range is overwritten.</paragraph> + <paragraph role="paragraph" id="par_id441595693011034"><emph>containsheader</emph>: When <literal>True</literal>, the first row/column is not sorted.</paragraph> + <paragraph role="paragraph" id="par_id241595693169032"><emph>casesensitive</emph>: Only for string comparisons. Default = <literal>False</literal></paragraph> + <paragraph role="paragraph" id="par_id1001595693326226"><emph>sortcolumns</emph>: When <literal>True</literal>, the columns are sorted from left to right. Default = <literal>False</literal> : rows are sorted from top to bottom.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id641595692394484">'Sort range based on columns A (ascending) and C (descending)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id54159569239416">oDoc.SortRange("A2:J200", Array(1, 3), Array("ASC", "DESC"), CaseSensitive := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id581621623543873">myDoc.SortRange("A2:J200", (1, 3), ("ASC", "DESC"), casesensitive = True)</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_chart.xhp#ChartService"/> + <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> + <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_chart.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_chart.xhp new file mode 100644 index 000000000..ca1cc338f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_chart.xhp @@ -0,0 +1,504 @@ +<?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_Chart" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDocuments.Chart service</title> + <filename>/text/sbasic/shared/03/sf_chart.xhp</filename> + </topic> + </meta> +<body> + <section id="ScriptForge-sf_chart"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id501600788076381"> + <bookmark_value>Chart service</bookmark_value> + </bookmark> + </section> + <section id="abstract"> + <h1 id="bm_id681600788076499"><variable id="ChartService"><link href="text/sbasic/shared/03/sf_chart.xhp" name="Chart service"><literal>SFDocuments</literal>.<literal>Chart</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id181600788076612">The <literal>Chart</literal> service provides a set of properties and methods to handle charts in Calc documents. With this service it is possible to:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id301600788076785" role="listitem">Access chart objects in Calc documents and manipulate their properties.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id1001600788076848" role="listitem">Create and insert new charts into a Calc document.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id67160078807676" role="listitem">Export charts as image files.</paragraph> + </listitem> + </list> + </section> + + <h2 id="hd_id331635273472588">Chart names</h2> + <paragraph role="paragraph" id="par_id251635273489315">Charts may have two different names:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id41635273536840" role="listitem">An <emph>internal name</emph> given by %PRODUCTNAME as soon as the chart object is created (usually "Object 1", "Object 2" and so on).</paragraph> + </listitem> + <listitem> + <paragraph id="par_id641635273537122" role="listitem">A <emph>user-defined name</emph>, which can be defined by right-clicking the chart and choosing <menuitem>Name</menuitem> in the context menu.</paragraph> + </listitem> + </list> + <note id="par_id191635273980553">The <literal>Chart</literal> service primarily uses the user-defined name to access a chart object. If it does not exist, than the internal name is used.</note> + + <h2 id="hd_id281600788076359">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Chart</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id321614902851541">The <literal>Chart</literal> service is instantiated from a <literal>Calc</literal> service instance either using the <literal>Charts</literal> or <literal>CreateChart</literal> methods.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id531635274285114">The example below creates a <literal>Chart</literal> service instance from an existing chart in the current Calc document:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id851600788076202">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001600788076254">Dim oDoc as Object, oChart as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721600788076288">Set oDoc = CreateScriptService("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791600788431935">Set oChart = oDoc.Charts("Sheet1", "Object 1")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id851635274721129">The following example instantiate the <literal>Chart</literal> service by creating a new chart object based on the data contained in the range "Sheet1.A1:C10".</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id221635274765110">Dim oDoc as Object, oChart as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461635274776072">Set oDoc = CreateScriptService("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621635274776400">Set oChart = oDoc.CreateChart("My Chart", "Sheet1", "Sheet1.A1:C10")</paragraph> + </bascode> + <tip id="par_id881635275036852">Read the <link href="text/sbasic/shared/03/sf_calc.xhp#CreateChart" name="CreateChart_link">CreateChart</link> method description to learn more about its arguments.</tip> + + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id131635275172617">The examples above can be written in Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id631626695710139">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626695710433">doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id311626695710851">chart = doc.Charts("Sheet1", "Object 1")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831635275439182">doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381635275439396">chart = doc.CreateChart("My Chart", "Sheet1", "Sheet1.A1:C10")</paragraph> + </pycode> + + <bookmark xml-lang="en-US" branch="index" localize="false" id="bm_id111614901524769"> + <bookmark_value>Chart service;ChartType</bookmark_value> + <bookmark_value>Chart service;Deep</bookmark_value> + <bookmark_value>Chart service;Dim3D</bookmark_value> + <bookmark_value>Chart service;Exploded</bookmark_value> + <bookmark_value>Chart service;Filled</bookmark_value> + <bookmark_value>Chart service;Legend</bookmark_value> + <bookmark_value>Chart service;Percent</bookmark_value> + <bookmark_value>Chart service;Stacked</bookmark_value> + <bookmark_value>Chart service;Title</bookmark_value> + <bookmark_value>Chart service;XTitle</bookmark_value> + <bookmark_value>Chart service;YTitle</bookmark_value> + <bookmark_value>Chart service;XChartObj</bookmark_value> + <bookmark_value>Chart service;XDiagram</bookmark_value> + <bookmark_value>Chart service;XShape</bookmark_value> + <bookmark_value>Chart service;XTableChart</bookmark_value> + </bookmark> + <h2 id="hd_id711600788076834">Properties</h2> + <table id="tab_id701600788076583"> + <tablerow> + <tablecell> + <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076591" role="tablehead">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076328" role="tablehead">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id67160078807636" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491600788076621" role="tablecontent" localize="false">ChartType</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311600788076756" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831600788076785" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441600788076826" role="tablecontent">Specifies the chart type as a string that can assume one of the following values: "Pie", "Bar", "Donut", "Column", "Area", "Line", "XY", "Bubble", "Net".</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id941600788076595" role="tablecontent" localize="false">Deep</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id49160078807654" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961600788076376" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81600788076419" role="tablecontent">When <literal>True</literal> indicates that the chart is three-dimensional and each series is arranged in the z-direction.</paragraph> + <paragraph id="par_id471635276257118" role="tablecontent">When <literal>False</literal> series are arranged considering only two dimensions.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721600788076638" role="tablecontent" localize="false">Dim3D</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711600788076534" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911600788076842" role="tablecontent" localize="false">Boolean or String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541600788076645" role="tablecontent">Specifies if the chart is displayed with 3D elements. If the value is a string, it must be either "Bar", "Cylinder", "Cone" or "Pyramid".</paragraph> + <paragraph id="par_id541600788076141" role="tablecontent">If the boolean <literal>True</literal> value is specified, then the chart is displayed using 3D bars.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id961600788076890" role="tablecontent" localize="false">Exploded</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891600788076190" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076562" role="tablecontent" localize="false">Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91600788076674" role="tablecontent">Specifies how much pie segments are offset from the chart center as a percentage of the radius. Applicable to pie and donut charts only.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021719135" localize="false" role="tablecontent">Filled</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021747903" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021748455" localize="false" role="tablecontent">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021749007" role="tablecontent">When <literal>True</literal>, specifies a filled net chart. Applicable to net charts only.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951600788076443" role="tablecontent" localize="false">Legend</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391600788076253" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381600788076799" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21600788076541" role="tablecontent">Specifies whether or not the chart has a legend.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id41600788076936" role="tablecontent" localize="false">Percent</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211600788076138" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076518" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521600788076371" role="tablecontent">When <literal>True</literal>, chart series are stacked and each category sums up to 100%. Applicable to Area, Bar, Bubble, Column and Net charts.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161600788076362" role="tablecontent" localize="false">Stacked</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21600788076758" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id871600788076196" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781600788076694" role="tablecontent">When <literal>True</literal>, chart series are stacked. Applicable to Area, Bar, Bubble, Column and Net charts.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471600788076885" role="tablecontent" localize="false">Title</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261600788076841" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661600788076636" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id11600788076757" role="tablecontent">Specifies the main title of the chart.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id221600789141781" role="tablecontent" localize="false">XTitle</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531600789141795" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561600789141282" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301600789141619" role="tablecontent">Specifies the title of the X axis.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821600789286339" role="tablecontent" localize="false">YTitle</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541600789286532" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id181600789286889" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701600789286280" role="tablecontent">Specifies the title of the Y axis.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31600789752717" role="tablecontent" localize="false">XChartObj</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941608709527698" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id100100678952791" role="tablecontent">UNO Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661300789527859" role="tablecontent">Returns the object representing the chart, which is an instance of the <link href="https://docs.libreoffice.org/sc/html/classScChartObj.html" name="ScChartObj"><literal>ScChartObj</literal></link> class.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31600789527717" role="tablecontent" localize="false">XDiagram</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941600789527698" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id100160078952791" role="tablecontent">UNO Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id631600789527859" role="tablecontent">Returns the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1chart_1_1XDiagram.html" name="XDiagram"><literal>com.sun.star.chart.XDiagram</literal></link> object representing the diagram of the chart.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31600789527123" role="tablecontent" localize="false">XShape</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941600789527099" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id100160078953251" role="tablecontent">UNO Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id631600789522587" role="tablecontent">Returns the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1drawing_1_1XShape.html" name="XShape"><literal>com.sun.star.drawing.XShape</literal></link> object representing the shape of the chart.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31600789527332" role="tablecontent" localize="false">XTableChart</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941600789527208" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id100160078952007" role="tablecontent">UNO Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id631600789527364" role="tablecontent">Returns the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1table_1_1XTableChart.html" name="XTableChart"><literal>com.sun.star.table.XTableChart</literal></link> object representing the data being displayed in the chart.</paragraph> + </tablecell> + </tablerow> + </table> + + <h2 id="hd_id581635335807782">Creating a chart</h2> + <paragraph role="paragraph" id="par_id231635335826090">Consider the following data in the range "A1:B6" of a sheet named "Report".</paragraph> + <table id="tab_id471635335950545"> + <tablerow> + <tablecell> + <paragraph id="par_id901635335950545" localize="false" role="tablehead"></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111635335950545" localize="false" role="tablehead">A</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651635335950545" localize="false" role="tablehead">B</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591635335950822" localize="false" role="tablehead">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401635335950901" localize="false" role="tablecontent">Sample A</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151635335950965" localize="false" role="tablecontent">Sample B</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591635335958021" localize="false" role="tablehead">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401635335950888" localize="false" role="tablecontent">36</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151635335950047" localize="false" role="tablecontent">40</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591635335956841" localize="false" role="tablehead">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401635335950126" localize="false" role="tablecontent">39</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151635335933645" localize="false" role="tablecontent">43</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591635335959875" localize="false" role="tablehead">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401635335950008" localize="false" role="tablecontent">45</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151635335950367" localize="false" role="tablecontent">40</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591635335950287" localize="false" role="tablehead">5</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401635335951225" localize="false" role="tablecontent">52</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151635335950255" localize="false" role="tablecontent">48</paragraph> + </tablecell> + </tablerow> + </table> + <paragraph role="paragraph" id="par_id911635336313498">The examples below in Basic and Python show how to create a line chart from this data with legends.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id971635337992020">oDoc = CreateScriptService("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671633022413022">oChart = oDoc.CreateChart("Samples", "Report", "Report.A1:B6")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721633022413266">oChart.ChartType = "Line"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691633022413526">oChart.Legend = True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id41633022413831">oChart.Resize(1000, 1000, 25000, 15000)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id841633022704586">doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id281633022704771">chart = doc.CreateChart("Samples", "Report", "Report.A1:B6")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211633022704988">chart.ChartType = "Line"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id21635338077411">chart.Legend = True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941633022705212">chart.Resize(1000, 1000, 25000, 15000)</paragraph> + </pycode> + <tip id="par_id931635338174647">The chart does not need to be created in the same sheet where the data is located. It can be created in any existing sheet in the current file by specifying the sheet name in the second argument of the <literal>CreateChart</literal> method.</tip> + + <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="2"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Chart Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_chart.xhp#ExportToFile" name="ExportToFile method">ExportToFile</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_chart.xhp#Resize" name="Resize method">Resize</link><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + + <section id="ExportToFile"> + <comment> ExportToFile ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969883"> + <bookmark_value>Chart service;ExportToFile</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698251" localize="false">ExportToFile</h2> + <paragraph role="paragraph" id="par_id93158919969864">Saves the chart as an image file in a specified location. Returns <literal>True</literal> if the image file could be successfully created.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534014732"> + <input>chart.ExportToFile(filename: str, imagetype: str = "png", overwrite: bool = False): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203996"><emph>filename</emph>: Identifies the path and file name where the image will be saved. It must follow the notation defined in <literal>SF_FileSystem.FileNaming</literal>.</paragraph> + <paragraph role="paragraph" id="par_id821591631203116"><emph>imagetype</emph>: The name of the image type to be created. The following values are accepted: "gif", "jpeg", "png" (default), "svg" and "tiff".</paragraph> + <paragraph role="paragraph" id="par_id821591631203133"><emph>overwrite</emph>: Specifies if the destination file can be overwritten (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41158919969204">oChart.ExportToFile("C:\Temp\myChart.svg", ImageType := "svg", Overwrite := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534175122">chart.ExportToFile(r"C:\Temp\myChart.svg", imagetype="svg", overwrite=True)</paragraph> + </pycode> + </section> + + <section id="Resize"> + <comment> Resize ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969883"> + <bookmark_value>Chart service;Resize</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698887" localize="false">Resize</h2> + <paragraph role="paragraph" id="par_id93158919969165">Changes the position of the chart in the current sheet and modifies its width and height. Returns <literal>True</literal> if resizing was successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534025532"> + <input>chart.Resize([xpos: int], [ypos: int], [width: int], [height: int]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631200626"><emph>xpos, ypos:</emph> Specify the new X and Y positions of the chart. If any of these values are omitted or if negative values are provided, the corresponding positions are left unchanged.</paragraph> + <paragraph role="paragraph" id="par_id821591631204288"><emph>width:</emph> Specify the new width of the chart. If this argument is omitted or if a negative value is provided, the chart width is left unchanged.</paragraph> + <paragraph role="paragraph" id="par_id821591631203208"><emph>height:</emph> Specify the new height of the chart. If this argument is omitted or if a negative value is provided, the chart height is left unchanged.</paragraph> + <note id="par_id301635340527472">All arguments are provided as integer values that correspond to 1/100 of a millimeter.</note> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id431635340711712">' Changes only X and Y position</paragraph> + <paragraph role="bascode" localize="false" id="bas_id41158919969836">oChart.Rezise(1000, 3000)</paragraph> + <paragraph role="bascode" id="bas_id241635340728398">' Changes only the chart width and height</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251635340748780">oChart.Resize(, , 25000, 12500)</paragraph> + <paragraph role="bascode" id="bas_id201635340749006">' Keyword arguments are supported</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991635340749181">oChart.Resize(Width := 25000, Height := 12500)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534175071">chart.Rezise(1000, 3000)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391635340950666">chart.Resize(-1, -1, 20000, 20000)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id11635340951050">chart.Resize(width=25000, height=12500)</paragraph> + </pycode> + </section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_calc.xhp#CalcService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_database.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_database.xhp new file mode 100644 index 000000000..468f83b58 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_database.xhp @@ -0,0 +1,404 @@ +<?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_Database" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDatabases.Database service</title> + <filename>/text/sbasic/shared/03/sf_database.xhp</filename> + </topic> +</meta> +<body> +<section id="ScriptForge-sf_database"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id151587913266190"> + <bookmark_value>Database service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="hd_id371587913266310" xml-lang="en-US"><variable id="DatabaseService"><link href="text/sbasic/shared/03/sf_database.xhp" name="Database service"><literal>SFDatabases</literal>.<literal>Database</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id891599407198144" xml-lang="en-US">The <literal>Database</literal> service provides access to databases either embedded or described in Base documents. This service provides methods to:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id551615386924481" role="listitem">Get access to data in database tables.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id551615386924285" role="listitem">Run <literal>SELECT</literal> queries and perform aggregate functions.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id551615386924111" role="listitem">Run SQL action statements such as <literal>INSERT</literal>, <literal>UPDATE</literal>, <literal>DELETE</literal>, etc.</paragraph> + </listitem> + </list> +</section> + <paragraph role="paragraph" id="par_id811599407236602" xml-lang="en-US">Each instance of the <literal>Database</literal> service represents a single database and gives access to its tables, queries and data.</paragraph> + <paragraph role="paragraph" id="par_id111625692871642">This service does not provide access to forms or reports in the Base document that contains the database. To access forms in a Base document, refer to the method <link href="text/sbasic/shared/03/sf_base.xhp#FormDocuments" name="FormDocuments"><literal>FormDocuments</literal></link> of the <literal>Base</literal> service.</paragraph> + <note id="par_id231615386789950">All exchanges between this service and the database are done using SQL only.</note> + <paragraph role="paragraph" id="par_id121599407322804" xml-lang="en-US">SQL statements may be run in <emph>direct</emph> or <emph>indirect</emph> mode. In direct mode the statement is transferred to the database engine without any syntax checking or review.</paragraph> + <paragraph role="paragraph" id="par_id681599407189019" xml-lang="en-US">The provided interfaces include simple tables and queries lists, as well as access to database data.</paragraph> + <tip id="par_id891599407280007" xml-lang="en-US">To make SQL statements more readable, you may use square brackets "[ ]" to enclose names of tables, queries and fields instead of using other enclosing characters that may be exclusive to certain Relational Database Management Systems (RDBMS). But beware that enclosing characters are mandatory in this context.</tip> + + <h2 id="hd_id91587913266988" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Database</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id541599408159668" xml-lang="en-US">To create a instance of the <literal>Database</literal> service you can use the <literal>CreateScriptService</literal> method:</paragraph> + <paragraph role="paragraph" localize="false" id="par_id251625693098616"> + <input>CreateScriptService("SFDatabases.Database", [filename: str], [registrationname], [readonly], [user, [password]]): svc</input> + </paragraph> + <note id="par_id551625693442959">In the syntax described above you can use either "SFDatabases.Database" or simply "Database" as the first argument of the <literal>CreateScriptService</literal> method.</note> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id111615146818256"><emph>filename</emph>: The name of the Base file. Must be expressed using <literal>SF_FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id771615146944307"><emph>registrationname</emph>: The name of a registered database. If <literal>filename</literal> is provided, this argument should not be used.</paragraph> + <paragraph role="paragraph" id="par_id491615147048748">Conversely, if a <literal>registrationname</literal> is specified, the <literal>filename</literal> parameter should not be defined.</paragraph> + <paragraph role="paragraph" id="par_id841615147168279"><emph>readonly</emph>: Determines if the database will be opened as readonly (Default = <literal>True</literal>).</paragraph> + <paragraph role="paragraph" id="par_id291615147236001"><emph>user, password</emph>: Additional connection parameters to the database server.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id451625698094586">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191625698094873">Dim myDatabase as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181625698095184">Set myDatabase = CreateScriptService("Database", "/home/user/Documents/myDB.odb")</paragraph> + <paragraph role="bascode" id="bas_id871625698095504">' Run queries, SQL statements, ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id501625698095793">myDatabase.CloseDatabase()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id291625698186091">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id141625698186499">myDatabase = CreateScriptService("Database", "/home/user/Documents/myDB.odb")</paragraph> + <paragraph role="pycode" id="pyc_id791625698186675"># Run queries, SQL statements, ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id521625698186867">myDatabase.CloseDatabase()</paragraph> + </pycode> + + <h2 id="hd_id771615147491563">Accessing Databases with the UI Service</h2> + <paragraph role="paragraph" id="par_id901599408410712" xml-lang="en-US">It is also possible to access the database associated with a Base document using the <link href="text/sbasic/shared/03/sf_ui.xhp" name="UI Service"><literal>ScriptForge.UI</literal></link> service, as shown in the examples below:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id1001599408773502">Dim myDoc As Object, myDatabase As Object, ui As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631599408779968">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801599408784337">Set myDoc = ui.OpenBaseDocument("/home/user/Documents/myDB.odb")</paragraph> + <paragraph role="bascode" id="bas_id631615147843278">' User and password are supplied below, if needed</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741599408788321">Set myDatabase = myDoc.GetDatabase()</paragraph> + <paragraph role="bascode" id="bas_id921599408791887">' Run queries, SQL statements, ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971625699354855">myDatabase.CloseDatabase()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251599408799447">myDoc.CloseDocument()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id881625699438103">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id111625699438354">doc = ui.OpenBaseDocument("/home/user/Documents/myDB.odb")</paragraph> + <paragraph role="pycode" id="pyc_id731625699527917"># User and password are supplied below, if needed</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id741625699438527">myDatabase = doc.GetDatabase()</paragraph> + <paragraph role="pycode" id="pyc_id201625699438702"># Run queries, SQL statements, ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id171625699438887">myDatabase.CloseDatabase()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231625699570502">doc.CloseDocument()</paragraph> + </pycode> + <tip id="par_id361619188184750">The <link href="text/sbasic/shared/03/sf_base.xhp#GetDatabase" name="GetDatabase method">GetDatabase</link> method used in the example above is part of ScriptForge's <literal>Base</literal> service.</tip> + + <bookmark xml-lang="en-US" branch="index" id="bm_id771615387442357" localize="false"> + <bookmark_value>Database Service;Queries</bookmark_value> + <bookmark_value>Database Service;Tables</bookmark_value> + </bookmark> + <h2 id="hd_id841587913266618" xml-lang="en-US">Properties</h2> + <table id="tab_id291587913266435"> + <tablerow> + <tablecell> + <paragraph id="par_id521587913266568" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587913266368" role="tablehead" xml-lang="en-US">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id631587914939732" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951587913266220" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161587913266162" role="tablecontent" xml-lang="en-US" localize="false">Queries</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651587913266754" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587914989890" role="tablecontent" xml-lang="en-US">Array of strings</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351587913266349" role="tablecontent" xml-lang="en-US">The list of stored queries.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851599409717318" role="tablecontent" xml-lang="en-US" localize="false">Tables</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id931599409717463" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71599409717945" role="tablecontent" xml-lang="en-US">Array of strings</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id341599409717612" role="tablecontent" xml-lang="en-US">The list of stored tables.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id561599409777730" role="tablecontent" xml-lang="en-US" localize="false">XConnection</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741599409777967" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id101599409777906" role="tablecontent" xml-lang="en-US" localize="false"><link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sdbc_1_1XConnection.html" name="XConnection API">XConnection</link></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id551599409777759" role="tablecontent" xml-lang="en-US">The UNO object representing the current database connection.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id361599409887831" role="tablecontent" xml-lang="en-US" localize="false">XMetaData</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271599409887585" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701599409887579" role="tablecontent" xml-lang="en-US" localize="false"><link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sdbc_1_1XDatabaseMetaData.html" name="XDatabaseMetaData API">XDatabaseMetaData</link></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861599409887284" role="tablecontent" xml-lang="en-US">The UNO object representing the metadata describing the database system attributes.</paragraph> + </tablecell> + </tablerow> + </table> + +<table id="tab_id551614360519973"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id231614360519973" role="tablehead">List of Methods in the Database Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id611614360519255" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_database.xhp#CloseDatabase" name="CloseDatabase">CloseDatabase</link><br/> + <link href="text/sbasic/shared/03/sf_database.xhp#DFunctions" name="DAvg">DAvg</link><br/> + <link href="text/sbasic/shared/03/sf_database.xhp#DFunctions" name="DCount">DCount</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611614360519104" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_database.xhp#DFunctions" name="DMin">DMin</link><br/> + <link href="text/sbasic/shared/03/sf_database.xhp#DFunctions" name="DMax">DMax</link><br/> + <link href="text/sbasic/shared/03/sf_database.xhp#DFunctions" name="DSum">DSum</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611614360518452" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_database.xhp#DLookup" name="DLookup">DLookup</link><br/> + <link href="text/sbasic/shared/03/sf_database.xhp#GetRows" name="GetRows">GetRows</link><br/> + <link href="text/sbasic/shared/03/sf_database.xhp#RunSql" name="RunSql">RunSql</link> + </paragraph> + </tablecell> + </tablerow> +</table> + +<section id="CloseDatabase"> + <comment> CloseDatabase ---------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id991587913266189"> + <bookmark_value>Database Service;CloseDatabase</bookmark_value> + </bookmark> + <h2 id="hd_id76158791326673" localize="false">CloseDatabase</h2> + <paragraph role="paragraph" id="par_id201587913266596">Closes the current database connection.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821625699786747"> + <input>db.CloseDatabase()</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id191625699910447">myDatabase.CloseDatabase() ' Basic</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id591625699936578">myDatabase.CloseDatabase() # Python</paragraph> + </pycode> +</section> + +<section id="DFunctions"> + <comment> DFunctions ----------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id861599488343584"> + <bookmark_value>Database Service;DAvg</bookmark_value> + </bookmark> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id221599488343636"> + <bookmark_value>Database Service;DCount</bookmark_value> + </bookmark> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id261599488343619"> + <bookmark_value>Database Service;DMax</bookmark_value> + </bookmark> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231599488343876"> + <bookmark_value>Database Service;DMin</bookmark_value> + </bookmark> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id831599488343138"> + <bookmark_value>Database Service;DSum</bookmark_value> + </bookmark> + <h2 id="hd_id281596554849363" localize="false">DAvg, DCount, DMin, DMax, DSum</h2> + <paragraph role="paragraph" id="par_id13159655484952">Computes the given aggregate function on a field or expression belonging to a table.</paragraph> + <paragraph role="paragraph" id="par_id101615148468548">Optionally, a SQL <literal>WHERE</literal> clause can be specified as a filter that will be applied prior to the aggregate function.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id481625700732942"> + <input>db.DAvg(expression: str, tablename: str, [criteria: str]): any</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id481625700732113"> + <input>db.DCount(expression: str, tablename: str, [criteria: str]): any</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id481625700730298"> + <input>db.DMin(expression: str, tablename: str, [criteria: str]): any</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id481625700720177"> + <input>db.DMax(expression: str, tablename: str, [criteria: str]): any</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id481625700731179"> + <input>db.DSum(expression: str, tablename: str, [criteria: str]): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441596554849949"><emph>expression</emph>: A SQL expression in which the field names are surrounded with square brackets.</paragraph> + <paragraph role="paragraph" id="par_id381596554849698" xml-lang="en-US"><emph>tablename</emph>: A table name (without square brackets).</paragraph> + <paragraph role="paragraph" id="par_id521596554849185" xml-lang="en-US"><emph>criteria</emph>: A <literal>WHERE</literal> clause without the "WHERE" keyword, in which field names are surrounded with square brackets.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id781615150306678">The example below assumes the file <literal>Employees.odb</literal> has a table named <literal>EmployeeData</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id921596554849612">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561615149909875">Dim myDB as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211615149928005">Set myDB = CreateScriptService("Database", "/home/user/Databases/Employees.odb")</paragraph> + <paragraph role="bascode" id="bas_id871615150277916">' Counts the number of employees in the table</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31615149929509">MsgBox myDB.DCount("[ID]", "EmployeeData")</paragraph> + <paragraph role="bascode" id="bas_id291615150373387">' Returns the sum of all salaries in the table</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881615150162528">MsgBox myDB.DSum("[Salary]", "EmployeeData")</paragraph> + <paragraph role="bascode" id="bas_id931615150423062">' Below are some examples of how tables can be filtered</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241615149929870">MsgBox myDB.DCount("[ID]", "EmployeeData", "[Position] = 'Manager'")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241615149929145">MsgBox myDB.DCount("[ID]", "EmployeeData", "[Position] = 'Sales' AND [City] = 'Chicago'")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311615150740276">MsgBox myDB.DCount("[ID]", "EmployeeData", "[FirstName] LIKE 'Paul%'")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id641625700473857">myDB = CreateScriptService("Database", "/home/user/Databases/Employees.odb")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id611625700474124">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id991625700474287">bas.MsgBox(myDB.DCount("[ID]", "EmployeeData"))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id321625700474470">bas.MsgBox(myDB.DSum("[Salary]", "EmployeeData"))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id811625700474663">bas.MsgBox(myDB.DCount("[ID]", "EmployeeData", "[Position] = 'Manager'"))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id421625700474895">bas.MsgBox(myDB.DCount("[ID]", "EmployeeData", "[Position] = 'Sales' AND [City] = 'Chicago'"))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441625700475239">bas.MsgBox(myDB.DCount("[ID]", "EmployeeData", "[FirstName] LIKE 'Paul%'"))</paragraph> + </pycode> +</section> + +<section id="DLookup"> + <comment> DLookup -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id161599488113736"> + <bookmark_value>Database Service;DLookup</bookmark_value> + </bookmark> + <h2 id="hd_id151599488113565" localize="false">DLookup</h2> + <paragraph role="paragraph" id="par_id41599488113961">Computes a SQL expression on a single record returned by a <literal>WHERE</literal> clause defined by the <literal>Criteria</literal> parameter.</paragraph> + <paragraph role="paragraph" id="par_id601615381471954">If the query returns multiple records, only the first one is considered. Use the <literal>OrderClause</literal> parameter to determine how query results are sorted.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id41625701240138"> + <input>db.DLookup(expression: str, tablename: str, [criteria:str], [orderclause: str]): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id671599488113986"><emph>expression</emph>: A SQL expression in which the field names are surrounded with square brackets.</paragraph> + <paragraph role="paragraph" id="par_id441599488113247" xml-lang="en-US"><emph>tablename</emph>: A table name (without square brackets).</paragraph> + <paragraph role="paragraph" id="par_id40159948811316" xml-lang="en-US"><emph>criteria</emph>: A <literal>WHERE</literal> clause without the "WHERE" keyword, in which field names are surrounded with square brackets.</paragraph> + <paragraph role="paragraph" id="par_id71599488689029" xml-lang="en-US"><emph>orderclause</emph>: An <literal>ORDER BY</literal> clause without the "ORDER BY" keywords. Field names should be surrounded with square brackets.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id311599488264597">MsgBox myDB.DLookup("[FirstName]", "EmployeeData", Criteria := "[LastName] LIKE 'Smith'", OrderClause := "[FirstName] DESC")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311599488113597">MsgBox myDB.DLookup("[Salary]", "EmployeeData", Criteria := "[ID] = '3'")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21599488808504">MsgBox myDB.DLookup("[Quantity] * [Value]", "Sales", Criteria := "[SaleID] = '5014'")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id151625701420880">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181625701421328">bas.MsgBox(myDB.DLookup("[FirstName]", "EmployeeData", criteria = "[LastName] LIKE 'Smith'", orderclause = "[FirstName] DESC"))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801625701421784">bas.MsgBox(myDB.DLookup("[Salary]", "EmployeeData", criteria = "[ID] = '3'"))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id551625701422176">bas.MsgBox(myDB.DLookup("[Quantity] * [Value]", "Sales", criteria = "[SaleID] = '5014'"))</paragraph> + </pycode> +</section> + +<section id="GetRows"> + <comment> GetRows ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id91599489278645"> + <bookmark_value>Database Service;GetRows</bookmark_value> + </bookmark> + <h2 id="hd_id79159948927847" localize="false">GetRows</h2> + <paragraph role="paragraph" id="par_id481599489278579">Stores the contents of a table or the results of a <literal>SELECT</literal> query or of an SQL statement in a two-dimensional array. The first index in the array corresponds to the rows and the second index refers to the columns.</paragraph> + <paragraph role="paragraph" id="par_id821615384762425">An upper limit can be specified to the number of returned rows. Optionally column names may be inserted in the first row of the array.</paragraph> + <paragraph role="paragraph" id="par_id271599490209915" xml-lang="en-US">The returned array will be empty if no rows are returned and the column headers are not required.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id121625701537873"> + <input>db.GetRows(sqlcommand: str, directsql: bool = False, header: bool = False, maxrows: int = 0): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id451599489278429"><emph>sqlcommand</emph>: A table or query name (without square brackets) or a <literal>SELECT</literal> SQL statement.</paragraph> + <paragraph role="paragraph" id="par_id271599489278141" xml-lang="en-US"><emph>directsql</emph>: When <literal>True</literal>, the SQL command is sent to the database engine without pre-analysis. Default is <literal>False</literal>. This argument is ignored for tables. For queries, the applied option is the one set when the query was defined.</paragraph> + <paragraph role="paragraph" id="par_id941599489278747" xml-lang="en-US"><emph>header</emph>: When <literal>True</literal>, the first row of the returned array contains the column headers.</paragraph> + <paragraph role="paragraph" id="par_id591599489278926" xml-lang="en-US"><emph>maxrows</emph>: The maximum number of rows to return. The default is zero, meaning there is no limit to the number of returned rows.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id721615385125947">Below are a few examples of how the <literal>GetRows</literal> method can be used:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id821599489278193">Dim queryResults as Variant</paragraph> + <paragraph role="bascode" id="bas_id171615385196045">' Returns all rows in the table with column headers</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261599489278488">queryResults = myDB.GetRows("EmployeeData", Header := True)</paragraph> + <paragraph role="bascode" id="bas_id371615385230721">' Returns the first 50 employee records ordered by the 'FirstName' field</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871615385264078">queryResults = myDB.GetRows("SELECT * FROM EmployeeData ORDER BY [FirstName]", MaxRows := 50)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id41625701996174">queryResults = myDB.GetRows("EmployeeData", header = True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871625701996504">queryResults = myDB.GetRows("SELECT * FROM EmployeeData ORDER BY [FirstName]", maxrows = 50)</paragraph> + </pycode> +</section> + +<section id="RunSql"> + <comment> RunSql -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id781599490609499"> + <bookmark_value>Database Service;RunSql</bookmark_value> + </bookmark> + <h2 id="hd_id80159949060917" localize="false">RunSql</h2> + <paragraph role="paragraph" id="par_id31599490609759">Executes an action query of an SQL statement such as creating a table, as well as inserting, updating and deleting records.</paragraph> + <paragraph role="paragraph" id="par_id331615385491925">The method returns <literal>True</literal> when successful.</paragraph> + <tip id="par_id21599490810021" xml-lang="en-US">The <literal>RunSql</literal> method is rejected with an error message in case the database was previously opened in read-only mode.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id421625701780046"> + <input>db.RunSql(sqlcommand: str, directsql: bool = False): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id701599490609473"><emph>sqlcommand</emph>: A query name (without square brackets) or a SQL statement.</paragraph> + <paragraph role="paragraph" id="par_id51599490609377" xml-lang="en-US"><emph>directsql</emph>: When <literal>True</literal>, the SQL command is sent to the database engine without pre-analysis. (Default = <literal>False</literal>). For queries, the applied option is the one set when the query was defined.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id47159949060973">myDatabase.RunSql("INSERT INTO [EmployeeData] VALUES(25, 'Smith', 'John')", DirectSQL := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id331625701876367">myDatabase.RunSql("INSERT INTO [EmployeeData] VALUES(25, 'Smith', 'John')", directsql = True)</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> + <embed href="text/sbasic/shared/03/sf_form.xhp#FormService"/> + <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_dialog.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_dialog.xhp new file mode 100644 index 000000000..8f9f755c1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_dialog.xhp @@ -0,0 +1,681 @@ +<?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_Dialog" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDialogs.Dialog service</title> + <filename>/text/sbasic/shared/03/sf_dialog.xhp</filename> + </topic> + </meta> +<body> +<section id="SFDocuments-sf_Dialog"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41582391760252"> + <bookmark_value>Dialog service</bookmark_value> + </bookmark> +</section> +<section id="abstract"> + <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="dlg_h1"><link href="text/sbasic/shared/03/sf_dialog.xhp" name="SFDialogs.Dialog"><literal>SFDialogs</literal>.<literal>Dialog</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The <literal>Dialog</literal> service contributes to the management of dialogs created with the Basic <link href="text/sbasic/guide/create_dialog.xhp" name="Dialog Editor">Dialog Editor</link>. Each instance of the current class represents a single dialog box displayed to the user.</paragraph> +</section> + <tip id="par_id831598110550771" xml-lang="en-US">A dialog box can be displayed in modal or in non-modal modes.</tip> + <paragraph role="paragraph" id="par_id221598110444025" xml-lang="en-US">In modal mode, the box is displayed and the execution of the macro process is suspended until one of the OK or Cancel buttons is pressed. In the meantime, user actions executed on the box can trigger specific actions.</paragraph> + <paragraph role="paragraph" id="par_id981598110463521" xml-lang="en-US">In non-modal mode, the dialog box is "floating" on the user desktop and the execution of the macro process continues normally. A non-modal dialog closes when it is terminated with the <literal>Terminate()</literal> method or when the %PRODUCTNAME session ends. The window close button is inactive in non-modal dialogs.</paragraph> + <paragraph role="paragraph" id="par_id721598110472337" xml-lang="en-US">A dialog box disappears from memory after its explicit termination.</paragraph> + <tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDialogs.Dialog</literal> service is closely related to the <literal>SFDialogs.DialogControl</literal> service.</tip> + + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation and usage</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Dialog</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id361598174756160" xml-lang="en-US">The <literal>Dialog</literal> service is invoked through the <literal>CreateScriptService</literal> method. It requires three positional arguments to specify the dialog box to activate:</paragraph> + <paragraph role="paragraph" id="par_id31612271944733"><emph>Container</emph>: "<link href="text/sbasic/shared/03131900.xhp" name="GlobalScope specifier"><literal>GlobalScope</literal></link>" for preinstalled libraries or a window name as defined by <link href="text/sbasic/shared/03/sf_ui.xhp" name="ScriptForge.UI"><literal>ScriptForge.UI</literal></link> service. Empty string "" default value stands for the current document.</paragraph> + <paragraph role="paragraph" id="par_id311612271947124"><emph>Library</emph>: The case-sensitive name of a library contained in the container. Default value is "Standard".</paragraph> + <paragraph role="paragraph" id="par_id821612271946316"><emph>DialogName</emph>: A case-sensitive string designating the dialog.</paragraph> + <paragraph role="paragraph" id="par_id761620142701399">Below %PRODUCTNAME Basic and Python examples are displaying the <literal>dlgConsole</literal> dialog that belongs to <literal>ScriptForge</literal> shared library:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id471598171198389">Dim oDlg As Object, lButton As Long</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611598171572062">Dim Container As String, Library As String, DialogName As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571598171205739">Set oDlg = CreateScriptService("SFDialogs.Dialog", "GlobalScope", "ScriptForge", "dlgConsole")</paragraph> + <paragraph role="bascode" id="bas_id321598171269873">'... controls initialization goes here...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991598171277414">lButton = oDlg.Execute()</paragraph> + <paragraph role="bascode" id="bas_id471598176518738">'Default mode = Modal</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271598171282891">If lButton = oDlg.OKBUTTON Then</paragraph> + <paragraph role="bascode" id="bas_id551598171288547">'... Process controls and do what is needed here</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741598171294507">End If</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591598171300285">oDlg.Terminate()</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id601619622310089">Or using Python:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id81619619964621">dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', 'ScriptForge', 'dlgConsole')</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="pyc_id41619622700314"># ... controls initialization goes here...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id661619619964814">rc = dlg.Execute()</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="pyc_id661611699964814"># Default mode is Modal</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id711619619964997">if rc == dlg.OKBUTTON:</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="pyc_id681619619965191"> # ... Process controls and do what is needed here</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id821619619965373">dlg.Terminate()</paragraph> + </pycode> + + <paragraph role="paragraph" id="par_id951598174966322" xml-lang="en-US">Alternatively a <literal>Dialog</literal> instance can be retrieved via the <literal>SFDialogs.DialogEvent</literal> service, providing that the dialog was initiated with the <literal>Dialog</literal> service. <literal>DialogEvent</literal> returns the <literal>SFDialogs.Dialog</literal> service instance that triggered the event.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id471620305309968">Sub SomeEvent(ByRef poEvent As Object)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781598175253859"> Dim oDlg As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921598175248581"> Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421598175139021">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id741619625211462">with Python:</paragraph> + <pycode> + <paragraph role="pycode" id="pyc_id221620305385871" localize="false">def some_event(event: uno):</paragraph> + <paragraph role="pycode" id="pyc_id661819619965191" localize="false"> dlg = CreateScriptService("SFDialogs.DialogEvent", event)</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id251598176312571" xml-lang="en-US">Note that in previous examples, the prefix <literal>"SFDialogs."</literal> may be omitted when deemed appropriate.</paragraph> + + <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> + <table id="tab_id381583668386455"> + <tablerow> + <tablecell> + <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491583668386455" role="tablehead" xml-lang="en-US">ReadOnly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668474014" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401583668386455" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151583668386455" role="tablecontent" localize="false">OKBUTTON</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371583668519172" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668386455" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Value = 1. An OK button was pressed.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951583839708571" role="tablecontent" localize="false">CANCELBUTTON</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541583839708548" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751583839708362" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Value = 0. A Cancel button was pressed.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id511584027709311" role="tablecontent" localize="false">Caption</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761584027709516" role="tablecontent " xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491584027709825" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">Specify the title of the dialog.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491583839767611" role="tablecontent" localize="false">Height</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31583839767743" role="tablecontent " xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741583839767926" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Specify the height of the dialog box.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id83158383992056" role="tablecontent" localize="false">Modal</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583839920487" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971583839920282" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451583839920858" role="tablecontent" xml-lang="en-US">Specifies if the dialog box is currently in execution in modal mode.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id751588333908795" role="tablecontent" localize="false">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571588333908716" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781588333908500" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">The name of the dialog</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id251583774433989" role="tablecontent" localize="false">Page</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501583774433513" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411583774433779" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id151598177605296" xml-lang="en-US">A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731588334016220" role="tablecontent" localize="false">Visible</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271588334016191" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991588334016273" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Specify if the dialog box is visible on the desktop. By default it is not visible until the Execute() method is run and visible afterwards.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id741598177924441" role="tablecontent" localize="false">XDialogModel</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451598177924437" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729"> + <bookmark_value>API;UnoControlDialogModel</bookmark_value> + </bookmark> + <paragraph id="par_id94159817792441" role="tablecontent" xml-lang="en-US" localize="true">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing the dialog model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControlModel.html" name="XControlModel interface">XControlModel</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialogModel-members.html" name="css.awt.UnoControlDialogModel">UnoControlDialogModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801598178083859" role="tablecontent" localize="false">XDialogView</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id811598178083501" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729"> + <bookmark_value>API;UnoControlDialog</bookmark_value> + </bookmark> + <paragraph id="par_id981598178083938" role="tablecontent" xml-lang="en-US" localize="true">UNO<br />object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the dialog view. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControlModel.html" name="XControl interface">XControl</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialog-members.html" name="UnoControlDialog interface">UnoControlDialog</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491583938767611" role="tablecontent" localize="false">Width</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31385839767743" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id147583839767926" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111583839717695" role="tablecontent" xml-lang="en-US">Specify the width of the dialog box.</paragraph> + </tablecell> + </tablerow> + </table> + <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2> + <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">Returns a URI string with the reference to the script triggered by the event. Read its specification in the <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification" name="URI specification">scripting framework URI specification</link>.</paragraph> + <table id="tab_id951612628879819"> + <tablerow> + <tablecell> + <paragraph id="par_id961612628879819" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401612628879819" role="tablehead" xml-lang="en-US">ReadOnly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id281612628879819" role="tablehead" xml-lang="en-US">Basic IDE Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431612629836735" localize="false" role="tablecontent" xml-lang="en-US">OnFocusGained</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111612629836630" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001612629836902" role="tablecontent" xml-lang="en-US">When receiving focus</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id701612629836389" localize="false" role="tablecontent" xml-lang="en-US">OnFocusLost</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291612629836294" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id62161262983683" role="tablecontent" xml-lang="en-US">When losing focus</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241612629836863" localize="false" role="tablecontent" xml-lang="en-US">OnKeyPressed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81612629836634" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881612629836744" role="tablecontent" xml-lang="en-US">Key pressed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id201612629836996" localize="false" role="tablecontent" xml-lang="en-US">OnKeyReleased</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591612629836830" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161612629836775" role="tablecontent" xml-lang="en-US">Key released</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id111612629836950" localize="false" role="tablecontent" xml-lang="en-US">OnMouseDragged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891612629836630" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461612629836679" role="tablecontent" xml-lang="en-US">Mouse moved while key presses</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id711612629836495" localize="false" role="tablecontent" xml-lang="en-US">OnMouseEntered</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131612629836291" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151612629836151" role="tablecontent" xml-lang="en-US">Mouse inside</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id971612629836286" localize="false" role="tablecontent" xml-lang="en-US">OnMouseExited</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211612629836725" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id361612629836624" role="tablecontent" xml-lang="en-US">Mouse outside</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721612629836537" localize="false" role="tablecontent" xml-lang="en-US">OnMouseMoved</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311612629836481" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721612629836752" role="tablecontent" xml-lang="en-US">Mouse moved</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id55161262983695" localize="false" role="tablecontent" xml-lang="en-US">OnMousePressed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981612629836116" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381612629836635" role="tablecontent" xml-lang="en-US">Mouse button pressed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id621612629836155" localize="false" role="tablecontent" xml-lang="en-US">OnMouseReleased</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711612629836704" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id35161262983642" role="tablecontent" xml-lang="en-US">Mouse button released</paragraph> + </tablecell> + </tablerow> + </table> + <table id="tab_id891606472825856"> + <tablerow> + <tablecell><paragraph id="par_id581606472825856" role="tablehead" localize="false"></paragraph></tablecell> + <tablecell><paragraph id="par_id921606472825856" role="tablehead">Methods</paragraph></tablecell> + <tablecell><paragraph id="par_id781606472825856" role="tablehead" localize="false"></paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialog.xhp#Activate" name="Activate method">Activate</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#Center" name="Center method">Center</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#Controls" name="Controls method">Controls</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id451606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialog.xhp#EndExecute" name="EndExecute method">EndExecute</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#Execute" name="Execute method">Execute</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#GetTextsFromL10N" name="GetTextsFromL10N method">GetTextsFromL10N</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialog.xhp#Resize" name="Resize method">Resize</link><br/> + <link href="text/sbasic/shared/03/sf_dialog.xhp#Terminate" name="Terminate method">Terminate</link><br/><br/> + </paragraph></tablecell> + </tablerow> + </table> + +<section id="Activate"> + <comment> Activate -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721583933076548"> + <bookmark_value>Dialog service;Activate</bookmark_value> + </bookmark> + <h2 id="hd_id681583933076692" localize="false">Activate</h2> + <paragraph role="paragraph" id="par_id871583933076448">Set the focus on the current <literal>Dialog</literal> instance. Return <literal>True</literal> if focusing was successful.</paragraph> + <paragraph role="paragraph" id="par_id151598178880227" xml-lang="en-US">This method is called from a dialog or control event, or when a dialog is displayed in non-modal mode.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id581619625572111"><input>svc.Activate(): bool</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id221598179105596">Dim oDlg As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171598179111121">Set oDlg = CreateScriptService(,, "myDialog")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681598179123436">oDlg.Execute()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371598179128761">' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361598179135096">oDlg.Activate()</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id811620109056270">Python and %PRODUCTNAME Basic examples both assume that the dialog is stored in current document's <literal>Standard</literal> library.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761619626867424">dlg = CreateScriptService(,,'myDialog')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id111619626868945">dlg.Execute()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id781620108954143"># ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391619626869458">dlg.Activate()</paragraph> + </pycode> +</section> + +<section id="Center"> + <comment> Center -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41584541257826"> + <bookmark_value>Dialog service;Center</bookmark_value> + </bookmark> + <h2 id="hd_id95518454125767" localize="false">Center</h2> + <paragraph role="paragraph" id="par_id391651225506119">Centers the current dialog instance in the middle of a parent window. Without arguments, the method centers the dialog in the middle of the current window.</paragraph> + <paragraph role="paragraph" id="par_id391651552206119">Returns <literal>True</literal> when successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id81619265753895"><input>svc.Center(opt Parent: obj): bool</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id1001585441257789"><emph>Parent</emph>: An optional object that can be either …</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id412598177970993" role="listitem" xml-lang="en-US">a ScriptForge dialog object</paragraph> + </listitem> + <listitem> + <paragraph id="par_id81591858229301" role="listitem" xml-lang="en-US">a ScriptForge document (Calc, Base, ...) object</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id591651232045794">Sub TriggerEvent(oEvent As Object)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id15159958185478904"> Dim oDialog1 As Object, oDialog2 As Object, lExec As Long</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id12598185484092"> Set oDialog1 = CreateScriptService("DialogEvent", oEvent) ' The dialog that caused the event</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id641598184589492"> Set oDialog2 = CreateScriptService("Dialog", ...) ' Open a second dialog</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921598185491593"> oDialog2.Center(oDialog1)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981651231801683"> lExec = oDialog2.Execute()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841651231804826"> Select Case lExec</paragraph> + <paragraph role="bascode" localize="false" id="bas_id501651231990722"> ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101651232400516">End Sub</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id21651232676628">def triggerEvent(event: uno):</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="pyc_id351619267575732"> dlg1 = CreateScriptService('DialogEvent.Dialog', event) # The dialog having caused the event</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="pyc_id431619267576082"> dlg2 = CreateScriptService('Dialog', ...) # Open a second dialog</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id141651235460258"> dlg2.Center(dlg1)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id131619267576307"> rc = dlg2.Execute()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id991651233319117"> if rc is False:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id691651233365005"> # ...</paragraph> + </pycode> +</section> + +<section id="Controls"> + <comment> Controls -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41584541257826"> + <bookmark_value>Dialog service;Controls</bookmark_value> + </bookmark> + <h2 id="hd_id95158454125767" localize="false">Controls</h2> + <paragraph role="paragraph" id="par_id161584541257982">Return either:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id421598179770993" role="listitem" xml-lang="en-US">the list of the controls contained in the dialog</paragraph> + </listitem> + <listitem> + <paragraph id="par_id81598185229301" role="listitem" xml-lang="en-US">a <literal>DialogControl</literal> class instance based on its name</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id81619625753895"><input>svc.Controls(): str[0..*]</input></paragraph> + <paragraph role="paragraph" localize="false" id="par_id61819625753598"><input>svc.Controls(controlname: str): svc</input></paragraph> + <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> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id151598185478904">Dim myDialog As Object, myList As Variant, myControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21598185484092">Set myDialog = CreateScriptService("SFDialogs.Dialog", , "Standard", "Dialog1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641598185489492">myList = myDialog.Controls()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921598185495193">Set myControl = myDialog.Controls("myTextBox")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id351619627575732">dlg = CreateScriptService('SFDialogs.Dialog','', 'Standard', 'Dialog1')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id431619627576082">ctrls = dlg.Controls()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id131619627576307">ctrl = dlg.Controls('myTextBox')</paragraph> + </pycode> +</section> + +<section id="EndExecute"> + <comment> EndExecute -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id171598185776261"> + <bookmark_value>Dialog service;EndExecute</bookmark_value> + </bookmark> + <h2 id="hd_id491598185776436" localize="false">EndExecute</h2> + <paragraph role="paragraph" id="par_id381598185776500">Ends the display of a modal dialog and gives back the argument as return value for the current <literal>Execute()</literal> running action.</paragraph> + <paragraph role="paragraph" id="par_id551598185953362"><literal>EndExecute()</literal> is usually contained in the processing of a macro triggered by a dialog or control event.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id451619627879243"><input>svc.EndExecute(returnvalue: int)</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id451598185776957"><emph>returnvalue</emph>: The value passed to the running <literal>Execute()</literal> method.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id411620110780170">Using %PRODUCTNAME Basic:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id521598186134426">Sub OnEvent(poEvent As com.sun.star.lang.EventObject)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631598186139835"> Dim oDlg As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251598186144483"> Set oDlg = CreateScriptService("SFDialogs.DialogEvent", poEvent)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191598186150509"> oDlg.EndExecute(ReturnValue := 25)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91598186155632">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id11620110819754">Using Python:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id231619627971450">from com.sun.star.lang import EventObject</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id71619627976171">def on_event(event: EventObject):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id621619627976387"> dlg = CreateScriptService("SFDialogs.DialogEvent", event)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id191619627976590"> dlg.EndExecute(25)</paragraph> + </pycode> + <tip id="par_id81620201915101">Above <link href="https://api.libreoffice.org/docs/idl/ref/structcom_1_1sun_1_1star_1_1lang_1_1EventObject.html" name="com.sun.star.lang.EventObject">com.sun.star.lang.EventObject</link> mentions are optional. Such annotations help identify %PRODUCTNAME Application Programming Interface (API).</tip> +</section> + +<section id="Execute"> + <comment> Execute -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id351598186461621"> + <bookmark_value>Dialog service;Execute</bookmark_value></bookmark> + <h2 id="hd_id531598186461915" localize="false">Execute</h2> + <paragraph role="paragraph" id="par_id29159818646178">Display the dialog box and, when modal, wait for its termination by the user. The returned value is either:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id541598186676277" role="listitem" xml-lang="en-US">0 : <literal>Cancel</literal> button pressed</paragraph> + </listitem> + <listitem> + <paragraph id="par_id821598186716345" role="listitem" xml-lang="en-US">1 : <literal>OK</literal> button pressed</paragraph> + </listitem> + <listitem> + <paragraph id="par_id951598186738346" role="listitem" xml-lang="en-US">Otherwise the dialog stopped with an <literal>EndExecute()</literal> statement issued by a dialog or control event</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id741598187335869" xml-lang="en-US">For non-modal dialog boxes the method always returns 0 and the execution of the macro continues.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id291619628195418"><input>svc.Execute(modal: bool = True): int</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id11598186461227"><emph>modal</emph>: <literal>False</literal> when non-modal dialog. Default = <literal>True</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id231620110023843">In this Basic example <literal>myDialog</literal> dialog is stored in current document's <literal>Standard</literal> library.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id591598186461923">Dim oDlg As Object, lReturn As Long</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681598186461370">Set oDlg = CreateScriptService("SFDialogs.Dialog", , , "myDialog")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281598186461514">lReturn = oDlg.Execute(Modal := False)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291598186461410">Select Case lReturn</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741598187182079"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781612273203518">End Select</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id191620110162627">This Python code displays <literal>DlgConvert</literal> modal dialog from <literal>Euro</literal> shared Basic library.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id541619628291899">dlg = CreateScriptService("SFDialogs.Dialog", 'GlobalScope', 'Euro', "DlgConvert")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121619628292915">rc = dlg.Execute()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211620109965604">if rc == dlg.CANCELBUTTON:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id61620109984292"> # ...</paragraph> + </pycode> +</section> + +<section id="GetTextsFromL10N"> + <comment> GetTextsFromL10N -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953209"> + <bookmark_value>Dialog service;GetTextsFromL10N</bookmark_value> + </bookmark> + <h2 id="hd_id101598187950391" localize="false">GetTextsFromL10N</h2> + <paragraph role="paragraph" id="par_id21598187900349">Replaces all fixed text strings in a dialog by their translated versions based on a <literal>L10N</literal> service instance. This method translates the following strings:</paragraph> + <embed href="text/sbasic/shared/03/sf_l10n.xhp#L10NDlgControls"/> + <paragraph role="paragraph" id="par_id641625855723650">The method returns <literal>True</literal> if successful.</paragraph> + <paragraph role="paragraph" id="par_id61637871260604">To create a list of translatable strings in a dialog use the <link href="text/sbasic/shared/03/sf_l10n.xhp#AddTextsFromDialog" name="AddTextsFromDialog">AddTextsFromDialog</link> method from the L10N service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id171619628383909"> + <input>svc.GetTextsFromL10N(l10n: svc): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id451598185776205"><emph>l10n</emph>: A <literal>L10N</literal> service instance from which translated strings will be retrieved.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id951620300689850">The following example loads translated strings and applies them to the dialog "MyDialog".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id971620301083254">oDlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981620301085205">myPO = CreateScriptService("L10N", "/home/user/po_files/")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id916203010852399">oDlg.GetTextsFromL10N(myPO)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121598187953341">oDlg.Execute()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id491620303073122">dlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841620302327011">myPO = CreateScriptService("L10N", "/home/user/po_files/")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381620302328388">dlg.GetTextsFromL10N(myPO)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id251620302328896">dlg.Execute()</paragraph> + </pycode> + <tip id="par_id901637872163895">Read the <link href="text/sbasic/shared/03/sf_l10n.xhp" name="L10N">L10N service</link> help page to learn more about how PO and POT files are handled.</tip> +</section> + +<section id="Resize"> + <comment> Resize -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729"> + <bookmark_value>Dialog service;Resize</bookmark_value> + </bookmark> + <h2 id="hd_id101598187953210" localize="false">Resize</h2> + <paragraph role="paragraph" id="par_id21598187953697">Moves the topleft corner of a dialog to new coordinates and/or modify its dimensions. All distances are expressed in 1/100 mm. Without arguments, the method resets the initial dimensions. Return <literal>True</literal> if the resize was successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711619628389339"><input>svc.Resize(opt Left: num, opt Top: num, opt Width: num, opt Height: num): bool</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481651236673068"><emph>Left</emph>: the horizontal distance from the top-left corner</paragraph> + <paragraph role="paragraph" id="par_id721651236674379"><emph>Top</emph>: the vertical distance from the top-left corner</paragraph> + <paragraph role="paragraph" id="par_id991651236674995"><emph>Width</emph>: the width of the rectangle containing the dialog</paragraph> + <paragraph role="paragraph" id="par_id771651236675564"><emph>Height</emph>: the height of the rectangle containing the dialog</paragraph> + <paragraph role="paragraph" id="par_id211651236676180">Negative or missing arguments are left unchanged</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" xml-lang="en-US" id="bas_id791620301085031">oDialog.Resize(1000, 2000, Height := 6000) ' Width is not changed</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id181620112217958">With Python:</paragraph> + <pycode> + <paragraph role="pycode" xml-lang="en-US" id="pyc_id941620303073866">oDialog.Resize(1000, 2000, Height = 6000) # Width is not changed</paragraph> + </pycode> +</section> + +<section id="Terminate"> + <comment> Terminate -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141598187953729"> + <bookmark_value>Dialog service;Terminate</bookmark_value> + </bookmark> + <h2 id="hd_id101598187953201" localize="false">Terminate</h2> + <paragraph role="paragraph" id="par_id21598187953679">Terminate the <literal>Dialog</literal> service for the current instance. Return <literal>True</literal> if the termination was successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id171619628389339"><input>svc.Terminate(): bool</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id951620300687150">Below Basic and Python examples open <literal>DlgConsole</literal> and <literal>dlgTrace</literal> non-modal dialogs. They are respectively stored in <literal>ScriptForge</literal> and <literal>Access2Base</literal> shared libraries. Dialog close buttons are disabled and explicit termination is performed at the end of a running process.</paragraph> + <paragraph role="paragraph" id="par_id301620302137482">In this example a button in <literal>DlgConsole</literal> is substituting inhibited window closing:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id971620301085031">oDlg = CreateScriptService("SFDialogs.Dialog","GlobalScope","ScriptForge","DlgConsole")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981620301085983">oDlg.Execute(modal:=False)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91620301085248">Wait 5000</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121598187953168">oDlg.Terminate()</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id811620112217958">With Python:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> +<pycode> + <paragraph role="pycode" localize="false" id="pyc_id491620303073866">from time import sleep</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841620302327611">dlg = CreateScriptService('SFDialogs.Dialog',"GlobalScope",'Access2Base',"dlgTrace")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381620302328144">dlg.Execute(modal=False)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id251620302328330">sleep 5</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id101620302328498">dlg.Terminate()</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#ctrls_h1"/> + <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_dialogcontrol.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_dialogcontrol.xhp new file mode 100644 index 000000000..59bb03085 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_dialogcontrol.xhp @@ -0,0 +1,1273 @@ +<?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_DialogControl" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDialogs.DialogControl service</title> + <filename>/text/sbasic/shared/03/sf_dialogcontrol.xhp</filename> + </topic> + </meta> +<body> +<section id="abstract"> + <bookmark localize="false" branch="index" id="bm_id41582391760252"> + <bookmark_value>DialogControl service</bookmark_value> + </bookmark> + <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="ctrls_h1"><link href="text/sbasic/shared/03/sf_dialogcontrol.xhp" name="SFDialogs.DialogControl service"><literal>SFDialogs</literal>.<literal>DialogControl</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The <literal>DialogControl</literal> service manages the controls belonging to a dialog defined with the Basic <link href="text/sbasic/guide/create_dialog.xhp" name="Dialog Editor">Dialog Editor</link>. Each instance of the current service represents a single control within a dialog box.</paragraph> + <bookmark xml-lang="en-US" branch="index" id="bm_id331612167249331" localize="false"> + <bookmark_value>API;awt.XControl</bookmark_value> + <bookmark_value>API;awt.XControlModel</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="par_id701598191157426" xml-lang="en-US">The focus is set on getting and setting the values displayed by the controls of the dialog box. Formatting is accessible via the <literal>XControlModel</literal> and <literal>XControlView</literal> properties.</paragraph> + <paragraph role="paragraph" id="par_id981598191184526" xml-lang="en-US">Note that the unique <literal>DialogControl.Value</literal> property content varies according to the control type.</paragraph> + <paragraph role="paragraph" id="par_id991612698027551" xml-lang="en-US">A special attention is given to controls of type tree control. It is easy to populate a tree, either branch by branch, or with a set of branches at once. Populating a tree control can be performed statically or dynamically.</paragraph> +</section> + <tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDialogs.DialogControl</literal> service is closely related to the <link href="text/sbasic/shared/03/sf_dialog.xhp" name="Dialog service"><literal>SFDialogs.Dialog</literal></link> service.</tip> + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>DialogControl</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id361598174756160" xml-lang="en-US">The <literal>DialogControl</literal> service is invoked from an existing <literal>Dialog</literal> service instance through its <literal>Controls()</literal> method. The dialog must be initiated with the <literal>SFDialogs.Dialog</literal> service.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id791598453192421">Dim myDialog As Object, myControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251598453197473">Set myDialog = CreateScriptService("SFDialogs.Dialog", "GlobalScope", myLibrary, DialogName)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421598453203458">Set myControl = myDialog.Controls("myTextBox")</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id581598453210170">myControl.Value = "Dialog started at " & Now()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id11598453215943">myDialog.Execute()</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id961598453222539">' ... process the controls actual values</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981598453230245">myDialog.Terminate()</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id481026225234594">from time import localtime, strftime</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id481620225234594">dlg = CreateScriptService('SFDialogs.Dialog', 'GlobalScope', lib_name, dlg_name)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id811620225234785">text = dlg.Controls('myTextBox')</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="pyc_id861620225235002">text.Value = "Dialog started at " + strftime("%a, %d %b %Y %H:%M:%S", localtime())</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361620225235185">dlg.Execute()</paragraph> + <paragraph role="pycode" xml-lang="en-US" id="pyc_id841620225235377"># ... process the controls actual values</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id411620225235569">dlg.Terminate()</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id951598174966322" xml-lang="en-US">Alternatively a control instance can be retrieved via the <literal>SFDialogs.DialogEvent</literal> service, providing the dialog was initiated with the <literal>Dialog</literal> service. <literal>DialogEvent</literal> returns the <literal>SFDialogs.DialogControl</literal> class instance that triggered the event.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id311598175259794">Sub SomeEvent(ByRef poEvent As Object)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781598175253859"> Dim oControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921598175248581"> Set oControl = CreateScriptService("SFDialogs.DialogEvent", poEvent)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711598175146308"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421598175139021">End Sub</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id921620228762243">def some_event(event: uno):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181620228763531"> ctrl = CreateScriptService('SFDialogs.DialogEvent', event)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id731620228763715"> # ...</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id251598176312571" xml-lang="en-US">Note that in previous examples, the prefix <literal>"SFDialogs."</literal> may be omitted.</paragraph> + <h2 id="hd_id71598455687512" xml-lang="en-US">Control types</h2> + <paragraph role="paragraph" id="par_id851598455863395" xml-lang="en-US">The <literal>DialogControl</literal> service is available for these control types:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id121598455880500" localize="false" role="listitem">Button</paragraph> + </listitem> + <listitem> + <paragraph id="par_id441598455934376" localize="false" role="listitem">CheckBox</paragraph> + </listitem> + <listitem> + <paragraph id="par_id471598455940400" localize="false" role="listitem">ComboBox</paragraph> + </listitem> + <listitem> + <paragraph id="par_id181598455945642" localize="false" role="listitem">CurrencyField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id181598455949653" localize="false" role="listitem">DateField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id541598455953714" localize="false" role="listitem">FileControl</paragraph> + </listitem> + <listitem> + <paragraph id="par_id441598455957858" localize="false" role="listitem">FixedLine</paragraph> + </listitem> + <listitem> + <paragraph id="par_id971598455961404" localize="false" role="listitem">FixedText</paragraph> + </listitem> + <listitem> + <paragraph id="par_id721598455965612" localize="false" role="listitem">FormattedField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id291598455969826" localize="false" role="listitem">GroupBox</paragraph> + </listitem> + <listitem> + <paragraph id="par_id861598455974724" localize="false" role="listitem">ImageControl</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851598455979572" localize="false" role="listitem">ListBox</paragraph> + </listitem> + <listitem> + <paragraph id="par_id321598455984243" localize="false" role="listitem">NumericField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id981598455990524" localize="false" role="listitem">PatternField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id991598455998589" localize="false" role="listitem">ProgressBar</paragraph> + </listitem> + <listitem> + <paragraph id="par_id281598456002561" localize="false" role="listitem">RadioButton</paragraph> + </listitem> + <listitem> + <paragraph id="par_id91598456007438" localize="false" role="listitem">ScrollBar</paragraph> + </listitem> + <listitem> + <paragraph id="par_id171612698897041" localize="false" role="listitem">TableControl</paragraph> + </listitem> + <listitem> + <paragraph id="par_id271598456011504" localize="false" role="listitem">TextField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id661598456015339" localize="false" role="listitem">TimeField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id171612698897514" localize="false" role="listitem">TreeControl</paragraph> + </listitem> + </list> + <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> + <table id="tab_id381583668386455"> + <tablerow> + <tablecell> + <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491583668386455" role="tablehead" xml-lang="en-US">ReadOnly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668474014" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291598538799794" role="tablehead" xml-lang="en-US">Applicable to</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401583668386455" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151583668386455" role="tablecontent" localize="false">Cancel</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371583668519172" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668386455" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id231598538847029" role="tablecontent" localize="false" xml-lang="en-US">Button</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Specifies if a command button has or not the behaviour of a Cancel button.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951583839708571" role="tablecontent" localize="false">Caption</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541583839708548" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751583839708362" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351598538934413" role="tablecontent" localize="false">Button, CheckBox, FixedLine, FixedText, GroupBox, RadioButton</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Specifies the text associated with the control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id511584027709311" role="tablecontent" localize="false">ControlType</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761584027709516" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491584027709825" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261598539120502" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">One of the types listed above.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id141612705482724" role="tablecontent" localize="false">CurrentNode</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id67161270548283" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id341612705482566" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id51612705482172" role="tablecontent" localize="false">TreeControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001612705482919" role="tablecontent" xml-lang="en-US">The currently upmost node selected in the tree control. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XmutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491583839767611" role="tablecontent" localize="false">Default</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31583839767743" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741583839767926" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71598539168348" role="tablecontent" localize="false">Button</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Specifies whether a command button is the default (OK) button.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id83158383992056" role="tablecontent" localize="false">Enabled</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583839920487" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971583839920282" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891598539196786" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451583839920858" role="tablecontent" xml-lang="en-US">Specifies if the control is accessible with the cursor.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id751588333908795" role="tablecontent" localize="false">Format</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571588333908716" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781588333908500" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491598539231618" role="tablecontent" localize="false">DateField, TimeField, FormattedField</paragraph> + <paragraph id="par_id491598529331618" role="tablecontent" xml-lang="en-US">(read-only)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">Specifies the format used to display dates and times. It must be one these strings:</paragraph> + <paragraph role="paragraph" id="par_id891598456980194" xml-lang="en-US">For dates: "Standard (short)", "Standard (short YY)", "Standard (short YYYY)", "Standard (long)", "DD/MM/YY", "MM/DD/YY", "YY/MM/DD", "DD/MM/YYYY", "MM/DD/YYYY" , "YYYY/MM/DD", "YY-MM-DD", "YYYY-MM-DD".</paragraph> + <paragraph role="paragraph" id="par_id221598456991070" xml-lang="en-US">For times: "24h short", "24h long", "12h short", "12h long".</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id251583774433989" role="tablecontent" localize="false">ListCount</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501583774433513" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411583774433779" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531598539561342" role="tablecontent" localize="false">ComboBox, ListBox, TableControl</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id151598177605296" xml-lang="en-US">Specifies the number of rows in a ListBox, a ComboBox or a TableControl.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731588334016220" role="tablecontent" localize="false">ListIndex</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271588334016191" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991588334016273" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451598539598242" role="tablecontent" localize="false">ComboBox, ListBox, TableControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Specifies which item is selected in a ListBox, a ComboBox or a TableControl.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id451598457655392" role="tablecontent" localize="false">Locked</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961598457655506" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571598457655365" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111598539631340" role="tablecontent" localize="false">ComboBox, CurrencyField, DateField, FileControl, FormattedField, ListBox, NumericField, PatternField, TextField, TimeField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id2159845765568" role="tablecontent" xml-lang="en-US">Specifies if the control is read-only.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id21159845795140" role="tablecontent" localize="false">MultiSelect</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621598457951781" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311598457951281" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id361598539747680" role="tablecontent" localize="false">ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821598457951782" role="tablecontent" xml-lang="en-US">Specifies whether a user can make multiple selections in a listbox.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id421598458170141" role="tablecontent" localize="false">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351598458170114" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391598458170757" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151598539764402" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621598458170392" role="tablecontent" xml-lang="en-US">The name of the control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id281598458357593" role="tablecontent" localize="false">Page</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id80159845835726" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id191598458357402" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841598539781888" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id791598458357756" role="tablecontent" xml-lang="en-US">A dialog may have several pages that can be traversed by the user step by step. The Page property of the Dialog object defines which page of the dialog is active.</paragraph> + <paragraph role="paragraph" id="par_id441598458459145" xml-lang="en-US">The Page property of a control defines the page of the dialog on which the control is visible.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id2915984585802" role="tablecontent" localize="false">Parent</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161598458580581" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id921598458580608" role="tablecontent" xml-lang="en-US"><literal>Dialog</literal><br/>service</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id181598539807426" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801598458580456" role="tablecontent" xml-lang="en-US">The parent <literal>SFDialogs.Dialog</literal> class object instance.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181598458773220" role="tablecontent" localize="false">Picture</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971598458773352" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471598458773993" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831598539848472" role="tablecontent" localize="false">Button, ImageControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451598458773588" role="tablecontent" xml-lang="en-US">Specifies the file name containing a bitmap or other type of graphic to be displayed on the specified control. The filename must comply with the <literal>FileNaming</literal> attribute of the <literal>ScriptForge.FileSystem</literal> service.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id791612700624395" role="tablecontent" localize="false">RootNode</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831612700624650" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711612700624483" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581612700624717" role="tablecontent" localize="false">TreeControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id11612700624514" role="tablecontent" xml-lang="en-US">An object representing the lowest root node (usually there is only one such root node). Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XmutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681598516577774" role="tablecontent" localize="false">RowSource</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401598516577225" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id59159851657754" role="tablecontent" localize="false">Array of strings</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131598539880024" role="tablecontent" localize="false">ComboBox, ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311598516577712" role="tablecontent" xml-lang="en-US">Specifies the data contained in a combobox or a listbox.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491598516764653" role="tablecontent" localize="false">Text</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781598516764550" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741598516764696" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761598539912452" role="tablecontent" localize="false">ComboBox, FileControl, FormattedField, PatternField, TextField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id11159851676440" role="tablecontent" xml-lang="en-US">Gives access to the text being displayed by the control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311598517275908" role="tablecontent" localize="false">TipText</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411598517275112" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971598517275920" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id171598539985022" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651598517275384" role="tablecontent" xml-lang="en-US">Specifies the text that appears as a tooltip when you hold the mouse pointer over the control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951598517418614" role="tablecontent" localize="false">TripleState</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821598517418463" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id231598517418608" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81598540007035" role="tablecontent" localize="false">CheckBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141598517418822" role="tablecontent" xml-lang="en-US">Specifies if the checkbox control may appear dimmed (grayed) or not.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31598517671415" role="tablecontent" localize="false">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701598517671373" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id2159851767113" role="tablecontent" localize="false">Variant</paragraph> + </tablecell> + <tablecell></tablecell> + <tablecell> + <paragraph id="par_id1001598540024225" role="tablecontent" xml-lang="en-US">Refer to <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#hd_id81598540704978" name="Value property">Value property</link></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id571598517730264" role="tablecontent" localize="false">Visible</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661598517730941" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981598517730694" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761598540042290" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881598517730836" role="tablecontent" xml-lang="en-US">Specifies if the control is hidden or visible.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id741598177924441" role="tablecontent" localize="false">XControlModel</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451598177924437" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id94159817792441" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311598540066789" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing the control model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControlModel.html" name="awt.XControlModel">XControlModel</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialogModel.html)" name="awt.XControlDialogModel">UnoControlDialogModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801598178083859" role="tablecontent" localize="false">XControlView</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id811598178083501" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981598178083938" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id551598540079329" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the control view. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControl.html" name="awt.XControl">XControl</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlDialog.html)" name="awt.UnoControlDialog">UnoControlDialog</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id55161269944658" role="tablecontent" localize="false">XTreeDataModel</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741612699446459" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311612699446893" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id25161269944611" role="tablecontent" localize="false">TreeControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691612699446892" role="tablecontent" xml-lang="en-US">The UNO object representing the tree control data model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeDataModel.html" name="awt.tree.XMutableTreeDataModel">XMutableTreeDataModel</link> in Application Programming Interface (API) documentation for detailed information.</paragraph> + </tablecell> + </tablerow> + </table> + + <h2 id="hd_id81598540704978" xml-lang="en-US">The <variable id="ValueProperty">Value property</variable></h2> + <table id="tab_id48159854325479"> + <tablerow> + <tablecell> + <paragraph id="par_id10159854325492" role="tablehead" xml-lang="en-US">Control type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741598543254158" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961598543254444" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id461598543254494" role="tablecontent" localize="false">Button</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271598543254590" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741598543254108" role="tablecontent" xml-lang="en-US">For toggle buttons only</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id131598543254931" role="tablecontent" localize="false">CheckBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741598543254376" role="tablecontent" xml-lang="en-US">Boolean or Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521598543254630" role="tablecontent" xml-lang="en-US">0, False: not checked<br />1, True: checked<br />2: grayed, don't know</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891598543254563" role="tablecontent" localize="false">ComboBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781598543254887" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id331598543254947" role="tablecontent" xml-lang="en-US">The selected value. The <literal>ListIndex</literal> property is an alternate option.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id58159854325446" role="tablecontent" localize="false">CurrencyField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id5159854325443" role="tablecontent" xml-lang="en-US">Numeric</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241598543254415" role="tablecontent" localize="false">DateField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401598543254743" role="tablecontent" localize="false">Date</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851598543254508" role="tablecontent" localize="false">FileControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731598543254544" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971598543254757" role="tablecontent" xml-lang="en-US">A file name formatted in accordance with the <literal>FileNaming</literal> property of the <literal>ScriptForge.FileSystem</literal> service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id921598543254323" role="tablecontent" localize="false">FormattedField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221598543254760" role="tablecontent" xml-lang="en-US">String or Numeric</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151598543254318" role="tablecontent" localize="false">ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id42159854325422" role="tablecontent" xml-lang="en-US">String or array of strings</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601598543254780" role="tablecontent" xml-lang="en-US">The selected row(s) as a scalar or as an array depending on the <literal>MultiSelect</literal> attribute</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id771598543254973" role="tablecontent" localize="false">NumericField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461598543254909" role="tablecontent" xml-lang="en-US">Numeric</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id38159854325480" role="tablecontent" localize="false">PatternField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81598543254625" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951598543254998" role="tablecontent" localize="false">ProgressBar</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id631598543254771" role="tablecontent" xml-lang="en-US">Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91598543254766" role="tablecontent" xml-lang="en-US">Must be within the predefined bounds</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id791598543254779" role="tablecontent" localize="false">RadioButton</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561598543254115" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id851598543254624" role="tablecontent" xml-lang="en-US">Each button has its own name. They are linked together if their TAB positions are contiguous. If a radiobutton is set to <literal>True</literal>, the other related buttons are automatically set to <literal>False</literal></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id141598543254361" role="tablecontent" localize="false">ScrollBar</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531598543254869" role="tablecontent" xml-lang="en-US">Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21598543254994" role="tablecontent" xml-lang="en-US">Must be within the predefined bounds</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id811598543254007" role="tablecontent" localize="false">TableControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751598543254805" role="tablecontent" localize="false">Array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441598543254951" role="tablecontent" xml-lang="en-US">One-dimensional array with the data of the currently selected row.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id811598543254140" role="tablecontent" localize="false">TextField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751598543254299" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441598543254738" role="tablecontent" xml-lang="en-US">The text appearing in the field</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id89159854325478" role="tablecontent" localize="false">TimeField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id341598543254600" role="tablecontent" localize="false">Date</paragraph> + </tablecell> + <tablecell> + </tablecell> + </tablerow> + </table> + <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2> + <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">Returns a URI string with the reference to the script triggered by the event. Read its specification in the <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification" name="URI specification">scripting framework URI specification</link>.</paragraph> + <table id="tab_id951612628879819"> + <tablerow> + <tablecell> + <paragraph id="par_id961612628879819" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401612628879819" role="tablehead" xml-lang="en-US">ReadOnly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id281612628879819" role="tablehead" xml-lang="en-US">Description as labeled in the Basic IDE</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801612707166342" localize="false" role="tablecontent" xml-lang="en-US">OnActionPerformed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91612707166532" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291612707166258" role="tablecontent" xml-lang="en-US">Execute action</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id261612707166662" localize="false" role="tablecontent" xml-lang="en-US">OnAdjustmentValueChanged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id79161270716675" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831612707166731" role="tablecontent" xml-lang="en-US">While adjusting</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431612629836735" localize="false" role="tablecontent" xml-lang="en-US">OnFocusGained</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111612629836630" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001612629836902" role="tablecontent" xml-lang="en-US">When receiving focus</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id701612629836389" localize="false" role="tablecontent" xml-lang="en-US">OnFocusLost</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291612629836294" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id62161262983683" role="tablecontent" xml-lang="en-US">When losing focus</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id10161270735471" localize="false" role="tablecontent" xml-lang="en-US">OnItemStateChanged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id51612707354544" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211612707354899" role="tablecontent" xml-lang="en-US">Item status changed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241612629836863" localize="false" role="tablecontent" xml-lang="en-US">OnKeyPressed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81612629836634" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881612629836744" role="tablecontent" xml-lang="en-US">Key pressed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id201612629836996" localize="false" role="tablecontent" xml-lang="en-US">OnKeyReleased</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591612629836830" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161612629836775" role="tablecontent" xml-lang="en-US">Key released</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id111612629836950" localize="false" role="tablecontent" xml-lang="en-US">OnMouseDragged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891612629836630" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461612629836679" role="tablecontent" xml-lang="en-US">Mouse moved while key presses</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id711612629836495" localize="false" role="tablecontent" xml-lang="en-US">OnMouseEntered</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131612629836291" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151612629836151" role="tablecontent" xml-lang="en-US">Mouse inside</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id971612629836286" localize="false" role="tablecontent" xml-lang="en-US">OnMouseExited</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211612629836725" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id361612629836624" role="tablecontent" xml-lang="en-US">Mouse outside</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721612629836537" localize="false" role="tablecontent" xml-lang="en-US">OnMouseMoved</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311612629836481" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721612629836752" role="tablecontent" xml-lang="en-US">Mouse moved</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id55161262983695" localize="false" role="tablecontent" xml-lang="en-US">OnMousePressed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981612629836116" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381612629836635" role="tablecontent" xml-lang="en-US">Mouse button pressed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id621612629836155" localize="false" role="tablecontent" xml-lang="en-US">OnMouseReleased</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711612629836704" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id35161262983642" role="tablecontent" xml-lang="en-US">Mouse button released</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id671612707606983" localize="false" role="tablecontent" xml-lang="en-US">OnNodeExpanded</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id851612707606863" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351612707606197" role="tablecontent" xml-lang="en-US">(Not in Basic IDE) when the expansion button is pressed on a node in a tree control</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id331612707606104" localize="false" role="tablecontent" xml-lang="en-US">OnNodeSelected</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id121612707606251" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881612707606121" role="tablecontent" xml-lang="en-US">(Not in Basic IDE) when a node in a tree control is selected</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id84161270760678" localize="false" role="tablecontent" xml-lang="en-US">OnTextChanged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id811612707606330" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621612707606219" role="tablecontent" xml-lang="en-US">Text modified</paragraph> + </tablecell> + </tablerow> + </table> + + <h2 id="hd_id421583670049913" xml-lang="en-US">Methods</h2> + + <table id="tab_id891606472825856"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the DialogControl Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id751612709117248" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubNode" name="AddSubNode method">AddSubNode</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#AddSubTree" name="AddSubTree method">AddSubTree</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#CreateRoot" name="CreateRoot method">CreateRoot</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id63161270911712" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#FindNode" name="FindNode method">FindNode</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetFocus" name="SetFocus method">SetFocus</link><br/><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id651612709117457" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#SetTableData" name="SetTableData method">SetTableData</link><br/> + <link href="text/sbasic/shared/03/sf_dialogcontrol.xhp#WriteLine" name="WriteLine method">WriteLine</link><br/><br/> + </paragraph></tablecell> + </tablerow> + </table> + +<section id="AddSubNode"> + <comment> AddSubNode -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id1516127118236"> + <bookmark_value>DialogControl service;AddSubNode</bookmark_value> + </bookmark> + <h2 id="hd_id791612711823914" localize="false">AddSubNode</h2> + <paragraph role="paragraph" id="par_id831612711823126">Create and return a new node of the tree control as a UNO object subordinate to a parent node. <variable id="XMutableTreeNode">Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1tree_1_1XMutableTreeNode.html" name="awt.tree.XMutableTreeNode">XMutableTreeNode</link> in Application Programming Interface (API) documentation for detailed information.</variable></paragraph> + <section id="OnNodeExpanded"> + <paragraph role="paragraph" id="par_id741612711823706" xml-lang="en-US">This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event - using the <literal>OnNodeExpanded</literal> event - to complete the tree dynamically.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id781620224364283"> + <input>svc.AddSubNode(parentnode: uno, displayvalue: str, opt datavalue: any): uno</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id761612711823834"><emph>parentnode</emph>: A node UNO object, of type <literal>com.sun.star.awt.tree.XMutableTreeNode</literal>.</paragraph> + <paragraph role="paragraph" id="par_id791612711823819"><emph>displayvalue</emph>: The text appearing in the tree control box.</paragraph> + <section id="datavalue"> + <paragraph role="paragraph" id="par_id911612711823382"><emph>datavalue</emph>: Any value associated with the new node. <literal>datavalue</literal> may be a string, a number or a date. Omit the argument when not applicable.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id901620317110685">%PRODUCTNAME Basic and Python examples pick up current document's <literal>myDialog</literal> dialog from <literal>Standard</literal> library.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id781612711823502">Dim oDlg As Object, myTree As Object, myNode As Object, theRoot As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811612711823106">Set oDlg = CreateScriptService("Dialog",,, "myDialog")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751612711823763">Set myTree = oDlg.Controls("myTreeControl")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31612711823423">Set theRoot = myTree.CreateRoot("Tree top")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211612712366538">Set myNode = myTree.AddSubNode(theRoot, "A branch ...")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id771620316787550">dlg = CreateScriptService('SFDialogs.Dialog', None, None, 'myDialog')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id511620316787792">tree = dlg.Controls('myTreeControl')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id291620316787950">root = tree.CreateRoot('Tree top')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id201620316788142">node = tree.AddSubNode(root, 'A branch ...')</paragraph> + </pycode> +</section> + +<section id="AddSubTree"> + <comment> AddSubTree -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id481612713087784"> + <bookmark_value>DialogControl service;AddSubTree</bookmark_value> + </bookmark> + <h2 id="hd_id81161271308746" localize="false">AddSubTree</h2> + <paragraph role="paragraph" id="par_id221612713087885">Return <literal>True</literal> when a subtree, subordinate to a parent node, could be inserted successfully in a tree control. If the parent node had already child nodes before calling this method, the child nodes are erased.</paragraph> + <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#OnNodeExpanded"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id731620308640671"> + <input>svc.AddSubTree(parentnode: uno, flattree: any, opt withdatavalue: bool): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id781612713087722"><emph>parentnode</emph>: A node UNO object, of type <literal>com.sun.star.awt.tree.XMutableTreeNode</literal>.</paragraph> + <paragraph role="paragraph" id="par_id36161271308759"><emph>flattree</emph>: a two dimension array sorted on the columns containing the display values. Such an array can be issued by the <literal>GetRows</literal> method applied on the <literal>SFDatabases.Database</literal> service. When an array item containing the text to be displayed is <literal>Empty</literal> or <literal>Null</literal>, no new subnode is created and the remainder of the row is skipped.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id61612716027443">Flat tree >>>> Resulting subtree</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881612716035711">A1 B1 C1 |__ A1 </paragraph> + <paragraph role="bascode" localize="false" id="bas_id221612716043100">A1 B1 C2 |__ B1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id861612716050132">A1 B2 C3 |__ C1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251612716057266">A2 B3 C4 |__ C2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id316127156064145">A2 B3 C5 |__ B2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321612716075452">A3 B4 C6 |__ C3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171612716083505"> |__ A2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231612716092043"> |__ B3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id216124716100898"> |__ C4</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241612716108208"> |__ C5</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531612716115408"> |__ A3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621612716122130"> |__ B4</paragraph> + <paragraph role="bascode" localize="false" id="bas_id212612716132791"> |__ C6</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id51612713087915"><emph>withdatavalue</emph>: When <literal>False</literal> default value is used, every column of <literal>flattree</literal> contains the text to be displayed in the tree control. When <literal>True</literal>, the texts to be displayed (<literal>displayvalue</literal>) are in columns 0, 2, 4, ... while the data values (<literal>datavalue</literal>) are in columns 1, 3, 5, ...</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id531612713087285">Dim myTree As Object, theRoot As Object, oDb As Object, vData As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991612713087724">Set myTree = myDialog.Controls("myTreeControl")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581612713087989">Set theRoot = myTree.CreateRoot("By product category")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771612713087670">Set oDb = CreateScriptService("SFDatabases.Database", "/home/.../mydatabase.odb")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id731612713087683">vData = oDb.GetRows("SELECT [Category].[Name], [Category].[ID], [Product].[Name], [Product].[ID] " _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id551612714130895"> & "FROM [Category], [Product] WHERE [Product].[CategoryID] = [Category].[ID] " _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id551612714139429"> & "ORDER BY [Category].[Name], [Product].[Name]")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361612714193588">myTree.AddSubTree(theRoot, vData, WithDataValue := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id671620317364456">SQL_STMT = "SELECT [Category].[Name], [Category].[ID], [Product].[Name], [Product].[ID] \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id51620317364911"> FROM [Category], [Product] WHERE [Product].[CategoryID] = [Category].[ID] \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id101620318087874"> ORDER BY [Category].[Name], [Product].[Name]"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id901620317363542">tree = dlg.Controls('myTreeControl')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361620317363735">root = tree.CreateRoot('By Product category')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361620317363903">db = CreateScriptService('SFDatabases.Database', '/home/.../mydatabase.odb')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id911620317364071">sub_tree = db.GetRows(SQL_STMT)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221620317364271">tree.AddSubTree(root, sub_tree, withdatavalue=True)</paragraph> + </pycode> +</section> + +<section id="CreateRoot"> + <comment> CreateRoot ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id791612780723864"> + <bookmark_value>DialogControl service;CreateRoot</bookmark_value> + </bookmark> + <h2 id="hd_id291612780723671" localize="false">CreateRoot</h2> + <paragraph role="paragraph" id="par_id151612780723320">Returns a new root node of the tree control, as a node UNO object of type <literal>com.sun.star.awt.tree.XMutableTreeNode</literal>. The new tree root is inserted below pre-existing root nodes. <embedvar href="text/sbasic/shared/03/sf_dialogcontrol.xhp#XMutableTreeNode"/></paragraph> + <paragraph role="paragraph" id="par_id821612780723965" xml-lang="en-US">This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event to complete the tree dynamically.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id991620309297239"> + <input>svc.CreateRoot(displayvalue: str, opt datavalue: any): uno</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id791612117823819"><emph>displayvalue</emph>: The text appearing in the tree control box.</paragraph> + <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#datavalue"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id491612780723925">Dim myTree As Object, myNode As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241612780723722">Set myTree = myDialog.Controls("myTreeControl")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441612780723817">Set myNode = myTree.CreateRoot("Tree starts here ...")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id441620318437138">tree = dlg.Controls('myTreeControl')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id301620318437324">node = tree.CreateRoot('Tree starts here ...')</paragraph> + </pycode> +</section> + +<section id="FindNode"> + <comment> FindNode ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id741612781589926"> + <bookmark_value>DialogControl service;FindNode</bookmark_value> + </bookmark> + <h2 id="hd_id801612781589891" localize="false">FindNode</h2> + <paragraph role="paragraph" id="par_id171612781589503">Traverses the tree and finds recursively, starting from the root, a node meeting some criteria. Either - 1 match is enough - having its display value matching <literal>displayvalue</literal> pattern or having its data value equal to <literal>datavalue</literal>. The comparisons may be or not case-sensitive. The first matching occurrence is returned as a node UNO object of type <literal>com.sun.star.awt.tree.XMutableTreeNode</literal>. <embedvar href="text/sbasic/shared/03/sf_dialogcontrol.xhp#XMutableTreeNode"/></paragraph> + <paragraph role="paragraph" id="par_id741612782475457" xml-lang="en-US">When not found, the method returns <literal>Nothing</literal>, to be tested with the <literal>IsNull()</literal> builtin function.</paragraph> + <paragraph role="paragraph" id="par_id41612781589363" xml-lang="en-US">This method may be called before displaying the dialog box to build the initial tree. It may also be called from a dialog or control event.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id61620309668544"> + <input>svc.FindNode(displayvalue: str = '', opt datavalue: any, casesensitive = False): uno</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id541613670199211">One argument out of <literal>displayvalue</literal> or <literal>datavalue</literal> must be specified. If both present, one match is sufficient to select the node.</paragraph> + <paragraph role="paragraph" id="par_id591612781589560"><emph>displayvalue</emph>: The pattern to be matched. Refer to <link href="text/sbasic/shared/03/sf_string.xhp#IsLike" name="String service IsLike() method"><literal>SF_String.IsLike()</literal></link> method for the list of possible wildcards. When equal to the zero-length string (default), this display value is not searched for.</paragraph> + <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#datavalue"/> + <paragraph role="paragraph" id="par_id141582384726168"><emph>casesensitive</emph>: Default value is <literal>False</literal></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id61612781589464">Dim myTree As Object, myNode As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991612781589903">Set myTree = myDialog.Controls("myTreeControl")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461612781589942">Set myNode = myTree.FindNode("*Sophie*", CaseSensitive := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id191620318816450">tree = dlg.Controls('myTreeControl')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id281620318817089">node = FindNode('*Sophie*', casesensitive=True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id861620319785763">if node is None:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id471620319809524"> # ...</paragraph> + </pycode> +</section> + +<section id="SetFocus"> + <comment> SetFocus ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id721583933076548"> + <bookmark_value>DialogControl service;SetFocus</bookmark_value> + </bookmark> + <h2 id="hd_id681583933076692" localize="false">SetFocus</h2> + <paragraph role="paragraph" id="par_id871583933076448">Set the focus on the control. Return <literal>True</literal> if focusing was successful.</paragraph> + <paragraph role="paragraph" id="par_id151598178880227" xml-lang="en-US">This method is often called from a dialog or control event.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id11620310325234"> + <input>svc.SetFocus(): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id221598179105596">Dim oControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171598179111121">Set oDlg = CreateScriptService("SFDialogs.Dialog",,, "myDialog")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681598179123436">Set oControl = oDlg.Controls("thisControl")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361598179135096">oControl.SetFocus()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id591620319169802">dlg = CreateScriptService('Dialog', None, None, 'myDialog')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id201620319170298">ctrl = dlg.Controls('thisControl')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id821620319170682">ctrl.SetFocus()</paragraph> + </pycode> +</section> + +<section id="SetTableData"> + <comment> SetTableData ------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id761598619892024"> + <bookmark_value>DialogControl service;SetTableData</bookmark_value> + </bookmark> + <h2 id="hd_id961598619890364" localize="false">SetTableData</h2> + <paragraph role="paragraph" id="par_id541638553960464">Fills a <literal>TableControl</literal> with the given data. All preexisting data is cleared before inserting the new data passed as argument.</paragraph> + <paragraph role="paragraph" id="par_id551638554058131">When the <literal>TableControl</literal> is added to the dialog, it is possible to use the Basic IDE to define whether column and row headers will be shown in the table. If the <literal>TableControl</literal> has column and/or row headers, the first column and/or row in the provided data array are used as labels for the table headers.</paragraph> + <paragraph role="paragraph" id="par_id411638569396108">This method returns <literal>True</literal> when successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id841620310380255"> + <input>svc.SetTableData(dataarray: any[0..*, 0..*], widths: int[0..*], alignments: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id1001584541257133"><emph>dataarray</emph>: Data to be entered into the table represented as an Array of Arrays in Basic or a tuple of tuples in Python. The data must include column and row headers if they are to be displayed by the <literal>TableControl</literal>.</paragraph> + <paragraph role="paragraph" id="par_id1001584541257025"><emph>widths</emph>: Array containing the relative widths of each column. In other words, <literal>widths = Array(1, 2)</literal> means that the second column is twice as wide as the first one. If the number of values in the array is smaller than the number of columns in the table, then the last value in the array is used to define the width of the remaining columns.</paragraph> + <paragraph role="paragraph" id="par_id1001584541257007"><emph>alignments</emph>: Defines the alignment in each column as a string in which each character can be "L" (Left), "C" (Center), "R" (Right) or " " (whitespace, default, meaning left for strings and right for numeric values). If the length of the string is shorter than the number of columns in the table, then the last character in the string is used to define the alignment of the remaining columns.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id381638569172413">The following example assumes that the dialog <literal>myDialog</literal> has a <literal>TableControl</literal> named <literal>Grid1</literal> with "Show row header" and "Show column header" properties set to "Yes".</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id901638569052132">Dim myDialog As Object, oTable As Object, tableData As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781638569039123">myDialog = CreateScriptService("Dialog", "GlobalScope", "Standard", "myDialog")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281638569051918">oTable = myDialog.Controls("Grid1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361638569052324">tableData = Array("Column A", "Column B", "Column C")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291638569052525">tableData = SF_Array.AppendRow(tableData, Array("Row 1", 1, 2))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631638569052740">tableData = SF_Array.AppendRow(tableData, Array("Row 2", 3, 4))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371638569052941">tableData = SF_Array.AppendRow(tableData, Array("Row 3", 5, 6))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781638569053179">vAlignments = "LCC"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181638569053413">vWidths = Array(2, 1, 1)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191638569053613">oTable.SetTableData(tableData, vWidths, vAlignments)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981638569053837">myDialog.Execute()</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id171638650502346">The <literal>Value</literal> property returns the selected row in the table. If no row is selected, an empty Array object is returned. The following code snippet shows how to test if any row is selected in the table.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891638651540245">rowValues = oTable.Value</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431638651540427">If UBound(rowValues) < 0 Then</paragraph> + <paragraph role="bascode" id="bas_id361638651540588"> MsgBox "No row selected."</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121638651540820">Else</paragraph> + <paragraph role="bascode" id="bas_id781638651541028"> MsgBox "Row " & oTable.ListIndex & " is selected."</paragraph> + <paragraph role="bascode" localize="false" id="bas_id601638651541333">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id111638569958471">dlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "myDialog")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871638569958742">table_control = dlg.Controls("Grid1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id141638569958918">table_data = (("Column A", "Column B", "Column C"),</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id616385699590945"> ("Row 1", 1, 2),</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id991638569959270"> ("Row 2", 3, 4),</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381638569959454"> ("Row 3", 5, 6))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id251638569959654">alignments = "LCC"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id971638569959870">widths = (100, 50, 50)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id571638569960094">table_control.SetTableData(table_data, widths, alignments)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id601638569960326">dlg.Execute()</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id311638651802570">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121638651802186">row_values = table_control.Value</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id216386518024106">if len(row_values) == 0:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941638651802762"> bas.MsgBox("No row selected.")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id491638651803057">else:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id261638651804210"> bas.MsgBox(f"Row {table_control.ListIndex} is selected.")</paragraph> + </pycode> +</section> + +<section id="WriteLine"> + <comment> WriteLine -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id761598619892798"> + <bookmark_value>DialogControl service;WriteLine</bookmark_value> + </bookmark> + <h2 id="hd_id961598619892816" localize="false">WriteLine</h2> + <paragraph role="paragraph" id="par_id671598619892378">Add a new line at the end of a multiline text field. A newline character will be inserted when appropriate. The method returns <literal>True</literal> when successful.</paragraph> + <paragraph role="paragraph" id="par_id941598619892915" xml-lang="en-US">An error is raised if the actual control is not of the type <literal>TextField</literal> or is not multiline.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id841620310387185"> + <input>svc.WriteLine(opt line: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id1001584541257789"><emph>Line</emph>: The string to insert. Default is an empty line.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id681598619892624">Dim oDlg As Object, oControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id521598619892148">Set oDlg = CreateScriptService("SFDialogs.Dialog",,, "myDialog")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391598619892465">Set oControl = oDlg.Controls("thisControl")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281598619892850">oControl.WriteLine("a new line")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id61620319410491">dlg = CreateScriptService('SFDialogs.Dialog', None, None, 'myDialog')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id701620319411995">ctrl = dlg.Controls('thisControl')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id591620319412507">ctr.WriteLine("a new line")</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_dialog.xhp#dlg_h1"/> + <embed href="text/sbasic/shared/03/sf_string.xhp#StringService"/> + <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_dictionary.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_dictionary.xhp new file mode 100644 index 000000000..7d94a6c9f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_dictionary.xhp @@ -0,0 +1,523 @@ +<?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_Dictionary" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.Dictionary service</title> + <filename>/text/sbasic/shared/03/sf_dictionary.xhp</filename> + </topic> +</meta> +<body> +<section id="abstract"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id261582733781987"> + <bookmark_value>Dictionary service</bookmark_value> + </bookmark> + + <h1 id="hd_id731582733781114" xml-lang="en-US"><variable id="SFDictionary"><link href="text/sbasic/shared/03/sf_dictionary.xhp" name="ScriptForge.Dictionary service"><literal>ScriptForge</literal>.<literal>Dictionary</literal> service</link></variable></h1> + + <paragraph role="paragraph" id="par_id891582884466217" xml-lang="en-US">A dictionary is a collection of key-item pairs</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id861582884516571" role="listitem" xml-lang="en-US">The key is a case-insensitive string</paragraph></listitem> + <listitem><paragraph id="par_id531582884549542" role="listitem" xml-lang="en-US">Items may be of any type</paragraph></listitem> + </list> +</section> + + <paragraph role="paragraph" id="par_id891582884593057" xml-lang="en-US">Keys and items can be retrieved, counted, updated, and much more.</paragraph> + <paragraph role="tip" id="par_id971582884636922" xml-lang="en-US">The Dictionary service is similar to the built-in %PRODUCTNAME Basic <literal>Collection</literal> object, however with more features. For example, <literal>Collection</literal> objects do not support the retrieval of keys. Moreover, Dictionaries provide additional capabilities as replacing keys, testing if a specific key already exists and converting the Dictionary into an Array object or JSON string.</paragraph> + + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id821610388789467">The following example creates <literal>myDict</literal> as an empty dictionary.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id851582897798335">GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371582885621964">Dim myDict As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201582885621287">myDict = CreateScriptService("Dictionary")</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_id721582885621540">Set myDict = myDict.Dispose()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id551626869252987">The example below creates an empty instance of the <literal>Dictionary</literal> service and uses the Python native <literal>update</literal> method to populate it with the contents of a Python <literal>dict</literal> object.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id61626869417885">dico = dict('A' = 1, 'B' = 2, 'C' = 3)</paragraph> + <paragraph role="pycode" id="pyc_id61626869417128"># Initialize myDict as an empty dict object</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id501626869418687">myDict = CreateScriptService('Dictionary')</paragraph> + <paragraph role="pycode" id="pyc_id921626869402748"># Load the values of dico into myDict</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id921626869418958">myDict.update(dico)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id271626869419262">myDict['D'] = 4</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id681626869419637">print(myDict) # {'A': 1, 'B': 2, 'C': 3, 'D': 4}</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801626869419846">propval = myDict.ConvertToPropertyValues()</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id981626869718081">It is possible to create an instance of the <literal>Dictionary</literal> service using a Python <literal>dict</literal> object as argument as shown in the following example.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id891626869184970">dico = dict('A' = 1, 'B' = 2, 'C' = 3)</paragraph> + <paragraph role="pycode" id="pyc_id201626869185236"># Initialize myDict with the content of dico</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id201626869182054">myDict = CreateScriptService('Dictionary', dico)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id831626869185400">myDict['D'] = 4</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id351626869185567">print(myDict) # {'A': 1, 'B': 2, 'C': 3, 'D': 4}</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id721626869185728">propval = myDict.ConvertToPropertyValues()</paragraph> + </pycode> + <note id="par_id211626699007613">Because Python has built-in dictionary support, most of the methods in the <literal>Dictionary</literal> service are available for Basic scripts only. Exceptions are <literal>ConvertToPropertyValues</literal> and <literal>ImportFromPropertyValues</literal> that are supported in both Basic and Python.</note> + + <h2 id="hd_id351582885195476" xml-lang="en-US">Properties</h2> + <table id="tab_id971582885195582"> + <tablerow> + <tablecell> + <paragraph id="par_id41582885195836" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31582885195372" role="tablehead" xml-lang="en-US">Read-only</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31582885195238" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id931582885195131" role="tablehead" xml-lang="en-US" >Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id97158288519551" role="tablecontent" localize="false">Count</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221582885195686" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371582885195525" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881582885195976" role="tablecontent" xml-lang="en-US">The number of entries in the dictionary</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id841582886030384" role="tablecontent" localize="false">Items</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441582886030118" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131582886030297" role="tablecontent" xml-lang="en-US">Array of Variants</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471582886030489" role="tablecontent" xml-lang="en-US">The list of items as a one dimensional array</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id231582886791351" role="tablecontent" localize="false">Keys</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971582886791838" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271582886791111" role="tablecontent" xml-lang="en-US">Array of Strings</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id16158288679167" role="tablecontent" xml-lang="en-US">The list of keys as a one dimensional array</paragraph> + </tablecell> + </tablerow> + </table> + + <paragraph role="tip" id="par_id461582886731495" xml-lang="en-US">The <literal>Keys</literal> and <literal>Items</literal> properties return their respective contents, using an identical ordering. The order is unrelated to the creation sequence.</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id931610389113917">The following example uses the <literal>Keys</literal> property to iterate over all keys in the dictionary <literal>myDict</literal>.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id211582887012398">Dim a As Variant, b As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351582887179042">a = myDict.Keys</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251582887187534">For Each b In a</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121582887198799"> MsgBox(myDict.Item(b))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571606473148931">Next b</paragraph> + </bascode> + + <table id="tab_id891606472825856"> + <tablerow> + <tablecell><paragraph id="par_id581606472825856" role="tablehead" localize="false"></paragraph></tablecell> + <tablecell><paragraph id="par_id921606472825856" role="tablehead">Methods</paragraph></tablecell> + <tablecell><paragraph id="par_id781606472825856" role="tablehead" localize="false"></paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#Add" name="Add method">Add</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToArray" name="ConvertToArray method">ConvertToArray</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToJson" name="ConvertToJson method">ConvertToJson</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#ConvertToPropertyValues" name="ConvertToPropertyValues method">ConvertToPropertyValues</link> + </paragraph></tablecell> + <tablecell><paragraph id="par_id451606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#Exists" name="Exists method">Exists</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#ImportFromJson" name="ImportFromJson method">ImportFromJson</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#ImportFromPropertyValues" name="ImportFromPropertyValues method">ImportFromPropertyValues</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#Item" name="Item method">Item</link> + </paragraph></tablecell> + <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#Remove" name="Remove method">Remove</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#RemoveAll" name="RemoveAll method">RemoveAll</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#ReplaceItem" name="ReplaceItem method">ReplaceItem</link><br/> + <link href="text/sbasic/shared/03/sf_dictionary.xhp#ReplaceKey" name="ReplaceKey method">ReplaceKey</link> + </paragraph></tablecell> + </tablerow> + </table> + +<section id="Add"> + <comment> Add ---------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id781582887670029"> + <bookmark_value>Dictionary service;Add</bookmark_value> + </bookmark> + <h2 id="hd_id831582887670029" localize="false">Add</h2> + <paragraph role="paragraph" id="par_id831582887670029">Adds a new key-item pair into the dictionary. Returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id881626699610355"> + <input>dict.Add(key: str, item: any): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id341582887670030"><emph>key</emph>: String value used to identify the Item. The key is not case-sensitive.</paragraph> + <paragraph role="paragraph" id="par_id401582887670030"><emph>item</emph>: Any value, including an array, a Basic object, a UNO object, a dictionary, etc.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id191582887670030">Dim NewValue As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391582887670030">myDict.Add("NewKey", NewValue)</paragraph> + </bascode> + <warning id="par_id1001610391308765">Every key must be unique in the same dictionary. If the key already exists in the dictionary, a <literal>DUPLICATEKEYERROR</literal> will be raised. Keys that are made of space characters will raise a <literal>INVALIDKEYERROR</literal> error.</warning> +</section> + +<section id="ConvertToArray"> + <comment> ConvertToArray ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id621582888424103"> + <bookmark_value>Dictionary service;ConvertToArray</bookmark_value> + </bookmark> + <h2 id="hd_id211582888424104" localize="false">ConvertToArray</h2> + <paragraph role="paragraph" id="par_id81582888424104">Stores the contents of the dictionary in a two-columns zero-based array. The keys are stored in the first column and the items are stored in the second column.</paragraph> + <paragraph role="paragraph" id="par_id341610391565678">If the dictionary is empty, this method will return an empty <literal>Array</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id71626699963594"> + <input>dict.ConvertToArray(): any[0..*, 0..1]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id651610391840491">Dim myDict as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381610391862148">myDict = CreateScriptService("Dictionary")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61610391873262">myDict.Add("a", 1)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351610391876967">myDict.Add("b", 2)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491610391880959">myDict.Add("c", 3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id521610391883264">Dim arr as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361610391885584">arr = myDict.ConvertToArray()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911610391888240">'(("a", 1), ("b", 2), ("c", 3))</paragraph> + </bascode> +</section> + +<section id="ConvertToJson"> + <comment> ConvertToJson ------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id631601296836318"> + <bookmark_value>Dictionary service;ConvertToJson</bookmark_value> + </bookmark> + <h2 id="hd_id851601296836224" localize="false">ConvertToJson</h2> + <paragraph role="paragraph" id="par_id831601296836981">Converts the contents of a dictionary to <link href="https://en.wikipedia.org/wiki/JSON" name="JSON text">JSON (JavaScript Object Notation)</link> text.</paragraph> + <h3 id="hd_id261601297024828" xml-lang="en-US">Limitations</h3> + <paragraph role="paragraph" id="par_id401601297178073" xml-lang="en-US">This method supports the following data types: <literal>String</literal>, <literal>Boolean</literal>, numbers, <literal>Null</literal> and <literal>Empty</literal>. Arrays containing items of those types are also allowed, whatever their dimensions. Dates are converted into strings, however they cannot be used inside Arrays. Other data types are converted to their string representation using the <literal>SF_String.Represent</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id901626700139467"> + <input>dict.ConvertToJson(indent: str = ""): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id8816012968362"><emph>indent</emph>: When <literal>indent</literal> is a positive number or a text, JSON array elements and object members are pretty-printed with that indentation level. A negative <literal>indent</literal> value will add new lines with no indentation. The default value is an empty string "" which selects the most compact representation. Using a positive integer for <literal>indent</literal> indents that many spaces per level. When <literal>indent</literal> is a string, such as <literal>Chr(9)</literal> or <literal>Tab(1)</literal>, the Tab character is used to indent each level.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671601298281962">myDict.Add("p0", 12.5)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851601298288784">myDict.Add("p1", "a string àé""ê")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201601298295976">myDict.Add("p2", DateSerial(2020,9,28))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id951601298323286">myDict.Add("p3", True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id731601298329491">myDict.Add("p4", Array(1,2,3))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id451601298336500">MsgBox myDict.ConvertToJson() </paragraph> + <paragraph role="bascode" localize="false" id="bas_id511610392557702">'{"p0": 12.5, "p1": "a string \u00e0\u00e9\"\u00ea", "p2": "2020-09-28", "p3": true, "p4": [1, 2, 3]}</paragraph> + </bascode> +</section> + +<section id="ConvertToPropertyValues"> + <comment> ConvertToPropertyValues --------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id991582889470402"> + <bookmark_value>Dictionary service;ConvertToPropertyValues</bookmark_value> + <bookmark_value>API;PropertyValue</bookmark_value> + <bookmark_value>API;DateTime</bookmark_value> + </bookmark> + <h2 id="hd_id421582889470909" localize="false">ConvertToPropertyValues</h2> + <paragraph role="paragraph" id="par_id151582889470596">Stores the contents of the dictionary into an array of <literal>PropertyValues</literal>.</paragraph> + <paragraph role="paragraph" id="par_id231610392665049">Each entry in the array is a <literal>com.sun.star.beans.PropertyValue</literal>. The key is stored in <literal>Name</literal>, the item is stored in <literal>Value</literal>.</paragraph> + <paragraph role="paragraph" id="par_id341610392705367">If one of the items has a type <literal>Date</literal>, it is converted to a <literal>com.sun.star.util.DateTime</literal> structure. If one of the items is an empty array, it is converted to <literal>Null</literal>. The resulting array is empty when the dictionary is empty.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id481626700464253"> + <input>dict.ConvertToPropertyValues(): obj[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id81610393124521">Dim myDict as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971610393127816">myDict = CreateScriptService("Dictionary")</paragraph> + <paragraph role="bascode" id="bas_id531610393130289">'Adds some properties to the dictionary</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711610393132877">myDict.Add("Color", "Blue")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681610393135354">myDict.Add("Width", 20)</paragraph> + <paragraph role="bascode" id="bas_id571610393137959">'Converts to an Array of PropertyValue objects</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351610393140357">Dim prop as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101610393142717">prop = myDict.ConvertToPropertyValues()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id771626700938786">Note in the example below that a Python dictionary needs to be passed as the second argument of the <literal>CreateScriptService</literal> method.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id691626700585141">myDict = dict()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id811626700586188">myDict["Color"] = "Blue"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id331626700586409">myDict["Width"] = 30</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id171626700586634">sfDic = CreateScriptService("Dictionary", myDict)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id251626700586818">prop = sfDic.ConvertToPropertyValues()</paragraph> + </pycode> + <tip id="par_id421610393306916">Many services and methods in the UNO library take in parameters represented using the <literal>PropertyValue</literal> struct, which is part of the %PRODUCTNAME API.</tip> +</section> + +<section id="Exists"> + <comment> Exists ------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id81582889812915"> + <bookmark_value>Dictionary service;Exists</bookmark_value> + </bookmark> + <h2 id="hd_id461582889812915" localize="false">Exists</h2> + <paragraph role="paragraph" id="par_id841582889812916">Determines if a key exists in the dictionary.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id441626701103153"> + <input>dict.Exists(key: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id971582889812917"><emph>key</emph>: The key to be looked up in the dictionary.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id741582889812919">Dim myDict as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471582889812919">myDict = CreateScriptService("Dictionary")</paragraph> + <paragraph role="bascode" id="bas_id811606485130666">'Adds some properties to the dictionary</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391610393640781">myDict.Add("Color", "Blue")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891610393643755">myDict.Add("Width", 20)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531610393646186">'(...)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491610393648822">If Not myDict.Exists("Size") Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681610393651551"> MsgBox "You have to provide a Size value"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581610393654335">End If</paragraph> + </bascode> +</section> + +<section id="ImportFromJson"> + <comment> ImportFromJson ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id661601391980619"> + <bookmark_value>Dictionary service;ImportFromJson</bookmark_value> + </bookmark> + <h2 id="hd_id81601391980848" localize="false">ImportFromJson</h2> + <paragraph role="paragraph" id="par_id791601391980978">Adds the content of a <link href="https://en.wikipedia.org/wiki/JSON" name="JSON text">JSON (JavaScript Object Notation)</link> string into the current dictionary. Returns <literal>True</literal> if successful.</paragraph> + <h3 id="hd_id961601392113644" xml-lang="en-US">Limitations</h3> + <paragraph role="paragraph" id="par_id481601392181131" xml-lang="en-US">The JSON string may contain numbers, text, booleans, null values and arrays containing those types. It must not contain JSON objects namely sub-dictionaries.</paragraph> + <paragraph role="paragraph" id="par_id511601392205908" xml-lang="en-US">An attempt is made to convert text to date if the item matches one of these patterns: YYYY-MM-DD, HH:MM:SS or YYYY-MM-DD HH:MM:SS.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id841626701235169"> + <input>dict.ImportFromJson(inputstr: str, overwrite: bool = False): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id69160139198061"><emph>inputstr</emph>: The string to import.</paragraph> + <paragraph role="paragraph" id="par_id201601391980268"><emph>overwrite</emph>: When <literal>True</literal>, entries with same name may exist in the dictionary and their values are overwritten. When <literal>False</literal> (default), repeated keys will raise an error. Beware that dictionary keys are not case-sensitive while names are case-sensitive in JSON strings.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id411601393205207">Dim s As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891601393212562">s = "{'firstName': 'John','lastName': 'Smith','isAlive': true,'age': 66, 'birth': '1954-09-28 20:15:00'" _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id221601393220997"> & ",'address': {'streetAddress': '21 2nd Street','city': 'New York','state': 'NY','postalCode': '10021-3100'}" _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931601393226582"> & ",'phoneNumbers': [{'type': 'home','number': '212 555-1234'},{'type': 'office','number': '646 555-4567'}]" _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671601393233042"> & ",'children': ['Q','M','G','T'],'spouse': null}"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id131601393240390">s = Replace(s, "'", """")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351601393248554">myDict.ImportFromJson(s, OverWrite := True)</paragraph> + <paragraph role="bascode" id="bas_id521601393254694">'The (sub)-dictionaries "address" and "phoneNumbers" (0) and (1) are imported as Empty values.</paragraph> + </bascode> +</section> + +<section id="ImportFromPropertyValues"> + <comment> ImportFromPropertyValues ------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id791588941968651"> + <bookmark_value>Dictionary service;ImportFromPropertyValues</bookmark_value> + </bookmark> + <h2 id="hd_id71588941968955" localize="false">ImportFromPropertyValues</h2> + <paragraph role="paragraph" id="par_id651588941968228">Inserts the contents of an array of <literal>PropertyValue</literal> objects into the current dictionary. <literal>PropertyValue</literal> Names are used as Keys in the dictionary, whereas Values contain the corresponding values. Returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id431626701465848"> + <input>dict.ImportFromPropertyValues(propertyvalues: obj[0..*], overwrite: bool = False): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id751588941968522"><emph>propertyvalues</emph>: A zero-based 1-dimensional array containing <literal>com.sun.star.beans.PropertyValue</literal> objects. This parameter may also be a single <literal>PropertyValue</literal> object not contained in an Array.</paragraph> + <paragraph role="paragraph" id="par_id21588941968131"><emph>overwrite</emph>: When <literal>True</literal>, entries with same name may exist in the dictionary and their values are overwritten. When <literal>False</literal> (default), repeated keys will raise an error. Note that dictionary keys are not case-sensitive in Basic, whereas names are case-sensitive in sets of property values and in Python dictionaries.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id641626703615898">The examples below first create an array with two <literal>PropertyValue</literal> objects and then convert it to a dictionary.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id951588941968987">Dim vProp As New com.sun.star.beans.PropertyValue</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771588941968883">Dim arrProp : arrProp = Array()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831588943409828">vProp.Name = "Color"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891610395011237">vProp.Value = "Blue"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371626703397791">arrProp = SF_Array.Append(arrProp, vProp)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71626703398189">vProp.Name = "Date"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001626703398431">vProp.Value = CDateToUnoDateTime(Now)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881626703398656">arrProp = SF_Array.Append(arrProp, vProp)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id761626703398879">myDict = CreateScriptService("Dictionary")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181626703399098">myDict.ImportFromPropertyValues(arrProp, Overwrite := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121626703516023">Dim keys : keys = myDict.Keys</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971626703516446">For Each k In keys</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811626703516686"> MsgBox k & " - " & myDict.Item(k)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261626703516863">Next k</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id121626701725559">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id611626704519415">from datetime import datetime</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221626701725743">import uno</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id911626701725885">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941626701726044">arrProp = list()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id911626701726205">vProp = uno.createUnoStruct("com.sun.star.beans.PropertyValue")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id751626701726717">vProp.Name = "Color"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841626704518283">vProp.Value = "Blue"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id291626704518547">arrProp.append(vProp)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id271626704518745">vProp = uno.createUnoStruct("com.sun.star.beans.PropertyValue")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id691626704518975">vProp.Name = "Date"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id691626704519192">vProp.Value = bas.CDateToUnoDateTime(datetime.now())</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id631626704519647">arrProp.append(vProp)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id881626704519864">myDict = CreateScriptService("Dictionary")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id61626704520096">myDict.ImportFromPropertyValues(arrProp, overwrite=True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181626704520322">for k in myDict.keys():</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221626704799909"> bas.MsgBox("{} - {}".format(k, myDict[k]))</paragraph> + </pycode> +</section> + +<section id="Item"> + <comment> Item --------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id741582980366762"> + <bookmark_value>Dictionary service;Item</bookmark_value> + </bookmark> + <h2 id="hd_id301582098366573" localize="false">Item</h2> + <paragraph role="paragraph" id="par_id891582890366737">Retrieves an existing dictionary entry based on its key. Returns the value of the item if successful, otherwise returns <literal>Empty</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id501626704949678"> + <input>dict.Item(key: str): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id551582890399669"><emph>key</emph>: Not case-sensitive. If it does not exist, <literal>Empty</literal> value is returned.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id181610395933967">The following example iterates over all keys in the dictionary and uses the <literal>Item</literal> method to access their values.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id371528890366702">Dim myDict as Variant, k as Variant, allKeys as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661610395517565">myDict = CreateScriptService("Dictionary")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181610395523430">myDict.Add("key1", 100)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621610395527679">myDict.Add("key2", 200)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871610395530158">myDict.Add("key3", 300)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891610395534807">allKeys = myDict.Keys</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71610395537640">For Each k in allKeys</paragraph> + <paragraph role="bascode" localize="false" id="bas_id411610395540304"> MsgBox(myDict.Item(k))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931610395543522">Next k</paragraph> + </bascode> +</section> + +<section id="Remove"> + <comment> Remove ------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id741582890366762"> + <bookmark_value>Dictionary service;Remove</bookmark_value> + </bookmark> + <h2 id="hd_id301582890366573" localize="false">Remove</h2> + <paragraph role="paragraph" id="par_id891582890388737">Removes an existing dictionary entry based on its key. Returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id861626705083007"> + <input>dict.Remove(key: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id551582890366999"><emph>key</emph>: Not case-sensitive. Must exist in the dictionary, otherwise an <literal>UNKNOWNKEYERROR</literal> error is raised.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id56158289627581">myDict.Add("key1", 100)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651610399290742">myDict.Add("key2", 200)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741610399296091">myDict.Add("key3", 300)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591610399299316">MsgBox(myDict.Count) ' 3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661610399302807">myDict.Remove("key2")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671610399305808">MsgBox(myDict.Count) ' 2</paragraph> + </bascode> +</section> + +<section id="RemoveAll"> + <comment> RemoveAll ---------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id471582896275914"> + <bookmark_value>Dictionary service;RemoveAll</bookmark_value> + </bookmark> + <h2 id="hd_id911582896275637" localize="false">RemoveAll</h2> + <paragraph role="paragraph" id="par_id921582896275624">Removes all the entries from the dictionary. Returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id561626705190520"> + <input>dict.RemoveAll(): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id56158289627580">myDict.Add("key1", 100)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651610399290743">myDict.Add("key2", 200)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741610399296092">myDict.Add("key3", 300)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591610399299317">MsgBox(myDict.Count) ' 3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661610399302808">myDict.RemoveAll()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671610399305809">MsgBox(myDict.Count) ' 0</paragraph> + </bascode> +</section> + +<section id="ReplaceItem"> + <comment> ReplaceItem -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id891582895615851"> + <bookmark_value>Dictionary service;ReplaceItem</bookmark_value> + </bookmark> + <h2 id="hd_id801582895615477" localize="false">ReplaceItem</h2> + <paragraph role="paragraph" id="par_id281582895615444">Replaces an existing item value based on its key. Returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id551626705258936"> + <input>dict.ReplaceItem(key: str, value: any): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id991582895615535"><emph>key</emph>: String value representing the key whose value will be replaced. Not case-sensitive. If the key does not exist in the dictionary, an <literal>UNKNOWNKEYERROR</literal> error is raised.</paragraph> + <paragraph role="paragraph" id="par_id721582895615186"><emph>value</emph>: The new value of the item referred to with the <literal>key</literal> parameter.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id581582895615680">myDict.Add("a", 1)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351582895615555">MsgBox(myDict.Item("a")) ' 1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361610399892402">myDict.ReplaceItem("a", 100)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id411610399896001">MsgBox(myDict.Item("a")) ' 100</paragraph> + </bascode> +</section> + +<section id="ReplaceKey"> + <comment> ReplaceKey --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id411582896597981"> + <bookmark_value>Dictionary service;ReplaceKey</bookmark_value> + </bookmark> + <h2 id="hd_id231582896597839" localize="false">ReplaceKey</h2> + <paragraph role="paragraph" id="par_id571582896597766">Replaces an existing key in the dictionary by a new key. The item value is left unchanged. Returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id851626705393127"> + <input>dict.ReplaceKey(key: str, value: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id911582896597619"><emph>key</emph>: String value representing the key to be replaced. Not case-sensitive. If the key does not exist in the dictionary, a <literal>UNKNOWNKEYERROR</literal> error is raised.</paragraph> + <paragraph role="paragraph" id="par_id531582896597989"><emph>value</emph>: String value for the new key. Not case-sensitive. If the new key already exists in the dictionary, an <literal>DUPLICATEKEYERROR</literal> error is raised.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id521582896597313">myDict.Add("oldKey", 100)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961610400326541">MsgBox(myDict.Item("oldKey")) ' 100</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631610400329115">myDict.ReplaceKey("oldKey", "newKey")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id761610400331545">MsgBox(myDict.Item("newKey")) ' 100</paragraph> + </bascode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_array.xhp#ArrayService"/> + <embed href="text/sbasic/shared/collection.xhp#Collection_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_document.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_document.xhp new file mode 100644 index 000000000..f0c0ee7c5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_document.xhp @@ -0,0 +1,729 @@ +<?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_Document" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDocuments.Document service</title> + <filename>/text/sbasic/shared/03/sf_document.xhp</filename> + </topic> +</meta> + +<body> +<section id="SFDocuments-sf_document"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id261582733781987"> + <bookmark_value>Document service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="hd_id731582733781114" xml-lang="en-US"><variable id="DocumentService"><link href="text/sbasic/shared/03/sf_document.xhp" name="Exception service"><literal>SFDocuments</literal>.<literal>Document</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id381589189355849" xml-lang="en-US">The <literal>SFDocuments</literal> library provides methods and properties to facilitate the management and manipulation of %PRODUCTNAME documents.</paragraph> + <paragraph role="paragraph" id="par_id591589189364267" xml-lang="en-US">Methods that are applicable for all types of documents (Text Documents, Sheets, Presentations, etc) are provided by the <literal>SFDocuments.Document</literal> service. Some examples are:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id891589189452545" role="listitem" xml-lang="en-US">Opening, closing and saving documents</paragraph> + </listitem> + <listitem> + <paragraph id="par_id811589189463041" role="listitem" xml-lang="en-US">Accessing standard or custom properties of documents</paragraph> + </listitem> + </list> +</section> + + <warning id="par_id301611085807704">The properties, methods or arguments marked with <emph>(*)</emph> are <emph>NOT applicable to Base documents</emph>.</warning> + <paragraph role="paragraph" id="par_id241589189701274" xml-lang="en-US">Methods and properties that are specific to certain %PRODUCTNAME components are stored in separate services, such as <literal>SFDocuments.SF_Calc</literal> and <literal>SFDocuments.SF_Base</literal>.</paragraph> + <paragraph role="paragraph" id="par_id641611090052376">Although the Basic language does not offer inheritance between object classes, the latter services may be considered as subclasses of the <literal>SFDocuments.Document</literal> service. Such subclasses can invoke the properties and methods described below.</paragraph> + + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Document</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id581611090387382">Below are three variants of how the <literal>Document</literal> service can be invoked.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id181622816732197">Using the <literal>getDocument</literal> method from the <literal>ScriptForge</literal>.<literal>UI</literal> service:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id371582885621964">Dim ui As Object, oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201582885621287">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561589191748697">Set oDoc = ui.GetDocument("Untitled 1")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id181622818236233">Alternatively you can use the methods <literal>CreateDocument</literal> and <literal>OpenDocument</literal> from the <literal>UI</literal> service.</paragraph> + <bascode> + <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> + <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_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> + <paragraph role="bascode" localize="false" id="bas_id31598109342395"> Dim oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id481598109349427"> Set oDoc = CreateScriptService("SFDocuments.DocumentEvent", poEvent)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401622818141194"> ' (...)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991622818141557">End Sub</paragraph> + </bascode> + <note id="par_id831622816562430">The <literal>Document</literal> service is closely related to the <literal>UI</literal> and <literal>FileSystem</literal> services.</note> + <paragraph role="paragraph" id="par_id891582733781994" xml-lang="en-US">Except when the document was closed by program with the CloseDocument method (it is then superfluous), it is recommended to free resources after use:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id61582733781413">Set oDoc = oDoc.Dispose()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id261622818031652">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id291622818032129">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id781622818032358">doc = ui.GetDocument("Untitled 1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id741622818032551"># (...)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221622818032804">doc.Dispose()</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id421622818033432">docA = ui.CreateDocument("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id451622818787113">docB = ui.OpenDocument("C:\Documents\MyFile.odt")</paragraph> + </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_id551622819064247">def RunEvent(event)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id311622819064554"> doc = CreateScriptService("SFDocuments.DocumentEvent", Event)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221622819064967"> # (...)</paragraph> + </pycode> + <tip id="par_id71611090922315">The use of the prefix "<literal>SFDocuments.</literal>" while calling the service is optional.</tip> + + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id81611339709014"> + <bookmark_value>API;Duration</bookmark_value> + <bookmark_value>API;XComponent</bookmark_value> + <bookmark_value>API;ODatabaseDocument</bookmark_value> + </bookmark> + <h2 id="hd_id351582885195476" xml-lang="en-US">Properties</h2> + <table id="tab_id971582885195582"> + <tablerow> + <tablecell> + <paragraph id="par_id41582885195836" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31582885195372" role="tablehead" xml-lang="en-US">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31582885195238" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id931582885195131" role="tablehead" xml-lang="en-US" >Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id7715828856553" role="tablecontent" xml-lang="en-US" localize="false">CustomProperties (*)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861582885655779" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271582885655525" role="tablecontent" xml-lang="en-US" localize="false">Dictionary service</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581582885655885" role="tablecontent" xml-lang="en-US" >Returns a <literal>ScriptForge.Dictionary</literal> object instance. After update, can be passed again to the property for updating the document.<br />Individual items of the dictionary may be either strings, numbers, (Basic) dates or <link href="https://api.libreoffice.org/docs/idl/ref/structcom_1_1sun_1_1star_1_1util_1_1Duration.html" name="Duration API"><literal>com.sun.star.util.Duration</literal></link> items.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id841582886030384" role="tablecontent" xml-lang="en-US" localize="false">Description (*)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441582886030118" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131582886030297" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471582886030489" role="tablecontent" xml-lang="en-US" >Gives access to the Description property of the document (also known as "Comments")</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id231582886791351" role="tablecontent" xml-lang="en-US" localize="false">DocumentProperties (*)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971582886791838" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271582886791111" role="tablecontent" xml-lang="en-US" localize="false">Dictionary service</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id16158288679167" role="tablecontent" xml-lang="en-US" >Returns a <literal>ScriptForge.Dictionary</literal> object containing all the entries. Document statistics are included. Note that they are specific to the type of document. As an example, a Calc document includes a "CellCount" entry. Other documents do not.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id881589194571813" role="tablecontent" xml-lang="en-US" localize="false">DocumentType</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201589194571955" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951589194571781" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941589194571801" role="tablecontent" xml-lang="en-US" >String value with the document type ("Base", "Calc", "Writer", etc)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id881589194572136" role="tablecontent" xml-lang="en-US" localize="false">ExportFilters</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201589194571699" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951589194571391" role="tablecontent" xml-lang="en-US" localize="false">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941589194571327" role="tablecontent" xml-lang="en-US">Returns a list with the export filter names applicable to the current document as a zero-based array of strings. Filters used for both import/export are also returned.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id881589194573253" role="tablecontent" xml-lang="en-US" localize="false">ImportFilters</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201589194571067" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951589194571292" role="tablecontent" xml-lang="en-US" localize="false">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941589194571922" role="tablecontent" xml-lang="en-US">Returns a list with the import filter names applicable to the current document as a zero-based array of strings. Filters used for both import/export are also returned.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241589194633142" role="tablecontent" xml-lang="en-US" localize="false">IsBase<br />IsCalc<br />IsDraw<br />IsImpress<br />IsMath<br />IsWriter</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761589194633950" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741589194633956" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611589194633853" role="tablecontent" xml-lang="en-US" >Exactly one of these properties is <literal>True</literal> for a given document.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311589194910727" role="tablecontent" xml-lang="en-US" localize="false">Keywords (*)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id231589194910179" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421589194910942" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311589194910190" role="tablecontent" xml-lang="en-US">Gives access to the Keywords property of the document. Represented as a comma-separated list of keywords</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id911589638614922" role="tablecontent" xml-lang="en-US" localize="false">Readonly (*)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id921589638614972" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501589638614132" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801589638614518" role="tablecontent" xml-lang="en-US"><literal>True</literal> if the document is actually in read-only mode</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id921589195028191" role="tablecontent" xml-lang="en-US" localize="false">Subject (*)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201589195028733" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id551589195028724" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371589195028843" role="tablecontent" xml-lang="en-US">Gives access to the Subject property of the document.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id521589195028736" role="tablecontent" xml-lang="en-US" localize="false">Title (*)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451589195028910" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31589195028773" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771589195028748" role="tablecontent" xml-lang="en-US">Gives access to the Title property of the document.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id97158288519551" role="tablecontent" xml-lang="en-US" localize="false">XComponent</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221582885195686" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371582885195525" role="tablecontent" xml-lang="en-US">UNO Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881582885195976" role="tablecontent" xml-lang="en-US" >The UNO object <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1lang_1_1XComponent.html" name="XComponent API"><literal>com.sun.star.lang.XComponent</literal></link> or <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sdb_1_1OfficeDatabaseDocument.html" name="ODatabaseDocument API"><literal>com.sun.star.comp.dba.ODatabaseDocument</literal></link> representing the document</paragraph> + </tablecell> + </tablerow> +</table> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id861611146581334">The example below prints all the properties of a document. Note that the <literal>oDoc</literal> object returned by the <literal>UI.OpenDocument</literal> method is a <literal>SFDocuments.Document</literal> object.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id391611146834072">Dim ui as Variant : Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471611146957794">Dim oDoc as Object</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id311611146962193">Set oDoc = ui.OpenDocument("C:\Documents\MyFile.ods")</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id711611146962784">Dim propDict as Object</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id391611146963409">Set propDict = oDoc.DocumentProperties</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id621611146963920">Dim keys as Variant : propKeys = propDict.Keys</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id21611146964465">Dim k as String, strProp as String</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id681611146965001">For Each k In propKeys</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id191611146965538"> strProp = strProp & k & ": " & propDict.Item(k) & CHR$(10)</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id741611146966256">Next k</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id911611146967874">MsgBox strProp</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681611147290092">oDoc.CloseDocument()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id571622826920742">To access document properties in a Python script the user needs to directly access them using their names, as shown below:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id391622827274657">doc = ui.GetDocument(r"C:\Documents\MyFile.ods")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id261622827328471">msg = doc.Title + '\n' + doc.Description + '\n' + doc.Keywords</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id41622827328938">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id71622827329510">bas.MsgBox(msg)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id71622827327225">doc.CloseDocument()</paragraph> + </pycode> + + <table id="tab_id901611086279902"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Document Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_document.xhp#Activate" name="Activate method">Activate</link><br/> + <link href="text/sbasic/shared/03/sf_document.xhp#CloseDocument" name="CloseDocument method">CloseDocument</link><br/> + <link href="text/sbasic/shared/03/sf_document.xhp#CreateMenu" name="CreateMenu method">CreateMenu</link><br/> + <link href="text/sbasic/shared/03/sf_document.xhp#ExportAsPDF" name="ExportAsPDF method">ExportAsPDF</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_document.xhp#PrintOut" name="PrintOut method">PrintOut</link><br/> + <link href="text/sbasic/shared/03/sf_document.xhp#RemoveMenu" name="RemoveMenu method">RemoveMenu</link><br/> + <link href="text/sbasic/shared/03/sf_document.xhp#RunCommand" name="RunCommand method">RunCommand</link><br/> + <link href="text/sbasic/shared/03/sf_document.xhp#Save" name="Save method">Save</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086279903" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_document.xhp#SaveAs" name="SaveAs method">SaveAs</link><br/> + <link href="text/sbasic/shared/03/sf_document.xhp#SaveCopyAs" name="SaveCopyAs method">SaveCopyAs</link><br/> + <link href="text/sbasic/shared/03/sf_document.xhp#SetPrinter" name="SetPrinter method">SetPrinter</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + +<section id="Activate"> + <comment> Activate -------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969883"> + <bookmark_value>Document service;Activate</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698251" localize="false">Activate</h2> + <paragraph role="paragraph" id="par_id93158919969864">Returns <literal>True</literal> if the document could be activated. Otherwise, there is no change in the actual user interface. It is equivalent to the <literal>Activate</literal> method of the <literal>UI</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id421611148353046">This method is useful when one needs to give focus for a document that is minimized or hidden.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id181622827609276"> + <input>svc.Activate(): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id601611148017930">The example below considers that the file "My_File.ods" is already open but not active.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41158919969836">Dim oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881611147617212">Set oDoc = CreateScriptService("Document", "MyFile.ods")</paragraph> + <paragraph role="bascode" localize="false" id="pyc_id571611147618913">oDoc.Activate()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id411622827715523">doc = CreateScriptService("Document", "MyFile.ods")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id171622827715836">doc.Activate()</paragraph> + </pycode> + <tip id="par_id601611148080503">Keep in mind that you can invoke the <literal>Document</literal> service by passing to <literal>CreateScriptService</literal> either "Document" or "SFDocuments.Document"</tip> +</section> + +<section id="CloseDocument"> + <comment> CloseDocument ---------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721589200121249"> + <bookmark_value>Document service;CloseDocument</bookmark_value> + </bookmark> + <h2 id="hd_id261589200121415" localize="false">CloseDocument</h2> + <paragraph role="paragraph" id="par_id651589200121138">Closes the document. If the document is already closed, regardless of how the document was closed, this method has no effect and returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id341611149562894">The method will also return <literal>False</literal> if the user declines to close it.</paragraph> + <paragraph role="paragraph" id="par_id981611149616934">Returns <literal>True</literal> if the document was successfully closed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001622887222169"> + <input>svc.CloseDocument(saveask: bool = True): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id361589200121646"><emph>saveask</emph> : If <literal>True</literal> (default), the user is invited to confirm if the changes should be written on disk. This argument is ignored if the document was not modified.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891580290121516">If oDoc.CloseDocument(True) Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51589200506125"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751622827903730">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731622827946898">if doc.CloseDocument(True):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221622827947414"> # ...</paragraph> + </pycode> +</section> + +<section id="CreateMenu"> + <comment> CreateMenu --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721589200120958"> + <bookmark_value>Document service;CreateMenu</bookmark_value> + </bookmark> + <h2 id="hd_id261589200121339" localize="false">CreateMenu</h2> + <paragraph role="paragraph" id="par_id651589200121080">Creates a new menu entry in the menubar of a given document window.</paragraph> + <paragraph role="paragraph" id="par_id981611149616155">This method returns an instance of the <link href="text/sbasic/shared/03/sf_menu.xhp" name="Menu_link1"><input>SFWidgets.Menu</input></link> service.</paragraph> + <note id="par_id721643121487974">The menu created is only available during the current %PRODUCTNAME session and is not saved neither in the document nor in the global application settings. Hence closing the document window will make the menu disappear. It will only reappear when the macro that creates the menu is executed again.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001622887222964"> + <input>svc.CreateMenu(menuheader: str, [before: any], submenuchar: str = ">"): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id361589200120316"><emph>menuheader</emph>: The toplevel name of the new menu.</paragraph> + <paragraph role="paragraph" id="par_id361589200129686"><emph>before</emph>: The name (as a string) or position (as an integer starting at 1) of an existing menu before which the new menu will be placed. If no value is defined for this argument, the menu will be created at the last position in the menubar.</paragraph> + <paragraph role="paragraph" id="par_id361589200122507"><emph>submenuchar</emph>: The delimiter used to create menu trees when calling methods as <literal>AddItem</literal> from the <literal>Menu</literal> service. The default value is ">".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891580290121500">Dim oDoc as Object, oMenu as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id515892005061251">Set oDoc = CreateScriptService("Document")</paragraph> + <paragraph role="bascode" id="bas_id751622827903865">Set oMenu = oDoc.CreateMenu("My Menu")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621643120224240">With oMenu</paragraph> + <paragraph role="bascode" id="bas_id391643120224507"> ' Add items to the menu</paragraph> + <paragraph role="bascode" localize="false" id="bas_id411643120224708"> .AddItem("Item A")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id411643120224719"> .AddItem("Item B")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461643120224936"> ' ...</paragraph> + <paragraph role="bascode" id="bas_id100164312025160"> ' After creating the menu, the service instance can be disposed of</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401643120225361"> .Dispose()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701643120225536">End With</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731622827946021">doc = CreateScriptService("Document")</paragraph> + <paragraph role="pycode" id="pyc_id221622827943208">menu = doc.CreateMenu("My Menu")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381643120494454">menu.AddItem("Item A")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381643120494463">menu.AddItem("Item B")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361643120494723"># ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151643120494942">menu.Dispose()</paragraph> + </pycode> + <section id="menu_tip"> + <tip id="par_id271643139068194">Refer to the <link href="text/sbasic/shared/03/sf_menu.xhp" name="Menu_link2"><input>SFWidgets.Menu</input></link> help page to learn more about how to create/remove menus in %PRODUCTNAME document windows.</tip> + </section> +</section> + +<section id="ExportAsPDF"> + <comment> ExportAsPDF -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721985200121025"> + <bookmark_value>Document service;ExportAsPDF</bookmark_value> + </bookmark> + <h2 id="hd_id261589202100695" localize="false">ExportAsPDF</h2> + <paragraph role="paragraph" id="par_id156589200123048">Exports the document directly as a PDF file to the specified location. Returns <literal>True</literal> if the PDF file was successfully created.</paragraph> + <paragraph role="paragraph" id="par_id811638276067119">The export options can be set either manually using the <menuitem>File - Export As - Export as PDF</menuitem> dialog or by calling the methods <literal>GetPDFExportOptions</literal> and <literal>SetPDFExportOptions</literal> from the <link href="text/sbasic/shared/03/sf_session.xhp" name="SFSession">Session</link> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001622827826679"> + <input>svc.ExportAsPDF(filename: str, overwrite: bool = False, opt pages: str, opt password: str, opt watermark: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id211635436910641"><emph>filename</emph>: The full path and file name of the PDF to be created. It must follow the <literal>SF_FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id141635436912005"><emph>overwrite</emph>: Specifies if the destination file can be overwritten (Default = <literal>False</literal>). An error will occur if <literal>overwrite</literal> is set to <literal>False</literal> and the destination file already exists.</paragraph> + <paragraph role="paragraph" id="par_id141635436913587"><emph>pages</emph><emph></emph>: String specifying which pages will be exported. This argument uses the same notation as in the dialog <menuitem>File - Export As - Export as PDF</menuitem>.</paragraph> + <paragraph role="paragraph" id="par_id141635436919655"><emph>password</emph><emph></emph>: Specifies a password to open the PDF file.</paragraph> + <paragraph role="paragraph" id="par_id141635436913365"><emph>watermark</emph>: Text to be used as watermark in the PDF file, which will be drawn in every page of the resulting PDF.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id301638234284727">The following example exports the current document as a PDF file, defines a password and overwrites the destination file if it already exists.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891589200127786">oDoc.ExportAsPDF("C:\User\Documents\myFile.pdf", Password := "1234", Overwrite := True)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id311638276257020">The code snippet below gets the current PDF export options and uses them to create the PDF file.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id791638277305385">Dim exportSettings as Object, oSession as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51638277174044">oSession = CreateScriptService("Session")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291638277174233">exportSettings = oSession.GetPDFExportOptions()</paragraph> + <paragraph role="bascode" id="bas_id851638277174798">' Sets to True the option to export comments as PDF notes</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71638277174405">exportSettings.ReplaceItem("ExportNotes", True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611638277174622">oSession.SetPDFExportOptions(exportSettings)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461638277174958">oDoc.ExportAsPDF("C:\User\Documents\myFile.pdf")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731622728946003">doc.ExportAsPDF(r"C:\User\Documents\myFile.pdf", password = "1234", overwrite = True)</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id481638277330132">session = CreateScriptService("Session")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id881638277330334">exportSettings = oSession.GetPDFExportOptions()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121638277330485">exportSettings.ReplaceItem("ExportNotes", True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id401638277330637">session.SetPDFExportOptions(exportSettings)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id591638277330780">doc.ExportAsPDF(r"C:\User\Documents\myFile.pdf")</paragraph> + </pycode> +</section> + +<section id="PrintOut"> + <comment> PrintOut ---------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721985200121249"> + <bookmark_value>Document service;PrintOut</bookmark_value> + </bookmark> + <h2 id="hd_id261589202101415" localize="false">PrintOut</h2> + <paragraph role="paragraph" id="par_id156589200121138">This method sends the contents of the document to the default printer or to the printer defined by the <literal>SetPrinter</literal> method.</paragraph> + <paragraph role="paragraph" id="par_id981611169416934">Returns <literal>True</literal> if the document was successfully printed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001622827822169"> + <input>svc.PrintOut(pages: str = "", copies: num = 1): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id211635436910093"><emph>pages</emph>: The pages to print as a string, like in the user interface. Example: "1-4;10;15-18". Default is all pages.</paragraph> + <paragraph role="paragraph" id="par_id141635436912146"><emph>copies</emph>: The number of copies. Default is 1.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891589200121516">If oDoc.PrintOut("1-4;10;15-18", Copies := 2) Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id515892500606125"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751682227903730">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731622728946898">if doc.PrintOut(copies=3, pages='45-88'):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221628227947414"> # ...</paragraph> + </pycode> +</section> + +<section id="RemoveMenu"> + <comment> RemoveMenu --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721589200129148"> + <bookmark_value>Document service;RemoveMenu</bookmark_value> + </bookmark> + <h2 id="hd_id261589200121147" localize="false">RemoveMenu</h2> + <paragraph role="paragraph" id="par_id651589200165470">Removes a toplevel menu from the menubar of a given document window.</paragraph> + <paragraph role="paragraph" id="par_id981611149610695">Returns <literal>True</literal> if the specified menu could be removed. If the specified menu does not exist, the method returns <literal>False</literal>.</paragraph> + <note id="par_id571643121106014">This method can be used to remove any menu entry from the document window, including default menus. However, none of these changes in the menubar are saved to the document or to the application settings. To restore the menubar to the default settings, simply close and reopen the document window.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001622887065864"> + <input>svc.RemoveMenu(menuheader: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id361589200121156"><emph>menuheader</emph>: The toplevel name of the menu to be removed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891580290121522">Dim oDoc as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id515892005060659">Set oDoc = CreateScriptService("Document")</paragraph> + <paragraph role="bascode" id="bas_id391643120223147">oDoc.RemoveMenu("My Menu")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731622827946155">doc = CreateScriptService("Document")</paragraph> + <paragraph role="pycode" id="pyc_id221622827946338">doc.RemoveMenu("My Menu")</paragraph> + </pycode> + <embed href="text/sbasic/shared/03/sf_document.xhp#menu_tip"/> +</section> + +<section id="RunCommand"> + <comment> RunCommand --------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id601589202413561"> + <bookmark_value>Document service;RunCommand</bookmark_value> + </bookmark> + <h2 id="hd_id611589202413141" localize="false">RunCommand</h2> + <paragraph role="paragraph" id="par_id991589202413257">Runs a UNO command on the document window associated with the service instance. A few typical commands are: Save, SaveAs, ExportToPDF, Undo, Copy, Paste, etc.</paragraph> + <paragraph role="paragraph" id="par_id261589202778896" xml-lang="en-US">The document itself does not need to be active to be able to run commands.</paragraph> + <paragraph role="paragraph" id="par_id921611152932311">Commands can be run with or without arguments. Arguments are not validated before running the command. If the command or its arguments are invalid, then nothing will happen.</paragraph> + <tip id="par_id31644182402479">For a complete list of UNO commands that can be run in %PRODUCTNAME, refer to the Wiki page <link href="https://wiki.documentfoundation.org/Development/DispatchCommands" name="Commands_Wiki">Development/DispatchCommands</link>.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id521622828226683"> + <input>svc.RunCommand(command: str, [args: any])</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401589202413575"><emph>command</emph>: Case-sensitive string containing the UNO command name. The inclusion of the prefix ".uno:" in the command is optional. The command itself is not checked for correctness. If nothing happens after the command call, then the command is probably wrong.</paragraph> + <paragraph role="paragraph" id="par_id521644182774710"><emph>args</emph>: For each argument to be passed to the command, specify a pair containing the argument name and value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id721611153068137">The following example runs the <literal>SelectData</literal> command in a Calc file named "MyFile.ods", which will result in the selection of the data area based on the currently selected cell. Note that this command does not require any arguments.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id401611153339973">Set oDoc = CreateScriptService("Document", "MyFile.ods")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121589202413630">oDoc.RunCommand("SelectData")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id371644184276886">Below is an example that runs the UNO command <literal>ReplaceAll</literal> and passes values for its arguments <literal>SearchString</literal> and <literal>ReplaceString</literal>. Running this command will replace all occurrence of the string "abc" by "ABC" in the current sheet.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id631644184414955">' Arguments passed to the command:</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621644184336024">' SearchString = "abc"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id516441843364240">' ReplaceString = "ABC"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391644184337449">oDoc.RunCommand(".uno:ReplaceAll", "SearchString", "abc", "ReplaceString", "ABC")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id41644184549167">Note that calling the command <literal>ReplaceAll</literal> without arguments will open the <menuitem>Find and Replace</menuitem> dialog.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821622828361025">doc = CreateScriptService("Document", "MyFile.ods")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211622828361293">doc.RunCommand("SelectData")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id661644184648102">doc.RunCommand(".uno:ReplaceAll", "SearchString", "abc", "ReplaceString", "ABC")</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id811644243228448">In Python it is also possible to call <literal>RunCommand</literal> using keyword arguments:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id301644243318500">doc.RunCommand(".uno:ReplaceAll", SearchString = "abc", ReplaceString = "ABC")</paragraph> + </pycode> + <tip id="par_id191611153511038">Each %PRODUCTNAME component has its own set of commands available. One easy way to learn commands is going to <emph>Tools - Customize - Keyboard</emph>. When you position your mouse over a function in the <emph>Function</emph> list, a tooltip will appear with the corresponding UNO command.</tip> +</section> + +<section id="Save"> + <comment> Save ------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id691589202925124"> + <bookmark_value>Document service;Save</bookmark_value> + </bookmark> + <h2 id="hd_id3615892029256" localize="false">Save</h2> + <paragraph role="paragraph" id="par_id81589202925519">Stores the document to the file location from which it was loaded. The method is ignored if the document was not modified.</paragraph> + <paragraph role="paragraph" id="par_id731611153918907">Returns <literal>False</literal> if the document could not be saved. An error is raised if the file is open as read-only, or if it is a new file that has not been saved yet.</paragraph> + <paragraph role="paragraph" id="par_id211589203690937" xml-lang="en-US">The document itself does not need to be active to run this method.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711622828457342"> + <input>svc.Save(): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id31589202925376">If Not oDoc.Save() Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821589203188905"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811622828432150">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id981622828541243">if not doc.Save():</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id781622828542374"> # ...</paragraph> + </pycode> +</section> + +<section id="SaveAs"> + <comment> SaveAs --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141589203370367"> + <bookmark_value>Document service;SaveAs</bookmark_value> + </bookmark> + <h2 id="hd_id161589203370594" localize="false">SaveAs</h2> + <paragraph role="paragraph" id="par_id121589203370778">Stores the document to the given file location. The new location becomes the new file name on which simple Save method calls will be applied.</paragraph> + <paragraph role="paragraph" id="par_id31611154475602">Returns <literal>False</literal> if the document could not be saved. An error is raised when overwriting the destination is rejected or when the destination has its read-only attribute set.</paragraph> + <paragraph role="paragraph" id="par_id391589203370902" xml-lang="en-US">The document itself does not need to be active to run this method.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id561622828596238"> + <input>svc.SaveAs(filename: str, overwrite: bool = False, password: str = '', filtername: str = '', filteroptions: str = ''): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id331589203370950"><emph>filename</emph>: A string containing the file name to be used. It must follow the <literal>SF_FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id631589204010142" xml-lang="en-US"><emph>overwrite</emph>: If <literal>True</literal>, the destination file may be overwritten (default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id811589204084107" xml-lang="en-US"><emph>password</emph> (*): A non-space string to protect the document.</paragraph> + <paragraph role="paragraph" id="par_id451589204163772" xml-lang="en-US"><emph>filtername</emph> (*): The name of a filter that should be used for saving the document. If this argument is passed, then the filter must exist.</paragraph> + <paragraph role="paragraph" id="par_id981589204207800" xml-lang="en-US"><emph>filteroptions</emph> (*): An optional string of options associated with the filter.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id81589203370943">oDoc.SaveAs("C:\Documents\NewCopy.odt", overwrite := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id801622828865363">doc.SaveAs(r"C:\Documents\NewCopy.odt", overwrite = True)</paragraph> + </pycode> +</section> + +<section id="SaveCopyAs"> + <comment> SaveCopyAs ------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id71158920514765"> + <bookmark_value>Document service;SaveCopyAs</bookmark_value> + </bookmark> + <h2 id="hd_id811589205147824" localize="false">SaveCopyAs</h2> + <paragraph role="paragraph" id="par_id911589205147502">Stores a copy of or export the document to the given file location. The actual location is unchanged.</paragraph> + <paragraph role="paragraph" id="par_id381611154800685">Returns <literal>False</literal> if the document could not be saved. An error is raised when overwriting the destination is rejected or when the destination has its read-only attribute set.</paragraph> + <paragraph role="paragraph" id="par_id11589205147643" xml-lang="en-US">The document itself does not need to be active to run this method.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id561622828596855"> + <input>svc.SaveCopyAs(filename: str, overwrite: bool = False, password: str = '', filtername: str = '', filteroptions: str = ''): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id301589205147697"><emph>filename</emph>: A string containing the file name to be used. It must follow the <literal>SF_FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id851589205147348" xml-lang="en-US"><emph>overwrite</emph>: If <literal>True</literal>, the destination file may be overwritten (default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id821589205147330" xml-lang="en-US"><emph>password</emph> (*): A non-space string to protect the document.</paragraph> + <paragraph role="paragraph" id="par_id67158920514729" xml-lang="en-US"><emph>filtername</emph> (*): The name of a filter that should be used for saving the document. If this argument is passed, then the filter must exist.</paragraph> + <paragraph role="paragraph" id="par_id881589205147911" xml-lang="en-US"><emph>filteroptions</emph> (*): An optional string of options associated with the filter.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id431589205147164">oDoc.SaveCopyAs("C:\Documents\Copy2.odt", Overwrite := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941622829095519">doc.SaveCopyAs(r"C:\Documents\Copy2.odt", overwrite = True)</paragraph> + </pycode> +</section> + +<section id="SetPrinter"> + <comment> SetPrinter ------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id71158921504765"> + <bookmark_value>Document service;SetPrinter</bookmark_value> + </bookmark> + <h2 id="hd_id811589502147824" localize="false">SetPrinter</h2> + <paragraph role="paragraph" id="par_id911298505147502">Defines the printer options for the document.</paragraph> + <paragraph role="paragraph" id="par_id381651114800685">Returns <literal>True</literal> when successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id261652828596855"> + <input>svc.SetPrinter(opt printer: str, opt orientation: str, paperformat: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <section id="setPrinterArgs"> + <paragraph role="paragraph" id="par_id301589205741697"><emph>printer</emph>: The name of the printer queue where to print to. When absent, the default printer is set.</paragraph> + <paragraph role="paragraph" id="par_id851985205147348"><emph>orientation</emph>: Either <literal>PORTRAIT</literal> or <literal>LANDSCAPE</literal>. When absent, left unchanged with respect to the printer settings.</paragraph> + <paragraph role="paragraph" id="par_id821985205147330"><emph>paperformat</emph>: Specifies the paper format as a string value that can be either <literal>A3</literal>, <literal>A4</literal>, <literal>A5</literal>, <literal>LETTER</literal>, <literal>LEGAL</literal> or <literal>TABLOID</literal>. Left unchanged when absent.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id431589204157164">oDoc.SetPrinter(Orientation := "PORTRAIT")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941628229095519">doc.SetPrinter(paperformat='TABLOID')</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_dictionary.xhp#SFDictionary"/> + <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> + <embed href="text/sbasic/shared/03/sf_menu.xhp#MenuService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_exception.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_exception.xhp new file mode 100644 index 000000000..416c43457 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_exception.xhp @@ -0,0 +1,459 @@ +<?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_Exception" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.Exception service (SF_Exception)</title> + <filename>/text/sbasic/shared/03/sf_exception.xhp</filename> + </topic> +</meta> +<body> +<section id="abstract"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id381587139303941"> + <bookmark_value>Exception service</bookmark_value> + </bookmark> + <h1 id="hd_id521580038927003" xml-lang="en-US"><variable id="ExceptionService"><link href="text/sbasic/shared/03/sf_exception.xhp" name="Exception service"><literal>ScriptForge</literal>.<literal>Exception</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id181587139648008" xml-lang="en-US">The <literal>Exception</literal> service is a collection of methods to assist in code debugging in Basic and Python scripts and in error handling in Basic scripts.</paragraph> + <paragraph role="paragraph" id="par_id141587140927573" xml-lang="en-US">In <emph>Basic scripts</emph>, when a run-time error occurs, the methods and properties of the <literal>Exception</literal> service help identify the error context and allow to handle it.</paragraph> +</section> + <list type="unordered"> + <listitem> + <paragraph id="par_id401621450898070" role="listitem">The <literal>SF_Exception</literal> service is similar to the <link href="text/sbasic/shared/ErrVBA.xhp" name="VBA Err object">VBA <literal>Err</literal> object</link>.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id361621450908874" role="listitem">The <literal>Number</literal> property identifies the error.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id861621450910254" role="listitem">Use the <literal>Raise</literal> method to interrupt processing. The <literal>RaiseWarning</literal> method can be used to trap an anomaly without interrupting the macro execution.</paragraph> + </listitem> + </list> + <tip id="par_id621587225732733" xml-lang="en-US">Errors and warnings raised with the <literal>Exception</literal> service are stored in memory and can be retrieved using the <literal>Console</literal> method.</tip> + + <paragraph role="paragraph" id="par_id411587141146677" xml-lang="en-US">The <literal>Exception</literal> service console stores events, variable values and information about errors. Use the console when the Basic IDE is not easily accessible, for example in <link href="text/scalc/guide/userdefined_function.xhp" name="Calc user-defined function">Calc user defined functions (UDF)</link> or during events processing.</paragraph> + <paragraph role="paragraph" id="par_id251621034725811">Use the <literal>DebugPrint</literal> method to add any relevant information to the console. Console entries can be dumped to a text file or visualized in a dialog window.</paragraph> + <paragraph role="paragraph" id="par_id111587141158495" xml-lang="en-US">When an error occurs, an application macro may:</paragraph> + <list type="ordered"> + <listitem><paragraph role="paragraph" id="par_id451587141202844" xml-lang="en-US">Report the error in the <literal>Exception</literal> console</paragraph></listitem> + <listitem><paragraph role="paragraph" id="par_id751587141235313" xml-lang="en-US">Inform the user about the error using either a standard message or a custom message</paragraph></listitem> + <listitem><paragraph role="paragraph" id="par_id931587141260777" xml-lang="en-US">Optionally stop its execution</paragraph></listitem> + </list> + <paragraph role="paragraph" id="par_id771621035263403">In <emph>Python scripts</emph> the <literal>Exception</literal> service is mostly used for debugging purposes. Methods such as <literal>DebugPrint</literal>, <literal>Console</literal> and <literal>DebugDisplay</literal> are useful to quickly print messages, log data and open the console window from within a Python script.</paragraph> + <note id="par_id211621035276160">Not all methods and properties are available for Python scripts since the Python language already has a comprehensive exception handling system.</note> + + <h2 id="hd_id201586594659135" xml-lang="en-US">Service invocation</h2> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id161610652161795">The following examples show three different approaches to call the method <literal>Raise</literal>. All other methods can be executed in a similar fashion.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id881610652359633">SF_Exception.Raise(...)</paragraph> + </bascode> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id441586594733346">Dim exc : exc = SF_Exception</paragraph> + <paragraph role="bascode" localize="false" id="bas_id481586594739978">exc.Raise(...)</paragraph> + </bascode> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id431586594750461">Dim exc : exc = CreateScriptService("Exception")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471586594758689">exc.Raise(...)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id901621036227048">The code snippet below creates an instance of the <literal>Exception</literal> service, logs a message and displays the <literal>Console</literal> window.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id651621036305969">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id101621036327340">exc = CreateScriptService("Exception")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id71621036480430">someVar = 100</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id291621036366532">exc.DebugPrint("Value of someVar", someVar)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id411621036455976">exc.Console()</paragraph> + </pycode> + + <h2 id="hd_id651584978211886" xml-lang="en-US">Properties</h2> + <paragraph role="paragraph" id="par_id911621036526404">The properties listed below are only available for <emph>Basic</emph> scripts.</paragraph> + <table id="tab_id761584978211275"> + <tablerow> + <tablecell> + <paragraph id="par_id271584978211792" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id241584978211550" role="tablehead">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621584978211403" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id581584978715552" role="tablecontent" localize="false">Description</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71584978715562" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581584978715701" role="tablecontent" xml-lang="en-US">The error message text.</paragraph> + <paragraph role="paragraph" id="par_id241610652688334">Default value is "" or a string containing the Basic run-time error message.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id91584978211231" role="tablecontent" localize="false">Number</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211584978211383" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691584978211774" role="tablecontent" xml-lang="en-US">The code of the error. It can be a numeric value or text.</paragraph> + <paragraph role="paragraph" id="par_id151610652632828">Default value is 0 or the numeric value corresponding to the Basic run-time error code.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id1001584978666440" role="tablecontent" localize="false">Source</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id671584978666689" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951584978666296" role="tablecontent" xml-lang="en-US">The location in the code where the error occurred. It can be a numeric value or text.</paragraph> + <paragraph role="paragraph" id="par_id681610652723345">Default value is 0 or the code line number for a standard Basic run-time error.</paragraph> + </tablecell> + </tablerow> + </table> + <tip id="par_id461584978880380" xml-lang="en-US">Raising or clearing an <literal>Exception</literal> resets its properties.</tip> + <embed href="text/sbasic/shared/ErrVBA.xhp#RestrictedErrorCodes"/> + + <table id="tab_id441608131596153"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id881608131596153" role="tablehead">List of Methods in the Exception Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id461608131596153" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_exception.xhp#Clear" name="Clear method">Clear</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#Console" name="Console method">Console</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#ConsoleClear" name="ConsoleClear method">ConsoleClear</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id871608132025242" localize="false"> + <link href="text/sbasic/shared/03/sf_exception.xhp#ConsoleToFile" name="ConsoleToFile method">ConsoleToFile</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#DebugDisplay" name="DebugDisplay method">DebugDisplay</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#DebugPrint" name="DebugPrint method">DebugPrint</link><br/><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" id="par_id831608132069033" localize="false"> + <link href="text/sbasic/shared/03/sf_exception.xhp#PythonPrint" name="PythonPrint method">PythonPrint</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#PythonShell" name="PythonShell method">PythonShell</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#Raise" name="Raise method">Raise</link><br/> + <link href="text/sbasic/shared/03/sf_exception.xhp#RaiseWarning" name="RaiseWarning method">RaiseWarning</link><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + +<section id="Clear"> + <comment> Clear -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id121582203710297"> + <bookmark_value>Exception service;Clear</bookmark_value> + </bookmark> + <h2 id="hd_id791579683635979" localize="false">Clear</h2> + <paragraph role="paragraph" id="par_id271579683706571">Resets the current error status and clears the <literal>SF_Exception</literal> properties.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#Basic_Only"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id531579684617249">SF_Exception.Clear()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id701610654263121">The following example shows how to catch a division-by-zero exception, whose error code is 11.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id631579688532444">Sub Example_Clear()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721587215452594"> Dim a, b, c</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431587221926496"> On Local Error GoTo Catch</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541601735163562"> Try:</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441587215463149"> a = 10 : b = 0</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531587215470406"> c = a / b</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361587215477209"> '...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931587215483393"> Exit Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851587215489779"> Catch:</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771587215496761"> If SF_Exception.Number = 11 Then SF_Exception.Clear()</paragraph> + <paragraph role="bascode" id="bas_id51587215508130" xml-lang="en-US"> 'If division by zero, ignore the error</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801579688542131">End Sub</paragraph> + </bascode> + <tip id="par_id201610654368082">For a complete list of Basic run-time error codes, refer to <link href="text/sbasic/shared/01030300.xhp" name="Run-Time Error Codes">Debugging a Basic Program</link>.</tip> +</section> + +<section id="Console"> + <comment> Console -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id9159871817936"> + <bookmark_value>Exception service;Console</bookmark_value> + </bookmark> + <h2 id="hd_id971598718179751" localize="false">Console</h2> + <paragraph role="paragraph" id="par_id651598718179382">Displays the console messages in a modal or non-modal dialog. In both modes, all the past messages issued by a <literal>DebugPrint()</literal> method or resulting from an exception are displayed. In non-modal mode, subsequent entries are added automatically.</paragraph> + <paragraph role="paragraph" id="par_id161598718286205" xml-lang="en-US">If the console is already open, when non-modal, it is brought to the front.</paragraph> + <paragraph role="paragraph" id="par_id801598718629151" xml-lang="en-US">A modal console can only be closed by the user. A non-modal console can either be closed by the user or upon macro termination.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id571621040248589"> + <input>exc.Console(modal: bool = True)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id511598718179819"><emph>modal</emph>: Determine if the console window is modal (<literal>True</literal>) or non-modal (<literal>False</literal>). Default value is <literal>True</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id78159871817999"> SF_Exception.Console(Modal := False)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id621621040451660">exc.Console(modal = False)</paragraph> + </pycode> +</section> + +<section id="ConsoleClear"> + <comment> ConsoleClear -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id621587215098307"> + <bookmark_value>Exception service;ConsoleClear</bookmark_value> + </bookmark> + <h2 id="hd_id671587215098845" localize="false">ConsoleClear</h2> + <paragraph role="paragraph" id="par_id641587215098903">Clears the console keeping an optional number of recent messages. If the console is activated in non-modal mode, it is refreshed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id651621040714152"> + <input>exc.ConsoleClear(keep: int = 0)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id351587215098527"><emph>keep</emph>: The number of recent messages to be kept. Default value is 0.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id521610655023824">The following example clears the console keeping the 10 most recent messages.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id981587215098452"> SF_Exception.ConsoleClear(10)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id891621040671870">exc.ConsoleClear(10)</paragraph> + </pycode> +</section> + +<section id="ConsoleToFile"> + <comment> ConsoleToFile -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id911587218077199"> + <bookmark_value>Exception service;ConsoleToFile</bookmark_value> + </bookmark> + <h2 id="hd_id691587218077803" localize="false">ConsoleToFile</h2> + <paragraph role="paragraph" id="par_id281587218077400">Exports the contents of the console to a text file. If the file already exists and the console is not empty, it will be overwritten without warning. Returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id171621042623495"> + <input>exc.ConsoleToFile(filename: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id851587218077862"><emph>filename</emph>: The name of the text file the console should be dumped into. The name is expressed according to the current <literal>FileNaming</literal> property of the <literal>SF_FileSystem</literal> service. By default, <link href="text/sbasic/shared/00000002.xhp" name="Url notation">URL notation</link> and the native operating system's format are both admitted.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id941587218077971"> SF_Exception.ConsoleToFile("C:\Documents\myFile.txt")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id901621041580099">exc.ConsoleToFile(r"C:\Documents\myFile.txt")</paragraph> + </pycode> +</section> + +<section id="DebugDisplay"> + <comment> DebugDisplay -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id591587218637462"> + <bookmark_value>Exception service;DebugDisplay</bookmark_value> + </bookmark> + <h2 id="hd_id691587218077177" localize="false">DebugDisplay</h2> + <paragraph role="paragraph" id="par_id701621043185177">Concatenates all the arguments into a single human-readable string and displays it in a <literal>MsgBox</literal> with an Information icon and an OK button.</paragraph> + <paragraph role="paragraph" id="par_id791621097689492">The final string is also added to the Console.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id461621042840877"> + <input>exc.DebugDisplay(arg0: any, [arg1: any, ...])</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481587218636884"><emph>arg0[, arg1, ...]</emph>: Any number of arguments of any type.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id871621043432964">SF_Exception.DebugDisplay("Current Value", someVar)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id501621043522869">exc.DebugDisplay("Current Value", someVar)</paragraph> + </pycode> +</section> + +<section id="DebugPrint"> + <comment> DebugPrint -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id591587218637462"> + <bookmark_value>Exception service;DebugPrint</bookmark_value> + </bookmark> + <h2 id="hd_id981587218637683" localize="false">DebugPrint</h2> + <paragraph role="paragraph" id="par_id281587218637490">Assembles all the given arguments into a single human-readable string and adds it as a new entry in the console.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id461621042840764"> + <input>exc.DebugPrint(arg0: any, [arg1: any, ...])</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481587218637988"><emph>arg0[, arg1, ...]</emph>: Any number of arguments of any type.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id58158721863732">SF_Exception.DebugPrint(Null, Array(1, 2, 3), "line1" & Chr(10) & "Line2", DateSerial(2020, 04, 09))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151610655617295">' [NULL] [ARRAY] (0:2) (1, 2, 3) line1\nLine2 2020-04-09</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id591621043074050">exc.DebugPrint(None, [1, 2, 3], "line1\nline2")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id161621098073293"># None [1, 2, 3] line1\nline2</paragraph> + </pycode> +</section> + +<section id="PythonPrint"> + <comment> PythonPrint -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id301587219428104"> + <bookmark_value>Exception service;PythonPrint</bookmark_value> + </bookmark> + <h2 id="hd_id5515879128204789" localize="false">PythonPrint</h2> + <paragraph role="paragraph" id="par_id111621624672183">Displays the list of arguments in a readable form in the Python shell (APSO) console. Arguments are separated by a TAB character (simulated by spaces).</paragraph> + <paragraph role="paragraph" id="par_id841621426229467">The same string is added to the ScriptForge debug console.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#Basic_Only"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id81630591881423">exc.PythonPrint(arg0: any, [arg1: any, ...])</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#Requires_APSO"/> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id391126449167833"><emph>arg0[, arg1, ...]</emph>: Any number of arguments of any type. The maximum length of each individual argument is 1024 characters.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="pyc_id451621479450230">exc.PythonPrint(a, Array(1, 2, 3), , "line1" & Chr(10) & "Line2", DateSerial(2020, 04, 09))</paragraph> + </bascode> + <note id="par_id261123015276160">In python use simply the builtin print() statement.</note> +</section> + +<section id="PythonShell"> + <comment> PythonShell -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id301587219824104"> + <bookmark_value>Exception service;PythonShell</bookmark_value> + </bookmark> + <h2 id="hd_id5515872198204789" localize="false">PythonShell</h2> + <paragraph role="paragraph" id="par_id111621426672183">Opens an APSO Python shell as a non-modal window. The Python script keeps running after the shell is opened. The output from <literal>print</literal> statements inside the script are shown in the shell.</paragraph> + <paragraph role="paragraph" id="par_id841621426922467">Only a single instance of the APSO Python shell can be opened at any time. Hence, if a Python shell is already open, then calling this method will have no effect.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#Requires_APSO"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id411621625580764"> + <input>exc.PythonShell(variables: dict)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id391621449167833"><emph>variables</emph>: a Python dictionary with variable names and values that will be passed on to the APSO Python shell. By default all local variables are passed using Python's builtin <literal>locals()</literal> function.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id991621449657850">The example below opens the APSO Python shell passing all global and local variables considering the context where the script is running.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id451621449750230">exc.PythonShell({**globals(), **locals()})</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id521621449800348">When the APSO Python shell is open, any subsequent output printed by the script will be shown in the shell. Hence, the string printed in the example below will be displayed in the Python shell.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id441621449844658">exc.PythonShell()</paragraph> + <paragraph role="pycode" id="pyc_id731621449899901">print("Hello world!")</paragraph> + </pycode> +</section> + +<section id="Raise"> + <comment> Raise -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id301587219824932"> + <bookmark_value>Exception service;Raise</bookmark_value> + </bookmark> + <h2 id="hd_id551587219824275" localize="false">Raise</h2> + <paragraph role="paragraph" id="par_id541587219824771">Generates a run-time error. An error message is displayed to the user and reported in the console. The execution is stopped. The <literal>Raise()</literal> method can be placed inside the normal script flow or in a dedicated error-handling routine.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#Basic_Only"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id29158721982455">SF_Exception.Raise([Number As Variant], [Source As Variant], [Description As String])</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id921587220542454" xml-lang="en-US">The code snippets presented next are equivalent. They show alternative ways to raise an exception with code 2100.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id881587220508733">SF_Exception.Raise(2100)</paragraph> + </bascode> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id361587220516558">SF_Exception.Number = 2100</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51587220525168">SF_Exception.Raise()</paragraph> + </bascode> + <bascode> + <paragraph role="bascode" id="bas_id491608216264445" localize="false">SF_Exception.Raise Number := 2100</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <section id="Raise_Parameters"> + <paragraph role="paragraph" id="par_id851587219824597"><emph>Number</emph>: The error code, as a number or as a string. Default value is that of <literal>Err</literal> Basic builtin function.</paragraph> + <paragraph role="paragraph" id="par_id461587220986452" xml-lang="en-US"><emph>Source</emph>: The location of the error, as a number or as a string. Default value is that of <literal>Erl</literal> Basic builtin function.</paragraph> + <paragraph role="paragraph" id="par_id721587221018162" xml-lang="en-US"><emph>Description</emph>: The message to display to the user and to report in the console. Default value is that of <literal>Error$</literal> Basic builtin function.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id101587221964367">Sub Example_Raise()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681587221964375"> Dim a, b, c</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811587221964318"> On Local Error GoTo Catch</paragraph> + <paragraph role="bascode" localize="false" id="bas_id511601735068745"> Try:</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831587221964580"> a = 10 : b = 0</paragraph> + <paragraph role="bascode" localize="false" id="bas_id4115872219641"> c = a / b</paragraph> + <paragraph role="bascode" localize="false" id="bas_id85158722196499"> '...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241587221964418"> Exit Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721587221964962"> Catch:</paragraph> + <paragraph role="bascode" id="bas_id211587222852310" xml-lang="en-US"> 'See variants below ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61587221964946">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id111587222580987" xml-lang="en-US">To raise an exception with the standard values:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id341587222627299">Catch:</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261587222635009"> SF_Exception.Raise()</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id751587222598238" xml-lang="en-US">To raise an exception with a specific code:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id421587222644102">Catch:</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171587222653391"> SF_Exception.Raise(11)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id501587222607771" xml-lang="en-US">To replace the usual message:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id721587222663630">Catch:</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id431587222670849"> SF_Exception.Raise(, , "It is not a good idea to divide by zero.")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id611587222617174" xml-lang="en-US">To raise an application error:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id441587222684053">Catch:</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id71587222694657"> SF_Exception.Raise("MyAppError", "Example_Raise()", "Something wrong happened !")</paragraph> + </bascode> +</section> + +<section id="RaiseWarning"> + <comment> RaiseWarning -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id811587224839918"> + <bookmark_value>Exception service;RaiseWarning</bookmark_value> + </bookmark> + <h2 id="hd_id391587224839449" localize="false">RaiseWarning</h2> + <paragraph role="paragraph" id="par_id1001587224839900" xml-lang="en-US">This method has exactly the same syntax, arguments and behavior as the <literal>Raise()</literal> method.</paragraph> + <paragraph role="paragraph" id="par_id761587224839624" xml-lang="en-US">However, when a warning is raised, <emph>the macro execution is not stopped</emph>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#Basic_Only"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id25197821982455">SF_Exception.RaiseWarning([Number As Variant], [Source As Variant], [Description As String])</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <embed href="text/sbasic/shared/03/sf_exception.xhp#Raise_Parameters"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id71587222649657">SF_Exception.RaiseWarning(Source:="Example_Raise()", _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841608217948025"> Description:="Something wrong happened !", _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361608217956289"> Number:="MyAppError")</paragraph> + </bascode> +</section> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03050000.xhp#ErrHandlingh1"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_filesystem.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_filesystem.xhp new file mode 100644 index 000000000..9461b7604 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_filesystem.xhp @@ -0,0 +1,1129 @@ +<?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_FileSystem" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.FileSystem service</title> + <filename>/text/sbasic/shared/03/sf_filesystem.xhp</filename> + </topic> +</meta> + +<body> +<section id="ScriptForge-sf_filesystem"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41582391760252"> + <bookmark_value>FileSystem service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="FileSystemService"><link href="text/sbasic/shared/03/sf_filesystem.xhp" name="FileSystem service"><literal>ScriptForge</literal>.<literal>FileSystem</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The <literal>FileSystem</literal> service includes routines to handle files and folders. Next are some examples of the features provided by this service:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id121612917070593" role="listitem">Verify whether a file or folder exists.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id121612917070594" role="listitem">Create and delete folders and files.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id121612917070595" role="listitem">Launch dialog boxes to open/save files.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id121612917070596" role="listitem">Access the list of files in a folder, etc.</paragraph> + </listitem> + </list> +</section> + <note id="par_id121612917368946">The methods in the FileSystem service are mostly based on the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1ucb_1_1XSimpleFileAccess.html" name="XSimpleFileAccess API"><literal>XSimpleFileAccess</literal> UNO interface.</link></note> + + <h2 id="hd_id961583589783025" xml-lang="en-US">Definitions</h2> + <paragraph role="paragraph" id="par_id821612988815351">The table below lists the main parameters used by most of the methods in the <literal>FileSystem</literal> service.</paragraph> + <table id="tab_id721612988600163"> + <tablerow> + <tablecell> + <paragraph id="par_id891612988600163" role="tablehead">Parameter</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711612988600163" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181612988600163" role="tablecontent" localize="false"><literal>FileName</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321612988600163" role="tablecontent">The full name of the file including the path without a path separator at the end.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181612988600164" role="tablecontent" localize="false"><literal>FolderName</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321612988600165" role="tablecontent">The full name of the folder including the path. It may or may not contain the ending path separator.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181612988600166" role="tablecontent" localize="false"><literal>Name</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321612988600167" role="tablecontent">The last component of the <emph>Folder Name</emph> or <emph>File Name</emph> including its extension. This parameter is always expressed using the native format of the operating system.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181612988600168" role="tablecontent" localize="false"><literal>BaseName</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321612988600169" role="tablecontent">The last component of the <emph>Folder Name</emph> or <emph>File Name</emph> without its extension.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181612988600171" role="tablecontent" localize="false"><literal>NamePattern</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321612988600172" role="tablecontent">Any of the above names containing wildcards in its last component. Admitted wildcards are:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id851583590809104" role="listitem" xml-lang="en-US">"?" represents any single character</paragraph> + </listitem> + <listitem> + <paragraph id="par_id161583590819320" role="listitem" xml-lang="en-US">"*" represents zero, one, or multiple characters</paragraph> + </listitem> + </list> + </tablecell> + </tablerow> + </table> + <tip id="par_id911584540527980" xml-lang="en-US">The <literal>FileSystem</literal> service allows to perform operations over multiple files at the same time. By using name patterns, user scripts can copy, move or delete multiple files. Conversely, Basic built-in methods can only handle single files.</tip> + + <h3 id="hd_id991612918109871">File Naming Notation</h3> + <paragraph role="paragraph" id="par_id791612918141083">The notation used to express file and folder names, both for arguments and returned values, is defined by the <literal>FileNaming</literal> property of the <literal>FileSystem</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id951612918220255">In short, the possible representation types are "URL" (URL file notation), "SYS" (operating system notation) and "ANY" (default). See more information <link href="text/sbasic/shared/03/sf_filesystem.xhp#properties" name="Properties Table">below</link>.</paragraph> + <tip id="par_id861583589907100" xml-lang="en-US">An example of the URL notation is <emph>file:///C:/Documents/my_file.odt</emph>. Whenever possible consider using the URL notation because it is a more portable alternative.</tip> + <warning id="par_id931626652451855">The use of the shortcut "~" (tilde), which is common in Linux-based operating systems, is not supported to express a path to a folder and file name. Instead of using <emph>"~/Documents/my_file.odt"</emph> use the full path <emph>"/home/user/Documents/my_file.odt"</emph>.</warning> + + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id691612990276070">The following code snippet invokes the <literal>FileSystem</literal> service. The method <literal>BuildPath</literal> was used as an example.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id551610734764343">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371582885621964">Dim FSO As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201582885621287">Set FSO = CreateScriptService("FileSystem")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id901612990364784">FSO.BuildPath(...)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id301626147154020">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id771626147154696">fs = CreateScriptService("FileSystem")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id741626147154953">fs.BuildPath(...)</paragraph> + </pycode> + + <bookmark xml-lang="en-US" branch="index" id="bm_id901612991354326" localize="false"> + <bookmark_value>FileSystem service;FileNaming property</bookmark_value> + <bookmark_value>FileSystem service;ConfigFolder property</bookmark_value> + <bookmark_value>FileSystem service;ExtensionsFolder property</bookmark_value> + <bookmark_value>FileSystem service;HomeFolder property</bookmark_value> + <bookmark_value>FileSystem service;InstallFolder property</bookmark_value> + <bookmark_value>FileSystem service;TemplatesFolder property</bookmark_value> + <bookmark_value>FileSystem service;TemporaryFolder property</bookmark_value> + <bookmark_value>FileSystem service;UserTemplatesFolder property</bookmark_value> + </bookmark> + <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> + <section id="properties"> + <table id="tab_id381583668386455"> + <tablerow> + <tablecell> + <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491583668386455" role="tablehead" xml-lang="en-US">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668474014" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401583668386455" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151583668386455" role="tablecontent" xml-lang="en-US" localize="false">FileNaming</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371583668519172" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668386455" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Sets or returns the current files and folders notation, either "ANY", "URL" or "SYS":</paragraph> + <list type="unordered"> + <listitem> + <paragraph role="paragraph" id="par_id881585396501844" xml-lang="en-US"><emph>"ANY"</emph>: (default) the methods of the <literal>FileSystem</literal> service accept both URL and current operating system's notation for input arguments but always return URL strings.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id261583669091722" xml-lang="en-US"><emph>"URL"</emph>: the methods of the <literal>FileSystem</literal> service expect URL notation for input arguments and return URL strings.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id731583669120436" xml-lang="en-US"><emph>"SYS"</emph>: the methods of the <literal>FileSystem</literal> service expect current operating system's notation for both input arguments and return strings.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id211583765169579" xml-lang="en-US">Once set, the <literal>FileNaming</literal> property remains unchanged either until the end of the %PRODUCTNAME session or until it is set again.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951583839708571" role="tablecontent" xml-lang="en-US" localize="false">ConfigFolder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541583839708548" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751583839708362" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Returns the configuration folder of %PRODUCTNAME.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id511584027709311" role="tablecontent" xml-lang="en-US" localize="false">ExtensionsFolder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761584027709516" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491584027709825" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">Returns the folder where extensions are installed.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491583839767611" role="tablecontent" xml-lang="en-US" localize="false">HomeFolder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31583839767743" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741583839767926" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Returns the user home folder.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id83158383992056" role="tablecontent" xml-lang="en-US" localize="false">InstallFolder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583839920487" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971583839920282" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451583839920858" role="tablecontent" xml-lang="en-US">Returns the installation folder of %PRODUCTNAME.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id751588333908795" role="tablecontent" xml-lang="en-US" localize="false">TemplatesFolder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571588333908716" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781588333908500" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">Returns the folder containing the system templates files.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id251583774433989" role="tablecontent" xml-lang="en-US" localize="false">TemporaryFolder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501583774433513" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411583774433779" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71583774433459" role="tablecontent" xml-lang="en-US">Returns the temporary files folder defined in the %PRODUCTNAME path settings.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731588334016220" role="tablecontent" xml-lang="en-US" localize="false">UserTemplatesFolder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271588334016191" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991588334016273" role="tablecontent" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Returns the folder containing the user-defined template files.</paragraph> + </tablecell> + </tablerow> + </table> + </section> + +<table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead">List of Methods in the FileSystem Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#BuildPath" name="BuildPath method">BuildPath</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#CompareFiles" name="CompareFiles method">CompareFiles</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#CopyFile" name="CopyFile method">CopyFile</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#CopyFolder" name="CopyFolder method">CopyFolder</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#CreateFolder" name="CreateFolder method">CreateFolder</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#CreateTextFile" name="CreateTextFile method">CreateTextFile</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#DeleteFile" name="DeleteFile method">DeleteFile</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#DeleteFolder" name="DeleteFolder method">DeleteFolder</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#ExtensionFolder" name="ExtensionFolder method">ExtensionFolder</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#FileExists" name="FileExists method">FileExists</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#Files" name="Files method">Files</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#FolderExists" name="FolderExists method">FolderExists</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#GetBaseName" name="GetBaseName method">GetBaseName</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#GetExtension" name="GetExtension method">GetExtension</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#GetFileLen" name="GetFileLen method">GetFileLen</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#GetFileModified" name="GetFileModified method">GetFileModified</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#GetName" name="GetName method">GetName</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#GetParentFolderName" name="GetParentFolderName method">GetParentFolderName</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#GetTempName" name="GetTempName method">GetTempName</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#HashFile" name="HashFile method">HashFile</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#MoveFile" name="MoveFile method">MoveFile</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#MoveFolder" name="MoveFolder method">MoveFolder</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#OpenTextFile" name="OpenTextFile method">OpenTextFile</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#PickFile" name="PickFile method">PickFile</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#PickFolder" name="PickFolder method">PickFolder</link><br/> + <link href="text/sbasic/shared/03/sf_filesystem.xhp#SubFolders" name="SubFolders method">SubFolders</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> +</table> + +<section id="BuildPath"> + <comment> BuildPath ----------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721583933076548"> + <bookmark_value>FileSystem service;BuildPath</bookmark_value> + </bookmark> + <h2 id="hd_id681583933076692" localize="false">BuildPath</h2> + <paragraph role="paragraph" id="par_id871583933076448">Joins a folder path and the name of a file and returns the full file name with a valid path separator. The path separator is added only if necessary.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id251626147640389"> + <input>svc.BuildPath(foldername: str, name: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id90158393307695"><emph>foldername</emph>: The path with which <literal>name</literal> will be combined. The specified path does not need to be an existing folder.</paragraph> + <paragraph role="paragraph" id="par_id891583933076975"><emph>name</emph>: The name of the file to be appended to <literal>foldername</literal>. This parameter uses the notation of the current operating system.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id571583933076688">Dim FSO as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891626278435709">Set FSO = CreateScriptService("FileSystem")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771626215559964">Dim aFileName as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271583933076624">FSO.FileNaming = "URL"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531583933076390">aFileName = FSO.BuildPath("file:///home/user", "sample file.odt")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591583933645158">' file:///home/user/sample%20file.odt</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id811626215598688">fs = CreateScriptService("FileSystem")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id951626215599055">fs.FileNaming = "URL"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151626215599287">aFileName = fs.BuildPath("file:///home/user", "sample file.odt")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id731626215599407"># file:///home/user/sample%20file.odt</paragraph> + </pycode> +</section> + +<section id="CompareFiles"> + <comment> CompareFiles ----------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141601118910914"> + <bookmark_value>FileSystem service;CompareFiles</bookmark_value> + </bookmark> + <h2 id="hd_id441601118910655" localize="false">CompareFiles</h2> + <paragraph role="paragraph" id="par_id33160111891079">Compares two files and returns <literal>True</literal> when they seem identical.</paragraph> + <paragraph role="paragraph" id="par_id631601119001315" xml-lang="en-US">Depending on the value of the <literal>comparecontents</literal> argument, the comparison between both files can be either based only on file attributes (such as the last modified date), or based on the file contents.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id61626148854349"> + <input>svc.CompareFiles(filename1: str, filename2: str, comparecontents: bool = False): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481601118910755"><emph>filename1, filename2</emph>: The files to compare.</paragraph> + <paragraph role="paragraph" id="par_id111601118910848" xml-lang="en-US"><emph>comparecontents</emph>: When <literal>True</literal>, the contents of the files are compared (default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id231601118910666">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101601118910778">If FSO.CompareFiles("C:\myFile1.txt", "C:\myFile2.txt", CompareContents := False) Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171601123413866"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271612997571657">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id341626215746128">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id141626215746355">if fs.CompareFiles(r"C:\myFile1.txt", r"C:\myFile2.txt", comparecontents = False):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id111626215746495"> # ...</paragraph> + </pycode> +</section> + +<section id="CopyFile"> + <comment> CopyFile ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41584541257826"> + <bookmark_value>FileSystem service;CopyFile</bookmark_value> + </bookmark> + <h2 id="hd_id95158454125767" localize="false">CopyFile</h2> + <paragraph role="paragraph" id="par_id161584541257982">Copies one or more files from one location to another. Returns <literal>True</literal> if at least one file has been copied or <literal>False</literal> if an error occurred.</paragraph> + <paragraph role="paragraph" id="par_id401612998805699">An error will also occur if the <literal>source</literal> parameter uses wildcard characters and does not match any files.</paragraph> + <paragraph role="paragraph" id="par_id331612998814805">The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id611626148998301"> + <input>svc.CopyFile(source: str, destination: str, overwrite: bool = True): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id1001584541257789"><emph>source</emph>: It can be a <literal>FileName</literal> or a <literal>NamePattern</literal> indicating one or more files to be copied.</paragraph> + <paragraph role="paragraph" id="par_id111584542310166" xml-lang="en-US"><emph>destination</emph>: It can be either a <literal>FileName</literal> specifying where the single <literal>source</literal> file is to be copied, or a <literal>FolderName</literal> into which the multiple files from <literal>source</literal> are to be copied.</paragraph> + <list type="unordered"> + <listitem> + <paragraph role="paragraph" id="par_id491612999134752">If <literal>destination</literal> does not exist, it is created.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id591612999166788">Wildcard characters are not allowed in <literal>destination</literal>.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id251584542431558" xml-lang="en-US"><emph>overwrite</emph>: If <literal>True</literal> (default), files may be overwritten. The method will fail if <literal>destination</literal> is readonly, regardless of the value specified in <literal>overwrite</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id691626216252568">In the examples below the first line copies a single file whereas the second line copies multiple files using wildcards.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id851613000918341">FSO.CopyFile("C:\Documents\my_file.odt", "C:\Temp\copied_file.odt")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id501584541257221">FSO.CopyFile("C:\Documents\*.*", "C:\Temp\", Overwrite := False)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id471626216422324">fs.CopyFile(r"C:\Documents\my_file.odt", r"C:\Temp\copied_file.odt")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id141626216422517">fs.CopyFile(r"C:\Documents\*.*", r"C:\Temp", overwrite = False)</paragraph> + </pycode> + <note id="par_id411626216328023">Beware that subfolders and their contents are not copied when wildcards are used in the <emph>source</emph> argument.</note> +</section> + +<section id="CopyFolder"> + <comment> CopyFolder ----------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id661584544734386"> + <bookmark_value>FileSystem service;CopyFolder</bookmark_value> + </bookmark> + <h2 id="hd_id201584544734113" localize="false">CopyFolder</h2> + <paragraph role="paragraph" id="par_id731584544734412">Copies one or more folders from one location to another. Returns <literal>True</literal> if at least one folder has been copied or <literal>False</literal> if an error occurred.</paragraph> + <paragraph role="paragraph" id="par_id21612999775377">An error will also occur if the <literal>source</literal> parameter uses wildcard characters and does not match any folders.</paragraph> + <paragraph role="paragraph" id="par_id701612999808912">The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id381626149136823"> + <input>svc.CopyFolder(source: str, destination: str, overwrite: bool = True): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id851584544734202"><emph>source</emph>: It can be a <literal>FolderName</literal> or a <literal>NamePattern</literal> indicating one or more folders to be copied.</paragraph> + <paragraph role="paragraph" id="par_id321584544734273" xml-lang="en-US"><emph>destination</emph>: Specifies the <literal>FolderName</literal> into which the single or multiple folders defined in <literal>source</literal> are to be copied.</paragraph> + <list type="unordered"> + <listitem> + <paragraph role="paragraph" id="par_id491612999134762">If <literal>destination</literal> does not exist, it is created.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id591612999166740">Wildcard characters are not allowed in <literal>destination</literal>.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id251584542431525" xml-lang="en-US"><emph>overwrite</emph>: If <literal>True</literal> (default), files may be overwritten. The method will fail if <literal>destination</literal> is readonly, regardless of the value specified in <literal>overwrite</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id751626216627481">In the examples below all files, folders and subfolders are copied.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id761584882338442">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651584544734985">FSO.CopyFolder("C:\Documents\*", "C:\Temp\", Overwrite := False)</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id431626216707056"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id771626216707454">fs.CopyFolder(r"C:\Documents\*", r"C:\Temp", overwrite = False)</paragraph> + </pycode> +</section> + +<section id="CreateFolder"> + <comment> CreateFolder -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id95158454067521"> + <bookmark_value>FileSystem service;CreateFolder</bookmark_value> + </bookmark> + <h2 id="hd_id501584540675285" localize="false">CreateFolder</h2> + <paragraph role="paragraph" id="par_id31158454067562">Creates the specified <literal>FolderName</literal>. Returns <literal>True</literal> if the folder could be successfully created.</paragraph> + <paragraph role="paragraph" id="par_id431613000475359">If the specified folder has a parent folder that does not exist, it is created.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id531626177201641"> + <input>svc.CreateFolder(foldername: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id491584540675469"><emph>foldername</emph>: A string representing the folder to be created. If the folder already exists, an exception will be raised.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id441584540675381">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491584540675179">FSO.CreateFolder("C:\NewFolder")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id971626216947436"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181626216947810">fs.CreateFolder(r"C:\NewFolder")</paragraph> + </pycode> +</section> + +<section id="CreateTextFile"> + <comment> CreateTextFile ------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id651585322689546"> + <bookmark_value>FolderSystem service;CreateTextFile</bookmark_value> + </bookmark> + <h2 id="hd_id19158532268911" localize="false">CreateTextFile</h2> + <paragraph role="paragraph" id="par_id731585322689518">Creates a specified file and returns a <literal>TextStream</literal> service instance that can be used to write to the file.</paragraph> + <paragraph role="paragraph" id="par_id821613001057759">The method returns a <literal>Null</literal> object if an error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id431626178025633"> + <input>svc.CreateTextFile(filename: str, overwrite: bool = True, encoding: str = 'UTF-8'): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id901585322689715"><emph>filename</emph>: The name of the file to be created.</paragraph> + <paragraph role="paragraph" id="par_id501585322689209"><emph>overwrite</emph>: Boolean value that determines if <literal>filename</literal> can be overwritten (default = <literal>True</literal>).</paragraph> + <paragraph role="paragraph" id="par_id551585322689192"><emph>encoding</emph>: The character set to be used. The default encoding is "UTF-8".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id291585322689770">Dim myFile As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541585322689351">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51585322689982">Set myFile = FSO.CreateTextFile("C:\Temp\ThisFile.txt", Overwrite := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id291626217084462">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id251626217084848">myFile = fs.CreateTextFile(r"C:\Temp\ThisFile.txt", overwrite = True)</paragraph> + </pycode> + <note id="par_id141613001281573">To learn more about the names of character sets, visit <link href="https://www.iana.org/assignments/character-sets/character-sets.xhtml" name="Character Sets">IANA's Character Set</link> page. Beware that %PRODUCTNAME does not implement all existing character sets.</note> +</section> + +<section id="DeleteFile"> + <comment> DeleteFile -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id421584882040621"> + <bookmark_value>FileSystem service;DeleteFile</bookmark_value> + </bookmark> + <h2 id="hd_id191584882040749" localize="false">DeleteFile</h2> + <paragraph role="paragraph" id="par_id11584882040881">Deletes one or more files. Returns <literal>True</literal> if at least one file has been deleted or <literal>False</literal> if an error occurred.</paragraph> + <paragraph role="paragraph" id="par_id21612999775356">An error will also occur if the <literal>filename</literal> parameter uses wildcard characters and does not match any files.</paragraph> + <paragraph role="paragraph" id="par_id21613001848493">The files to be deleted must not be readonly.</paragraph> + <paragraph role="paragraph" id="par_id701612999808832">The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id11626178195995"> + <input>svc.DeleteFile(filename: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441584882040860"><emph>filename</emph>: It can be a <literal>FileName</literal> or a <literal>NamePattern</literal> indicating one or more files to be deleted.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id851626217167909">In the examples below only files are deleted, subfolders are not deleted.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id321584882040274">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id501584882040356">FSO.DeleteFile("C:\Temp\*.docx")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id41626217239069"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id491626217239297">fs.DeleteFile(r"C:\Temp\*.docx")</paragraph> + </pycode> +</section> + +<section id="DeleteFolder"> + <comment> DeleteFolder -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id91584882542710"> + <bookmark_value>FileSystem service;DeleteFolder</bookmark_value> + </bookmark> + <h2 id="hd_id151584882542309" localize="false">DeleteFolder</h2> + <paragraph role="paragraph" id="par_id11584882015881">Deletes one or more folders. Returns <literal>True</literal> if at least one folder has been deleted or <literal>False</literal> if an error occurred.</paragraph> + <paragraph role="paragraph" id="par_id21612999775346">An error will also occur if the <literal>foldername</literal> parameter uses wildcard characters and does not match any folders.</paragraph> + <paragraph role="paragraph" id="par_id21613001848853">The folders to be deleted must not be readonly.</paragraph> + <paragraph role="paragraph" id="par_id701612999808842">The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id61626178267917"> + <input>svc.DeleteFolder(foldername: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id451584882542247"><emph>foldername</emph>: It can be a <literal>FolderName</literal> or a <literal>NamePattern</literal> indicating one or more folders to be deleted.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id651626217314709">In the examples below only folders and their contents are deleted. Files in the parent folder "C:\Temp" are not deleted.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id751584882542695">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611584882542154">FSO.DeleteFolder("C:\Temp\*")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id441626217397570"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id371626217398060">fs.DeleteFolder(r"C:\Temp\*")</paragraph> + </pycode> +</section> + +<section id="ExtensionFolder"> + <comment> ExtensionFolder --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id91584882542365"> + <bookmark_value>FileSystem service;ExtensionFolder</bookmark_value> + </bookmark> + <h2 id="hd_id151584882542104" localize="false">ExtensionFolder</h2> + <paragraph role="paragraph" id="par_id11584882015025">Returns a string containing the folder where the specified extension package is installed.</paragraph> + <paragraph role="paragraph" id="par_id21612999775311">The current value of the property <literal>SF_FileSystem.FileNaming</literal> is used to determine the notation of the returned string.</paragraph> + <tip id="par_id891644442917193">Use the property <link href="text/sbasic/shared/03/sf_platform.xhp#hd_id711600788076834" name="Extensions_link"><literal>Extensions</literal></link> from the <literal>Platform</literal> service to get string array with the IDs of all installed extensions.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id61626178211365"> + <input>svc.ExtensionFolder(extension: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id451584882542121"><emph>extension</emph>: A string value with the ID of the extension. If the extension is not installed, an exception is raised.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id651626217313369">The examples below in Basic and Python return the folder where the APSO extension is installed.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id116444434113410">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751584882540355">sFolder = FSO.ExtensionFolder("apso.python.script.organizer")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611584882542269">' file:///home/username/.config/libreoffice/4/user/uno_packages/cache/uno_packages/lu10833wz3u2i.tmp_/apso_1_2_7.oxt</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id441626217397588"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id371626217398166">sFolder = fs.ExtensionFolder("apso.python.script.organizer")</paragraph> + </pycode> +</section> + +<section id="FileExists"> + <comment> FileExists --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id571583764426508"> + <bookmark_value>FileSystem service;FileExists</bookmark_value> + </bookmark> + <h2 id="hd_id39158376442641" localize="false">FileExists</h2> + <paragraph role="paragraph" id="par_id161583764426709">Returns <literal>True</literal> if a given file name is valid and exists, otherwise the method returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id91613003122613">If the <literal>filename</literal> parameter is actually an existing folder name, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id201626178344527"> + <input>svc.FileExists(filename: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id361583764426547"><emph>filename</emph>: A string representing the file to be tested.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id621583764787755">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821583764426197">If FSO.FileExists("C:\Documents\my_file.odt") Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191613003283635"> '...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891613003291580">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id551626270512839">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id411626270513159">if fs.FileExists(r"C:\Documents\my_file.odt"):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id591626270513425"> # ...</paragraph> + </pycode> +</section> + +<section id="Files"> + <comment> Files ------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id771583944327771"> + <bookmark_value>FileSystem service;Files</bookmark_value> + </bookmark> + <h2 id="hd_id461583944327647" localize="false">Files</h2> + <paragraph role="paragraph" id="par_id11158394432779">Returns a zero-based array of the files stored in a given folder. Each entry in the array is a string containing the full path and file name.</paragraph> + <paragraph role="paragraph" id="par_id641613003790120">If the argument <literal>foldername</literal> specifies a folder that does not exist, an exception is raised.</paragraph> + <paragraph role="paragraph" id="par_id821613003779799">The resulting list may be filtered with wildcards.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id211626178396995"> + <input>svc.Files(foldername: str, filter: str = ''): str[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id731583944543140"><emph>foldername</emph>: A string representing a folder. The folder must exist. This argument must not designate a file.</paragraph> + <paragraph role="paragraph" id="par_id591585648450060" xml-lang="en-US"><emph>filter</emph>: A string containing wildcards ("?" and "*") that will be applied to the resulting list of files (default = "").</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id381583944327923">Dim filesList As Variant, file As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581583944327968">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id451583944327508">filesList = FSO.Files("/home/user/", "*.txt")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id521583944732086">For Each file In filesList</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421583944743304"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721583944748672">Next file</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id811626270625785">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id761626270626093">filesList = fs.Files("/home/user/", "*.txt")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381626270626357">for file in fileList:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941626270626838"> # ...</paragraph> + </pycode> +</section> + +<section id="FolderExists"> + <comment> FolderExists -------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id11583765642643"> + <bookmark_value>FileSystem service;FolderExists</bookmark_value> + </bookmark> + <h2 id="hd_id421583765642360" localize="false">FolderExists</h2> + <paragraph role="paragraph" id="par_id51583765642590">Returns <literal>True</literal> if the specified <literal>FolderName</literal> is valid and exists, otherwise the method returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id151613004111990">If the <literal>foldername</literal> parameter is actually an existing file name, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id451626270785443"> + <input>svc.FolderExists(foldername: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id1001583765642211"><emph>foldername</emph>: A string representing the folder to be tested.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id301583765642138">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771583765642330">If FSO.FolderExists("C:\Documents\Thesis") Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21613004201438"> '...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id861613004206334">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761626270831628">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id531626270831916">if fs.FolderExists(r"C:\Documents\Thesis")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801626270832082"> # ...</paragraph> + </pycode> +</section> + +<section id="GetBaseName"> + <comment> GetBaseName ---------------------------------------------------------------------------------------</comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id54158411061866"> + <bookmark_value>FileSystem service;GetBaseName</bookmark_value> + </bookmark> + <h2 id="hd_id111584110618587" localize="false">GetBaseName</h2> + <paragraph role="paragraph" id="par_id521584110618989">Returns the <literal>BaseName</literal> (equal to the last component) of a folder or file name, without its extension.</paragraph> + <paragraph role="paragraph" id="par_id731613004316790">The method does not check if the specified file or folder exists.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id301626178954105"> + <input>svc.GetBaseName(filename: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id691584110618308"><emph>filename</emph>: A string representing the file name and its path.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id1001626271201609">In the examples below, the first <literal>GetBaseName</literal> method call corresponds to a folder, so the function returns the last component of the path. The second call receives a file name as input, so the name of the file is returned without its extension.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id201584110618266">MsgBox FSO.GetBaseName("/home/user/Documents") ' "Documents"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211584110618884">MsgBox FSO.GetBaseName("/home/user/Documents/my_file.ods") ' "my_file"</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id431626271314848">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id411626271315092">bas.MsgBox(fs.GetBaseName("/home/user/Documents")) # "Documents"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id821626271315317">bas.MsgBox(fs.GetBaseName("/home/user/Documents/my_file.ods")) # "my_file"</paragraph> + </pycode> +</section> + +<section id="GetExtension"> + <comment> GetExtension ------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id271584032680645"> + <bookmark_value>FileSystem service;GetExtension</bookmark_value> + </bookmark> + <h2 id="hd_id441584032680932" localize="false">GetExtension</h2> + <paragraph role="paragraph" id="par_id831584032680866">Returns the extension part of a file or folder name without the dot "." character.</paragraph> + <paragraph role="paragraph" id="par_id941613060736524">The method does not check for the existence of the specified file or folder.</paragraph> + <paragraph role="paragraph" id="par_id561613060896361">If this method is applied to a folder name or to a file without an extension, then an empty string is returned.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id481626179171535"> + <input>svc.GetExtension(filename: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821584032680311"><emph>filename</emph>: A string representing the file name and its path.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id241584032680600">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651584032680887">ext = FSO.GetExtension("C:\Windows\Notepad.exe") ' "exe"</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id391626271533012"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id751626271533408">ext = fs.GetExtension(r"C:\Windows\Notepad.exe") # "exe"</paragraph> + </pycode> +</section> + +<section id="GetFileLen"> + <comment> GetFileLen ----------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id511600685050691"> + <bookmark_value>FileSystem service;GetFileLen</bookmark_value> + </bookmark> + <h2 id="hd_id301600685050869" localize="false">GetFileLen</h2> + <paragraph role="paragraph" id="par_id48160068505010">The builtin <literal>FileLen</literal> Basic function returns the number of bytes contained in a file as a <literal>Long</literal> value, i.e. up to 2GB.</paragraph> + <paragraph role="paragraph" id="par_id571613061005426">The <literal>GetFileLen</literal> method can handle files with much larger sizes by returning a <literal>Currency</literal> value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id1001626179285915"> + <input>svc.GetFileLen(filename: str): num</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id161600685050367"><emph>filename</emph>: A string representing an existing file.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id901600685050677">Dim fLen As Currency</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721600685050519">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961600685050123">fLen = FSO.GetFileLen("C:\pagefile.sys")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id201626271668440">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361626271668899">fLen = fs.GetFileLen(r"C:\pagefile.sys")</paragraph> + </pycode> +</section> + +<section id="GetFileModified"> + <comment> GetFileModified -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id901584811478304"> + <bookmark_value>FileSystem service;GetFileModified</bookmark_value> + </bookmark> + <h2 id="hd_id651584811478113" localize="false">GetFileModified</h2> + <paragraph role="paragraph" id="par_id191584811478936">Returns the last modified date of a given file.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id491626179415178"> + <input>svc.GetFileModified(filename: str): datetime</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id25158481147822"><emph>filename</emph>: A string representing an existing file.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id911584811636241">Dim aDate As Date</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351584811478870">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id111584811478888">aDate = FSO.GetFileModified("C:\Documents\my_file.odt")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id531626271811921">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id301626271812468">aDate = FSO.GetFileModified(r"C:\Documents\my_file.odt")</paragraph> + </pycode> +</section> + +<section id="GetName"> + <comment> GetName -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id501584032366770"> + <bookmark_value>FileSystem service;GetName</bookmark_value> + </bookmark> + <h2 id="hd_id761584032366379" localize="false">GetName</h2> + <paragraph role="paragraph" id="par_id711584032366587">Returns the last component of a file or folder name in native operating system format.</paragraph> + <paragraph role="paragraph" id="par_id541613061300811">The method does not check if the specified file or folder exists.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id601626179529154"> + <input>svc.GetName(filename: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id671584032366193"><emph>filename</emph>: A string representing the file name and its path.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id731626271995119">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61158403236686">a = FSO.GetName("C:\Windows\Notepad.exe") ' Notepad.exe</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id91626272012883"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221626272013299">a = fs.GetName(r"C:\Windows\Notepad.exe") # Notepad.exe</paragraph> + </pycode> +</section> + +<section id="GetParentFolderName"> + <comment> GetParentFolderName -------------------------------------------------------------------------------</comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id211584113432829"> + <bookmark_value>FileSystem service;GetParentFolderName</bookmark_value> + </bookmark> + <h2 id="hd_id94158411343258" localize="false">GetParentFolderName</h2> + <paragraph role="paragraph" id="par_id871584113432747">Returns a string containing the name of the parent folder of a specified file or folder name.</paragraph> + <paragraph role="paragraph" id="par_id611613061603039">The method does not check if the specified file or folder exists.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id791626179605250"> + <input>svc.GetParentFolderName(filename: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id471584113432231"><emph>filename</emph>: A string with the file or folder name to be analyzed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id100158411343225">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id161584113432533">a = FSO.GetParentFolderName("C:\Windows\Notepad.exe") ' C:\Windows\</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id871626272152981"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id711626272153205">a = fs.GetParentFolderName(r"C:\Windows\Notepad.exe") # C:\Windows\</paragraph> + </pycode> +</section> + +<section id="GetTempName"> + <comment> GetTempName ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id621583851172862"> + <bookmark_value>FileSystem service;GetTempName</bookmark_value> + </bookmark> + <h2 id="hd_id981583851172348" localize="false">GetTempName</h2> + <paragraph role="paragraph" id="par_id82158385117289">Returns a randomly generated temporary file name that is useful for performing operations that require a temporary file.</paragraph> + <paragraph role="paragraph" id="par_id391613061770924">The returned file name does not have any suffix. The folder part of the returned string is the system's temporary folder.</paragraph> + <paragraph role="paragraph" id="par_id971613061774934">The method does not create the temporary file.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id81626212807031"> + <input>svc.GetTempName(): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41583851448294">Dim fName As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311583851172939">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381583851172545">fName = FSO.GetTempName() & ".txt"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381583851275546">' "/tmp/SF_574068.txt"</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id791626272322530">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121626272322966">fName = FSO.GetTempName() + ".txt"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id991626272323308"># "/tmp/SF_574068.txt"</paragraph> + </pycode> +</section> + +<section id="HashFile"> + <comment> HashFile -------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id771601042514294"> + <bookmark_value>FileSystem service;HashFile</bookmark_value> + </bookmark> + <h2 id="hd_id251601042514585" localize="false">HashFile</h2> + <paragraph role="paragraph" id="par_id58160104251423">Hash functions are used by some cryptographic algorithms, in digital signatures, message authentication codes, fraud detection, fingerprints, checksums (message integrity check), hash tables, password storage and much more.</paragraph> + <paragraph role="paragraph" id="par_id301601042791356" xml-lang="en-US">The <literal>HashFile</literal> method returns the result of a hash function, applied on a given file and using a specified algorithm. The returned value is a string of lower-case hexadecimal digits.</paragraph> + <paragraph role="paragraph" id="par_id861601043268484" xml-lang="en-US">The hash algorithms supported are: <literal>MD5</literal>, <literal>SHA1</literal>, <literal>SHA224</literal>, <literal>SHA256</literal>, <literal>SHA384</literal> and <literal>SHA512</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id311626212875189"> + <input>svc.HashFile(filename: str, algorithm: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id28160104251451"><emph>filename</emph>: A string representing an existing file.</paragraph> + <paragraph role="paragraph" id="par_id71601042959846" xml-lang="en-US"><emph>algorithm</emph>: One of the supported algorithms.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id1160104251483">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391601042514664">sHash = FSO.HashFile("C:\pagefile.sys", "MD5")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id161626272480577"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id221626272480829">sHash = FSO.HashFile(r"C:\pagefile.sys", "MD5")</paragraph> + </pycode> +</section> + +<section id="MoveFile"> + <comment> MoveFile -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41584791330923"> + <bookmark_value>FileSystem service;MoveFile</bookmark_value> + </bookmark> + <h2 id="hd_id321584791330580" localize="false">MoveFile</h2> + <paragraph role="paragraph" id="par_id51584791330688">Moves one or more files from one location to another. Returns <literal>True</literal> if at least one file has been moved or <literal>False</literal> if an error occurred.</paragraph> + <paragraph role="paragraph" id="par_id631613062890648">An error will also occur if the <literal>source</literal> parameter uses wildcard characters and does not match any files.</paragraph> + <paragraph role="paragraph" id="par_id241613062902777">The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id851626214194605"> + <input>svc.MoveFile(source: str, destination: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id721584791330406"><emph>source</emph>: It can be a <literal>FileName</literal> or <literal>NamePattern</literal> to designate one or more files to be moved.</paragraph> + <paragraph role="paragraph" id="par_id291584791330181" xml-lang="en-US"><emph>destination</emph>: If <literal>source</literal> is a <literal>FileName</literal> then this parameter indicates the new path and file name of the moved file.</paragraph> + <paragraph role="paragraph" id="par_id31613063334246">If the move operation involves multiple files, then <literal>destination</literal> must be a folder name. If it does not exist, it is created.</paragraph> + <paragraph role="paragraph" id="par_id391613063494599">If <literal>source</literal> and <literal>destination</literal> have the same parent folder, the method will rename the <literal>source</literal>.</paragraph> + <paragraph role="paragraph" id="par_id941613063476533">Wildcard characters are not allowed in <literal>destination</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id91626272612758">In the following examples only files are moved, subfolders are not.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id211584791330821">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881584791330102">FSO.MoveFile("C:\Temp1\*.*", "C:\Temp2")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731626272648304"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id501626272649065">fs.MoveFile(r"C:\Temp1\*.*", r"C:\Temp2")</paragraph> + </pycode> +</section> + +<section id="MoveFolder"> + <comment> MoveFolder --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141584791330310"> + <bookmark_value>FolderSystem service;MoveFolder</bookmark_value> + </bookmark> + <h2 id="hd_id221584791330200" localize="false">MoveFolder</h2> + <paragraph role="paragraph" id="par_id301584791330868">Moves one or more folders from one location to another. Returns <literal>True</literal> if at least one folder has been moved or <literal>False</literal> if an error occurred.</paragraph> + <paragraph role="paragraph" id="par_id411613072570664">An error will also occur if the <literal>source</literal> parameter uses wildcard characters and does not match any folders.</paragraph> + <paragraph role="paragraph" id="par_id601613072595264">The method stops immediately after it encounters an error. The method does not roll back nor does it undo changes made before the error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id181626214342806"> + <input>svc.MoveFolder(source: str, destination: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id541584791330777"><emph>source</emph>: It can be a <literal>FolderName</literal> or <literal>NamePattern</literal> to designate one or more folders to be moved.</paragraph> + <paragraph role="paragraph" id="par_id551584791330279" xml-lang="en-US"><emph>destination</emph>: If the move operation involves a single folder, then <literal>destination</literal> is the name and path of the moved folder and it must not exist.</paragraph> + <paragraph role="paragraph" id="par_id11613072890641">If multiple folders are being moved, then <literal>destination</literal> designates where the folders in <literal>source</literal> will be moved into. If <literal>destination</literal> does not exist, it is created.</paragraph> + <paragraph role="paragraph" id="par_id301613072928159">Wildcard characters are not allowed in <literal>destination</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id1001584791330720">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201584791330500">FSO.MoveFolder("C:\Temp1\*", "C:\Temp2")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id11626275697779"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361626275698068">fs.MoveFolder(r"C:\Temp1\*", r"C:\Temp2")</paragraph> + </pycode> +</section> + +<section id="OpenTextFile"> + <comment> OpenTextFile ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id531585320922937"> + <bookmark_value>FolderSystem service;OpenTextFile</bookmark_value> + </bookmark> + <h2 id="hd_id481585320922643" localize="false">OpenTextFile</h2> + <paragraph role="paragraph" id="par_id121585320922117">Opens a file and returns a <literal>TextStream</literal> object that can be used to read from, write to, or append to the file.</paragraph> + <paragraph role="paragraph" id="par_id591613073104711">Note that the method does not check if the given file is really a text file.</paragraph> + <paragraph role="paragraph" id="par_id951613073135036">The method returns a <literal>Null</literal> object (in Basic) or <literal>None</literal> (in Python) if an error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id21626214460569"> + <input>svc.OpenTextFile(filename: str, iomode: int = 1, create: bool = False, encoding: str = 'UTF-8'): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id551585320922678"><emph>filename</emph>: Identifies the file to open.</paragraph> + <paragraph role="paragraph" id="par_id671585320922388" xml-lang="en-US"><emph>iomode</emph>: Indicates the input/output mode. It can be one of three constants: <literal>svc.ForReading</literal> (default), <literal>svc.ForWriting</literal>, or <literal>svc.ForAppending</literal>.</paragraph> + <paragraph role="paragraph" id="par_id21585321398586" xml-lang="en-US"><emph>create</emph>: Boolean value that indicates whether a new file can be created if the specified <literal>filename</literal> doesn't exist:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id721613073434797" role="listitem">If <literal>True</literal> a new file and its parent folders will be created if they do not exist;</paragraph> + </listitem> + <listitem> + <paragraph id="par_id201613073469289" role="listitem">If <literal>False</literal> then new files are not created (default).</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id771585321576210" xml-lang="en-US"><emph>encoding</emph>: The character set to be used. The default encoding is "UTF-8".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id841585320922219">Dim myFile As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831585320922237">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id141585320922524">Set myFile = FSO.OpenTextFile("C:\Temp\ThisFile.txt", FSO.ForReading)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id341585321797611">If Not IsNull(myFile) Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261585321805705"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801613073013084">End If</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id971626275941924">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id271626275942194">myFile = fs.OpenTextFile(r"C:\Temp\ThisFile.txt", fs.ForReading)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id141626275942434">if myFile is not None:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id721626275942719"> # ...</paragraph> + </pycode> +</section> + +<section id="PickFile"> + <comment> PickFile --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id1001583670342501"> + <bookmark_value>FileSystem service;PickFile</bookmark_value> + </bookmark> + <h2 id="hd_id421583670342501" localize="false">PickFile</h2> + <paragraph role="paragraph" id="par_id871583670342501">Opens a dialog box to open or save files.</paragraph> + <paragraph role="paragraph" id="par_id881613074436979">If the <literal>SAVE</literal> mode is set and the picked file exists, a warning message will be displayed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id751626214688263"> + <input>svc.PickFile(defaultfile: str ='', mode: str = 'OPEN', filter: str = ''): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481583670342502"><emph>defaultfile</emph>: This argument is a string composed of a folder and file name:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id511613074665951" role="listitem">The folder part indicates the folder that will be shown when the dialog opens (default = the last selected folder).</paragraph> + </listitem> + <listitem> + <paragraph id="par_id631613074685308" role="listitem">The file part designates the default file to open or save.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id981583670342502"><emph>mode</emph>: A string value that can be either "OPEN" (for input files) or "SAVE" (for output files). The default value is "OPEN".</paragraph> + <paragraph role="paragraph" id="par_id31583670342502"><emph>filter</emph>: The extension of the files displayed when the dialog is opened (default = no filter).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id881626276134300">The examples below open a file picker with the "txt" filter applied.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id791626276255605">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691583670342504">aFile = FSO.PickFile("C:\Documents", "OPEN", "txt")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id681626276275531"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id701626276275757">aFile = fs.PickFile(r"C:\Documents", "OPEN", "txt")</paragraph> + </pycode> +</section> + +<section id="PickFolder"> + <comment> PickFolder ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id171583671701309"> + <bookmark_value>FileSystem service;PickFolder</bookmark_value> + </bookmark> + <h2 id="hd_id581583671701385" localize="false">PickFolder</h2> + <paragraph role="paragraph" id="par_id521583671701777">Opens a dialog box to select a folder.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id671626215115555"> + <input>svc.PickFolder(defaultfolder: str = '', freetext: str = ''): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id951583671701872"><emph>defaultfolder</emph>: A string containing the folder name that will be displayed when the dialog is opened (default = the last selected folder).</paragraph> + <paragraph role="paragraph" id="par_id821583671701764"><emph>freetext</emph>: Text to display in the dialog (default = "").</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id391583764844033">' Basic</paragraph> + <paragraph role="bascode" id="bas_id921583671701610">aFolder = FSO.PickFolder("C:\Documents", "Choose a folder or press Cancel")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id291626276402041"># Python</paragraph> + <paragraph role="pycode" id="pyc_id631626276402296">aFolder = fs.PickFolder(r"C:\Documents", "Choose a folder or press Cancel")</paragraph> + </pycode> +</section> + +<section id="SubFolders"> + <comment> SubFolders ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id901584016761417"> + <bookmark_value>FileSystem service;Files</bookmark_value> + </bookmark> + <h2 id="hd_id51584016761775" localize="false">SubFolders</h2> + <paragraph role="paragraph" id="par_id431584016761996">Returns a zero-based array of strings corresponding to the folders stored in a given <literal>foldername</literal>.</paragraph> + <paragraph role="paragraph" id="par_id431613075267241">The list may be filtered with wildcards.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id531626215218570"> + <input>svc.SubFolders(foldername: str, filter: str = ''): str[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id701584016761945"><emph>foldername</emph>: A string representing a folder. The folder must exist. <literal>foldername</literal> must not designate a file.</paragraph> + <paragraph role="paragraph" id="par_id471585648674921" xml-lang="en-US"><emph>filter</emph>: A string containing wildcards ("?" and "*") that will be applied to the resulting list of folders (default = "").</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id541584016761911">Dim folderList As Variant, folder As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391584016761116">FSO.FileNaming = "SYS"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701584016761482">folderList = FSO.SubFolders("/home/user/")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631584016761643">For Each folder In folderList</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871584016761279"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881584016761778">Next folder</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id891626276476767">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id131626276476995">folderList = fs.SubFolders("/home/user/")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id661626276477186">for folder in folderList:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id891626276477415"> # ...</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_textstream.xhp#TextStreamService"/> + <embed href="text/sbasic/shared/03160000.xhp#Input_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_form.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_form.xhp new file mode 100644 index 000000000..d9515a222 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_form.xhp @@ -0,0 +1,841 @@ +<?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_Form" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDocuments.Form service</title> + <filename>/text/sbasic/shared/03/sf_form.xhp</filename> + </topic> + </meta> +<body> +<section id="ScriptForge-sf_form"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41582391760252"> + <bookmark_value>Form service</bookmark_value> + </bookmark> +</section> +<section id="abstract"> + <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="FormService"><link href="text/sbasic/shared/03/sf_form.xhp" name="SFDocuments.Form"><literal>SFDocuments</literal>.<literal>Form</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The <literal>Form</literal> service provides methods and properties to manage forms in %PRODUCTNAME documents. This service supports forms in Base, Calc and Writer documents and allows to:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id381618172063851" role="listitem">Open and activate forms.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id261618172129782" role="listitem">Navigate through records shown by the form.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id281618172141607" role="listitem">Get access to the controls inside the form.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id371618172155483" role="listitem">Get access to subforms of a parent form.</paragraph> + </listitem> + </list> +</section> + <tip id="par_id351616768789190" xml-lang="en-US">The <literal>SFDocuments</literal>.<literal>Form</literal> service is available from %PRODUCTNAME 7.2 onwards.</tip> + <paragraph role="paragraph" id="par_id451616765867881" xml-lang="en-US">Forms are usually used in %PRODUCTNAME documents to create user interfaces connected to relational databases. Hence, the <literal>Form</literal> service provides quick access to the linked database through the <link href="text/sbasic/shared/03/sf_database.xhp" name="SFDatabases.Database"><literal>SFDatabases</literal>.<literal>Database</literal> service</link>.</paragraph> + <tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDocuments</literal>.<literal>Form</literal> service is closely related to the <link href="text/sbasic/shared/03/sf_formcontrol.xhp" name="SFDocuments.FormControl"><literal>SFDocuments</literal>.<literal>FormControl</literal> service.</link></tip> + <h2 id="hd_id161616766330804" xml-lang="en-US">Definitions</h2> + <h3 id="hd_id751616766382317" xml-lang="en-US" localize="false">FormDocument</h3> + <paragraph role="paragraph" id="par_id951618172906010">Forms are usually created in Base documents, but they can be added to Writer and Calc documents as well.</paragraph> + <paragraph role="paragraph" id="par_id671618173380680">In Base, each form you create using the <menuitem>Insert - Form</menuitem> functionality or through the <link href="text/shared/autopi/01090000.xhp" name="FormWizard">Form Wizard</link> is actually a <literal>FormDocument</literal> that can be handled with the <literal>Form</literal> service. Base documents can contain an unlimited number of form documents.</paragraph> + <paragraph role="paragraph" id="par_id841618177362626">Below is an example showing the hierarchy of all the elements involved in accessing forms and subforms in a Base document. Suppose you have a Base file named <literal>Employees.odb</literal> and inside it you created a form document to add new employees to the database. The form document contains a main form named <literal>EmployeeData</literal> that gives access to a table. There is also a subform <literal>WorksAtPlant</literal> that allows you to associate the new employee to one of the plants of the company.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id151618176848874">Employees.odb (Base document)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381618176868013"> |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351618176868854"> |-- AddEmployee (FormDocument)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211618176869166"> |</paragraph> + <paragraph role="bascode" id="bas_id941618176869485"> |-- EmployeeData (Main Form)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571618176869726"> |</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291618176869942"> |-- WorksAtPlant (SubForm)</paragraph> + </bascode> + <note id="par_id221618173444457">A <literal>FormDocument</literal> can be seen as a set of forms that provide access to datasets such as database tables and queries from within %PRODUCTNAME documents. The names of forms and subforms inside a FormDocument can be accessed using the <link href="text/shared/02/01170600.xhp" name="FormNavigator">Form Navigator</link>.</note> + <h3 id="hd_id851616767037521" xml-lang="en-US">Forms and Subforms</h3> + <paragraph role="paragraph" id="par_id681616767265034" xml-lang="en-US">A form document is composed of one or more forms which, in turn, may also contain any number of subforms. A Form is an abstract set of controls that are linked to a specified data source, which can be a database table, a query or a SQL <literal>SELECT</literal> statement.</paragraph> + <paragraph role="paragraph" id="par_id711618178831976">In Calc and Writer documents, each form can be linked to datasets located in different databases. On the other hand, in Base documents the database contained in the document is common to all forms.</paragraph> + <tip id="par_id191616837111507" xml-lang="en-US">To invoke the <literal>SFDocuments</literal>.<literal>Form</literal> service refer to the methods <literal>Forms()</literal>, <literal>FormDocuments()</literal> and <literal>OpenFormDocument()</literal> of the <link href="text/sbasic/shared/03/sf_document.xhp" name="SFDocuments"><literal>SFDocuments</literal>.<literal>Document</literal></link> service</tip> +<section id="serviceInvocation"> + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Form</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <h3 id="hd_id991618179698545">In Writer documents</h3> + <paragraph role="paragraph" id="par_id51616767892693" xml-lang="en-US">The code snippet below shows how to access the form named <literal>Form1</literal> that is inside a Writer file:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id471598171198389">Dim oDoc As Object, myForm As Object, ui as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561618179461775">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611598171572062">Set oDoc = ui.OpenDocument("/home/user/Documents/MyForm.odt")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571598171205739">Set myForm = oDoc.Forms("Form1")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id241622014444493">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391622014212514">ui = CreateScriptService('UI') </paragraph> + <paragraph role="pycode" localize="false" id="pyc_id891622014222625">doc = ui.OpenDocument('/home/user/Documents/MyForm.odt')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id931622014224129">my_form = doc.Forms('Form1')</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id531618179517628">Forms can be accessed by their names or by their indices, as shown below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id991598171277414">Set myForm = oDoc.Forms(0)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <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> + <paragraph role="paragraph" id="par_id481618179851104">A form in a Calc file must have a unique name inside its sheet. Hence, the <literal>Forms</literal> method requires two arguments, the first indicating the sheet name and the second specifying the form name.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id471598171198125">Dim oDoc As Object, myForm As Object, ui as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561618179462475">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611598170362062">Set oDoc = ui.OpenDocument("/home/user/Documents/MyForms.ods")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571598171200339">Set myForm = oDoc.Forms("Sheet1", "Form1")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id51622028165429">This is achieved identically using Python:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id871622021672708">ui = CreateScriptService('UI')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id671622021672931">doc = ui.OpenDocument('/home/user/Documents/MyForms.ods')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id301622021673180">my_form = doc.Forms('Sheet1', 'Form1')</paragraph> + </pycode> + <h3 id="hd_id201618180055756">In Base documents</h3> + <paragraph role="paragraph" id="par_id711616768164987" xml-lang="en-US">A <literal>FormDocument</literal> inside a Base document is accessed by its name. The following example opens the form document named <literal>thisFormDocument</literal> and accesses the form <literal>MainForm</literal>:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id471598176518738">Dim oDb As Object, myForm As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271598171282891">Set oDb = CreateScriptService("SFDocuments.Document", ThisDatabaseDocument)</paragraph> + <paragraph role="bascode" id="bas_id271598171225874">' The statement below is necessary only if the form hasn't been opened yet</paragraph> + <paragraph role="bascode" localize="false" id="bas_id551598171288547">oDb.OpenFormDocument("thisFormDocument")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741598171294507">Set myForm = oDoc.Forms("thisFormDocument", "MainForm")</paragraph> + <paragraph role="bascode" id="bas_id51616768358888">' Or, alternatively, to access the form by its index ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591598171300285">Set myForm = oDb.Forms("thisFormDocument", 0)</paragraph> + </bascode> + <note id="par_id991618249636036">To perform any action on a form using the <literal>Form</literal> service, the <literal>FormDocument</literal> must have been opened either manually by the user or programmatically in a user script. The latter can be done by calling the <literal>OpenFormDocument</literal> method of the <link href="text/sbasic/shared/03/sf_base.xhp" name="ScriptForge Base Service"><literal>Base</literal> service</link>.</note> + <paragraph role="paragraph" id="par_id11618180564274">To access a given subform of a form use the <literal>SubForms</literal> method. Note that in the example below <literal>mySubForm</literal> is a new instance of the <literal>Form</literal> service.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id71618182658792">Dim mySubForm As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681616768495330">Set mySubForm = myForm.SubForms("mySubForm")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id681622028653480">Previous examples translate in Python as:</paragraph> + <pycode> + <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" 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" 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> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id931616768628138">Sub OnEvent(ByRef poEvent As Object)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931616768621093"> Dim myForm As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271616768613253"> Set myForm = CreateScriptService("SFDocuments.FormEvent", poEvent)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001618180405172"> '(...)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751618180415566">End sub</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <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() ' Basic</paragraph> + </bascode> + <pycode> + <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> + <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> + <table id="tab_id381583668386455"> + <tablerow> + <tablecell> + <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491583668386455" role="tablehead" xml-lang="en-US">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668474014" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401583668386455" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151583668386455" role="tablecontent" localize="false">AllowDeletes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371583668519172" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668386455" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Specifies if the form allows to delete records.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951583839708571" role="tablecontent" localize="false">AllowInserts</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541583839708548" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751583839708362" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Specifies if the form allows to add records.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id511584027709311" role="tablecontent" localize="false">AllowUpdates</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761584027709516" role="tablecontent " xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491584027709825" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">Specifies if the form allows to update records.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491583839767611" role="tablecontent" localize="false">BaseForm</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31583839767743" role="tablecontent " xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741583839767926" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Specifies the hierarchical name of the Base Form containing the actual form.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id83158383992056" role="tablecontent" localize="false">Bookmark</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583839920487" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971583839920282" role="tablecontent" localize="false">Variant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451583839920858" role="tablecontent" xml-lang="en-US">Specifies uniquely the current record of the form's underlying table, query or SQL statement.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id751588333908795" role="tablecontent" localize="false">CurrentRecord</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571588333908716" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781588333908500" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">Identifies the current record in the dataset being viewed on a form. If the row number is positive, the cursor moves to the given row number with respect to the beginning of the result set. Row count starts at 1. If the given row number is negative, the cursor moves to an absolute row position with respect to the end of the result set. Row -1 refers to the last row in the result set.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id251583774433989" role="tablecontent" localize="false">Filter</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501583774433513" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411583774433779" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id151598177605296" xml-lang="en-US">Specifies a subset of records to be displayed as a <literal>SQL</literal> <literal>WHERE</literal>-clause without the <literal>WHERE</literal> keyword.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731588334016220" role="tablecontent" localize="false">LinkChildFields</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271588334016191" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991588334016273" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Specifies how records in a child subform are linked to records in its parent form.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id881616774153888" role="tablecontent" localize="false">LinkParentFields</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id901616774153495" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981616774153884" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981616774153723" role="tablecontent" xml-lang="en-US">Specifies how records in a child subform are linked to records in its parent form.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id561616774304843" role="tablecontent" localize="false">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501616774304840" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71616774304482" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461616774304497" role="tablecontent" xml-lang="en-US">The name of the current form.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id331616774384380" role="tablecontent" localize="false">OrderBy</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751616774384451" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id641616774384366" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321616774384489" role="tablecontent" xml-lang="en-US">Specifies in which order the records should be displayed as a <literal>SQL</literal> <literal>ORDER BY</literal> clause without the <literal>ORDER BY</literal> keywords.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id281616774918384" role="tablecontent" localize="false">Parent</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261616774918923" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861616774918694" role="tablecontent" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id171616774918881" role="tablecontent" xml-lang="en-US">The parent of the current form. It can be either a <literal>SFDocuments</literal>.<literal>Form</literal> or a <literal>SFDocuments</literal>.<literal>Document</literal> object.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id581616777650809" role="tablecontent" localize="false">RecordSource</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501616777650751" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991616777650362" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91616777650933" role="tablecontent" xml-lang="en-US">Specifies the source of the data, as a table name, a query name or a SQL statement.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id741598177924441" role="tablecontent" localize="false">XForm</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451598177924437" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id94159817792441" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing interactions with the form. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form_1_1XForm.html" name="XForm interface">XForm</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1form_1_1component_1_1DataForm.html" name="DataForm service">DataForm</link> in the API documentation for detailed information.</paragraph> + </tablecell> + </tablerow> + </table> + <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2> + <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">The properties below return or set URI strings that define the script triggered by the event.</paragraph> + <table id="tab_id951612628879819"> + <tablerow> + <tablecell> + <paragraph id="par_id961612628879819" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401612628879819" role="tablehead" xml-lang="en-US">ReadOnly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id281612628879819" role="tablehead" xml-lang="en-US">Basic IDE Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431612629836735" localize="false" role="tablecontent" xml-lang="en-US">OnApproveCursorMove</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111612629836630" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001612629836902" role="tablecontent" xml-lang="en-US">Before record change</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id701612629836389" localize="false" role="tablecontent" xml-lang="en-US">OnApproveParameter</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291612629836294" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id62161262983683" role="tablecontent" xml-lang="en-US">Fill parameters</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241612629836863" localize="false" role="tablecontent" xml-lang="en-US">OnApproveReset</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81612629836634" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881612629836744" role="tablecontent" xml-lang="en-US">Prior to reset</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id201612629836996" localize="false" role="tablecontent" xml-lang="en-US">OnApproveRowChange</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591612629836830" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161612629836775" role="tablecontent" xml-lang="en-US">Before record action</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id111612629836950" localize="false" role="tablecontent" xml-lang="en-US">OnApproveSubmit</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891612629836630" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461612629836679" role="tablecontent" xml-lang="en-US">Before submitting</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id711612629836495" localize="false" role="tablecontent" xml-lang="en-US">OnConfirmDelete</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131612629836291" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151612629836151" role="tablecontent" xml-lang="en-US">Confirm deletion</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id971612629836286" localize="false" role="tablecontent" xml-lang="en-US">OnCursorMoved</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211612629836725" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id361612629836624" role="tablecontent" xml-lang="en-US">After record change</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721612629836537" localize="false" role="tablecontent" xml-lang="en-US">OnErrorOccurred</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311612629836481" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721612629836752" role="tablecontent" xml-lang="en-US">Error occurred</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id55161262983695" localize="false" role="tablecontent" xml-lang="en-US">OnLoaded</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981612629836116" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381612629836635" role="tablecontent" xml-lang="en-US">When loading</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id621612629836155" localize="false" role="tablecontent" xml-lang="en-US">OnReloaded</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711612629836704" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id35161262983642" role="tablecontent" xml-lang="en-US">When reloading</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id541616778783953" localize="false" role="tablecontent" xml-lang="en-US">OnReloading</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id44161677878329" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661616778783899" role="tablecontent" xml-lang="en-US">Before reloading</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id961616778529182" localize="false" role="tablecontent" xml-lang="en-US">OnResetted</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651616778529764" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311616778529570" role="tablecontent" xml-lang="en-US">After resetting</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id171616778529918" localize="false" role="tablecontent" xml-lang="en-US">OnRowChanged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601616778529481" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351616778529352" role="tablecontent" xml-lang="en-US">After record action</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id91616778529622" localize="false" role="tablecontent" xml-lang="en-US">OnUnloaded</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711616778529292" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981616778529250" role="tablecontent" xml-lang="en-US">When unloading</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id71616778529970" localize="false" role="tablecontent" xml-lang="en-US">OnUnloading</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521616778529932" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id511616778529291" role="tablecontent" xml-lang="en-US">Before unloading</paragraph> + </tablecell> + </tablerow> + </table> + <tip id="par_id961618181634322">To learn more about URI strings, refer to the <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification" name="URI specification">Scripting Framework URI Specification</link>.</tip> + <table id="tab_id891606472825856"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id921606472825856" role="tablehead">List of methods in the Form service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_form.xhp#Activate" name="Activate method">Activate</link><br/> + <link href="text/sbasic/shared/03/sf_form.xhp#CloseFormDocument" name="CloseFormDocument method">CloseFormDocument</link><br/> + <link href="text/sbasic/shared/03/sf_form.xhp#Controls" name="Controls method">Controls</link><br/> + <link href="text/sbasic/shared/03/sf_form.xhp#GetDatabase" name="GetDatabase method">GetDatabase</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id451606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_form.xhp#MoveFirst" name="MoveFirst method">MoveFirst</link><br/> + <link href="text/sbasic/shared/03/sf_form.xhp#MoveLast" name="MoveLast method">MoveLast</link><br/> + <link href="text/sbasic/shared/03/sf_form.xhp#MoveNext" name="MoveNext method">MoveNext</link><br/> + <link href="text/sbasic/shared/03/sf_form.xhp#MoveNew" name="MoveNew method">MoveNew</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_form.xhp#MovePrevious" name="MovePrevious method">MovePrevious</link><br/> + <link href="text/sbasic/shared/03/sf_form.xhp#Requery" name="Requery method">Requery</link><br/> + <link href="text/sbasic/shared/03/sf_form.xhp#Subforms" name="Subforms method">SubForms</link><br/><br/> + </paragraph></tablecell> + </tablerow> + </table> +<section id="Activate"> + <comment> Activate -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721583933076548"> + <bookmark_value>Form service;Activate</bookmark_value> + </bookmark> + <h2 id="hd_id681583933076692" localize="false">Activate</h2> + <paragraph role="paragraph" id="par_id871583933076448">Sets the focus on the current <literal>Form</literal> instance. Returns <literal>True</literal> if focusing was successful.</paragraph> + <paragraph role="paragraph" id="par_id81616858956290" xml-lang="en-US">The behavior of the <literal>Activate</literal> method depends on the type of document where the form is located:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id761616858967361" role="listitem" xml-lang="en-US"><emph>In Writer documents:</emph> Sets the focus on that document.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id931616859010103" role="listitem" xml-lang="en-US"><emph>In Calc documents:</emph> Sets the focus on the sheet to which the form belongs.</paragraph> + </listitem> + <listitem> + <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> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id11622536171845" localize="false"><input>svc.Activate(): bool</input></paragraph> + <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> + <paragraph role="bascode" localize="false" id="bas_id421618228118346">Dim oDoc as Object, myForm as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261618228156375">Set oDoc = CreateScriptService("Document", ThisComponent)</paragraph> + <paragraph role="paragraph" localize="false" id="par_id451618228193979">Set myForm = oDoc.Forms("Sheet1", "FormA")</paragraph> + <paragraph role="bascode" id="bas_id201618228487565">'Activates the form</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361598179135096">myForm.Activate()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <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> +<section id="CloseFormDocument"> + <comment> CloseFormDocument -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id14161686043795"> + <bookmark_value>Form service;CloseFormDocument</bookmark_value> + </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> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id811622538068303" localize="false"><input>svc.CloseFormDocument(): bool</input></paragraph> + <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" 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> +<section id="Controls"> + <comment> Controls -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41584541257826"> + <bookmark_value>Form service;Controls</bookmark_value> + </bookmark> + <h2 id="hd_id95158454125767" localize="false">Controls</h2> + <paragraph role="paragraph" id="par_id161584541257982">The value returned by the <literal>Controls</literal> method depends on the arguments provided:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id421598179770993" role="listitem" xml-lang="en-US">If the method is called <emph>without arguments</emph>, then it returns the list of the controls contained in the form. Beware that the returned list does not contain any subform controls.</paragraph> + </listitem> + <listitem> + <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> + <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> + <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> + <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> + <paragraph role="bascode" localize="false" id="bas_id641598185489492">myList = myform.Controls()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921598185495193">Set myControl = myform.Controls("myTextBox") ' SFDocuments.FormControl</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <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"> + <comment> GetDatabase -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id941616861134691"> + <bookmark_value>Form service;GetDatabase</bookmark_value> + </bookmark> + <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> + <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> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id701616861134906"><emph>user, password</emph>: The login optional parameters (Default = "").</paragraph> + <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" localize="false" id="pyc_id871622547824003">db = form.GetDatabase() # SFDatabases.Database</paragraph> + </pycode> +</section> +<section id="MoveFirst"> + <comment> MoveFirst -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id671616861787529"> + <bookmark_value>Form service;MoveFirst</bookmark_value> + </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> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id101622549004980" localize="false"><input>svc.MoveFirst(): bool</input></paragraph> + <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" localize="false" id="pyc_id421622549258920">form.MoveFirst() # Python</paragraph> + </pycode> +</section> +<section id="MoveLast"> + <comment> MoveLast -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id551616863143388"> + <bookmark_value>Form service;MoveLast</bookmark_value> + </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> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id931622549019307" localize="false"><input>svc.MoveLast(): bool</input></paragraph> + <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" localize="false" id="pyc_id831622549604397">form.MoveLast() # Python</paragraph> + </pycode> +</section> +<section id="MoveNew"> + <comment> MoveNew -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231616863143638"> + <bookmark_value>Form service;MoveNew</bookmark_value> + </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> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id131622549039501" localize="false"><input>svc.MoveNew(): bool</input></paragraph> + <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" localize="false" id="pyc_id381622549678558">form.MoveNew() # Python</paragraph> + </pycode> +</section> +<section id="MoveNext"> + <comment> MoveNext -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id171616863143921"> + <bookmark_value>Form service;MoveNext</bookmark_value> + </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> + <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> + <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> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id591616863143862">myForm.MoveNext() ' Basic</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id361622549859524">form.MoveNext() # Python</paragraph> + </pycode> +</section> +<section id="MovePrevious"> + <comment> MovePrevious -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id71161686379488"> + <bookmark_value>Form service;MovePrevious</bookmark_value> + </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> + <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> + <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> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id941616863794988">myForm.MovePrevious() ' Basic</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id221622549920933">form.MovePrevious() # Python</paragraph> + </pycode> +</section> +<section id="Requery"> + <comment> Requery -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id741616864216894"> + <bookmark_value>Form service;Requery</bookmark_value> + </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> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id731622550132517"><input>svc.Requery(): bool</input></paragraph> + <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" localize="false" id="pyc_id401622550186725">form.Requery() # Python</paragraph> + </pycode> +</section> +<section id="Subforms"> + <comment> Subforms -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id441616864510542"> + <bookmark_value>Form service;Subforms</bookmark_value> + </bookmark> + <h2 id="hd_id241616864510145" localize="false">Subforms</h2> + <paragraph role="paragraph" id="par_id891616864510614">The value returned by the <literal>Subforms</literal> method depends on the arguments provided:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id951616864510585" role="listitem" xml-lang="en-US">If the method is called <emph>without any arguments</emph>, then it returns the list of subforms contained in the current form or subform instance.</paragraph> + </listitem> + <listitem> + <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> + <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> + <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> + <paragraph role="bascode" localize="false" id="bas_id951616864510420">Set mySubform = myForm.Subforms("mySubform") ' SFDocuments.Form</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id101622552303831">subform_names = form.Subforms()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id781622552304561">subform = form.Subforms('mySubform') # SFDocuments.Form</paragraph> + </pycode> +</section> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_database.xhp#DatabaseService"/> + <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> + <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> + </section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_formcontrol.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_formcontrol.xhp new file mode 100644 index 000000000..4bcfaf687 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_formcontrol.xhp @@ -0,0 +1,1173 @@ +<?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_FormControl" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDocuments.FormControl service</title> + <filename>/text/sbasic/shared/03/sf_formcontrol.xhp</filename> + </topic> + </meta> +<body> +<section id="ScriptForge-sf_formcontrol"> + <bookmark localize="false" branch="index" id="bm_id41582391760252"> + <bookmark_value>FormControl service</bookmark_value> + </bookmark> +</section> +<section id="abstract"> + <h1 id="bm_id781582391760253" xml-lang="en-US"><variable id="FormControlService"><link href="text/sbasic/shared/03/sf_formcontrol.xhp" name="SFDocuments.FormControl service"><literal>SFDocuments</literal>.<literal>FormControl</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id931583589764919" xml-lang="en-US">The <literal>FormControl</literal> service provides access to the controls that belong to a form, a subform or a table control of a <literal>FormDocument</literal>. Each instance of the <literal>FormControl</literal> service refers to a single control in the form. This service allows users to:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id451618771561326" role="listitem">Get and set the properties of the control represented by the <literal>FormControl</literal> instance.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id601618771565183" role="listitem">Access the current value displayed by the control.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id981618771567951" role="listitem">Set the focus on the desired control.</paragraph> + </listitem> + </list> +</section> + <paragraph role="paragraph" id="par_id301616939922857" xml-lang="en-US">To use the <literal>FormControl</literal> service in a particular form, subform or table control, all controls must have unique names.</paragraph> + <warning id="par_id541618771629112">Radio buttons that share the same group name must also have unique control names.</warning> + <paragraph role="paragraph" id="par_id51618771641273">The main purpose of the <literal>FormControl</literal> service is setting and getting the properties and values displayed by the controls in a form.</paragraph> + <paragraph role="paragraph" id="par_id81618774023346">All controls have a <literal>Value</literal> property. However, its contents will vary according to the control type. For more information, read <link href="text/sbasic/shared/03/sf_formcontrol.xhp#hd_id81598540704978" name="Value property">The <literal>Value</literal> Property</link> below.</paragraph> + <paragraph role="paragraph" id="par_id881618771651907">It is also possible to format the controls via the <literal>XControlModel</literal> and <literal>XControlView</literal> properties.</paragraph> + <tip id="par_id891598188164936" xml-lang="en-US">The <literal>SFDocuments.FormControl</literal> service is closely related to the <link href="text/sbasic/shared/03/sf_form.xhp" name="Form service"><literal>SFDocuments.Form</literal></link> service.</tip> + <bookmark xml-lang="en-US" branch="index" id="bm_id331612167249331" localize="false"> + <bookmark_value>API;awt.XControl</bookmark_value> + <bookmark_value>API;awt.XControlModel</bookmark_value> + </bookmark> + + <h2 id="hd_id581582885621841" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>FormControl</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id361598174756160" xml-lang="en-US">The <literal>FormControl</literal> service is invoked from an existing <literal>Form</literal> service instance through its <literal>Controls</literal> method.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id791598453192421">Dim oDoc as Object, myForm As Object, myControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351618773083772">Set oDoc = CreateScriptService("SFDocuments.Document", ThisDataBaseDocument)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251598453197473">Set myForm = oDoc.Forms("formDocumentName", "formName") ' SFDocuments.Form</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421598453203458">Set myControl = myForm.Controls("myTextBox") ' SFDocuments.FormControl</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581598453210170">myControl.Value = "Current time = " & Now()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="paragraph" localize="false" id="par_id51622556288409">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id301622557445074">from time import localtime, strftime</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id621623152215419">bas = CreateScriptService('ScriptForge.Basic')</paragraph> + <paragraph role="paragraph" localize="false" id="par_id851622556289184">doc = CreateScriptService('SFDocuments.Document', bas.ThisDatabaseDocument)</paragraph> + <paragraph role="paragraph" localize="false" id="par_id981622556289672">form = doc.Forms('formDocumentName', 'formName') # SFDocuments.Form</paragraph> + <paragraph role="paragraph" localize="false" id="par_id291622556290144">control = form.Controls('myTextBox') # SFDocuments.FormControl</paragraph> + <paragraph role="pycode" id="pyc_id721622556808773">control.Value = 'Current Time = ' + strftime("%a, %d %b %Y %H:%M:%S", localtime())</paragraph> + </pycode> + <tip id="par_id781618772761258">To learn more about how to open a <literal>FormDocument</literal> and get access to its forms, refer to the <link href="text/sbasic/shared/03/sf_form.xhp" name="Form service">SFDocuments.Form</link> service help page.</tip> + <paragraph role="paragraph" id="par_id951598174966322" xml-lang="en-US">Alternatively a <literal>FormControl</literal> instance can be retrieved via the <literal>SFDocuments.FormEvent</literal> service, which returns the <literal>SFDocuments.FormControl</literal> class instance that triggered the event.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id311598175259794">Sub OnEvent(ByRef poEvent As Object)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781598175253859"> Dim oControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921598175248581"> Set oControl = CreateScriptService("SFDocuments.FormEvent", poEvent)</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="bas_id801598175242937"> ' oControl now represents the instance of the FormControl class that triggered the current event</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711598175146308"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421598175139021">End Sub</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id521622558177865">def onEvent(event: uno):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841622558178345"> control = CreateScriptService('SfDocuments.FormEvent', event)</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id251598176312571" xml-lang="en-US">Note that in previous examples, the prefix <literal>"SFDocuments."</literal> may be omitted.</paragraph> + <bookmark xml-lang="en-US" branch="index" id="bm_id541618773673421" localize="false"> + <bookmark_value>FormEvent service</bookmark_value> + </bookmark> + <section id="FormEvent_Note"> + <note id="par_id951618773412097">The <literal>FormEvent</literal> service is used exclusively to create instances of the <literal>SFDocuments.Form</literal> and <literal>SFDocuments.FormControl</literal> services when a form or control event takes place.</note> + </section> + <h2 id="hd_id71598455687512" xml-lang="en-US">Control types</h2> + <paragraph role="paragraph" id="par_id851598455863395" xml-lang="en-US">The <literal>FormControl</literal> service is available for the following control types:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id121598455880500" localize="false" role="listitem">Button</paragraph> + </listitem> + <listitem> + <paragraph id="par_id441598455934376" localize="false" role="listitem">CheckBox</paragraph> + </listitem> + <listitem> + <paragraph id="par_id471598455940400" localize="false" role="listitem">ComboBox</paragraph> + </listitem> + <listitem> + <paragraph id="par_id181598455945642" localize="false" role="listitem">CurrencyField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id181598455949653" localize="false" role="listitem">DateField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id541598455953714" localize="false" role="listitem">FileControl</paragraph> + </listitem> + <listitem> + <paragraph id="par_id971598455961404" localize="false" role="listitem">FixedText</paragraph> + </listitem> + <listitem> + <paragraph id="par_id721598455965612" localize="false" role="listitem">FormattedField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id291598455969826" localize="false" role="listitem">GroupBox</paragraph> + </listitem> + <listitem> + <paragraph id="par_id111616941115924" localize="false" role="listitem">HiddenControl</paragraph> + </listitem> + <listitem> + <paragraph id="par_id101616941115596" localize="false" role="listitem">ImageButton</paragraph> + </listitem> + <listitem> + <paragraph id="par_id861598455974724" localize="false" role="listitem">ImageControl</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851598455979572" localize="false" role="listitem">ListBox</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851616941210356" localize="false" role="listitem">NavigationBar</paragraph> + </listitem> + <listitem> + <paragraph id="par_id321598455984243" localize="false" role="listitem">NumericField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id981598455990524" localize="false" role="listitem">PatternField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id281598456002561" localize="false" role="listitem">RadioButton</paragraph> + </listitem> + <listitem> + <paragraph id="par_id91598456007438" localize="false" role="listitem">ScrollBar</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851616941293261" localize="false" role="listitem">SpinButton</paragraph> + </listitem> + <listitem> + <paragraph id="par_id241616941333335" localize="false" role="listitem">TableControl</paragraph> + </listitem> + <listitem> + <paragraph id="par_id271598456011504" localize="false" role="listitem">TextField</paragraph> + </listitem> + <listitem> + <paragraph id="par_id661598456015339" localize="false" role="listitem">TimeField</paragraph> + </listitem> + </list> + <h2 id="hd_id651583668365757" xml-lang="en-US">Properties</h2> + <table id="tab_id381583668386455"> + <tablerow> + <tablecell> + <paragraph id="par_id871583668386455" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491583668386455" role="tablehead" xml-lang="en-US">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668474014" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291598538799794" role="tablehead" xml-lang="en-US">Applicable to</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401583668386455" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151583668386455" role="tablecontent" localize="false">Action</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371583668519172" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271583668386455" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id231598538847029" role="tablecontent" localize="false" xml-lang="en-US">Button</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583668386455" role="tablecontent" xml-lang="en-US">Specifies the action triggered when the button is clicked. Accepted values are: <literal>none</literal>, <literal>submitForm</literal>, <literal>resetForm</literal>, <literal>refreshForm</literal>, <literal>moveToFirst</literal>, <literal>moveToLast</literal>, <literal>moveToNext</literal>, <literal>moveToPrev</literal>, <literal>saveRecord</literal>, <literal>moveToNew</literal>, <literal>deleteRecord</literal>, <literal>undoRecord</literal>.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951583839708571" role="tablecontent" localize="false">Caption</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541583839708548" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751583839708362" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351598538934413" role="tablecontent" localize="false">Button, CheckBox, FixedText, GroupBox, RadioButton</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731583839708412" role="tablecontent" xml-lang="en-US">Specifies the text displayed by the control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id901616942306877" role="tablecontent" localize="false">ControlSource</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411616942306677" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id791616942306698" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861616942306914" role="tablecontent" localize="false">CheckBox, ComboBox, CurrencyField, DateField, FormattedField, ImageControl, ListBox, NumericField, PatternField, RadioButton, TextField, TimeField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461616942306745" role="tablecontent" xml-lang="en-US">Specifies the rowset field mapped onto the current control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id511584027709311" role="tablecontent" localize="false">ControlType</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761584027709516" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491584027709825" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261598539120502" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971584027709752" role="tablecontent" xml-lang="en-US">One of the control types listed above.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491583839767611" role="tablecontent" localize="false">Default</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31583839767743" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741583839767926" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71598539168348" role="tablecontent" localize="false">Button</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111583839767195" role="tablecontent" xml-lang="en-US">Specifies whether a command button is the default OK button.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id321616942739272" role="tablecontent" localize="false">DefaultValue</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id241616942739459" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771616942739341" role="tablecontent" localize="false">Variant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861616942739836" role="tablecontent" localize="false">CheckBox, ComboBox, CurrencyField, DateField, FileControl, FormattedField, ListBox, NumericField, PatternField, RadioButton, SpinButton, TextField, TimeField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271616942739359" role="tablecontent" xml-lang="en-US">Specifies the default value used to initialize a control in a new record.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id83158383992056" role="tablecontent" localize="false">Enabled</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771583839920487" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971583839920282" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891598539196786" role="tablecontent" xml-lang="en-US">All (except HiddenControl)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451583839920858" role="tablecontent" xml-lang="en-US">Specifies if the control is accessible with the cursor.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id751588333908795" role="tablecontent" localize="false">Format</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571588333908716" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781588333908500" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491598539231618" role="tablecontent" localize="false">DateField, TimeField, FormattedField (read-only)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721588333908708" role="tablecontent" xml-lang="en-US">Specifies the format used to display dates and times. It must be one of following strings:</paragraph> + <paragraph role="paragraph" id="par_id891598456980194" xml-lang="en-US">For dates: "Standard (short)", "Standard (short YY)", "Standard (short YYYY)", "Standard (long)", "DD/MM/YY", "MM/DD/YY", "YY/MM/DD", "DD/MM/YYYY", "MM/DD/YYYY" , "YYYY/MM/DD", "YY-MM-DD", "YYYY-MM-DD".</paragraph> + <paragraph role="paragraph" id="par_id221598456991070" xml-lang="en-US">For times: "24h short", "24h long", "12h short", "12h long".</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id251583774433989" role="tablecontent" localize="false">ListCount</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501583774433513" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411583774433779" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531598539561342" role="tablecontent" localize="false">ComboBox, ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id151598177605296" xml-lang="en-US">Returns the number of rows in a ListBox or a ComboBox.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731588334016220" role="tablecontent" localize="false">ListIndex</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271588334016191" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991588334016273" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451598539598242" role="tablecontent" localize="false">ComboBox, ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251588334016874" role="tablecontent" xml-lang="en-US">Specifies which item is selected in a ListBox or ComboBox. In case of multiple selection, the index of the first item is returned or only one item is set.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id81616944120456" role="tablecontent" localize="false">ListSource</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891616944120697" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831616944120587" role="tablecontent" localize="false">Variant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301616944120610" role="tablecontent" localize="false">ComboBox, ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id901616944120614" role="tablecontent" xml-lang="en-US">Specifies the data contained in a ComboBox or a ListBox as a zero-based array of string values.</paragraph> + <paragraph role="paragraph" id="par_id21616944586559" xml-lang="en-US">Combined with <literal>ListSourceType</literal>, may also contain the name of a table, a query or a complete <literal>SQL</literal> statement.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id331616944631911" role="tablecontent" localize="false">ListSourceType</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821616944631740" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781616944631772" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id671616944631522" role="tablecontent" localize="false">ComboBox, ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131616944631625" role="tablecontent" xml-lang="en-US">Specifies the type of data contained in a combobox or a listbox.</paragraph> + <paragraph role="paragraph" id="par_id881616944631341" xml-lang="en-US">It must be one of the <link href="https://api.libreoffice.org/docs/idl/ref/ListSourceType_8idl_source.html" name="ListSourceType"><literal>com.sun.star.form.ListSourceType.*</literal></link> constants.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id451598457655392" role="tablecontent" localize="false">Locked</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961598457655506" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571598457655365" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111598539631340" role="tablecontent" localize="false">ComboBox, CurrencyField, DateField, FileControl, FileControl, FormattedField, ImageControl, ListBox, NumericField, PatternField, TextField, TimeField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id2159845765568" role="tablecontent" xml-lang="en-US">Specifies if the control is read-only.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id21159845795140" role="tablecontent" localize="false">MultiSelect</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621598457951781" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311598457951281" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id361598539747680" role="tablecontent" localize="false">ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821598457951782" role="tablecontent" xml-lang="en-US">Specifies whether the user can select multiple items in a listbox.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id421598458170141" role="tablecontent" localize="false">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351598458170114" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391598458170757" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151598539764402" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621598458170392" role="tablecontent" xml-lang="en-US">The name of the control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id2915984585802" role="tablecontent" localize="false">Parent</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161598458580581" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id921598458580608" role="tablecontent" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id181598539807426" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801598458580456" role="tablecontent" xml-lang="en-US">Depending on the parent type, a form, a subform or a tablecontrol, returns the parent <literal>SFDocuments</literal>.<literal>Form</literal> or <literal>SFDocuments</literal>.<literal>FormControl</literal> class object instance.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181598458773220" role="tablecontent" localize="false">Picture</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971598458773352" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471598458773993" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831598539848472" role="tablecontent" localize="false">Button, ImageButton, ImageControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451598458773588" role="tablecontent" xml-lang="en-US">Specifies the file name containing a bitmap or other type of graphic to be displayed on the control. The filename must comply with the <literal>FileNaming</literal> attribute of the <literal>ScriptForge.FileSystem</literal> service.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id341616946015404" role="tablecontent" localize="false">Required</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251616946015886" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461616946015486" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131616946015428" role="tablecontent" localize="false">CheckBox, ComboBox, CurrencyField, DateField, ListBox, NumericField, PatternField, RadioButton, SpinButton, TextField, TimeField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91616946015258" role="tablecontent" xml-lang="en-US">A control is said required when the underlying data must not contain a <literal>null</literal> value.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491598516764653" role="tablecontent" localize="false">Text</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781598516764550" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741598516764696" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761598539912452" role="tablecontent" localize="false">ComboBox, DateField, FileControl, FormattedField, PatternField, TextField, TimeField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id11159851676440" role="tablecontent" xml-lang="en-US">Gives access to the text being displayed by the control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311598517275908" role="tablecontent" localize="false">TipText</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411598517275112" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971598517275920" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id171598539985022" role="tablecontent" xml-lang="en-US">All (except HiddenControl)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651598517275384" role="tablecontent" xml-lang="en-US">Specifies the text that appears as a tooltip when you hover the mouse pointer over the control.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951598517418614" role="tablecontent" localize="false">TripleState</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821598517418463" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id231598517418608" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81598540007035" role="tablecontent" localize="false">CheckBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141598517418822" role="tablecontent" xml-lang="en-US">Specifies if the checkbox control may appear dimmed (grayed) or not.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31598517671415" role="tablecontent" localize="false">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701598517671373" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id2159851767113" role="tablecontent" localize="false">Variant</paragraph> + </tablecell> + <tablecell></tablecell> + <tablecell> + <paragraph id="par_id1001598540024225" role="tablecontent" xml-lang="en-US">This property depends on the current control type. Refer to <link href="text/sbasic/shared/03/sf_formcontrol.xhp#hd_id81598540704978" name="Value property">The <literal>Value</literal> property</link> for more information.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id571598517730264" role="tablecontent" localize="false">Visible</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661598517730941" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981598517730694" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761598540042290" role="tablecontent" xml-lang="en-US">All (except HiddenControl)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881598517730836" role="tablecontent" xml-lang="en-US">Specifies if the control is hidden or visible.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id741598177924441" role="tablecontent" localize="false">XControlModel</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451598177924437" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id94159817792441" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311598540066789" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id191598177924897" role="tablecontent" xml-lang="en-US">The UNO object representing the control model. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControlModel.html" name="awt.XControlModel">XControlModel</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControlModel.html" name="awt.UnoControlModel">UnoControlModel</link> in the API documentation for more information.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801598178083859" role="tablecontent" localize="false">XControlView</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id811598178083501" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981598178083938" role="tablecontent" xml-lang="en-US">UNO<br/>object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id551598540079329" role="tablecontent" xml-lang="en-US">All</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731598178083442" role="tablecontent" xml-lang="en-US">The UNO object representing the control view. Refer to <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XControl.html" name="awt.XControl">XControl</link> and <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1awt_1_1UnoControl.html" name="awt.UnoControl">UnoControl</link> in the API documentation for more information.</paragraph> + </tablecell> + </tablerow> + </table> + <h2 id="hd_id81598540704978" xml-lang="en-US">The <variable id="ValueProperty"><literal>Value</literal> property</variable></h2> + <table id="tab_id48159854325479"> + <tablerow> + <tablecell> + <paragraph id="par_id10159854325492" role="tablehead" xml-lang="en-US">Control type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741598543254158" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961598543254444" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id461598543254494" role="tablecontent" localize="false">Button</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271598543254590" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741598543254108" role="tablecontent" xml-lang="en-US">Applicable to toggle buttons only.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id131598543254931" role="tablecontent" localize="false">CheckBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741598543254376" role="tablecontent" xml-lang="en-US">Boolean or Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521598543254630" role="tablecontent" xml-lang="en-US">0, False: not checked<br />1, True: checked<br />2: grayed out, don't know (applicable if <literal>TripleState</literal> is <literal>True</literal>)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891598543254563" role="tablecontent" localize="false">ComboBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781598543254887" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id331598543254947" role="tablecontent" xml-lang="en-US">The selected value, as a String. The <literal>ListIndex</literal> property is an alternate option to access the index of the selected value.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id58159854325446" role="tablecontent" localize="false">CurrencyField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id5159854325443" role="tablecontent" xml-lang="en-US">Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id90159854325450" localize="false" role="tablecontent" xml-lang="en-US"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241598543254415" role="tablecontent" localize="false">DateField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401598543254743" role="tablecontent" localize="false">Date</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421598543254587" localize="false" role="tablecontent" xml-lang="en-US"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851598543254508" role="tablecontent" localize="false">FileControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731598543254544" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971598543254757" role="tablecontent" xml-lang="en-US">A file name formatted in accordance with the <literal>FileNaming</literal> property of the <literal>ScriptForge.FileSystem</literal> service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id921598543254323" role="tablecontent" localize="false">FormattedField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221598543254760" role="tablecontent" xml-lang="en-US">String or Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651598543254212" localize="false" role="tablecontent" xml-lang="en-US"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id581616946805539" role="tablecontent" localize="false">HiddenControl</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id37161694680551" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491616946805219" localize="false" role="tablecontent" xml-lang="en-US"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151598543254318" role="tablecontent" localize="false">ListBox</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id42159854325422" role="tablecontent" xml-lang="en-US">String or array of strings</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601598543254780" role="tablecontent" xml-lang="en-US">The selected row(s) as a single string or an array of strings. Only a single value can be set. If the box is linked to a database, this property gets or sets the underlying data. Otherwise it gets or sets the data being displayed.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id771598543254973" role="tablecontent" localize="false">NumericField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461598543254909" role="tablecontent" xml-lang="en-US">Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161598543254662" localize="false" role="tablecontent" xml-lang="en-US"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id38159854325480" role="tablecontent" localize="false">PatternField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81598543254625" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911598543254335" localize="false" role="tablecontent" xml-lang="en-US"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id791598543254779" role="tablecontent" localize="false">RadioButton</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561598543254115" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id851598543254624" role="tablecontent" xml-lang="en-US">Each button has its own name. Multiple RadioButton controls are linked together when they share the same group name. If a RadioButton is set to <literal>True</literal>, the other related buttons are automatically set to <literal>False</literal></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id141598543254361" role="tablecontent" localize="false">ScrollBar</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531598543254869" role="tablecontent" xml-lang="en-US">Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21598543254994" role="tablecontent" xml-lang="en-US">Must be within the predefined bounds</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id91616947400762" role="tablecontent" localize="false">SpinButton</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951616947400919" role="tablecontent" xml-lang="en-US">Numeric</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id48161694740085" role="tablecontent" xml-lang="en-US">Must be within the predefined bounds</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id811598543254140" role="tablecontent" localize="false">TextField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751598543254299" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441598543254738" role="tablecontent" xml-lang="en-US">The text appearing in the field</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id89159854325478" role="tablecontent" localize="false">TimeField</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id341598543254600" role="tablecontent" localize="false">Date</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881598543254964" localize="false" role="tablecontent" xml-lang="en-US"></paragraph> + </tablecell> + </tablerow> + </table> + <h2 id="hd_id421612628828054" xml-lang="en-US">Event properties</h2> + <paragraph role="paragraph" id="par_id41612629140856" xml-lang="en-US">The properties below return or set URI strings that define the script triggered by the event.</paragraph> + <table id="tab_id951612628879819"> + <tablerow> + <tablecell> + <paragraph id="par_id961612628879819" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401612628879819" role="tablehead" xml-lang="en-US">ReadOnly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id281612628879819" role="tablehead" xml-lang="en-US">Description as labeled in the Basic IDE</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801612707166342" localize="false" role="tablecontent" xml-lang="en-US">OnActionPerformed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91612707166532" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291612707166258" role="tablecontent" xml-lang="en-US">Execute action</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id261612707166662" localize="false" role="tablecontent" xml-lang="en-US">OnAdjustmentValueChanged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id79161270716675" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831612707166731" role="tablecontent" xml-lang="en-US">While adjusting</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431616948330476" localize="false" role="tablecontent" xml-lang="en-US">OnApproveAction</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301616948330694" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id901616948330305" role="tablecontent" xml-lang="en-US">Approve action</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id391616948330165" localize="false" role="tablecontent" xml-lang="en-US">OnApproveReset</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821616948330888" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111616948330257" role="tablecontent" xml-lang="en-US">Prior to reset</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id211616948330775" localize="false" role="tablecontent" xml-lang="en-US">OnApproveUpdate</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271616948330553" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451616948330759" role="tablecontent" xml-lang="en-US">Before updating</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471616948330872" localize="false" role="tablecontent" xml-lang="en-US">OnChanged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71616948330769" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211616948330895" role="tablecontent" xml-lang="en-US">Changed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id171616948330656" localize="false" role="tablecontent" xml-lang="en-US">OnErrorOccurred</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id121616948330654" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id2216169483303" role="tablecontent" xml-lang="en-US">Error occurred</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431612629836735" localize="false" role="tablecontent" xml-lang="en-US">OnFocusGained</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111612629836630" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001612629836902" role="tablecontent" xml-lang="en-US">When receiving focus</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id701612629836389" localize="false" role="tablecontent" xml-lang="en-US">OnFocusLost</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291612629836294" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id62161262983683" role="tablecontent" xml-lang="en-US">When losing focus</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id10161270735471" localize="false" role="tablecontent" xml-lang="en-US">OnItemStateChanged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id51612707354544" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211612707354899" role="tablecontent" xml-lang="en-US">Item status changed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241612629836863" localize="false" role="tablecontent" xml-lang="en-US">OnKeyPressed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81612629836634" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881612629836744" role="tablecontent" xml-lang="en-US">Key pressed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id201612629836996" localize="false" role="tablecontent" xml-lang="en-US">OnKeyReleased</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591612629836830" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161612629836775" role="tablecontent" xml-lang="en-US">Key released</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id111612629836950" localize="false" role="tablecontent" xml-lang="en-US">OnMouseDragged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891612629836630" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461612629836679" role="tablecontent" xml-lang="en-US">Mouse moved while key presses</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id711612629836495" localize="false" role="tablecYesontent" xml-lang="en-US">OnMouseEntered</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131612629836291" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151612629836151" role="tablecontent" xml-lang="en-US">Mouse inside</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id971612629836286" localize="false" role="tablecontent" xml-lang="en-US">OnMouseExited</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211612629836725" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id361612629836624" role="tablecontent" xml-lang="en-US">Mouse outside</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721612629836537" localize="false" role="tablecontent" xml-lang="en-US">OnMouseMoved</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311612629836481" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721612629836752" role="tablecontent" xml-lang="en-US">Mouse moved</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id55161262983695" localize="false" role="tablecontent" xml-lang="en-US">OnMousePressed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981612629836116" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381612629836635" role="tablecontent" xml-lang="en-US">Mouse button pressed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id621612629836155" localize="false" role="tablecontent" xml-lang="en-US">OnMouseReleased</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711612629836704" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id35161262983642" role="tablecontent" xml-lang="en-US">Mouse button released</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241616948666992" localize="false" role="tablecontent" xml-lang="en-US">OnResetted</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31616948666215" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951616948666674" role="tablecontent" xml-lang="en-US">After resetting</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id84161270760678" localize="false" role="tablecontent" xml-lang="en-US">OnTextChanged</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id811612707606330" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621612707606219" role="tablecontent" xml-lang="en-US">Text modified</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id571616948721115" localize="false" role="tablecontent" xml-lang="en-US">OnUpdated</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id41616948721642" role="tablecontent" xml-lang="en-US">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311616948721872" role="tablecontent" xml-lang="en-US">After updating</paragraph> + </tablecell> + </tablerow> + </table> + <tip id="par_id961618181634181">To learn more about URI strings, refer to the <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification" name="URI specification">Scripting Framework URI Specification</link>.</tip> + <table id="tab_id891606472825856"> + <tablerow> + <tablecell colspan="2"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the FormControl Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id751612709117248" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_formcontrol.xhp#Controls" name="Controls method">Controls</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id63161270911712" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_formcontrol.xhp#SetFocus" name="SetFocus method">SetFocus</link><br/> + </paragraph></tablecell> + </tablerow> + </table> + +<section id="Controls"> + <comment> Controls -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41584541257826"> + <bookmark_value>FormControl service;Controls</bookmark_value> + </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> + <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> + <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> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id151598185478904">Dim myGrid As Object, myList As Variant, myControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21598185484092">Set myGrid = myForm.Controls("myTableControl") ' SFDocuments.FormControl</paragraph> + <paragraph role="bascode" id="bas_id471618778075117">' Returns an Array with the names of all controls in "myTableControl"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641598185489492">myList = myGrid.Controls()</paragraph> + <paragraph role="paragraph" id="par_id931618778110273">' Returns a FormControl class instance corresponding to "myCheckBox"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921598185495193">Set myControl = myGrid.Controls("myCheckBox")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id391622559441530">Using Python:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id81622558961009">grid = form.Controls('myTableControl') # SFDocuments.FormControl</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391622558961234">control_names = form.Controls()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id571622558961435">control = grid.Controls('myCheckBox') # SFDocuments.FormControl</paragraph> + </pycode> +</section> +<section id="SetFocus"> + <comment> SetFocus -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id721583933076548"> + <bookmark_value>FormControl service;SetFocus</bookmark_value> + </bookmark> + <h2 id="hd_id681583933076692" localize="false">SetFocus</h2> + <paragraph role="paragraph" id="par_id871583933076448">Sets the focus on the control. Returns <literal>True</literal> if focusing was successful.</paragraph> + <paragraph role="paragraph" id="par_id151598178880227" xml-lang="en-US">This method is often called from a form or control event.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id991622559468457"><input>svc.SetFocus(): bool</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id221598179105596">Dim oDoc As Object, oForm As Object, oControl As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id171598179111121">Set oDoc = CreateScriptService("SFDocuments.Document", ThisComponent)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681598179123436">Set oForm = oDoc.Forms(0)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741616950370203">Set oControl = oForm.Controls("thisControl") ' SFDocuments.FormControl</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361598179135096">oControl.SetFocus()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id51623154762285">bas = CreateScriptService('ScriptForge.Basic')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id571622559687626">doc = CreateScriptService('SFDocuments.Document', bas.ThisComponent)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231622559687813">form = doc.Forms(0)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id891622559687994">control = form.Controls('thisControl') # SFDocuments.FormControl</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801622560297771">control.SetFocus()</paragraph> + </pycode> +</section> +<comment> Additional examples -------------------------------------------------------------------------------------------------------------------------- </comment> + <h2 id="hd_id141618777179310">Additional examples</h2> + <paragraph role="paragraph" id="par_id331618777195723">Below are two examples that illustrate the use of the <literal>FormControl</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id371618776324489">The first example reads the current value in a ComboBox containing city names and writes it to a FixedTest control in a Form:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id591618776422887">Dim oDoc as Object, myForm as Object, myControl as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911618776450399">Set oDoc = CreateScriptService("SFDocuments.Document", ThisDataBaseDocument)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311618776466602">myForm = oDoc.Forms("formDocumentName", "formName")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741618776467585">Dim lbCity : lbCity = myForm.Controls("labelCity")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291618776467995">Dim cbCity : cbCity = myForm.Controls("comboboxCity")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611618776468297">lbCity.Caption = "Selected City: " & cbCity.Value</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id991622562833004">bas = CreateScriptService('ScriptForge.Basic') # Basic-like methods</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id321622561047923">doc = CreateScriptService('SFDocuments.Document', bas.ThisDatabaseDocument)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id321622561048131">form = doc.Forms('formDocumentName', 'formName')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id1001622561048346">lbl_city = form.Controls('labelCity')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id151622561048563">combo_city = form.Controls('comboboxCity')</paragraph> + <paragraph role="pycode" id="pyc_id781622561048794">lbl_city.Caption = "Selected city: " + combo_city.Value</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id251618776614814">The following code snippet can be used to process RadioButton controls that share the same group name. In this example, suppose there are three radio buttons with names <literal>optA</literal>, <literal>optB</literal> and <literal>optC</literal> and we wish to display the caption of the selected control.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id461618776931086">Dim oDoc as Object, myForm as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491618776931454">Set oDoc = CreateScriptService("SFDocuments.Document", ThisDataBaseDocument)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id411618776931743">myForm = oDoc.Forms("formDocumentName", "formName")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721618776931999">Dim optNames As Object : optNames = Array("optA", "optB", "optC")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91618776932264">Dim optControl as Object, opt as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281618776932488">For Each opt In optNames</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211618776932791"> optControl = myForm.Controls(opt)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311618776933039"> If optControl.Value = True Then</paragraph> + <paragraph role="bascode" id="bas_id251618776933304"> MsgBox "Selected option: " & optControl.Caption</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581618776933600"> Exit For</paragraph> + <paragraph role="bascode" localize="false" id="bas_id511618776933863"> End If</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31618776934159">Next opt</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id991622562822004">bas = CreateScriptService('ScriptForge.Basic') # Basic-like methods</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id681622562079356">doc = CreateScriptService('SFDocuments.Document', bas.ThisDatabaseDocument)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941622562079539">form = doc.Forms('formDocumentName', 'formName')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id741622562079722">radio_buttons = ['optA', 'optB', 'optC']</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id901622562079883">for name in radio_buttons:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id51622562080068"> control = form.controls(name)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361622562080243"> if control.Value == True:</paragraph> + <paragraph role="pycode" id="pyc_id441622562080419"> bas.MsgBox('Selected option: ' + control.Caption)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id61622563076603"> break</paragraph> + </pycode> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_basic.xhp#BasicService"/> + <embed href="text/sbasic/shared/03/sf_form.xhp#FormService"/> + <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> + </section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_intro.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_intro.xhp new file mode 100644 index 000000000..98081e545 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_intro.xhp @@ -0,0 +1,181 @@ +<?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_FormControl" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Creating Python Scripts with ScriptForge</title> + <filename>/text/sbasic/shared/03/sf_intro.xhp</filename> + </topic> +</meta> + +<body> + <bookmark localize="false" branch="index" id="bm_id41582391760114"> + <bookmark_value>Python scripts with ScriptForge</bookmark_value> + </bookmark> + <h1 id="hd_id461623364876507"><variable id="title"><link href="text/sbasic/shared/03/sf_intro.xhp" name="SF_Intro_Page">Creating Python Scripts with <literal>ScriptForge</literal></link></variable></h1> + <h2 id="hd_id361623410405420">Differences between Basic and Python</h2> + <paragraph role="paragraph" id="par_id41623410443946">The <link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="SF_Lib">ScriptForge library</link> is available both for Basic and Python. Most services, methods and properties work identically in both programming languages. However, due to differences in how each language works, <literal>ScriptForge</literal> users must be aware of some characteristics of the library when using Python:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id551623410718241" role="listitem"><emph>Methods and Property names:</emph> In Python, all methods and properties can be used in lowercased, ProperCased or camelCased formats.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id741623411104297" role="listitem"><emph>Arguments:</emph> All keyword arguments passed on to methods are lowercased.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id441623411216354" role="listitem"><emph>Dates:</emph> All date objects are passed and returned as <literal>datetime.datetime</literal> native Python objects.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id891623411367669" role="listitem"><emph>Arrays:</emph> One-dimensional arrays are passed and returned as tuples (which is an immutable object). Two-dimensional arrays are passed and returned as tuples of tuples.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id981623411507442" role="listitem"><emph>None:</emph> Python's <literal>None</literal> keyword is equivalent to Basic's <literal>Null</literal>, <literal>Empty</literal> or <literal>Nothing</literal>.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id21623411611447" role="listitem"><emph>UNO objects:</emph> All UNO structures are exchanged between Basic and Python without any changes.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id651623412069496" role="listitem"><emph>Debugging:</emph> Whenever an error occurs in Python scripts that use <literal>ScriptForge</literal>, the error message provided by the Python execution stack displays the line of code that triggered the error. In Basic error messages do not display this information.</paragraph> + </listitem> + </list> + <tip id="par_id31623411828158">Visit <link href="text/sbasic/python/main0000.xhp#" name="pyscripts_link">%PRODUCTNAME Python Scripts Help</link> for more information on Python scripting using %PRODUCTNAME.</tip> + <h2 id="hd_id391623411150080">Running Python scripts on %PRODUCTNAME</h2> + <paragraph role="paragraph" id="par_id411623364895100">Depending on what you intend to achieve, you may choose one of the following approaches to running Python scripts in %PRODUCTNAME:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id681623365274024" role="listitem"><emph>Run Scripts inside the current %PRODUCTNAME process:</emph> Python scripts are executed from within the %PRODUCTNAME process by using the <menuitem>Tools - Macros - Run Macro</menuitem> menu or the APSO extension to call user scripts stored in the Python scripts folder. You can also use the APSO Python shell to interactively run Python scripts.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id761623365278133" role="listitem"><emph>Run Scripts separately from the %PRODUCTNAME process:</emph> Python scripts are executed from an external process that connects to an ongoing %PRODUCTNAME process using a socket.</paragraph> + </listitem> + </list> + <tip id="par_id631623365667011">If you plan to run scripts from inside the %PRODUCTNAME process, it is recommended to install the <link href="https://extensions.libreoffice.org/en/extensions/show/apso-alternative-script-organizer-for-python" name="APSO">APSO (Alternative Script Organizer for Python) extension</link>. However, to develop Python scripts from outside %PRODUCTNAME, you can choose your preferred Python IDE.</tip> + + <h2 id="hd_id431623365836802">Running Scripts from inside the %PRODUCTNAME process</h2> + <h3 id="hd_id111623365861568">Using the APSO extension</h3> + <paragraph role="paragraph" id="par_id681623365892513">The easiest way to get started with Python scripting in %PRODUCTNAME is by installing the APSO extension. After installing it, open any %PRODUCTNAME component and go to <menuitem>Tools - Macros - Organize Python Scripts</menuitem>.</paragraph> + <paragraph role="paragraph" id="par_id111623366334727">In APSO's main window go to <menuitem>Menu - Python Shell</menuitem>.</paragraph> + <tip id="par_id931623366329927">Alternatively you can open APSO using the default shortcut <keycode>Alt + Shift + F11</keycode>.</tip> + <paragraph role="paragraph" id="par_id661623366478092">Now you can start typing Python commands and the shell will print the corresponding output after each line of code is executed.</paragraph> + <paragraph role="paragraph" id="par_id581623366559478">To start using the <literal>ScriptForge</literal> library, you need to import the <literal>CreateScriptService</literal> method, with which you will be able to access the services provided by the library. The example below uses the <literal>Basic</literal> service to display a message box.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id531623366688016">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121623366689320">bas = CreateScriptService("Basic")</paragraph> + <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> + <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> + </pycode> + + <h3 id="hd_id961623367376768">Creating Python script files</h3> + <paragraph role="paragraph" id="par_id821623367433650">You can create your own Python files and edit them with your preferred text editor. Later you can call them from within any %PRODUCTNAME component.</paragraph> + <paragraph role="paragraph" id="par_id51623367560321">The first step is to locate where your user scripts are stored. For that, refer to <link href="text/sbasic/python/python_locations.xhp" name="Python_Scripts_Path">Python Scripts Organization and Location</link> help page.</paragraph> + <paragraph role="paragraph" id="par_id821623367773032">Now you can create a text file inside your Python user scripts folder, for instance <emph>sf_test.py</emph>, and start typing your scripts.</paragraph> + <paragraph role="paragraph" id="par_id271623367917630">Next is a simple example that gets the numeric value from a Calc cell and increments it by 1. Simply type the following code into the <emph>sf_test.py</emph> file.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id71623367973469">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id351623367973643">doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id821623367973796"></paragraph> + <paragraph role="pycode" localize="false" id="pyc_id331623367973949">def increment_cell(args=None):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id931623367974077"> value = doc.GetValue("A1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id741623367974212"> value += 1</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841623367974349"> doc.SetValue("A1", value)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231623368367747"></paragraph> + <paragraph role="pycode" localize="false" id="pyc_id11623368368139">g_exportedScripts = (increment_cell, )</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id171623368511426">This example creates the <literal>increment_cell</literal> function. Note that <literal>g_exportedScripts</literal> is a tuple that tells which functions will be displayed in %PRODUCTNAME as user scripts.</paragraph> + <paragraph role="paragraph" id="par_id471623368615244">To run this script from within a Calc document:</paragraph> + <list type="ordered"> + <listitem> + <paragraph id="par_id811623368677444" role="listitem">Create or open a Calc file.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id281623368679141" role="listitem">Enter some numeric value into cell "A1" in the current sheet.</paragraph> + </listitem> + <listitem> + <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> + </listitem> + <listitem> + <paragraph id="par_id131623368875763" role="listitem">Click <emph>Run</emph>. Note that the value in cell "A1" was incremented by 1.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id781623368934689">You can also use APSO to run Python scripts in a similar manner:</paragraph> + <list type="ordered"> + <listitem> + <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> + </listitem> + <listitem> + <paragraph id="par_id101623369005929" role="listitem">Click <menuitem>Execute</menuitem>.</paragraph> + </listitem> + </list> + + <h2 id="hd_id531623369208159">Running Scripts separately from the %PRODUCTNAME process</h2> + <section id="InstallPath"> + <h3 id="hd_id261623370168228">Determining the Installation Path</h3> + <paragraph role="paragraph" id="par_id261623369722023">The first step to run scripts from a separate process is to find the folder where %PRODUCTNAME is installed. There are several ways to do that, but <literal>ScriptForge</literal> provides a quick way to identify your installation path. For that, open APSO's Python shell and type:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id261623369853713">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id201623369854992">fs = CreateScriptService("FileSystem")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id831623370058117">fs.FileNaming = "SYS"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941623369856601">inst_dir = fs.InstallFolder</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941623369856722">print(inst_dir)</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id81623370150730">The output from the code above is the base directory where %PRODUCTNAME is installed. Now you need to add the "program" subfolder to the resulting path. This is the base folder from which you will run Python scripts from a separate process.</paragraph> + <paragraph role="paragraph" id="par_id451623370201479">For example, suppose you get <emph>/usr/lib/libreoffice/</emph> as the result from running the Python code above. Then you need to consider <emph>/usr/lib/libreoffice/program</emph> as the path to run your Python scripts.</paragraph> + </section> + + <h3 id="hd_id231623370501084">Start %PRODUCTNAME with socket settings</h3> + <paragraph role="paragraph" id="par_id721623369245475">To run Python scripts from a separate process, you need to start %PRODUCTNAME with a few additional options that specify the hostname and port through which the external process will communicate with the %PRODUCTNAME component process.</paragraph> + <paragraph role="paragraph" id="par_id221623369584132">Open the your operating system's command prompt, navigate to the program folder of your %PRODUCTNAME installation directory and type:</paragraph> + <paragraph role="paragraph" localize="false" id="par_id381623369456352"><input>./soffice --accept='socket,host=localhost,port=2021;urp;'</input></paragraph> + <paragraph role="paragraph" id="par_id981623370706743">The command above will start %PRODUCTNAME with a communication channel open so that other processes can exchange messages with it.</paragraph> + <paragraph role="paragraph" id="par_id621623370871360">Note that the previous example opens %PRODUCTNAME start center. If you want to open a specific component, for instance Writer, you can add the --writer flag to the command, as follows.</paragraph> + <paragraph role="paragraph" localize="false" id="par_id371623370974348"><input>./soffice --writer --accept='socket,host=localhost,port=2021;urp;'</input></paragraph> + <paragraph role="paragraph" id="par_id431623373618951">Take note of the <literal>host</literal> and <literal>port</literal> parameters, which in this example are <emph>localhost</emph> and <emph>2021</emph>, respectively.</paragraph> + + <h3 id="hd_id861623370468356">Running an External Python Shell</h3> + <paragraph role="paragraph" id="par_id621623371253647">Start the Python shell from within the <emph>program</emph> folder inside your %PRODUCTNAME installation path. Follow the steps <link href="text/sbasic/shared/03/sf_intro.xhp#InstallPath" name="Install_Path">above</link> to learn how to find your installation path.</paragraph> + <paragraph role="paragraph" id="par_id11623373098602"><emph>On Linux / Mac OS:</emph></paragraph> + <paragraph role="paragraph" localize="false" id="par_id601623372243559"><input>$ cd /usr/lib/libreoffice/program</input></paragraph> + <paragraph role="paragraph" localize="false" id="par_id601623372243336"><input>$ python</input></paragraph> + <paragraph role="paragraph" id="par_id311623373151552"><emph>On Windows:</emph></paragraph> + <paragraph role="paragraph" localize="false" id="par_id601623372243204"><input>$ cd C:\Program Files\LibreOffice\program\</input></paragraph> + <paragraph role="paragraph" localize="false" id="par_id601623372243399"><input>$ python.exe</input></paragraph> + <paragraph role="paragraph" id="par_id791623373520018">This will open the Python shell and now you can start typing commands that will be executed by %PRODUCTNAME. But first you need to set up the socket connection.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id281623373588570">from scriptforge import ScriptForge, CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121623373589306">ScriptForge(hostname='localhost', port=2021)</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id351623373686414">The second line of code above defines the <literal>host</literal> and <literal>port</literal> settings so that the Python shell can communicate with an ongoing %PRODUCTNAME process opened with the same socket settings.</paragraph> + <paragraph role="paragraph" id="par_id721623373769471">Now you can run other Python commands and they will be able to communicate with the %PRODUCTNAME process. For example:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731623373850131">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id731623373850255">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id671623373851588">doc = ui.OpenDocument("~/Documents/myFile.ods")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id631623373909828">bas.MsgBox(doc.DocumentType)</paragraph> + </pycode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#ScriptForge_lib"/> + <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> + <embed href="text/shared/guide/start_parameters.xhp#Title_h1"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_l10n.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_l10n.xhp new file mode 100644 index 000000000..453fe345a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_l10n.xhp @@ -0,0 +1,375 @@ +<?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_L10N" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.L10N service</title> + <filename>/text/sbasic/shared/03/sf_l10n.xhp</filename> + </topic> +</meta> +<body> +<section id="ScriptForge-sf_l10n"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id571585843652319"> + <bookmark_value>L10N service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="hd_id521585843652750" xml-lang="en-US"><variable id="L10NService"><link href="text/sbasic/shared/03/sf_l10n.xhp" name="L10N service"><literal>ScriptForge</literal>.<literal>L10N</literal> service</link></variable></h1> + <paragraph role="paragraph" xml-lang="en-US" id="par_id411585843652556">This service provides a number of methods related to the translation of strings with minimal impact on the program's source code. The methods provided by the <literal>L10N</literal> service can be used mainly to:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id601614351922212" role="listitem">Create POT files that can be used as templates for translation of all strings in the program.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id131614352196513" role="listitem">Get translated strings at runtime for the language defined in the <literal>Locale</literal> property.</paragraph> + </listitem> + </list> +</section> + + <note id="par_id971614966420419">The acronym <literal>L10N</literal> stands for Localization and refers to a set of procedures for translating software to a specific country or region.</note> + <paragraph role="paragraph" id="par_id291585843652438" xml-lang="en-US">PO files have long been promoted in the free software community as a means to providing multilingual user interfaces. This is accomplished through the use of human-readable text files with a well defined structure that specifies, for any given language, the source language string and the localized string.</paragraph> + <paragraph role="paragraph" id="par_id181585843652814" xml-lang="en-US">The main advantage of the PO format is dissociation of the programmer and the translator. PO files are independent text files, so the programmer can send POT template files to translators, who will then translate their contents and return the translated PO files for each supported language.</paragraph> + <tip id="par_id811614352321187">The <literal>L10N</literal> service is based on the GNU implementation of PO (portable object) files. To learn more about this file format, visit <link href="https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html" name="GetText">GNU gettext Utilities: PO Files</link>.</tip> + <paragraph role="paragraph" id="par_id91585843652832" xml-lang="en-US">This service implements the methods listed below:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id1158584365237" role="listitem" xml-lang="en-US"><emph>AddText</emph>: Used by the programmer to build a set of strings that will be translated later.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id81637866601151" role="listitem"><emph>AddTextsFromDialog</emph>: Extracts all strings from a <literal>Dialog</literal> service instance.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id681585843652331" role="listitem" xml-lang="en-US"><emph>ExportToPOTFile</emph>: Exports the strings added by the <literal>AddText</literal> method to a POT file.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id531585843652697" role="listitem" xml-lang="en-US"><emph>GetText</emph>: Gets the translated strings at runtime.</paragraph> + </listitem> + </list> + <note id="par_id361614361362393">Note that the first two methods are used to build a set of translatable strings and export them to a POT file. However, it is not mandatory to create POT files using these methods. Since they are text files, the programmer could have created them using any text editor.</note> + + <h2 id="hd_id351585843652312" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>L10N</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id421614353247163">There are several ways to invoke the <literal>L10N</literal> service using up to five optional arguments that specify the folder where PO files are stored, the locale and encoding to be used, as well as a fallback PO file and its encoding.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id481625854402332"> + <input>CreateScriptService("L10N", opt foldername: str, opt locale: str, encoding: str = "UTF-8", opt locale2: str, encoding2: str = "UTF-8"): svc</input> + </paragraph> + <paragraph role="paragraph" id="par_id331585843652877"><emph>foldername</emph>: The folder containing the PO files. It must be expressed in the <literal>FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id581585843652789"><emph>locale</emph>: A string in the form "la-CO" (language-COUNTRY) or in the form "la" (language) only.</paragraph> + <paragraph role="paragraph" id="par_id591646219881864"><emph>encoding</emph>: The character set to be used. The default encoding is "UTF-8".</paragraph> + <paragraph role="paragraph" id="par_id281646219882464"><emph>locale2</emph>: A string specifying the fallback locale to be used in case the PO file corresponding to the locale defined the <literal>locale</literal> parameter does not exist. This parameter is expressed in the form "la-CO" (language-COUNTRY) or "la" (language) only.</paragraph> + <paragraph role="paragraph" id="par_id881646219882951"><emph>encoding2</emph>: The character set of the fallback PO file corresponding to the <literal>locale2</literal> argument. The default encoding is "UTF-8".</paragraph> + <note id="par_id141613001281573">To learn more about the names of character sets, visit <link href="https://www.iana.org/assignments/character-sets/character-sets.xhtml" name="Character Sets">IANA's Character Set</link> page. Beware that %PRODUCTNAME does not implement all existing character sets.</note> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id891614358528334">The following example instantiates the <literal>L10N</literal> service without any optional arguments. This will only enable the <literal>AddText</literal> and <literal>ExportToPOTFile</literal> methods, which is useful for creating POT files.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891585843652669">GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821585843652135">Dim myPO As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151585843652269">Set myPO = CreateScriptService("L10N")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id611614358672609">The example below specifies the folder containing the PO files. Because the locale is not defined, the service instance will use the locale defined for the %PRODUCTNAME user interface, which is the same locale defined in the <literal>OfficeLocale</literal> property of the <link href="text/sbasic/shared/03/sf_platform.xhp" name="OfficeLocale_link">Platform</link> service.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id451614358683971">Set myPO = CreateScriptService("L10N", "C:\myPOFiles")</paragraph> + </bascode> + <warning id="par_id391625855630975">The example above will result in an runtime error if the PO file corresponding to the <literal>OfficeLocale</literal> locale does not exist in the specified folder.</warning> + <paragraph role="paragraph" id="par_id321614358809763">In the example below, the locale is explicitly defined to be Belgian French ("fr-BE"), hence the service will load the file "fr-BE.po" from the folder "C:\myPOFiles". If the file does not exist, an error will occur.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id661614358846464">Set myPO = CreateScriptService("L10N", "C:\myPOFiles", "fr-BE", "UTF-8")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id271646220649616">To avoid errors, it is possible to specify a preferred and a fallback locale and encoding. The following example will first try to load the file "fr-BE.po" from the specified folder and if it does not exist, the file "en-US.po" will be loaded.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id551646220782634">Set myPO = CreateScriptService("L10N", "C:\myPOFiles", "fr-BE", "UTF-8", "en-US", "UTF-8")</paragraph> + </bascode> + <paragraph role="tip" id="par_id411585843652496" xml-lang="en-US">PO files must be named in the form "la-CO.po" or "la.po", where "la" refers to the language and "CO" is the country. Some examples are: "en-US.po", "fr-BE.po" or "fr.po".</paragraph> + <paragraph role="paragraph" id="par_id171585843652545" xml-lang="en-US">It is recommended to free resources after use:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891585843652617">Set myPO = myPO.Dispose()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id281625854773330">The examples above can be translated to Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941625854656863">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id51625854657247">myPO = CreateScriptService('L10N')</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761625854846211">myPO = CreateScriptService('L10N', r'C:\myPOFiles')</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id311625854879209">myPO = CreateScriptService('L10N', r'C:\myPOFiles', 'fr-BE')</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id981646221720301">myPO = CreateScriptService('L10N', r'C:\myPOFiles', 'fr-BE', 'UTF-8', 'en-US', 'UTF-8')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id11625855490095">myPO = myPO.Dispose()</paragraph> + </pycode> + <note id="par_id301614358956087">Several instances of the <literal>L10N</literal> service may coexist. However, each instance must use a separate directory for its PO files.</note> + +<bookmark localize="false" branch="index" id="bm_id871614359551930"> + <bookmark_value>L10N service;Folder</bookmark_value> + <bookmark_value>L10N service;Languages</bookmark_value> + <bookmark_value>L10N service;Locale</bookmark_value> +</bookmark> +<h2 id="hd_id561585843652465" xml-lang="en-US">Properties</h2> + <table id="tab_id711585843652120"> + <tablerow> + <tablecell> + <paragraph id="par_id181585843652958" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741585843652162" role="tablehead" xml-lang="en-US">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291585843652823" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351585843652638" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id781585843652397" role="tablecontent" xml-lang="en-US" localize="false">Folder</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451585843652928" role="tablecontents" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351585843652874" role="tablecontents" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751585843652642" role="tablecontent" xml-lang="en-US">The folder containing the PO files (see the <link href="text/sbasic/shared/03/sf_filesystem.xhp#bm_id901612991354326" name="FileNaming property"><literal>FileSystem.FileNaming</literal></link> property to learn about the notation used).</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161585843652104" role="tablecontent" xml-lang="en-US" localize="false">Languages</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id96158584365279" role="tablecontents" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611585843652345" role="tablecontents" xml-lang="en-US" localize="false">Array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id331585843652912" role="tablecontent" xml-lang="en-US">A zero-based array listing all the base names (without the ".po" extension) of the PO-files found in the specified <literal>Folder</literal>.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721585843652496" role="tablecontent" xml-lang="en-US" localize="false">Locale</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961585843652589" role="tablecontents" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611585843652290" role="tablecontents" xml-lang="en-US" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561585843652947" role="tablecontent" xml-lang="en-US">The currently active language-COUNTRY combination. This property will be initially empty if the service was instantiated without any of the optional arguments.</paragraph> + </tablecell> + </tablerow> + </table> + +<table id="tab_id551614360519973"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id231614360519973" role="tablehead">List of Methods in the L10N Service</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id611614360519255" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_l10n.xhp#AddText" name="AddText">AddText</link><br/> + <link href="text/sbasic/shared/03/sf_l10n.xhp#AddTextsFromDialog" name="AddTextsFromDialog">AddTextsFromDialog</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611614360519104" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_l10n.xhp#ExportToPOTFile" name="ExportToPOTFile">ExportToPOTFile</link><br/><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611614360518452" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_l10n.xhp#GetText" name="GetText">GetText</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> +</table> + + +<section id="AddText"> + <comment> AddText ----------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id951585843652555"> + <bookmark_value>L10N service;AddText</bookmark_value> + </bookmark> + <h2 id="hd_id191585843652902" localize="false">AddText</h2> + <paragraph role="paragraph" id="par_id1001585843652271">Adds a new entry in the list of localizable strings. It must not exist yet.</paragraph> + <paragraph role="paragraph" id="par_id641625855725050">The method returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id241625855910866"> + <input>svc.AddText(context: str = '', msgid: str = '', comment: str = ''): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id391585843652753"><emph>context</emph>: The key to retrieve the translated string with the <literal>GetText</literal> method. This parameter has a default value of "".</paragraph> + <paragraph role="paragraph" id="par_id581585844419114" xml-lang="en-US"><emph>msgid</emph>: The untranslated string, which is the text appearing in the program code. It must not be empty. The <literal>msgid</literal> becomes the key to retrieve the translated string via <literal>GetText</literal> method when <literal>context</literal> is empty.</paragraph> + <paragraph role="paragraph" id="par_id311614361926844">The <literal>msgid</literal> string may contain any number of placeholders (%1 %2 %3 ...) for dynamically modifying the string at runtime.</paragraph> + <paragraph role="paragraph" id="par_id541585844475331" xml-lang="en-US"><emph>comment</emph>: Optional comment to be added alongside the string to help translators.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id461614364298440">The example below creates a set of strings in English:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id61585843652630">myPO.AddText(, "This is a string to be included in a POT file")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61585843652141">myPO.AddText("CTX1", "A string with a context")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61585843653298">myPO.AddText(, "Provide a String value", Comment := "Do not translate the word String")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821625856085258">myPO.AddText(msgid = 'This is a string to be included in a POT file')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id821625856440025">myPO.AddText('CTX1', 'A string with a context')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id521625856443322">myPO.AddText(msgid = 'Provide a String value', comment = 'Do not translate the word String')</paragraph> + </pycode> +</section> + +<section id="AddTextsFromDialog"> + <comment> AddTextsFromDialog ------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id951585843650024"> + <bookmark_value>L10N service;AddTextsFromDialog</bookmark_value> + </bookmark> + <h2 id="hd_id191585843652058" localize="false">AddTextsFromDialog</h2> + <paragraph role="paragraph" id="par_id1001585843659821">Automatically extracts strings from a dialog and adds them to the list of localizable text strings. The following strings are extracted:</paragraph> + <section id="L10NDlgControls"> + <list type="unordered"> + <listitem> + <paragraph id="par_id621637863440015" role="listitem">The title of the dialog.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id61637863440399" role="listitem">The caption of the following control types: Button, CheckBox, FixedLine, FixedText, GroupBox and RadioButton.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id251637863440626" role="listitem">Static strings in ListBoxes and ComboBoxes.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id811637863596791" role="listitem">The tooltip or help text displayed when the mouse hovers over the control.</paragraph> + </listitem> + </list> + </section> + <paragraph role="paragraph" id="par_id641625855723650">The method returns <literal>True</literal> if successful.</paragraph> + <note id="par_id731637863894577">The dialog from which strings will be extracted must not be open when the method is called.</note> + <paragraph role="paragraph" id="par_id911637864050221">When a <literal>L10N</literal> service instance is created from an existing PO file, use the <link href="text/sbasic/shared/03/sf_dialog.xhp#GetTextsFromL10N" name="GetTextsFromL10N">GetTextsFromL10N</link> method from the <literal>Dialog</literal> service to automatically load all translated strings into the dialog.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id241625855910158"> + <input>svc.AddTextsFromDialog(dialog: svc): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id391585843652113"><emph>dialog</emph>: a Dialog service instance corresponding to the dialog from which strings will be extracted.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id461614364298983">The following example extracts all strings from the dialog "MyDialog" stored in the "Standard" library and exports them to a POT file:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id61585843652225">oDlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "MyDialog")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61585843652012">myPO = CreateScriptService("L10N")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61585843653117">myPO.AddTextsFromDialog(oDlg)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id68163786595435">myPO.ExportToPOTFile("en-US.pot")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821625856085583">dlg = CreateScriptService("Dialog", "GlobalScope", "Standard", "Dialog1")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id821625856440596">myPO = CreateScriptService("L10N")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id521625856443065">myPO.AddTextsFromDialog(dlg)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id401637866328706">myPO.ExportToPOTFile("en-US.pot")</paragraph> + </pycode> +</section> + +<section id="ExportToPOTFile"> + <comment> ExportToPOTFile --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id471586102707389"> + <bookmark_value>L10N service;ExportToPOTFile</bookmark_value> + </bookmark> + <h2 id="hd_id231586102707125" localize="false">ExportToPOTFile</h2> + <paragraph role="paragraph" id="par_id281586102707242">Exports a set of untranslated strings as a POT file.</paragraph> + <paragraph role="paragraph" id="par_id711586102939257" xml-lang="en-US">To build a set of strings you can use either a succession of <literal>AddText</literal> method calls, or by a successful invocation of the <literal>L10N</literal> service with the <literal>foldername</literal> argument present. It is also possible to use a combination of both techniques.</paragraph> + <paragraph role="paragraph" id="par_id641625855725141">The method returns <literal>True</literal> if successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id161625856621303"> + <input>svc.ExportToPOTFile(filename: str, header: str = '', encoding:str = 'UTF-8'): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id31586102707537"><emph>filename</emph>: The output file in <literal>FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id851586102707579" xml-lang="en-US"><emph>header</emph>: Comments that will be added on top of the generated POT file.</paragraph> + <paragraph role="paragraph" id="par_id111614364686973">Do not include any leading "#" characters. If you want the header to be broken into multiple lines, insert escape sequences (\n) where relevant. A standard header will be added alongside the text specified in the <literal>header</literal> argument.</paragraph> + <paragraph role="paragraph" id="par_id5158610270728" xml-lang="en-US"><emph>encoding</emph>: The character set to be used (Default = "UTF-8").</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id761625856867301">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891586102707992">myPO.ExportToPOTFile("myFile.pot", Header := "First line of the header\nSecond line of the header")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id141625856892715"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id131625856893020">myPO.ExportToPOTFile('myFile.pot', header = 'First line of the header\nSecond line of the header')</paragraph> + </pycode> + <note id="par_id581614364494235">The generated file should successfully pass the <literal>msgfmt --check</literal> GNU command.</note> +</section> + +<section id="GetText"> + <comment> GetText ----------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id131586165768747"> + <bookmark_value>L10N service;GetText</bookmark_value> + </bookmark> + <h2 id="hd_id56158616576884" localize="false">GetText</h2> + <paragraph role="paragraph" id="par_id891586165768715">Gets the translated string corresponding to the given <literal>msgid</literal> argument.</paragraph> + <paragraph role="paragraph" id="par_id291614365296959">A list of arguments may be specified to replace the placeholders (%1, %2, ...) in the string.</paragraph> + <paragraph role="paragraph" id="par_id231586166181909">If no translated string is found, the method returns the untranslated string after replacing the placeholders with the specified arguments.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id871586352505927" xml-lang="en-US">This method can be called either by the full name <literal>GetText</literal> or by the shortcut <literal>_</literal> (a single underscore):</paragraph> + <paragraph role="paragraph" localize="false" id="par_id661625857165908"> + <input>svc.GetText(msgid: str, args: any[0..*]): str</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id661625857165119"> + <input>svc._(msgid: str, args: any[0..*]): str</input> + </paragraph> + <note id="par_id421614967136502">In the ScriptForge library, all methods starting with the "_" character are reserved for internal use only. However, the shortcut <literal>_</literal> used for <literal>GetText</literal> is the only exception to this rule, hence it can be safely used in Basic and Python scripts.</note> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id51586165768525" xml-lang="en-US"><emph>msgid</emph>: The untranslated string, which is the text appearing in the program code. It must not be empty. It may contain any number of placeholders (%1 %2 %3 ...) that can be used to dynamically insert text at runtime.</paragraph> + <paragraph role="paragraph" id="par_id11614365537450">Besides using a single <literal>msgid</literal> string, this method also accepts the following formats:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id961614365557277" role="listitem">The <literal>context</literal> string with which the method will retrieve the <literal>msgid</literal> in the PO file, or;</paragraph> + </listitem> + <listitem> + <paragraph id="par_id981614365589866" role="listitem">A combination <literal>context|msgid</literal>, instructing the method to retrieve the <literal>msgid</literal> using specified <literal>context</literal> value. The second part of the argument is used to improve code readability.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id571586165768106" xml-lang="en-US"><emph>args</emph>: Values to be inserted into the placeholders. Any variable type is allowed, however only strings, numbers and dates will be considered.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id701614365961454">Consider the following code is running on a %PRODUCTNAME installation with locale set to "es-ES". Additionally, there is a file "es-ES.po" inside the specified folder that translates the string passed to the <literal>GetText</literal> method:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id171614366110835">myPO = CreateScriptService("L10N", "C:\myPOFiles\")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id861586165768104">myPO.GetText("Welcome %1! Hope you enjoy this program", "John")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001586166834936">' "¡Bienvenido John! Espero que disfrutes de este programa"</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821625858120620">myPO = CreateScriptService('L10N', r"C:\myPOFiles")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231625858122952">myPO.GetText('Welcome %1! Hope you enjoy this program', 'John')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id831625858123194"># "¡Bienvenido John! Espero que disfrutes de este programa"</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/> + <embed href="text/sbasic/guide/translation.xhp#translation"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_menu.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_menu.xhp new file mode 100644 index 000000000..162c63083 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_menu.xhp @@ -0,0 +1,324 @@ +<?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_Menu" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFWidgets.Menu service</title> + <filename>/text/sbasic/shared/03/sf_menu.xhp</filename> + </topic> +</meta> +<body> + <section id="ScriptForge-sf_pmenu"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id501600788076877"> + <bookmark_value>Menu service</bookmark_value> + </bookmark> + </section> + <section id="abstract"> + <h1 id="bm_id681600788076499"><variable id="MenuService"><link href="text/sbasic/shared/03/sf_menu.xhp" name="Menu service"><literal>SFWidgets</literal>.<literal>Menu</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id181600788076612">The <literal>Menu</literal> service can be used to create and remove menus from the menubar of a %PRODUCTNAME document window. Each menu entry can be associated with a script or with a UNO command. This service provides the following capabilities:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id301600788076785" role="listitem">Creation of menus with custom entries, checkboxes, radio buttons and separators.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id1001600788076848" role="listitem">Decoration of menu items with icons and tooltips.</paragraph> + </listitem> + </list> + </section> + <note id="par_id581643133675012">Menus created with this service are available only for a specified document window. They are not saved into the document or as application settings. Closing and opening the document will restore the default menubar settings.</note> + <warning id="par_id291643224925643">When OLE objects such as Math formulas or Calc charts are edited from within a document, %PRODUCTNAME reconfigures the menubar according to the object. When this happens, the menus created with the <literal>Menu</literal> service are removed and are not be restored after editing the OLE object.</warning> + + <h2 id="hd_id281600788076359">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Menu</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id321614902851541">The <literal>Menu</literal> service is instantiated by calling the <link href="text/sbasic/shared/03/sf_document.xhp#CreateMenu" name="CreateMenu_link"><literal>CreateMenu</literal></link> method from the <literal>Document</literal> service. The code snippet below creates a menu named <emph>My Menu</emph> in the current document window with two entries <emph>Item A</emph> and <emph>Item B</emph>.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id791643134557838">Sub CreateMenu()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891643134322054"> GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id141643134322438"> Dim oDoc as Object, oMenu as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151643134322614"> Set oDoc = CreateScriptService("Document")</paragraph> + <paragraph role="bascode" id="bas_id261643134374056"> Set oMenu = oDoc.CreateMenu("My Menu")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261643134581928"> With oMenu</paragraph> + <paragraph role="bascode" id="bas_id431643134582213"> .AddItem("Item A", Command := "About")</paragraph> + <paragraph role="bascode" id="bas_id571643134582396"> .AddItem("Item B", Script := "vnd.sun.star.script:Standard.Module1.ItemB_Listener?language=Basic&location=application")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531643134582588"> .Dispose()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981643134582741"> End With</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791643134722777">End Sub</paragraph> + </bascode> + <note id="par_id371643135157996">After creating the menu, it is recommended to call the <literal>Dispose</literal> method to free the resources used by the <literal>Menu</literal> service instance.</note> + <paragraph role="paragraph" id="par_id341636718182262">In the example above, <emph>Item A</emph> is associated with the UNO command <literal>.uno:About</literal> whereas <emph>Item B</emph> is associated with the script <literal>ItemB_Listener</literal> defined in <literal>Module1</literal> of the <literal>Standard</literal> library of the <literal>My Macros</literal> container.</paragraph> + <paragraph role="paragraph" id="par_id851635274721129">The following example defines <literal>ItemB_Listener</literal> that will be called when <emph>Item B</emph> is clicked. This listener simply splits the argument string passed to the <literal>Sub</literal> and shows them in a message box.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id311643135422309">Sub ItemB_Listener(args As String)</paragraph> + <paragraph role="bascode" id="bas_id716431354225603"> ' Process the argument string passed to the listener</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211643135422708"> Dim sArgs as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461643135422860"> sArgs = Split(args, ",")</paragraph> + <paragraph role="bascode" id="bas_id901643135423012"> MsgBox "Menu name: " & sArgs(0) & Chr(13) & _</paragraph> + <paragraph role="bascode" id="bas_id301643136028263"> "Menu item: " & sArgs(1) & Chr(13) & _</paragraph> + <paragraph role="bascode" id="bas_id181643136028557"> "Item ID: " & sArgs(2) & Chr(13) & _</paragraph> + <paragraph role="bascode" id="bas_id561643136028710"> "Item status: " & sArgs(3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241643136028871">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id531636493797707">As shown in the example above, menu entries associated with a script receive a comma-separated string argument with the following values:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id921643136489994" role="listitem">The toplevel name of the menu.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id611643136491059" role="listitem">The string ID of the selected menu entry.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id961643136491491" role="listitem">The numeric ID of the selected menu entry.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id381643136494580" role="listitem">The current state of the menu item. This is useful for checkboxes and radio buttons. If the item is checked, the value "1" is returned, otherwise "0" is returned.</paragraph> + </listitem> + </list> + + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id131635275172617">The examples above can be written in Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id631626695710139">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441636718456158"></paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441636718456844">def create_menu(args=None):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626695710433"> oDoc = CreateScriptService("Document")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626695710122"> oMenu = oDoc.CreateMenu("My Menu")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id311626695710851"> oMenu.AddItem("Item A", command="About")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211636717609237"> oMenu.AddItem("Item B", script="vnd.sun.star.script:my_macros.py$item_b_listener?language=Python&location=user")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id616367176100230"> oMenu.Dispose()</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831635275439182">def item_b_listener(args):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id481643137165239"> bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381635275439396"> s_args = args.split(",")</paragraph> + <paragraph role="pycode" id="pyc_id981636717957632"> msg = f"Menu name: {s_args[0]}\n"</paragraph> + <paragraph role="pycode" id="pyc_id851636718008427"> msg += f"Menu item: {s_args[1]}\n"</paragraph> + <paragraph role="pycode" id="pyc_id331636727047102"> msg += f"Item ID: {s_args[2]}\n"</paragraph> + <paragraph role="pycode" id="pyc_id71643137333404"> msg += f"Item status: {s_args[3]}"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id111643137333564"> bas.MsgBox(msg)</paragraph> + </pycode> + + <bookmark xml-lang="en-US" branch="index" localize="false" id="bm_id111614901520029"> + <bookmark_value>PopupService service;ShortcutCharacter</bookmark_value> + <bookmark_value>PopupService service;SubmenuCharacter</bookmark_value> + </bookmark> + <h2 id="hd_id711600788076834">Properties</h2> + <table id="tab_id701600788076583"> + <tablerow> + <tablecell> + <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076591" role="tablehead">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076328" role="tablehead">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id67160078807636" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id941600788076595" role="tablecontent" localize="false">ShortcutCharacter</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id49160078807654" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961600788076376" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81600788076419" role="tablecontent">Character used to define the access key of a menu item. The default character is "~".</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491600788076621" role="tablecontent" localize="false">SubmenuCharacter</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311600788076756" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831600788076785" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441600788076826" role="tablecontent">Character or string that defines how menu items are nested. The default character is ">".</paragraph> + </tablecell> + </tablerow> + </table> + + <h2 id="hd_id181636719707892">Menu and Submenus</h2> + <paragraph role="paragraph" id="par_id741636719725402">To create a menu with submenus, use the character defined in the <literal>SubmenuCharacter</literal> property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id991636719842353">' Item A</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231636719842719">' Item B > Item B.1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421636719842904">' Item B.2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id916367201523640">' ------ (line separator)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541636719843240">' Item C > Item C.1 > Item C.1.1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701636719843447">' Item C.1.2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id601636719843672">' Item C > Item C.2 > Item C.2.1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921636719843864">' Item C.2.2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921636719843567">' ------ (line separator)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921636719843154">' Item C.2.3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921636719843965">' Item C.2.4</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id211636720111489">The code below uses the default submenu character ">" to create the menu/submenu hierarchy defined above:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="par_id961636720555061">oMenu.AddItem("Item A")</paragraph> + <paragraph role="bascode" localize="false" id="par_id371636720556397">oMenu.AddItem("Item B>Item B.1")</paragraph> + <paragraph role="bascode" localize="false" id="par_id941636720556623">oMenu.AddItem("Item B>Item B.2")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261636720973178">oMenu.AddItem("---")</paragraph> + <paragraph role="bascode" localize="false" id="par_id431636720556822">oMenu.AddItem("Item C>Item C.1>Item C.1.1")</paragraph> + <paragraph role="bascode" localize="false" id="par_id651636720557021">oMenu.AddItem("Item C>Item C.1>Item C.1.2")</paragraph> + <paragraph role="bascode" localize="false" id="par_id861636720557222">oMenu.AddItem("Item C>Item C.2>Item C.2.1")</paragraph> + <paragraph role="bascode" localize="false" id="par_id21636720557437">oMenu.AddItem("Item C>Item C.2>Item C.2.2")</paragraph> + <paragraph role="bascode" localize="false" id="par_id21636720557103">oMenu.AddItem("Item C>Item C.2>---")</paragraph> + <paragraph role="bascode" localize="false" id="par_id21636720557256">oMenu.AddItem("Item C>Item C.2>Item C.2.3")</paragraph> + <paragraph role="bascode" localize="false" id="par_id21636720557941">oMenu.AddItem("Item C>Item C.2>Item C.2.4")</paragraph> + </bascode> + <note id="par_id121636721243578">The string "---" is used to define line separators in menus or submenus.</note> + <embed href="text/sbasic/shared/03/sf_popupmenu.xhp#using_icons"/> + + <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Menu Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_menu.xhp#AddCheckBox" name="AddCheckBox method">AddCheckBox</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_menu.xhp#AddItem" name="AddItem method">AddItem</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613625804" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_menu.xhp#AddRadioButton" name="AddRadioButton method">AddRadioButton</link><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + + <section id="AddCheckBox"> + <comment> AddCheckBox ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969883"> + <bookmark_value>Menu service;AddCheckBox</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698251" localize="false">AddCheckBox</h2> + <paragraph role="paragraph" id="par_id93158919969864">Inserts a check box in the menu. Returns an integer value that identifies the inserted item.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534014732"> + <input>svc.AddCheckBox(menuitem: str, opt name: str, opt status: bool, opt icon: str, opt tooltip: str, opt command: str, opt script: str): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203996"><emph>menuitem:</emph> Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character.</paragraph> + <paragraph role="paragraph" id="par_id821591631203116"><emph>name:</emph> String value used to identify the menu item. By default, the last component of the menu hierarchy is used.</paragraph> + <paragraph role="paragraph" id="par_id821591631203133"><emph>status:</emph> Defines whether the item is selected when the menu is created (Default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id11636721653313"><emph>icon:</emph> Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used.</paragraph> + <paragraph role="paragraph" id="par_id11636721653208"><emph>tooltip:</emph> Text to be displayed as tooltip.</paragraph> + <paragraph role="paragraph" id="par_id11636721653328"><emph>command:</emph> The name of a UNO command without the <literal>.uno:</literal> prefix. If the command name does not exist, nothing happens.</paragraph> + <paragraph role="paragraph" id="par_id11636721653107"><emph>script:</emph> The URI for a Basic or Python script that will be executed when the item is clicked.</paragraph> + <section id="menu_note"> + <note id="par_id31643198954204">The arguments <literal>command</literal> and <literal>script</literal> are mutually exclusive, hence only one of them can be set for each menu item.</note> + <tip id="par_id31643148484084">Read <link href="https://wiki.documentfoundation.org/Documentation/DevGuide/Scripting_Framework#Scripting_Framework_URI_Specification" name="URI_Notation">Scripting Framework URI Specification</link> to learn more about the URI syntax used in the <literal>script</literal> argument.</tip> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id191643306748853">' Menu entry associated with the .uno:Paste command</paragraph> + <paragraph role="bascode" localize="false" id="bas_id41158919969204">oMenu.AddCheckBox("Item A", Status := True, ToolTip := "Paste values", Command := "Paste")</paragraph> + <paragraph role="bascode" id="bas_id271643147793320">' Runs the Basic script Standard.Module1.MyListener stored in the document</paragraph> + <paragraph role="bascode" localize="false" id="bas_id41158919969114">oMenu.AddCheckBox("Item B", Status := False, Script := "vnd.sun.star.script:Standard.Module1.MyListener?language=Basic&location=document")</paragraph> + <paragraph role="bascode" id="bas_id801643306742620">' Runs the Python script MyListener located in file myScripts.py in the user scripts folder</paragraph> + <paragraph role="bascode" localize="false" id="bas_id41158919969324">oMenu.AddCheckBox("Item C", Status := True, Script := "vnd.sun.star.script:myScripts.py$MyListener?language=Python&location=user")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534175122">oMenu.AddCheckBox("Item A", status=True, tooltip="Paste values", command="Paste")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id321621534175344">oMenu.AddCheckBox("Item B", status=False, script="vnd.sun.star.script:Standard.Module1.MyListener?language=Basic&location=document")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id591643307035249">oMenu.AddCheckBox("Item C", Status=True, Script="vnd.sun.star.script:myScripts.py$MyListener?language=Python&location=user")</paragraph> + </pycode> + </section> + + <section id="AddItem"> + <comment> AddItem ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919960353"> + <bookmark_value>Menu service;AddItem</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698158" localize="false">AddItem</h2> + <paragraph role="paragraph" id="par_id93158919963364">Inserts a label entry in the menu. Returns an integer value that identifies the inserted item.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534012185"> + <input>svc.AddItem(menuitem: str, opt name: str, opt icon: str, opt tooltip: str, opt command: str, opt script: str): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203021"><emph>menuitem:</emph> Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character.</paragraph> + <paragraph role="paragraph" id="par_id821591631203026"><emph>name:</emph> String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used.</paragraph> + <paragraph role="paragraph" id="par_id11636721652886"><emph>icon:</emph> Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used.</paragraph> + <paragraph role="paragraph" id="par_id11636721653118"><emph>tooltip:</emph> Text to be displayed as tooltip.</paragraph> + <paragraph role="paragraph" id="par_id11636721653314"><emph>command:</emph> The name of a UNO command without the <literal>.uno:</literal> prefix. If the command name does not exist, nothing happens.</paragraph> + <paragraph role="paragraph" id="par_id11636721652057"><emph>script:</emph> The URI for a Basic or Python script that will be executed when the item is clicked.</paragraph> + <embed href="text/sbasic/shared/03/sf_menu.xhp#menu_note"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id41158919969106">oMenu.AddItem("Item A", Tooltip := "A descriptive message")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id321621534170554">oMenu.AddItem("Item A", tooltip = "A descriptive message")</paragraph> + </pycode> + </section> + + <section id="AddRadioButton"> + <comment> AddRadioButton --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969447"> + <bookmark_value>Menu service;AddRadioButton</bookmark_value> + </bookmark> + <h2 id="hd_id201589199693022" localize="false">AddRadioButton</h2> + <paragraph role="paragraph" id="par_id93158919969399">Inserts a radio button entry in the menu. Returns an integer value that identifies the inserted item.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534013775"> + <input>svc.AddRadioButton(menuitem: str, opt name: str, opt status: str, opt icon: str, opt tooltip: str, opt command: str, opt script: str): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203501"><emph>menuitem:</emph> Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character.</paragraph> + <paragraph role="paragraph" id="par_id821591631228716"><emph>name:</emph> String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used.</paragraph> + <paragraph role="paragraph" id="par_id821591631203643"><emph>status:</emph> Defines whether the item is selected when the menu is created (Default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id11636721653228"><emph>icon:</emph> Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used.</paragraph> + <paragraph role="paragraph" id="par_id11636721653114"><emph>tooltip:</emph> Text to be displayed as tooltip.</paragraph> + <paragraph role="paragraph" id="par_id11636721653447"><emph>command:</emph> The name of a UNO command without the <literal>.uno:</literal> prefix. If the command name does not exist, nothing happens.</paragraph> + <paragraph role="paragraph" id="par_id11636721652598"><emph>script:</emph> The URI for a Basic or Python script that will be executed when the item is clicked.</paragraph> + <embed href="text/sbasic/shared/03/sf_menu.xhp#menu_note"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41158919969658">oMenu.AddRadioButton("Item A", Name := "A", Status := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534175471">oMenu.AddRadioButton("Item A", name="A", status=True)</paragraph> + </pycode> + </section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_popupmenu.xhp#PopupMenuService"/> + <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_methods.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_methods.xhp new file mode 100644 index 000000000..219669b9f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_methods.xhp @@ -0,0 +1,211 @@ +<?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="scriptforgemethods" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge Method Signatures</title> + <filename>/text/sbasic/shared/03/sf_methods.xhp</filename> + </topic> + </meta> + <body> + <h1 id="hd_id31529004750471" xml-lang="en-US"><variable id="SF_Signatures"><link href="text/sbasic/shared/03/sf_methods.xhp" name="ScriptForge Method Signatures"><literal>ScriptForge</literal> Method Signatures</link></variable></h1> + <bookmark xml-lang="en-US" branch="index" id="bm_id491529070339774"> + <bookmark_value>ScriptForge; Method signatures</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="par_id681619700336879">ScriptForge libraries aggregate macro scripting resources for %PRODUCTNAME to be invoked from Basic macros or Python scripts. Its modules and classes are invoked from user scripts as "Services" that expose properties, methods and events.</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id681623415196030" role="listitem">Whenever service methods are proposed solely for %PRODUCTNAME Basic, their syntax presentation matches that of Basic subroutines, functions or properties. </paragraph> + </listitem> + <listitem> + <paragraph id="par_id401623415235965" role="listitem">Whenever service methods are proposed for Python and Basic, or solely for Python, their syntax and arguments use a specific textual layout.</paragraph> + </listitem> + </list> + + <h2 id="hd_id1001623415980365">Basic only service method</h2> + <paragraph role="paragraph" id="par_id791623418737799">Typographical characters such as brackets, ellipsis or curly braces denote optional, repetitive or compulsory arguments:</paragraph> + <embed href="text/sbasic/shared/conventions.xhp#Typography"/> + <h3 id="hd_id511616863794613" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id241623422100136">FSO.HashFile(FileName As String, _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101623423263928"> Algorithm As String = {MD5|SHA1|SHA224|SHA256|SHA384|SHA512}) As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851623422099952">SF_Array.ImportFromCSVFile(FileName As String, _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741623423196368"> [Delimiter = ","], [DateFormat As String]) As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691623422100368">SF_String.SplitNotQuoted(InputStr As String, _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881623423667888"> [Delimiter As String], [Occurrences As Long], [QuoteChar As String]) As Variant</paragraph> + </bascode> + + <h2 id="hd_id711623416000470">Python or Basic service methods</h2> + <paragraph role="paragraph" id="par_id221623415475781">The following typographical rules are mixing the UML notation, the API documentation layout and the UNO object inspector user interface:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id661623417427142" role="listitem">Optional parameters are indicated with either opt, '=' accompanying a default value, or '[ ]' brackets.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id351623417430814" role="listitem">arguments are lowercased, in order to comply with Python PEP 8 while Basic is case-agnostic.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id781623417432494" role="listitem">Collections arguments or API sequences are denoted using UML multiplicity. That applies also to return values.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id741623417433319" role="listitem">Basic data types and Python annotations are syntactically transposed as:</paragraph> + </listitem> + </list> + <table id="tab_Datatypes"> + <tablerow> + <tablecell> + <paragraph id="par_id131613838858931" localize="false" role="tablehead">%PRODUCTNAME<br/>Basic</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441613838858931" role="tablehead">Syntax</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441613839128931" localize="false" role="tablehead">Python</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851613847558931" role="tablecontent">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="par_id581613836728425">bool</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontent" localize="false" id="par_id731613840022120">bool</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241623419591966" localize="false" role="tablecontent">Date</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541623420256687" localize="false" role="tablecontent">datetime</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421623420257224" localize="false" role="tablecontent">datetime</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id651623419593960" localize="false" role="tablecontent">Double</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321623420281678" localize="false" role="tablecontent">float</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471623420282320" localize="false" role="tablecontent">float</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id421623419594151" localize="false" role="tablecontent">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971623420314751" localize="false" role="tablecontent">int</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561623420315278" localize="false" role="tablecontent">int</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id511623419594366" localize="false" role="tablecontent">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451623420342159" localize="false" role="tablecontent">int</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591623420343208" localize="false" role="tablecontent">int</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id541623419594576" localize="false" role="tablecontent">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601623420375543" localize="false" role="tablecontent">obj</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601628420375147" localize="false" role="tablecontent"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id931623419594783" localize="false" role="tablecontent">Single</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821623420532337" localize="false" role="tablecontent">float</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351623420532936" localize="false" role="tablecontent">float</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id391623419595010" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211623420546503" localize="false" role="tablecontent">str</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id681623420559167" localize="false" role="tablecontent">str</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id61623419595200" localize="false" role="tablecontent">Variant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81623420571390" localize="false" role="tablecontent">any</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601628420044847" localize="false" role="tablecontent"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id931623419595424" role="tablecontent">UNO Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821623420607671" localize="false" role="tablecontent">uno</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601628420332587" localize="false" role="tablecontent"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951623419595631" role="tablecontent">User Defined<br/>Type (UDT)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491623420626262" localize="false" role="tablecontent">obj</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601628420215874" localize="false" role="tablecontent"></paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id451623419793734" role="tablecontent"><literal>ScriptForge</literal><br/>service</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761623420648335" localize="false" role="tablecontent">svc</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601628420373974" localize="false" role="tablecontent"></paragraph> + </tablecell> + </tablerow> + </table> + <h3 id="hd_id622616863794724" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#functexample"/></h3> + <paragraph role="paragraph" localize="false" id="par_id261623421276448"><input>svc.Forms( opt form: any ): svc[0..*]</input></paragraph> + <paragraph role="paragraph" localize="false" id="par_id921623420866535"><input>svc.MsgBox( prompt: str, buttons = svc.MB_OK , opt title: str ): opt str</input></paragraph> + <paragraph role="paragraph" localize="false" id="par_id641623420867288"><input>svc.InputBox( prompt: str, default = "", [ title: str ], [ xpostwips: int, ypostwips: int ] ): str</input></paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_platform.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_platform.xhp new file mode 100644 index 000000000..c9283925b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_platform.xhp @@ -0,0 +1,412 @@ +<?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_Platform" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.Platform service</title> + <filename>/text/sbasic/shared/03/sf_platform.xhp</filename> + </topic> + </meta> +<body> +<section id="ScriptForge-sf_platform"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id501600788076381"> + <bookmark_value>Platform service</bookmark_value> + </bookmark> +</section> +<section id="abstract"> + <h1 id="bm_id681600788076499"><variable id="PlatformService"><link href="text/sbasic/shared/03/sf_platform.xhp" name="Platform service"><literal>ScriptForge</literal>.<literal>Platform</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id181600788076612">The <literal>Platform</literal> service provides a collection of properties about the current execution environment and context, such as:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id301600788076785" role="listitem">The hardware platform (architecture, CPU count, machine type, etc)</paragraph> + </listitem> + <listitem> + <paragraph id="par_id1001600788076848" role="listitem">Operating system information (OS type, release, version, etc)</paragraph> + </listitem> + <listitem> + <paragraph id="par_id67160078807676" role="listitem">The %PRODUCTNAME version</paragraph> + </listitem> + <listitem> + <paragraph id="par_id671600788076855" role="listitem">The current user name</paragraph> + </listitem> + </list> +</section> + <note id="par_id951614903258253">All properties of the <literal>Platform</literal> service are read-only.</note> + <h2 id="hd_id281600788076359">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Platform</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id321614902851541">The examples below in Basic and Python instantiate the <literal>Platform</literal> service and access the <literal>Architecture</literal> property.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id851600788076202">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001600788076254">Dim platform As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721600788076288">platform = CreateScriptService("Platform")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791600788431935">MsgBox platform.Architecture</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id631626695710139">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626695710433">svc = CreateScriptService("Platform")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id311626695710851">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391626695711082">bas.MsgBox(svc.Architecture)</paragraph> + </pycode> + <bookmark xml-lang="en-US" branch="index" localize="false" id="bm_id111614901524769"> + <bookmark_value>Platform service;Architecture</bookmark_value> + <bookmark_value>Platform service;ComputerName</bookmark_value> + <bookmark_value>Platform service;CPUCount</bookmark_value> + <bookmark_value>Platform service;CurrentUser</bookmark_value> + <bookmark_value>Platform service;Extensions</bookmark_value> + <bookmark_value>Platform service;Fonts</bookmark_value> + <bookmark_value>Platform service;FormatLocale</bookmark_value> + <bookmark_value>Platform service;Locale</bookmark_value> + <bookmark_value>Platform service;Machine</bookmark_value> + <bookmark_value>Platform service;OfficeLocale</bookmark_value> + <bookmark_value>Platform service;OfficeVersion</bookmark_value> + <bookmark_value>Platform service;OSName</bookmark_value> + <bookmark_value>Platform service;OSPlatform</bookmark_value> + <bookmark_value>Platform service;OSRelease</bookmark_value> + <bookmark_value>Platform service;OSVersion</bookmark_value> + <bookmark_value>Platform service;Printers</bookmark_value> + <bookmark_value>Platform service;Processor</bookmark_value> + <bookmark_value>Platform service;PythonVersion</bookmark_value> + <bookmark_value>Platform service;SystemLocale</bookmark_value> + </bookmark> + <h2 id="hd_id711600788076834">Properties</h2> + <table id="tab_id701600788076583"> + <tablerow> + <tablecell> + <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076591" role="tablehead">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076328" role="tablehead">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id67160078807636" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491600788076621" role="tablecontent" localize="false">Architecture</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311600788076756" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831600788076785" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441600788076826" role="tablecontent">The hardware bit architecture. Example: '<literal>32bit</literal>' or '<literal>64bit</literal>'</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id941600788076595" role="tablecontent" localize="false">ComputerName</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id49160078807654" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961600788076376" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81600788076419" role="tablecontent">The computer's network name.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721600788076638" role="tablecontent" localize="false">CPUCount</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711600788076534" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911600788076842" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541600788076645" role="tablecontent">The number of central processing units.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id961600788076890" role="tablecontent" localize="false">CurrentUser</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891600788076190" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076562" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91600788076674" role="tablecontent">The name of the currently logged user.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021719246" localize="false" role="tablecontent">Extensions</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021747014" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021748566" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021749125" role="tablecontent">Returns a zero-based array of strings containing the internal IDs of all installed extensions.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021716585" localize="false" role="tablecontent">FilterNames</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021747209" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021748322" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021749118" role="tablecontent">Returns a zero-based unsorted array of strings containing the available document import and export filter names.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021719135" localize="false" role="tablecontent">Fonts</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021747903" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021748455" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021749007" role="tablecontent">Returns a zero-based array of strings containing the names of all available fonts.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021710186" localize="false" role="tablecontent">FormatLocale</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021748013" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021749655" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021749297" role="tablecontent">Returns the locale used for numbers and dates as a string in the format "la-CO" (language-COUNTRY).</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021719022" localize="false" role="tablecontent">Locale</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021743188" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021743058" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021749018" role="tablecontent">Returns the locale of the operating system as a string in the format "la-CO" (language-COUNTRY). This is equivalent to the <literal>SystemLocale</literal> property.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951600788076443" role="tablecontent" localize="false">Machine</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391600788076253" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381600788076799" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21600788076541" role="tablecontent">The machine type. Examples are: '<literal>i386</literal>' or '<literal>x86_64</literal>'.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021710156" localize="false" role="tablecontent">OfficeLocale</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021706513" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021746335" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021741117" role="tablecontent">Returns the locale of the user interface as a string in the format "la-CO" (language-COUNTRY).</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id41600788076936" role="tablecontent" localize="false">OfficeVersion</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211600788076138" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076518" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521600788076371" role="tablecontent">The actual %PRODUCTNAME version expressed as<br />' <literal>%PRODUCTNAME w.x.y.z (The Document Foundation)</literal>'.</paragraph> + <paragraph role="paragraph" id="par_id621614902220807">Example: '<literal>LibreOffice 7.4.1.2 (The Document Foundation, Debian and Ubuntu)</literal>'</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161600788076362" role="tablecontent" localize="false">OSName</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21600788076758" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id871600788076196" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781600788076694" role="tablecontent">The operating system type. Example: '<literal>Darwin</literal>, <literal>Linux</literal>' or '<literal>Windows</literal>'.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471600788076885" role="tablecontent" localize="false">OSPlatform</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261600788076841" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661600788076636" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id11600788076757" role="tablecontent">A single string identifying the underlying platform with as much useful and human-readable information as possible.</paragraph> + <paragraph role="paragraph" id="par_id501614902381381">Example: '<literal>Linux-5.8.0-44-generic-x86_64-with-glibc2.32</literal>'</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id221600789141781" role="tablecontent" localize="false">OSRelease</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531600789141795" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561600789141282" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301600789141619" role="tablecontent">The operating system's release. Example: '<literal>5.8.0-44-generic</literal>'</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821600789286339" role="tablecontent" localize="false">OSVersion</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541600789286532" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id181600789286889" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701600789286280" role="tablecontent">The operating system's build or version.</paragraph> + <paragraph role="paragraph" id="par_id351614902520555">Example: '<literal>#50-Ubuntu SMP Tue Feb 9 06:29:41 UTC 2021</literal>'</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31600789752717" role="tablecontent" localize="false">Printers</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941608709527698" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id100100678952791" role="tablecontent" localize="false">String<br/>array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661300789527859" role="tablecontent">The list of available printers as a zero-based array.</paragraph> + <paragraph role="paragraph" id="par_id111614952098396">The default printer is put in the first position of the list (index = 0).</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31600789527717" role="tablecontent" localize="false">Processor</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941600789527698" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id100160078952791" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id631600789527859" role="tablecontent">The real processor name. Example: '<literal>amdk6</literal>'.</paragraph> + <paragraph role="paragraph" id="par_id111614902598396">This property may return the same value as the <literal>Machine</literal> property.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31600789752228" role="tablecontent" localize="false">PythonVersion</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id941608709527036" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id100100678952208" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661300789527994" role="tablecontent">Returns the version of the Python interpreter being used as a string in the format "Python major.minor.patchlevel" (ex: "Python 3.9.7").</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id83163302112358" localize="false" role="tablecontent">SystemLocale</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021708547" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021746229" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021741336" role="tablecontent">Returns the locale of the operating system as a string in the format "la-CO" (language-COUNTRY). This is equivalent to the <literal>Locale</literal> property.</paragraph> + </tablecell> + </tablerow> + </table> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id311633022159446">The following examples in Basic and Python illustrate how to use the <literal>Fonts</literal> property to write the names of all available fonts to the current Calc sheet starting at cell "A1":</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671633022413022">Dim oDoc as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721633022413266">Dim allFonts as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691633022413526">Dim svcPlatform as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id41633022413831">Set oDoc = CreateScriptService("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541633022414069">Set svcPlatform = CreateScriptService("Platform")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641633022414366">allFonts = svcPlatform.Fonts</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651633022414637">oDoc.setArray("~.A1", allFonts)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id701633022704347">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841633022704586">svc_platform = CreateScriptService("Platform")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id281633022704771">doc = CreateScriptService("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211633022704988">all_fonts = svc_platform.Fonts</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941633022705212">doc.setArray("~.A1", all_fonts)</paragraph> + </pycode> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/python/python_platform.xhp#pythonplatform"/> + <paragraph role="paragraph" id="par_id301613065794148"><link href="text/scalc/01/04060104.xhp#bm_id3691824" name="Calc_Info">Platform information with INFO("system") Calc formula</link></paragraph> + <embed href="text/sbasic/shared/03132100.xhp#getguitype2"/> + <embed href="text/sbasic/shared/03/lib_tools.xhp#tools_lib"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_popupmenu.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_popupmenu.xhp new file mode 100644 index 000000000..b36ebbda3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_popupmenu.xhp @@ -0,0 +1,348 @@ +<?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_PopupMenu" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFWidgets.PopupMenu service</title> + <filename>/text/sbasic/shared/03/sf_popupmenu.xhp</filename> + </topic> +</meta> +<body> + <section id="ScriptForge-sf_popupmenu"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id501600788076877"> + <bookmark_value>PopupMenu service</bookmark_value> + </bookmark> + </section> + <section id="abstract"> + <h1 id="bm_id681600788076499"><variable id="PopupMenuService"><link href="text/sbasic/shared/03/sf_popupmenu.xhp" name="PopupMenu service"><literal>SFWidgets</literal>.<literal>PopupMenu</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id181600788076612">The <literal>PopupMenu</literal> service can be used to create popup menus that can be associated with events or executed by scripts. This service provides the following capabilities:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id301600788076785" role="listitem">Creation of popup menus with custom entries, checkboxes and radio buttons.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id1001600788076848" role="listitem">Decoration of menu items with icons and tooltips.</paragraph> + </listitem> + </list> + </section> + + <h2 id="hd_id281600788076359">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>PopupMenu</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id321614902851541">The <literal>PopupMenu</literal> service can be instantiated in multiple ways. The example below creates a popup menu without associating it with a mouse or application event.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id701636718117715">Sub ShowPopup</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851600788076202"> GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id100160078076254"> Dim myPopup As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721600788076288"> Set myPopup = CreateScriptService("SFWidgets.PopupMenu", , 300, 300)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791600788431935"> myPopup.AddItem("Item ~A")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791600788431755"> myPopup.AddItem("Item ~B")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791600788431206"> vResponse = myPopup.Execute()</paragraph> + <paragraph role="bascode" id="bas_id841636717357955"> MsgBox("Selected item ID: " & vResponse)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801636717387904"> myPopup.Dispose()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721636718154385">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id341636718182262">Running the <literal>Sub</literal> defined above will create a popup menu with two entries in the position X=300 and Y=300 on the screen.</paragraph> + <tip id="par_id711636493696169">The prefix <literal>SFWidgets</literal> can be suppressed while invoking the <literal>PopupMenu</literal> service.</tip> + <paragraph role="paragraph" id="par_id851635274721129">The following example defines a <literal>Sub</literal> that can be associated with a mouse event:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id221635274765110">Sub MyPopupClick(Optional poMouseEvent as Object)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461635274776072"> Dim myPopup As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621635274776400"> Set myPopup = CreateScriptService("PopupMenu", poMouseEvent)</paragraph> + <paragraph role="bascode" id="bas_id721636488722999"> ' Populate popupmenu with items</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201636488724356"> Dim vResponse As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371636488724573"> vResponse = myPopup.Execute(False)</paragraph> + <paragraph role="bascode" id="bas_id311636488724795"> ' Do something based on vResponse</paragraph> + <paragraph role="bascode" localize="false" id="bas_id501636493549364"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721636718367863"> myPopup.Dispose()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941636493510454">End Sub</paragraph> + </bascode> + <tip id="par_id991636718278125">Use the <literal>Dispose</literal> method to free resources after executing the popup menu.</tip> + <paragraph role="paragraph" id="par_id531636493797707">It is also possible to associate a popup menu with events triggered by %PRODUCTNAME applications, form and dialog controls. Events such as "Mouse button pressed" and "Mouse button released" are commonly associated with popup menus.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id221635274762410">Sub MyPopupClick(Optional poEvent as Object)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461635274776234"> Dim myPopup As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621635274776299"> Set myPopup = CreateScriptService("PopupMenu", poEvent)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id501636493549964"> ' ...</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941636493510712">End Sub</paragraph> + </bascode> + + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id131635275172617">The examples above can be written in Python as follows:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id631626695710139">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441636718456158"></paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441636718456844">def show_popup(args=None):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626695710433"> my_popup = CreateScriptService("SFWidgets.PopupMenu", None, 300, 300)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626695710122"> bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id311626695710851"> my_popup.AddItem("Item ~A")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211636717609237"> my_popup.AddItem("Item ~B")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id616367176100230"> response = my_popup.Execute()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id901636718500313"> bas.MsgBox(f"Selected item ID: {response}")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id416367185012216"> my_popup.Dispose()</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831635275439182">def my_popup_click(poEvent=None):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381635275439396"> my_popup = CreateScriptService("SFWidgets.PopupMenu", poEvent)</paragraph> + <paragraph role="pycode" id="pyc_id916367179574588"> # Populate popupmenu with items</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981636717957632"> response = my_popup.Execute()</paragraph> + <paragraph role="pycode" id="pyc_id851636718008427"> # Do something based on response</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id331636727047102"> my_popup.Dispose()</paragraph> + </pycode> + + <bookmark xml-lang="en-US" branch="index" localize="false" id="bm_id111614901520029"> + <bookmark_value>PopupService service;ShortcutCharacter</bookmark_value> + <bookmark_value>PopupService service;SubmenuCharacter</bookmark_value> + </bookmark> + <h2 id="hd_id711600788076834">Properties</h2> + <table id="tab_id701600788076583"> + <tablerow> + <tablecell> + <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076591" role="tablehead">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076328" role="tablehead">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id67160078807636" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id941600788076595" role="tablecontent" localize="false">ShortcutCharacter</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id49160078807654" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961600788076376" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81600788076419" role="tablecontent">Character used to define the access key of a menu item. The default character is "~".</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491600788076621" role="tablecontent" localize="false">SubmenuCharacter</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311600788076756" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831600788076785" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441600788076826" role="tablecontent">Character or string that defines how menu items are nested. The default character is ">".</paragraph> + </tablecell> + </tablerow> + </table> + + <h2 id="hd_id181636719707892">Menu and Submenus</h2> + <paragraph role="paragraph" id="par_id741636719725402">To create a popup menu with submenus, use the character defined in the <literal>SubmenuCharacter</literal> property while creating the menu entry to define where it will be placed. For instance, consider the following menu/submenu hierarchy.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id991636719842353">' Item A</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231636719842719">' Item B > Item B.1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421636719842904">' Item B.2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id916367201523640">' ------ (line separator)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541636719843240">' Item C > Item C.1 > Item C.1.1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701636719843447">' Item C.1.2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id601636719843672">' Item C > Item C.2 > Item C.2.1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921636719843864">' Item C.2.2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921636719843567">' ------ (line separator)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921636719843154">' Item C.2.3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921636719843965">' Item C.2.4</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id211636720111489">The code below uses the default submenu character ">" to create the menu/submenu hierarchy defined above:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id961636720555061">myPopup.AddItem("Item A")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371636720556397">myPopup.AddItem("Item B>Item B.1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941636720556623">myPopup.AddItem("Item B>Item B.2")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261636720973178">myPopup.AddItem("---")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431636720556822">myPopup.AddItem("Item C>Item C.1>Item C.1.1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651636720557021">myPopup.AddItem("Item C>Item C.1>Item C.1.2")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id861636720557222">myPopup.AddItem("Item C>Item C.2>Item C.2.1")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21636720557437">myPopup.AddItem("Item C>Item C.2>Item C.2.2")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21636720557103">myPopup.AddItem("Item C>Item C.2>---")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21636720557256">myPopup.AddItem("Item C>Item C.2>Item C.2.3")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21636720557941">myPopup.AddItem("Item C>Item C.2>Item C.2.4")</paragraph> + </bascode> + <note id="par_id121636721243578">The string "---" is used to define line separators in menus or submenus..</note> + <section id="using_icons"> + <h2 id="hd_id211636723438558">Using icons</h2> + <paragraph role="paragraph" id="par_id981636723485402">Items in the menu can have icons, which are specified as arguments in the <literal>AddCheckBox</literal>, <literal>AddItem</literal> and <literal>AddRadioButton</literal> methods.</paragraph> + <paragraph role="paragraph" id="par_id881636724112434">All icons available in %PRODUCTNAME can be used by specifying their path relative to the folder where icon files are located in the installation folder. Icons are located in the following folder:</paragraph> + <paragraph role="paragraph" localize="false" id="par_id991636724479899"><input>INSTALLDIR/share/config</input></paragraph> + <tip id="par_id941636724808906">Use the <literal>InstallFolder</literal> property of the <literal>FileSystem</literal> service to determine where %PRODUCTNAME is installed in your system.</tip> + <paragraph role="paragraph" id="par_id201636724575911">This folder contains a series of ZIP files containing the image files of each available icon set. The images inside these ZIP files are organized into folders. To use an icon, specify the icon file with the path to its location inside the ZIP file.</paragraph> + <paragraph role="paragraph" id="par_id641636724972071">The example below uses the icon "sc_newdoc.svg" that is located inside the "cmd" folder. The forward slash "/" character is used as the path separator regardless of the operating system.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id121636725026678">myMenu.AddItem("Item A", Icon := "cmd/sc_newdoc.svg")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id361643307394680">myMenu.AddItem("Item A", icon="cmd/sc_newdoc.svg")</paragraph> + </pycode> + <note id="par_id691636725233961">All icon sets have the same internal structure. The actual icon displayed depends on the icon set currently in use.</note> + </section> + + <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the PopupMenu Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_popupmenu.xhp#AddCheckBox" name="AddCheckBox method">AddCheckBox</link><br/> + <link href="text/sbasic/shared/03/sf_popupmenu.xhp#AddItem" name="AddItem method">AddItem</link> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_popupmenu.xhp#AddRadioButton" name="AddRadioButton method">AddRadioButton</link><br/><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613625804" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_popupmenu.xhp#Execute" name="Execute method">Execute</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + + <section id="AddCheckBox"> + <comment> AddCheckBox ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969883"> + <bookmark_value>PopupMenu service;AddCheckBox</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698251" localize="false">AddCheckBox</h2> + <paragraph role="paragraph" id="par_id93158919969864">Inserts a check box in the popup menu. Returns an integer value that identifies the inserted item.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534014732"> + <input>svc.AddCheckBox(menuitem: str, opt name: str, opt status: bool = False, opt icon: str, opt tooltip: str): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203996"><emph>menuitem:</emph> Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character.</paragraph> + <paragraph role="paragraph" id="par_id821591631203116"><emph>name:</emph> String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used.</paragraph> + <paragraph role="paragraph" id="par_id821591631203133"><emph>status:</emph> Defines whether the item is selected when the menu is created (Default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id11636721653313"><emph>icon:</emph> Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used.</paragraph> + <paragraph role="paragraph" id="par_id11636721653208"><emph>tooltip:</emph> Text to be displayed as tooltip.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41158919969204">myPopup.AddCheckBox("Option A", Status := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534175122">my_popup.AddCheckBox("Option A", status=True)</paragraph> + </pycode> + </section> + + <section id="AddItem"> + <comment> AddItem ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919960353"> + <bookmark_value>PopupMenu service;AddItem</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698158" localize="false">AddItem</h2> + <paragraph role="paragraph" id="par_id93158919963364">Inserts a menu entry in the popup menu. Returns an integer value that identifies the inserted item.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534012185"> + <input>svc.AddItem(menuitem: str, opt name: str, opt icon: str, opt tooltip: str): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203021"><emph>menuitem:</emph> Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character.</paragraph> + <paragraph role="paragraph" id="par_id821591631203026"><emph>name:</emph> String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used.</paragraph> + <paragraph role="paragraph" id="par_id11636721652886"><emph>icon:</emph> Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used.</paragraph> + <paragraph role="paragraph" id="par_id11636721653118"><emph>tooltip:</emph> Text to be displayed as tooltip.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id41158919969106">myPopup.AddItem("Item A", Tooltip := "A descriptive message")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id321621534170554">my_popup.AddItem("Item A", tooltip = "A descriptive message")</paragraph> + </pycode> + </section> + + <section id="AddRadioButton"> + <comment> AddRadioButton --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969447"> + <bookmark_value>PopupMenu service;AddRadioButton</bookmark_value> + </bookmark> + <h2 id="hd_id201589199693022" localize="false">AddRadioButton</h2> + <paragraph role="paragraph" id="par_id93158919969399">Inserts a radio button entry in the popup menu. Returns an integer value that identifies the inserted item.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534013775"> + <input>svc.AddRadioButton(menuitem: str, opt name: str, opt status: bool = False, opt icon: str, opt tooltip: str): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631203501"><emph>menuitem:</emph> Defines the text to be displayed in the menu. This argument also defines the hierarchy of the item inside the menu by using the submenu character.</paragraph> + <paragraph role="paragraph" id="par_id821591631228716"><emph>name:</emph> String value to be returned when the item is clicked. By default, the last component of the menu hierarchy is used.</paragraph> + <paragraph role="paragraph" id="par_id821591631203643"><emph>status:</emph> Defines whether the item is selected when the menu is created (Default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id11636721653228"><emph>icon:</emph> Path and name of the icon to be displayed without the leading path separator. The actual icon shown depends on the icon set being used.</paragraph> + <paragraph role="paragraph" id="par_id11636721653114"><emph>tooltip:</emph> Text to be displayed as tooltip.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41158919969658">myPopup.AddRadioButton("Option A", Name := "A", Status := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534175471">my_popup.AddRadioButton("Option A", name="A", status=True)</paragraph> + </pycode> + </section> + + <section id="Execute"> + <comment> Execute --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919962887"> + <bookmark_value>PopupMenu service;Execute</bookmark_value> + </bookmark> + <h2 id="hd_id201589199693201" localize="false">Execute</h2> + <paragraph role="paragraph" id="par_id93158919963279">Displays the popup menu and waits for a user action. Returns the item clicked by the user.</paragraph> + <paragraph role="paragraph" id="par_id101636726249788">If the user clicks outside the popup menu or presses the <keycode>Esc</keycode> key, then no item is selected. In such cases, the returned value depends on the <literal>returnid</literal> parameter. If <literal>returnid = True</literal> and no item is selected, then the value 0 (zero) is returned. Otherwise an empty string "" is returned.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821621534014414"> + <input>svc.Execute(opt returnid: bool = True): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id821591631202088"><emph>returnid:</emph> If <literal>True</literal> the selected item ID is returned. If <literal>False</literal> the method returns the item's name (Default = <literal>True</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id51636726671698">In the examples below, a popup menu is created and the item's name is returned because the <literal>returnid</literal> argument is set to <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41158919963328">myPopup.AddItem("Item A", Name := "A")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91636726598754">myPopup.AddItem("Item B", Name := "B")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871636726599326">Dim vResponse as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351636726599500">vResponse = myPopup.Execute(False)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id321621534173001">my_popup.AddItem("Item A", name="A")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id271636726772842">my_popup.AddItem("Item B", name="B")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id621636726773015">response = my_popup.Execute(False)</paragraph> + </pycode> + </section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_dialog.xhp#dlg_h1"/> + <embed href="text/sbasic/shared/03/sf_dialogcontrol.xhp#ctrls_h1"/> + <embed href="text/sbasic/shared/03/sf_menu.xhp#MenuService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_region.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_region.xhp new file mode 100644 index 000000000..2fee97f17 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_region.xhp @@ -0,0 +1,605 @@ +<?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_Region" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.Region service</title> + <filename>/text/sbasic/shared/03/sf_region.xhp</filename> + </topic> + </meta> +<body> +<section id="ScriptForge-sf_region"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id501600788079651"> + <bookmark_value>Region service</bookmark_value> + </bookmark> +</section> +<section id="abstract"> + <h1 id="bm_id681600788076499"><variable id="RegionService"><link href="text/sbasic/shared/03/sf_region.xhp" name="Region service"><literal>ScriptForge</literal>.<literal>Region</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id181600788076612">The <literal>Region</literal> service provides a collection of properties and methods to handle locale and region-related aspects of programming, such as:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id301600788076785" role="listitem">Accessing locale and region-dependent settings such as number formatting, currency and timezones.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id1001600788076848" role="listitem">Converting timezones and calculate Daylight Saving Time (DST) offsets.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id67160078807676" role="listitem">Transforming numbers into text in any supported language.</paragraph> + </listitem> + </list> +</section> + + <h2 id="hd_id851656012844548">Definitions</h2> + <h3 id="hd_id421656012886648">Locale or Region</h3> + <paragraph role="paragraph" id="par_id191656012908838">A string combining a language and a country in the format "la-CO". The language part is expressed with 2 or 3 lowercase characters followed by a dash and 2 uppercase characters representing the country.</paragraph> + <paragraph role="paragraph" id="par_id431656013368415">For instance, "en-US" corresponds to the English language in the United States; "fr-BE" corresponds to the French language in Belgium, and so forth.</paragraph> + <paragraph role="paragraph" id="par_id981656013623018">On some situations the full locale is not required and only the language or country may be specified.</paragraph> + <note id="par_id261656013132204">Most properties and methods accept a locale as argument. If no locale is specified, then the user-interface locale is used, which is defined in the <link href="text/sbasic/shared/03/sf_platform.xhp#bm_id111614901524769" name="OfficeLocale_link"><literal>OfficeLocale</literal></link> property of the <literal>Platform</literal> service.</note> + <h3 id="hd_id51656013825718">Timezone</h3> + <paragraph role="paragraph" id="par_id541656013854150">A string in the format "Region/City" such as "Europe/Berlin", or a timezone ID such as "UTC" or "GMT-8:00". Refer to the wiki page <link href="https://wikipedia.org/wiki/List_of_tz_database_time_zones" name="TimeZones_List">List of tz database and timezones</link> for a list of possible timezone names and IDs.</paragraph> + <warning id="par_id981656078937577">Providing an invalid timezone string to any of the methods in the <literal>Region</literal> service will not result in a runtime error. Instead, methods as <literal>UTCDateTime</literal> and <literal>UTCNow</literal> will return the current operating system date and time.</warning> + <paragraph role="paragraph" id="par_id611656014040098">The time offset between the timezone and the Greenwich Meridian Time (GMT) is expressed in minutes.</paragraph> + <paragraph role="paragraph" id="par_id121656014053670">The Daylight Saving Time (DST) is an additional offset.</paragraph> + <note id="par_id591656014140929">The timezone and DST offsets may be positive or negative.</note> + + <h2 id="hd_id281600788076359">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Region</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + <paragraph role="paragraph" id="par_id321614902851541">The examples below in Basic and Python instantiate the <literal>Region</literal> service and access the <literal>Country</literal> property.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id851600788076202">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001600788076254">Dim oRegion As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721600788076288">oRegion = CreateScriptService("Region")</paragraph> + <paragraph role="bascode" id="bas_id791600788431935">MsgBox oRegion.Country("en-US") ' United States</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id631626695710139">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626695710433">oRregion = CreateScriptService("Region")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id311626695710851">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391626695711082">bas.MsgBox(oRegion.Country("en-US"))</paragraph> + </pycode> + + <bookmark xml-lang="en-US" branch="index" localize="false" id="bm_id11161490152686"> + <bookmark_value>Region service;Country</bookmark_value> + <bookmark_value>Region service;Currency</bookmark_value> + <bookmark_value>Region service;DatePatterns</bookmark_value> + <bookmark_value>Region service;DateSeparator</bookmark_value> + <bookmark_value>Region service;DayAbbrevNames</bookmark_value> + <bookmark_value>Region service;DayNames</bookmark_value> + <bookmark_value>Region service;DayNarrowNames</bookmark_value> + <bookmark_value>Region service;DecimalPoint</bookmark_value> + <bookmark_value>Region service;Language</bookmark_value> + <bookmark_value>Region service;ListSeparator</bookmark_value> + <bookmark_value>Region service;MonthAbbrevNames</bookmark_value> + <bookmark_value>Region service;MonthNames</bookmark_value> + <bookmark_value>Region service;MonthNarrowNames</bookmark_value> + <bookmark_value>Region service;ThousandSeparator</bookmark_value> + <bookmark_value>Region service;TimeSeparator</bookmark_value> + </bookmark> + + <h2 id="hd_id711600788076834">Properties</h2> + <paragraph role="paragraph" id="par_id601656018689690">All properties listed below accept a <literal>locale</literal> argument, provided as a string. Some properties require this argument to be in the format "la-CO", whereas others may receive "la" or "CO" as input.</paragraph> + + <table id="tab_id701600788076583"> + <tablerow> + <tablecell> + <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076591" role="tablehead">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076328" role="tablehead">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330679679" role="tablehead">Locale</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id67160078807636" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491600788076621" role="tablecontent" localize="false">Country</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311600788076756" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831600788076785" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411656330757666" role="tablecontent" localize="false">"la‑CO"<br/>"CO"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441600788076826" role="tablecontent">Returns the country name in English corresponding to a given region.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id941600788076595" role="tablecontent" localize="false">Currency</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id49160078807654" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961600788076376" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330815396" role="tablecontent" localize="false">"la-CO"<br/>"CO"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81600788076419" role="tablecontent">Returns the ISO 4217 currency code of the specified region.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721600788076638" role="tablecontent" localize="false">DatePatterns</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711600788076534" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911600788076842" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330815199" role="tablecontent" localize="false">"la-CO"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541600788076645" role="tablecontent">Returns a zero-based array of strings containing the date acceptance patterns for the specified region.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id961600788076890" role="tablecontent" localize="false">DateSeparator</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891600788076190" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076562" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330809635" role="tablecontent" localize="false">"la-CO"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91600788076674" role="tablecontent">Returns the date separator used in the given region.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021719246" localize="false" role="tablecontent">DayAbbrevNames</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021747014" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021748566" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330815320" role="tablecontent" localize="false">"la-CO"<br/>"la"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021745014" role="tablecontent">Returns a zero-based array of strings containing the list of abbreviated weekday names in the specified language.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021716585" localize="false" role="tablecontent">DayNames</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021747209" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021748322" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330815767" role="tablecontent" localize="false">"la-CO"<br/>"la"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021748865" role="tablecontent">Returns a zero-based array of strings containing the list of weekday names in the specified language.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021719135" localize="false" role="tablecontent">DayNarrowNames</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021747903" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021748455" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330819641" role="tablecontent" localize="false">"la-CO"<br/>"la"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021747711" role="tablecontent">Returns a zero-based array of strings containing the list of the initials of weekday names in the specified language.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021710186" localize="false" role="tablecontent">DecimalPoint</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021748013" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021749655" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330816830" role="tablecontent" localize="false">"la-CO"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021749297" role="tablecontent">Returns the decimal separator used in numbers in the specified region.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021719022" localize="false" role="tablecontent">Language</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021743188" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021743058" localize="false" role="tablecontent">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330816697" role="tablecontent" localize="false">"la-CO"<br/>"la"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021749018" role="tablecontent">Returns the name of the language, in English, of the specified region.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id951600788076443" role="tablecontent" localize="false">ListSeparator</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391600788076253" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381600788076799" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330816642" role="tablecontent" localize="false">"la-CO"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21600788076541" role="tablecontent">Returns the list separator used in the specified region.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831633021710156" localize="false" role="tablecontent">MonthAbbrevNames</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561633021706513" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201633021746335" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330814533" role="tablecontent" localize="false">"la-CO"<br/>"la"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831633021741117" role="tablecontent">Returns a zero-based array of strings containing the list of abbreviated month names in the specified language.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id41600788076936" role="tablecontent" localize="false">MonthNames</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211600788076138" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076518" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330817644" role="tablecontent" localize="false">"la-CO"<br/>"la"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521600788076371" role="tablecontent">Returns a zero-based array of strings containing the list of month names in the specified language.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161600788076362" role="tablecontent" localize="false">MonthNarrowNames</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21600788076758" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id871600788076196" role="tablecontent">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330812262" role="tablecontent" localize="false">"la-CO"<br/>"la"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781600788076694" role="tablecontent">Returns a zero-based array of strings containing the list of the initials of month names in the specified language.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471600788076885" role="tablecontent" localize="false">ThousandSeparator</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261600788076841" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661600788076636" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330844830" role="tablecontent" localize="false">"la-CO"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id116007880767507" role="tablecontent">Returns the thousands separator used in numbers in the specified region.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id221600789141781" role="tablecontent" localize="false">TimeSeparator</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531600789141795" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561600789141282" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131656330817766" role="tablecontent" localize="false">"la-CO"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301600789141619" role="tablecontent">Returns the separator used to format times in the specified region.</paragraph> + </tablecell> + </tablerow> + </table> + + <table id="tab_id901611086279902"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the Region Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_region.xhp#DSTOffset" name="DSTOffset method">DSTOffset</link><br/> + <link href="text/sbasic/shared/03/sf_region.xhp#LocalDateTime" name="LocalDateTime method">LocalDateTime</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_region.xhp#Number2Text" name="Number2Text method">Number2Text</link><br/> + <link href="text/sbasic/shared/03/sf_region.xhp#TimeZoneOffset" name="TimeZoneOffset method">TimeZoneOffset</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086279903" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_region.xhp#UTCDateTime" name="UTCDateTime method">UTCDateTime</link><br/> + <link href="text/sbasic/shared/03/sf_region.xhp#UTCNow" name="UTCNow method">UTCNow</link><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + + <section id="DSTOffset"> + <comment> DSTOffset ---------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969187"> + <bookmark_value>Region service;DSTOffset</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698020" localize="false">DSTOffset</h2> + <paragraph role="paragraph" id="par_id71621894830071">Computes the additional Daylight Saving Time (DST) offset, in minutes, that is applicable to a given region and timezone.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897208117"> + <input>svc.DSTOffset(localdatetime: date, timezone: str, opt locale: str): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401621896675880"><emph>localdatetime</emph>: the local date and time expressed as a date.</paragraph> + <paragraph role="paragraph" id="par_id401621896675125"><emph>timezone</emph>: the timezone for which the offset will be calculated.</paragraph> + <paragraph role="paragraph" id="par_id401621896675963"><emph>locale</emph>: the locale specifying the country for which the offset will be calculated, given either in "la-CO" or "CO" formats. The default value is the locale defined in the <link href="text/sbasic/shared/03/sf_platform.xhp#bm_id111614901524769" name="OfficeLocale_link"><literal>OfficeLocale</literal></link> property of the <literal>Platform</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id531656022497519">' Calculates the offset applicable in the "America/Los_Angeles" timezone</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201656782497415">Dim aDateTime As Date, offset As Integer</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201656022497919">aDateTime = DateSerial(2022, 7, 1) + TimeSerial(16, 0, 0)</paragraph> + <paragraph role="bascode" id="bas_id801656022498143">offset = oRegion.DSTOffset(aDateTime, "America/Los_Angeles", "US") ' 60 (minutes)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id601656022498128">aDateTime = DateSerial(2022, 1, 1) + TimeSerial(16, 0, 0)</paragraph> + <paragraph role="bascode" id="bas_id831656022498543">offset = oRegion.DSTOffset(aDateTime, "America/Los_Angeles", "US") ' 0 (minutes)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761621898860952">import datetime</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id861621898933001">aDateTime = datetime.datetime(2022, 7, 1, 16, 0, 0)</paragraph> + <paragraph role="pycode" id="pyc_id871621898933281">offset = oRegion.DSTOffset(aDateTime, "America/Los_Angeles", "US") ' 60 (minutes)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id861621898934287">aDateTime = datetime.datetime(2022, 1, 1, 16, 0, 0)</paragraph> + <paragraph role="pycode" id="pyc_id871621898934141">offset = oRegion.DSTOffset(aDateTime, "America/Los_Angeles", "US") ' 0 (minutes)</paragraph> + </pycode> + </section> + + <section id="LocalDateTime"> + <comment> LocalDateTime ------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969630"> + <bookmark_value>Region service;LocalDateTime</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698124" localize="false">LocalDateTime</h2> + <paragraph role="paragraph" id="par_id71621894832058">Computes the local date and time from a UTC date and time.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897208785"> + <input>svc.LocalDateTime(utcdatetime: date, timezone: str, opt locale: str): date</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401621896674716"><emph>utcdatetime</emph>: the UTC date and time, expressed using a date object.</paragraph> + <paragraph role="paragraph" id="par_id401621896675449"><emph>timezone</emph>: the timezone for which the local time will be calculated.</paragraph> + <paragraph role="paragraph" id="par_id401621896675193"><emph>locale</emph>: the locale specifying the country for which the local time will be calculated, given either in "la-CO" or "CO" formats. The default value is the locale defined in the <link href="text/sbasic/shared/03/sf_platform.xhp#bm_id111614901524769" name="OfficeLocale_link"><literal>OfficeLocale</literal></link> property of the <literal>Platform</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id201656022497017">' June 6th, 2022 at 10:30:45 (used here as UTC time)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711656454548454">Dim UTCTime As Date, localTime As Date</paragraph> + <paragraph role="bascode" localize="false" id="bas_id803696022498143">UTCTime = DateSerial(2022, 6, 23) + TimeSerial(10, 30, 45)</paragraph> + <paragraph role="bascode" id="bas_id531656022497121">' Calculates local time in Sao Paulo, Brazil</paragraph> + <paragraph role="bascode" id="bas_id601656022498318">' June 6th, 2022 at 07:30:45</paragraph> + <paragraph role="bascode" localize="false" id="bas_id830696022498543">localTime = oRegion.LocalDateTime(UTCTime, "America/Sao_Paulo", "BR")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id761621898833352">import datetime</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id861621898933128">utcTime = datetime.datetime(2022, 6, 23, 10, 30, 45)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871621898933337">localTime = oRegion.LocalDateTime(utcTime, "America/Sao_Paulo", "BR")</paragraph> + </pycode> + </section> + + <section id="Number2Text"> + <comment> Number2Text ------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919966650"> + <bookmark_value>Region service;Number2Text</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698374" localize="false">Number2Text</h2> + <paragraph role="paragraph" id="par_id71621894832089">Converts numbers and monetary values into written text for any of the currently supported languages.</paragraph> + <tip id="par_id971656026551328">For a list of all supported languages visit the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1linguistic2_1_1XNumberText.html" name="XNumberText">XNumberText Interface</link> API reference.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897208441"> + <input>svc.Number2Text(number: any, opt locale: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401621896675306"><emph>number</emph>: the number to be converted into written text. It can be provided either as a numeric type or as a string. When a string is provided, it can be preceded by a prefix informing how the numbers should be written. It is also possible to include ISO 4217 currency codes. See examples below for more information.</paragraph> + <paragraph role="paragraph" id="par_id401621896675412"><emph>locale</emph>: the locale defining the language into which the number will be converted to, given either in "la-CO" or "la" formats. The default value is the locale defined in the <link href="text/sbasic/shared/03/sf_platform.xhp#bm_id111614901524769" name="OfficeLocale_link"><literal>OfficeLocale</literal></link> property of the <literal>Platform</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id301656027173020">' Returns "one hundred five"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851656454602974">Dim numText As String</paragraph> + <paragraph role="bascode" id="bas_id531656022496631">numText = oRegion.Number2Text(105, "en-US")</paragraph> + <paragraph role="bascode" id="bas_id771656027217144">' Returns: "two point four two"</paragraph> + <paragraph role="bascode" id="bas_id201656022493367">numText = oRegion.Number2Text(2.42, "en-US")</paragraph> + <paragraph role="bascode" id="bas_id281656027262234">' Returns: "twenty-five euro and ten cents" Notice the "EUR" currency symbol</paragraph> + <paragraph role="bascode" id="bas_id201656022497171">numText = oRegion.Number2Text("EUR 25.10", "en-US")</paragraph> + <paragraph role="bascode" id="bas_id981656027330132">' Returns: "fifteenth"; Notice the "ordinal" prefix</paragraph> + <paragraph role="bascode" id="bas_id841656027330394">numText = oRegion.Number2Text("ordinal 15", "en-US")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id401656027481473">numText = oRegion.Number2Text(105, "en-US")</paragraph> + <paragraph role="pycode" id="pyc_id781656027481769">numText = oRegion.Number2Text(2.42, "en-US")</paragraph> + <paragraph role="pycode" id="pyc_id951656027482096">numText = oRegion.Number2Text("EUR 25.10", "en-US")</paragraph> + <paragraph role="pycode" id="pyc_id231656027482425">numText = oRegion.Number2Text("ordinal 15", "en-US")</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id801656027524051">To get a list of all supported prefixes in a given language, call <literal>Number2Text</literal> with the special "help" argument, as shown in the example below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id851656027713735">prefixes = oRegion.Number2Text("help")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id716560277139601">MsgBox prefixes</paragraph> + <paragraph role="bascode" id="bas_id181656027807107">' Considering the "en-US" locale the message box will show the following text</paragraph> + <paragraph role="bascode" id="bas_id216560277123601">' one, two, three</paragraph> + <paragraph role="bascode" id="bas_id361656027712711">' ordinal: first, second, third</paragraph> + <paragraph role="bascode" id="bas_id891656027712920">' ordinal-number: 1st, 2nd, 3rd</paragraph> + <paragraph role="bascode" id="bas_id611656027713104">' year: nineteen ninety-nine, two thousand, two thousand one</paragraph> + <paragraph role="bascode" id="bas_id861656027713288">' currency (for example, USD): two U.S. dollars and fifty cents</paragraph> + <paragraph role="bascode" id="bas_id841656027713503">' money USD: two and 50/100 U.S. dollars</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id781656027840633">The first line in the message box does not have a prefix, which means that it is the standard format. The subsequent lines include the prefix and some examples of numbers using its format.</paragraph> + <note id="par_id781656028528520">Each language has its own set of supported prefixes.</note> + </section> + + <section id="TimeZoneOffset"> + <comment> TimeZoneOffset ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919966017"> + <bookmark_value>Region service;TimeZoneOffset</bookmark_value> + </bookmark> + <h2 id="hd_id201589199691085" localize="false">TimeZoneOffset</h2> + <paragraph role="paragraph" id="par_id71621894832117">Returns the offset between GMT and the given timezone and locale, in minutes.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897203066"> + <input>svc.TimeZoneOffset(timezone: str, opt locale: str): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401621896675018"><emph>timezone</emph>: the timezone for which the offset to the GMT will be calculated.</paragraph> + <paragraph role="paragraph" id="par_id401621896675691"><emph>locale</emph>: the locale specifying the country for which the offset will be calculated, given either in "la-CO" or "CO" formats. The default value is the locale defined in the <link href="text/sbasic/shared/03/sf_platform.xhp#bm_id111614901524769" name="OfficeLocale_link"><literal>OfficeLocale</literal></link> property of the <literal>Platform</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id101656454730797">Dim offset As Integer</paragraph> + <paragraph role="bascode" localize="false" id="bas_id916560675890495">offset = oRegion.TimeZoneOffset("America/New_York", "US") ' -300</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211656075890806">offset = oRegion.TimeZoneOffset("Europe/Berlin", "DE") ' 60</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id1001656076044293">offset = oRegion.TimeZoneOffset("America/New_York", "US") # -300</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id5015656076044605">offset = oRegion.TimeZoneOffset("Europe/Berlin", "DE") # 60</paragraph> + </pycode> + </section> + + <section id="UTCDateTime"> + <comment> UTCDateTime ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919943207"> + <bookmark_value>Region service;UTCDateTime</bookmark_value> + </bookmark> + <h2 id="hd_id201589199691808" localize="false">UTCDateTime</h2> + <paragraph role="paragraph" id="par_id71621894864217">Returns the UTC date and time considering a given local date and time in a timezone.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897202644"> + <input>svc.UTCDateTime(localdatetime: date, timezone: str, opt locale: str): date</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401621896674748"><emph>localdatetime</emph>: the local date and time in a specific timezone expressed as a date.</paragraph> + <paragraph role="paragraph" id="par_id401621896675739"><emph>timezone</emph>: the timezone for which the <literal>localdatetime</literal> argument was given.</paragraph> + <paragraph role="paragraph" id="par_id401621896675550"><emph>locale</emph>: the locale specifying the country for which the <literal>localdatetime</literal> argument was given, expressed either in "la-CO" or "CO" formats. The default value is the locale defined in the <link href="text/sbasic/shared/03/sf_platform.xhp#bm_id111614901524769" name="OfficeLocale_link"><literal>OfficeLocale</literal></link> property of the <literal>Platform</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id861656077547861">' Date/Time in Berlin, June 23, 2022 at 14:30:00</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771656454767976">Dim localDT As Date, utcTime As Date</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911656077521797">localDT = DateSerial(2022, 6, 23) + TimeSerial(14, 30, 0)</paragraph> + <paragraph role="bascode" id="bas_id731656077523173">' The UTC date/time is June 23, 2022 at 12:30:00</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001656077527477">utcTime = oRegion.UTCDateTime(localDT, "Europe/Berlin", "DE")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id361656077667354">import datetime</paragraph> + <paragraph role="pycode" id="pyc_id901656077667666">localDT = datetime.datetime(2022, 6, 23, 14, 30, 0)</paragraph> + <paragraph role="pycode" id="pyc_id521656077682826">utcTime = oRegion.UTCDateTime(localDT, "Europe/Berlin", "DE")</paragraph> + </pycode> + </section> + + <section id="UTCNow"> + <comment> UTCNow ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919939587"> + <bookmark_value>Region service;UTCNow</bookmark_value> + </bookmark> + <h2 id="hd_id201589199694336" localize="false">UTCNow</h2> + <paragraph role="paragraph" id="par_id71621894835287">Returns the current UTC date and time, given a timezone and locale.</paragraph> + <paragraph role="paragraph" id="par_id491656078254442">This method uses the current date and time of your operating system to calculate the UTC time.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897201935"> + <input>svc.UTCNow(timezone: str, opt locale: str): date</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401621896673318"><emph>timezone</emph>: the timezone for which the current UTC time will be calculated.</paragraph> + <paragraph role="paragraph" id="par_id401621896674831"><emph>locale</emph>: the locale specifying the country for which the current UTC time will be calculated, given either in "la-CO" or "CO" formats. The default value is the locale defined in the <link href="text/sbasic/shared/03/sf_platform.xhp#bm_id111614901524769" name="OfficeLocale_link"><literal>OfficeLocale</literal></link> property of the <literal>Platform</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id861656078128374">' Suppose the operating system time is June 23rd, 2022 at 10:42:00</paragraph> + <paragraph role="bascode" id="bas_id691656078180784">' If the computer is in Europe/Berlin, then UTC time is June 23rd, 2022 at 08:42:00</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351656454814865">Dim utcTime As Date</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881656078243397">utcTime = oRegion.UTCNow("Europe/Berlin", "DE")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" id="pyc_id821656078645252">utcTime = oRegion.UTCNow("Europe/Berlin", "DE")</paragraph> + </pycode> + </section> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_platform.xhp#PlatformService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_services.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_services.xhp new file mode 100644 index 000000000..e8462b426 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_services.xhp @@ -0,0 +1,107 @@ +<?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"><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" id="par_id241627513489594">The main purpose of the <literal>Services</literal> module is to provide access to the <literal>CreateScriptService</literal> method, which can be called in user scripts to instantiate services that are implemented using the ScriptForge framework.</paragraph> +</section> +<paragraph role="paragraph" id="par_id351582710868545">In ScriptForge terminology a service is a collection of methods and properties that can be used for a common purpose. For example, the <literal>String</literal> service provides methods for manipulating strings whereas the <literal>FileSystem</literal> service allows for the manipulation of files and folders.</paragraph> +<tip id="par_id541627513771828">The <literal>Services</literal> module of the ScriptForge library provides additional methods that are used either internally to register available services or by developers who are interested in extending ScriptForge by creating new services. The only method that is relevant for user scripts is <literal>CreateScriptService</literal>.</tip> + +<section id="CreateScriptService"> + <comment> CreateScriptService ----------------------------------------------------------------------------------- </comment> + <bookmark 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">This method is used to instantiate a ScriptForge service so it can be called in user scripts.</paragraph> + <paragraph role="paragraph" id="par_id711627514310039">The returned value is a Basic object or <literal>Nothing</literal> if an error occurred.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id961627475353964"> + <input>svc.CreateScriptService(service: str, [arg0: any] ...): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id971582714020045"><emph>service</emph>: The name of the service identified as a string in the format "library.service":</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id11627475954271" role="listitem">The <emph>library</emph> 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".</paragraph> + </listitem> + <listitem> + <paragraph id="par_id811627475954641" role="listitem">The <emph>service</emph> is one of the services registered by the ScriptForge library.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id391582714020045"><emph>arg0, ...</emph>: A list of arguments required by the invoked service.</paragraph> + <paragraph role="paragraph" id="par_id841627475900817">If the first argument refers to an event manager, then <literal>arg0</literal> is mandatory and must be the UNO object representing the event provided as argument to the user macro.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <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> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id881627426495369">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id431627426495747">svc = CreateScriptService("Array")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id681627426496018">svc = CreateScriptService("ScriptForge.Dictionary")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id811627426496299">svc = CreateScriptService("SFDocuments.Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id811627426496564">svc = CreateScriptService("Timer", True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id921627426496940">svc = CreateScriptService("SFDocuments.DocumentEvent", oEvent)</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id321627570607194">Python scripts support keyword arguments when calling <literal>CreateScriptService</literal>. The following example illustrates this concept by instantiating the <literal>Timer</literal> and <literal>Document</literal> services using keyword arguments.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id771627570744091">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id351627570744359"># Timer</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181627570744511">my_timer = CreateScriptService("Timer", start = True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id321627570744655"># Document</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id591627570744815">my_doc = CreateScriptService("Document", windowname = "some_file.ods")</paragraph> + </pycode> + <tip id="par_id901627576693156">To make writing Python scripts more fluid, ScriptForge provides the <literal>Basic</literal> service which allows Python scripts to call a collection of methods with the same syntax and meaning as their homonymous native Basic functions.</tip> + <paragraph role="paragraph" id="par_id41627644806288">The following example instantiates the <literal>Basic</literal> service and calls the <literal>MsgBox</literal> method, which is equivalent to the <literal>MsgBox</literal> function available in Basic:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id521627644939451">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id241627644939717">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id841627644939897">bas.MsgBox("Hello World!")</paragraph> + </pycode> + <note id="par_id581627645023307">Beware that the <literal>Basic</literal> service has to be instantiated in Python scripts using the <literal>CreateScriptService</literal> method.</note> +</section> + +<embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_basic.xhp#BasicService"/> + <embed href="text/sbasic/shared/03103700.xhp#Set_h1"/> + <embed href="text/sbasic/shared/03131900.xhp#GlobalScope_h1"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_session.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_session.xhp new file mode 100644 index 000000000..ff4124323 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_session.xhp @@ -0,0 +1,693 @@ +<?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_Session" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.Session service</title> + <filename>/text/sbasic/shared/03/sf_session.xhp</filename> + </topic> +</meta> +<body> + <section id="abstract"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id661582814720399"> + <bookmark_value>Session service</bookmark_value> + </bookmark> + <h1 id="hd_id901582814720985" xml-lang="en-US"><variable id="SessionService"><link href="text/sbasic/shared/03/sf_session.xhp" name="Session service"><literal>ScriptForge.Session</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id861582814720987" xml-lang="en-US">The <literal>Session</literal> service gathers various general-purpose methods about:</paragraph> + <list type = "unordered"> + <listitem> + <paragraph id="par_id34158281472051" role="listitem" xml-lang="en-US">the installation or execution environment</paragraph> + </listitem> + <listitem> + <paragraph id="par_id411582814720361" role="listitem" xml-lang="en-US">UNO introspection</paragraph> + </listitem> + <listitem> + <paragraph id="par_id321582814720863" role="listitem" xml-lang="en-US">the invocation of external scripts or programs</paragraph> + </listitem> + </list> + </section> + + <h2 id="hd_id91582814720116" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Session</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id931582897922121">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961582814720760">Dim session As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651582814720203">session = CreateScriptService("Session")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id891626808716096">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id261626808717344">session = CreateScriptService("Session")</paragraph> + </pycode> + <h2 id="hd_id291582814720762" xml-lang="en-US">Constants</h2> + <paragraph role="paragraph" id="par_id82158281472034" xml-lang="en-US">Below is a list of constants available to ease the designation of the library containing a Basic or Python script to invoke. Use them as <literal>session.CONSTANT</literal>.</paragraph> + <section id="constants"> + <table id="tab_id291582814720160"> + <tablerow> + <tablecell> + <paragraph id="par_id381582814720870" role="tablehead" xml-lang="en-US" localize="false">CONSTANT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id9158281472045" role="tablehead" xml-lang="en-US">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id241582814720636" role="tablehead" xml-lang="en-US">Where to find the library?</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id361582814720116" role="tablehead" xml-lang="en-US">Applicable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821582814720218" role="tablecontent" xml-lang="en-US" localize="false">SCRIPTISEMBEDDED</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401582814720597" role="tablecontent" xml-lang="en-US" localize="false">"document"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451582814720105" role="tablecontent" xml-lang="en-US">in the document</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421582814720733" role="tablecontent" xml-lang="en-US" localize="false">Basic + Python</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id191582814720876" role="tablecontent" xml-lang="en-US" localize="false">SCRIPTISAPPLICATION</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601582814720388" role="tablecontent" xml-lang="en-US" localize="false">"application"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id73158281472032" role="tablecontent" xml-lang="en-US">in any shared library</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id291582814720233" role="tablecontent" xml-lang="en-US" localize="false">Basic</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id571582814720667" role="tablecontent" xml-lang="en-US" localize="false">SCRIPTISPERSONAL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id4158281472033" role="tablecontent" xml-lang="en-US" localize="false">"user"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391582814720487" role="tablecontent" xml-lang="en-US">in My Macros</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701582814720517" role="tablecontent" xml-lang="en-US" localize="false">Python</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id691582814720670" role="tablecontent" xml-lang="en-US" localize="false">SCRIPTISPERSOXT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401582814720356" role="tablecontent" xml-lang="en-US" localize="false">"user:uno_packages"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id56158281472073" role="tablecontent" xml-lang="en-US">in an extension installed for the current user</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611582814720723" role="tablecontent" xml-lang="en-US" localize="false">Python</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id781582814720282" role="tablecontent" xml-lang="en-US" localize="false">SCRIPTISSHARED</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991582814720953" role="tablecontent" xml-lang="en-US" localize="false">"share"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21582814720997" role="tablecontent" xml-lang="en-US">in %PRODUCTNAME macros</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491582814720794" role="tablecontent" xml-lang="en-US" localize="false">Python</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id371582814720280" role="tablecontent" xml-lang="en-US" localize="false">SCRIPTISSHAROXT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id51582814720754" role="tablecontent" xml-lang="en-US" localize="false">"share:uno_packages"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981582814720125" role="tablecontent" xml-lang="en-US">in an extension installed for all users</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id66158281472037" role="tablecontent" xml-lang="en-US" localize="false">Python</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id71582814720886" role="tablecontent" xml-lang="en-US" localize="false">SCRIPTISOXT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id51582814720584" role="tablecontent" xml-lang="en-US" localize="false">"uno_packages"</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id93158281472047" role="tablecontent" xml-lang="en-US">in an extension but the installation parameters are unknown</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601582814720689" role="tablecontent" xml-lang="en-US" localize="false">Python</paragraph> + </tablecell> + </tablerow> + </table> + </section> + +<table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Session Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_session.xhp#ExecuteBasicScript" name="ExecuteBasicScript method">ExecuteBasicScript</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#ExecuteCalcFunction" name="ExecuteCalcFunction method">ExecuteCalcFunction</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#ExecutePythonScript" name="ExecutePythonScript method">ExecutePythonScript</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#GetPDFExportOptions" name="GetPDFExportOptions method">GetPDFExportOptions</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#HasUnoMethod" name="HasUnoMethod method">HasUnoMethod</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_session.xhp#HasUnoProperty" name="HasUnoProperty method">HasUnoProperty</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#OpenURLInBrowser" name="OpenURLInBrowser method">OpenURLInBrowser</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#RunApplication" name="RunApplication method">RunApplication</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#SendMail" name="SendMail method">SendMail</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#SetPDFExportOptions" name="SetPDFExportOptions method">SetPDFExportOptions</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_session.xhp#UnoMethods" name="UnoMethods method">UnoMethods</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#UnoProperties" name="UnoProperties method">UnoProperties</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#UnoObjectType" name="UnoObjectType method">UnoObjectType</link><br/> + <link href="text/sbasic/shared/03/sf_session.xhp#WebService" name="WebService method">WebService</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> +</table> + + <tip id="par_id491613061572993"><literal>Execute...</literal> methods in <literal>Session</literal> service behave as follows: + <br/>Arguments are passed by value. Changes made by the called function to the arguments do not update their values in the calling script. + <br/>A single value or an array of values is returned to the calling script. + </tip> + +<section id="ExecuteBasicScript"> + <comment> ExecuteBasicScript ------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id41582815407230"> + <bookmark_value>Session service;ExecuteBasicScript</bookmark_value> + </bookmark> + <h2 id="hd_id281582815407230" localize="false">ExecuteBasicScript</h2> + <paragraph role="paragraph" id="par_id451582815407230">Execute the Basic script given its name and location and fetch its result if any.</paragraph> + <paragraph role="paragraph" id="par_id921600856780901" xml-lang="en-US">If the script returns nothing, which is the case of procedures defined with <literal>Sub</literal>, the returned value is <literal>Empty</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id131626808989444"> + <input>session.ExecuteBasicScript(scope: str, script: str, args: any[0..*]): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id631582815407231"><emph>scope</emph>: String specifying where the script is stored. It can be either "document" (constant <literal>session.SCRIPTISEMBEDDED</literal>) or "application" (constant <literal>session.SCRIPTISAPPLICATION</literal>).</paragraph> + <paragraph role="paragraph" id="par_id691582815407231"><emph>script</emph>: String specifying the script to be called in the format "library.module.method" as a case-sensitive string.</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id741626828862265" role="listitem">The library is loaded in memory if necessary.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id981626828863001" role="listitem">The module must not be a class module.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id721626828863257" role="listitem">The method may be a <literal>Sub</literal> or a <literal>Function</literal>.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id881582815407231"><emph>args</emph>: The arguments to be passed to the called script.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id21626809513802">Consider the following Basic function named <literal>DummyFunction</literal> that is stored in "My Macros" in the "Standard" library inside a module named "Module1".</paragraph> + <paragraph role="paragraph" id="par_id551626810319766">The function simply takes in two integer values <literal>v1</literal> and <literal>v2</literal> and return the sum of all values starting in <literal>v1</literal> and ending in <literal>v2</literal>.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id21626810243092">Function DummyFunction(v1 as Integer, v2 as Integer) As Long</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571626810243635"> Dim result as Long, i as Integer</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321626810243876"> For i = v1 To v2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631626810244299"> result = result + i</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321626810244676"> Next i</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641626810245084"> DummyFunction = result</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381626810245324">End Function</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id461626810470057">The examples below show how to call <literal>DummyFunction</literal> from within Basic and Python scripts.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id251626810696112">Dim session : session = CreateScriptService("Session")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321626810696366">Dim b_script as String, result as Long</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291626810696576">b_script = "Standard.Module1.DummyFunction"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751626810696799">result = session.ExecuteBasicScript("application", b_script, 1, 10)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991626810697024">MsgBox result ' 55</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id291626810829019">session = CreateScriptService("Session")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231626810829279">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id261626810829451">b_script = 'Standard.Module1.DummyFunction'</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id111626810829725">result = session.ExecuteBasicScript('application', b_script, 1, 10)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id111626810838070">bas.MsgBox(result) # 55</paragraph> + </pycode> +</section> + +<section id="ExecuteCalcFunction"> + <comment> ExecuteCalcFunction ------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id571582816585180"> + <bookmark_value>Session service;ExecuteCalcFunction</bookmark_value> + </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 <link href="text/scalc/01/04060107.xhp" name="array formula">array formula</link>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701626811351722"> + <input>session.ExecuteCalcFunction(calcfunction: str, args: any[0..*]): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id771582816585183"><emph>calcfunction</emph>: The name of the Calc function to be called, in English.</paragraph> + <paragraph role="paragraph" id="par_id371582816585183"><emph>args</emph>: The arguments to be passed to the called Calc function. Each argument must be either a string, a numeric value or an array of arrays combining those types.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id461582816585184">session.ExecuteCalcFunction("AVERAGE", 1, 5, 3, 7) ' 4</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641582816585185">session.ExecuteCalcFunction("ABS", Array(Array(-1, 2, 3), Array(4, -5, 6), Array(7, 8, -9)))(2)(2) ' 9</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241582817051111">session.ExecuteCalcFunction("LN", -3)</paragraph> + <paragraph role="bascode" id="bas_id881582816585185" xml-lang="en-US">' Generates an error.</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id781626816579430">session.ExecuteCalcFunction("AVERAGE", 1, 5, 3, 7) # 4</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id721626816579849">session.ExecuteCalcFunction("ABS", ((-1, 2, 3), (4, -5, 6), (7, 8, -9)))[2][2] # 9</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id191626816580053">session.ExecuteCalcFunction("LN", -3)</paragraph> + </pycode> +</section> + +<section id="ExecutePythonScript"> + <comment> ExecutePythonScript ------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id671582818023244"> + <bookmark_value>Session service;ExecutePythonScript</bookmark_value> + </bookmark> + <h2 id="hd_id741582818023244" localize="false">ExecutePythonScript</h2> + <paragraph role="paragraph" id="par_id571582818023245">Execute the Python script given its location and name, fetch its result if any. Result can be a single value or an array of values.</paragraph> + <paragraph role="paragraph" id="par_id71600856817410" xml-lang="en-US">If the script is not found, or if it returns nothing, the returned value is <literal>Empty</literal>.</paragraph> + <embed href="text/sbasic/python/python_2_basic.xhp#APIScriptingFramework" /> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id421626816736635"> + <input>session.ExecutePythonScript(scope: str, script: str, args: any[0..*]): any</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id791582818023246"><emph>scope</emph>: One of the applicable constants listed <link href="text/sbasic/shared/03/sf_session.xhp#constants" name="Session constants">above</link>. The default value is <literal>session.SCRIPTISSHARED</literal>.</paragraph> + <paragraph role="paragraph" id="par_id71582818023247"><emph>script</emph>: Either "library/module.py$method" or "module.py$method" or "myExtension.oxt|myScript|module.py$method" as a case-sensitive string.</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id501613061041313" role="listitem">library: The folder path to the Python module.</paragraph></listitem> + <listitem><paragraph id="par_id771613061043097" role="listitem">myScript: The folder containing the Python module.</paragraph></listitem> + <listitem><paragraph id="par_id301613061123849" role="listitem">module.py: The Python module.</paragraph></listitem> + <listitem><paragraph id="par_id241613061044560" role="listitem">method: The Python function.</paragraph></listitem> + </list> + <paragraph role="paragraph" id="par_id711582818023247"><emph>args</emph>: The arguments to be passed to the called script.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id701626817164878">Consider the Python function <literal>odd_integers</literal> defined below that creates a list with odd integer values between <literal>v1</literal> and <literal>v2</literal>. Suppose this function is stored in a file named <emph>my_macros.py</emph> in your user scripts folder.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id21626817636630">def odd_integers(v1, v2):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231626817636935"> odd_list = [v for v in range(v1, v2 + 1) if v % 2 != 0]</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id901626817637127"> return odd_list</paragraph> + </pycode> + <tip id="par_id751626817335715">Read the help page <link href="text/sbasic/python/python_locations.xhp" name="pylocation_link">Python Scripts Organization and Location</link> to learn more about where Python scripts can be stored.</tip> + <paragraph role="paragraph" id="par_id121626817725471">The following examples show how to call the function <literal>odd_integers</literal> from within Basic and Python scripts.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id481626817835712">Dim script as String, session as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id141626817836000">script = "my_macros.py$odd_integers"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371626817836256">session = CreateScriptService("Session")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711626817836519">Dim result as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id221626817836809">result = session.ExecutePythonScript(session.SCRIPTISPERSONAL, script, 1, 9)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91626817837112">MsgBox SF_String.Represent(result)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id231626818075452">session = CreateScriptService("Session")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id481626818075720">script = "my_macros.py$odd_integers"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id661626818075938">result = session.ExecutePythonScript(session.SCRIPTISPERSONAL, script, 1, 9)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id811626818076162">bas.MsgBox(repr(result))</paragraph> + </pycode> +</section> + +<section id="GetPDFExportOptions"> + <comment> GetPDFExportOptions ------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id571582816536250"> + <bookmark_value>Session service;GetPDFExportOptions</bookmark_value> + </bookmark> + <h2 id="hd_id551582816589871" localize="false">GetPDFExportOptions</h2> + <paragraph role="paragraph" id="par_id111582816585087">Returns the current PDF export settings defined in the <menuitem>PDF Options</menuitem> dialog, which can be accessed by choosing <menuitem>File - Export as - Export as PDF</menuitem>.</paragraph> + <paragraph role="paragraph" id="par_id931638383270026">Export options set with the <menuitem>PDF Options</menuitem> dialog are kept for future use. Hence <literal>GetPDFExportOptions</literal> returns the settings currently defined. In addition, use <literal>SetPDFExportOptions</literal> to change current PDF export options.</paragraph> + <paragraph role="paragraph" id="par_id801638383659558">This method returns a <literal>Dictionary</literal> object wherein each key represent export options and the corresponding values are the current PDF export settings.</paragraph> + <tip id="par_id751638383457198">Read the <link href="https://wiki.openoffice.org/wiki/API/Tutorials/PDF_export" name="PDFExport_Wiki">PDF Export wiki page</link> to learn more about all available options.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701626811351883"> + <input>session.GetPDFExportOptions(): obj</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id361638384343807">Dim expSettings As Object, msg As String, key As String, optLabels As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721638384344196">expSettings = session.GetPDFExportOptions()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181638384344396">optLabels = expSettings.Keys</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271638384344575">For Each key in optLabels</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711638384344810"> msg = msg + key & ": " & expSettings.Item(key) & Chr(10)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651638384345031">Next key</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101638384345303">MsgBox msg</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431638384345510">' Zoom: 100</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001638384345677">' Changes: 4</paragraph> + <paragraph role="bascode" localize="false" id="bas_id11638384345891">' Quality: 90</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471638384346131">' ...</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#Basic_Only"/> +</section> + +<section id="HasUnoMethod"> + <comment> HasUnoMethod ------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id901587477335292"> + <bookmark_value>Session service;HasUnoMethod</bookmark_value> + </bookmark> + <h2 id="hd_id58158747733586" localize="false">HasUnoMethod</h2> + <paragraph role="paragraph" id="par_id111587477335982">Returns <literal>True</literal> if an UNO object contains the given method. Returns <literal>False</literal> when the method is not found or when an argument is invalid.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id761626818201301"> + <input>session.HasUnoMethod(unoobject: uno, methodname: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id921587477335673"><emph>unoobject</emph>: The object to inspect.</paragraph> + <paragraph role="paragraph" id="par_id631587477566016" xml-lang="en-US"><emph>methodname</emph>: the method as a case-sensitive string</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id471587477335112">Dim a As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71587477335350">a = CreateUnoService("com.sun.star.sheet.FunctionAccess")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671587477335639">MsgBox session.HasUnoMethod(a, "callFunction") ' True</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id201626818671015">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id781626818671422">a = bas.createUnoService("com.sun.star.sheet.FunctionAccess")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441626818671679">result = session.HasUnoMethod(a, "callFunction")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626818671871">bas.MsgBox(result) # True</paragraph> + </pycode> +</section> + +<section id="HasUnoProperty"> + <comment> HasUnoProperty ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id511587477832348"> + <bookmark_value>Session service;HasUnoProperty</bookmark_value> + </bookmark> + <h2 id="hd_id521587477832241" localize="false">HasUnoProperty</h2> + <paragraph role="paragraph" id="par_id191587477832959">Returns <literal>True</literal> if a UNO object has the given property. Returns <literal>False</literal> when the property is not found or when an argument is invalid.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821626818816336"> + <input>session.HasUnoProperty(unoobject: uno, propertyname: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id121587477832805"><emph>unoobject</emph>: The object to inspect.</paragraph> + <paragraph role="paragraph" id="par_id701587477832750" xml-lang="en-US"><emph>propertyname</emph>: the property as a case-sensitive string</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <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> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id331626818906928">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id191626818907607">a = bas.createUnoService("com.sun.star.sheet.FunctionAccess")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id951626818907799">result = session.HasUnoProperty(a, "Wildcards")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441626818907959">bas.MsgBox(result) # True</paragraph> + </pycode> +</section> + +<section id="OpenURLInBrowser"> + <comment> OpenURLInBrowser --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id321601129640799"> + <bookmark_value>Session service;OpenURLInBrowser</bookmark_value> + </bookmark> + <h2 id="hd_id971601129640909" localize="false">OpenURLInBrowser</h2> + <paragraph role="paragraph" id="par_id97160112964017">Open a Uniform Resource Locator (<link href="text/shared/00/00000002.xhp#URL" name="URL">URL</link>) in the default browser.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id831626819024511"> + <input>session.OpenURLInBrowser(url: str)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id241601129640549"><emph>url</emph>: The URL to open.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id531626819105690">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781601129640527">session.OpenURLInBrowser("help.libreoffice.org/")</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id551626819119460"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121626819119605">session.OpenURLInBrowser("help.libreoffice.org/")</paragraph> + </pycode> +</section> + +<section id="RunApplication"> + <comment> RunApplication ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id121582819697896"> + <bookmark_value>Session service;RunApplication</bookmark_value> + </bookmark> + <h2 id="hd_id511582819697896" localize="false">RunApplication</h2> + <paragraph role="paragraph" id="par_id311582819697897">Executes an arbitrary system command and returns <literal>True</literal> if it was launched successfully.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id691626819239862"> + <input>session.RunApplication(command: str, parameters: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id461582819697898"><emph>command</emph>: The command to execute. This may be an executable file or a document which is registered with an application so that the system knows what application to launch for that document. The command must be expressed in the current <literal>SF_FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id611582819697899"><emph>parameters</emph>: A list of space separated parameters as a single string. The method does not validate the given parameters, but only passes them to the specified command.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id111582819697900">session.RunApplication("Notepad.exe")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851582819697900">session.RunApplication("C:\myFolder\myDocument.odt")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641582819697901">session.RunApplication("kate", "/home/user/install.txt") ' GNU/Linux</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id381626819384936">session.RunApplication("Notepad.exe")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id601626819385217">session.RunApplication(r"C:\myFolder\myDocument.odt")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211626819385376">session.RunApplication("kate", "/home/user/install.txt") # GNU/Linux</paragraph> + </pycode> +</section> + +<section id="SendMail"> + <comment> SendMail ------------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id601601030349204"> + <bookmark_value>Session service;SendMail</bookmark_value> + </bookmark> + <h2 id="hd_id561601030349199" localize="false">SendMail</h2> + <paragraph role="paragraph" id="par_id131601030349755">Send a message - with optional attachments - to recipients from the user's mail client. The message may be edited by the user before sending or, alternatively, be sent immediately.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id691626819545788"> + <input>session.SendMail(recipient: str, cc: str = '', bcc: str = '', subject: str = '', body: str = '', filenames: str = '', editmessage: bool = True)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id701601030349896"><emph>recipient</emph>: An email address (the "To" recipient).</paragraph> + <paragraph role="paragraph" id="par_id571601030349904"><emph>cc</emph>: A comma-separated list of email addresses (the "carbon copy" recipients).</paragraph> + <paragraph role="paragraph" id="par_id961601031043346"><emph>bcc</emph>: A comma-separated list of email addresses (the "blind carbon copy" recipients).</paragraph> + <paragraph role="paragraph" id="par_id891601031050814"><emph>subject</emph>: the header of the message.</paragraph> + <paragraph role="paragraph" id="par_id191601031056673"><emph>body</emph>: The contents of the message as an unformatted text.</paragraph> + <paragraph role="paragraph" id="par_id511601031063269"><emph>filenames</emph>: a comma-separated list of file names. Each file name must respect the <literal>SF_FileSystem.FileNaming</literal> notation.</paragraph> + <paragraph role="paragraph" id="par_id161601032784063"><emph>editmessage</emph>: When <literal>True</literal> (default), the message is edited before being sent.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id481601030349950">session.SendMail("someone@example.com" _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id901601032999905"> , Cc := "b@other.fr, c@other.be" _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651601033006799"> , FileNames := "C:\myFile1.txt, C:\myFile2.txt")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821626819725867">session.SendMail("someone@example.com",</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391626819726171"> cc="john@other.fr, mary@other.be"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id771626819726363"> filenames=r"C:\myFile1.txt, C:\myFile2.txt")</paragraph> + </pycode> +</section> + +<section id="SetPDFExportOptions"> + <comment> SetPDFExportOptions ------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id571582816563070"> + <bookmark_value>Session service;SetPDFExportOptions</bookmark_value> + </bookmark> + <h2 id="hd_id551582816583371" localize="false">SetPDFExportOptions</h2> + <paragraph role="paragraph" id="par_id111582816583005">Modifies the PDF export settings defined in the <menuitem>PDF Options</menuitem> dialog, which can be accessed by choosing <menuitem>File - Export as - Export as PDF</menuitem>.</paragraph> + <paragraph role="paragraph" id="par_id181638385131806">Calling this method changes the actual values set in the <menuitem>PDF Options</menuitem> dialog, which are used by the <literal>ExportAsPDF</literal> method from the <literal>Document</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id391638385313847">This method returns <literal>True</literal> when successful.</paragraph> + <tip id="par_id751638383457321">Read the <link href="https://wiki.openoffice.org/wiki/API/Tutorials/PDF_export" name="PDFExport_Wiki">PDF Export wiki page</link> to learn more about all available options.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id701626811351011"> + <input>session.SetPDFExportOptions(pdfoptions: obj): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id771582816585233"><emph>pdfoptions</emph>: <literal>Dictionary</literal> object that defines the PDF export settings to be changed. Each key-value pair represents an export option and the value that will be set in the dialog.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id141638386087986">The following example changes the maximum image resolution to 150 dpi and exports the current document as a PDF file.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id501638385904841">Dim newSettings As Object, oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681638465060402">Set oDoc = CreateScriptService("Document")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id411638385905025">Set newSettings = CreateScriptService("Dictionary")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421638386212072">newSettings.Add("ReduceImageResolution", True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801638385905201">newSettings.Add("MaxImageResolution", 150)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id141638385905345">session.SetPDFExportOptions(newSettings)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381638465110336">oDoc.ExportAsPDF("C:\Documents\myFile.pdf", Overwrite := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#Basic_Only"/> +</section> + +<section id="UnoMethods"> + <comment> UnoMethods --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id701587478024358"> + <bookmark_value>Session service;UnoMethods</bookmark_value> + </bookmark> + <h2 id="hd_id861587478024365" localize="false">UnoMethods</h2> + <paragraph role="paragraph" id="par_id321587478024997">Returns a list of the methods callable from an UNO object. The list is a zero-based array of strings and may be empty.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id341626819941177"> + <input>session.UnoMethods(unoobject: uno): str[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id251587478024311"><emph>unoobject</emph>: The object to inspect.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id531587478024129">Dim svc : svc = CreateUnoService("com.sun.star.sheet.FunctionAccess")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931587478024509">Dim methods : methods = session.UnoMethods(svc)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211587478024770">Dim msg as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631626820375428">For Each m in methods</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101626820375677"> msg = msg & m & Chr(13)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151626820375931">Next m</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741626820376195">MsgBox msg</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id501626820431003">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id991626820431395">a = bas.createUnoService("com.sun.star.sheet.FunctionAccess")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id81626820431651">methods = session.UnoMethods(a)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id281626820432068">msg = "\n".join(methods)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id281626820432763">bas.MsgBox(msg)</paragraph> + </pycode> +</section> + +<section id="UnoProperties"> + <comment> UnoProperties ------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id57158747834361"> + <bookmark_value>Session service;UnoProperties</bookmark_value> + </bookmark> + <h2 id="hd_id101587478343870" localize="false">UnoProperties</h2> + <paragraph role="paragraph" id="par_id141587478343306">Returns a list of the properties of an UNO object. The list is a zero-based array of strings and may be empty.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="bas_id91626820631150"> + <input>session.UnoProperties(unoobject: uno): str[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id241587478343323"><emph>unoobject</emph>: The object to inspect.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <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") ' True</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821626820748621">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id861626820749053">svc = bas.createUnoService("com.sun.star.sheet.FunctionAccess")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id671626821449697">properties = session.UnoProperties(a)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id991626821450160">b = "Wildcards" in properties</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id371626820749214">bas.MsgBox(str(b)) # True</paragraph> + </pycode> +</section> + +<section id="UnoObjectType"> + <comment> UnoObjectType ------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id221582820251346"> + <bookmark_value>Session service;UnoObjectType</bookmark_value> + </bookmark> + <h2 id="hd_id751582820251347" localize="false">UnoObjectType</h2> + <paragraph role="paragraph" id="par_id371582820251347">Identify the type of a UNO object as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id121626821532107"> + <input>session.UnoObjectType(unoobject: uno): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id921582820251349"><emph>unoobject</emph>: The object to identify.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <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> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id501626821620216">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id501626821626352">svc = bas.createUnoService("com.sun.star.system.SystemShellExecute")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id131626821626637">txt = session.UnoObjectType(svc) # "com.sun.star.comp.system.SystemShellExecute"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id771626821626792">svc = bas.createUnoService("com.sun.star.beans.Property")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id251626821626944">txt = session.UnoObjectType(svc) # "com.sun.star.beans.Property"</paragraph> + </pycode> +</section> + +<section id="WebService"> + <comment> WebService ---------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id561582821057372"> + <bookmark_value>Session service;WebService</bookmark_value> + </bookmark> + <h2 id="hd_id101582821057372" localize="false">WebService</h2> + <paragraph role="paragraph" id="par_id341582821057373">Get some web content from a URI.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id941626821793360"> + <input>session.WebService(uri: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id771582821057374"><emph>uri</emph>: URI address of the web service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id901582821057375">session.WebService("wiki.documentfoundation.org/api.php?" _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id421582821057375"> & "hidebots=1&days=7&limit=50&action=feedrecentchanges&feedformat=rss")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id691626821991398">session.WebService(("wiki.documentfoundation.org/api.php?" </paragraph> + <paragraph role="pycode" localize="false" id="pyc_id671626821991593"> "hidebots=1&days=7&limit=50&action=feedrecentchanges&feedformat=rss"))</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + +<section id="relatedtopics"> + <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_basic.xhp#BasicService"/> + <embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_string.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_string.xhp new file mode 100644 index 000000000..2ca692c21 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_string.xhp @@ -0,0 +1,1501 @@ +<?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_String" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.String service (SF_String)</title> + <filename>/text/sbasic/shared/03/sf_string.xhp</filename> + </topic> +</meta> + +<body> +<section id="ScriptForge-sf_string"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id151579602147056"> + <bookmark_value>String service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="hd_id521580038927003"><variable id="StringService"><link href="text/sbasic/shared/03/sf_string.xhp" name="String service"><literal>ScriptForge</literal>.<literal>String</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id351579602570526">The <literal>String</literal> service provides a collection of methods for string processing. These methods can be used to:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id611611952070366" role="listitem">Validate the contents of strings</paragraph> + </listitem> + <listitem> + <paragraph id="par_id611611952070376" role="listitem">Format strings by trimming, justifying or wrapping their contents</paragraph> + </listitem> + <listitem> + <paragraph id="par_id611611952070367" role="listitem">Use regular expressions to search and replace substrings</paragraph> + </listitem> + <listitem> + <paragraph id="par_id611611952070368" role="listitem">Apply hash algorithms on strings, etc.</paragraph> + </listitem> + </list> +</section> + + <h2 id="hd_id961579603699855">Definitions</h2> + + <h3 id="hd_id441579603838777">Line breaks</h3> + <paragraph role="paragraph" id="par_id791611946942340">The <literal>String</literal> service recognizes the following line breaks:</paragraph> + <table id="tab_id411611947117831"> + <tablerow> + <tablecell> + <paragraph id="par_id151611947117831" role="tablehead">Symbolic name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721611947117831" role="tablehead">ASCII number</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611947117831" role="tablecontent"> + Line feed<br/> + Vertical tab<br/> + Carriage return<br/> + Line feed + Carriage return<br/> + File separator<br/> + Group separator<br/> + Record separator<br/> + Next line<br/> + Line separator<br/> + Paragraph separator + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211611947117831" role="tablecontent" localize="false"> + 10 <br/> 12 <br/> 13 <br/> 10 + 13 <br/> 28 <br/> 29 <br/> 30 <br/> 133 <br/> 8232 <br/> 8233 + </paragraph> + </tablecell> + </tablerow> + </table> + + <h3 id="hd_id161579604225813">Whitespaces</h3> + <paragraph role="paragraph" id="par_id401611948279056">The <literal>String</literal> service recognizes the following whitespaces:</paragraph> + <table id="tab_id411611947117831"> + <tablerow> + <tablecell> + <paragraph id="par_id151611947117893" role="tablehead">Symbolic name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721611947117855" role="tablehead">ASCII number</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611947117835" role="tablecontent"> + Space<br/> + Horizontal tab<br/> + Line feed<br/> + Vertical tab<br/> + Form feed<br/> + Carriage return<br/> + Next line<br/> + No-break space<br/> + Line separator<br/> + Paragraph separator + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211611947117832" role="tablecontent" localize="false"> + 32 <br/> 9 <br/> 10 <br/> 11 <br/> 12 <br/> 13 <br/> 133 <br/> 160 <br/> 8232 <br/> 8233 + </paragraph> + </tablecell> + </tablerow> + </table> + + <h3 id="hd_id191580480825160">Escape sequences</h3> + <paragraph role="paragraph" id="par_id971611949145057">Below is a list of escape sequences that can be used in strings.</paragraph> + <table id="tab_id411611947117834"> + <tablerow> + <tablecell> + <paragraph id="par_id151611947117287" role="tablehead">Escape Sequence</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721611947117732" role="tablehead">Symbolic name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721611947117144" role="tablehead">ASCII number</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id771611948706049" role="tablecontent" localize="false"> + \n <br/> \r <br/> \t + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611947119834" role="tablecontent"> + Line feed<br/> + Carriage return<br/> + Horizontal tab + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211611947117163" role="tablecontent" localize="false"> + 10 <br/> 13 <br/> 9 + </paragraph> + </tablecell> + </tablerow> + </table> + <tip id="par_id251611949474763">To have the escape sequence "\n" interpreted as an actual string, simply use "\\n" instead of <literal>"\" & Chr(10).</literal></tip> + + <h3 id="hd_id771579606799550">Non-printable characters:</h3> + <paragraph role="paragraph" id="par_id531579606877342">Characters defined in the Unicode Character Database as “Other” or “Separator” are considered as non-printable characters.</paragraph> + <paragraph role="paragraph" id="par_id221611949584320">Control characters (ascii code <= 0x1F) are also considered as non-printable.</paragraph> + + <h3 id="hd_id661579604944268">Quotes inside strings:</h3> + <paragraph role="paragraph" id="par_id551579605035332">To add quotes in strings use \' (single quote) or \" (double quote). For example:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id201611949691285" role="listitem">The string <literal>[str\'i\'ng]</literal> is interpreted as <literal>[str'i'ng]</literal></paragraph> + </listitem> + <listitem> + <paragraph id="par_id201611949691323" role="listitem">The string <literal>[str\"i\"ng]</literal> is interpreted as <literal>[str"i"ng]</literal></paragraph> + </listitem> + </list> + + <h2 id="hd_id201586594659135">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>ScriptForge.String</literal> service the <literal>ScriptForge</literal> library needs to be loaded using:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id871608192694632">GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id271627158844922">Loading the library will create the <literal>SF_String</literal> object that can be used to call the methods in the <literal>String</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id63158659509728">The following code snippets show the three ways to call methods from the <literal>String</literal> service (the <literal>Capitalize</literal> method is used as an example):</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id641627157912899">Dim s as String : s = "abc def"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181586594723543">s = SF_String.Capitalize(s) ' Abc Def</paragraph> + </bascode> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id641627157912017">Dim s as String : s = "abc def"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441586594733346">Dim svc : svc = SF_String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id481586594739978">s = svc.Capitalize(s) ' Abc Def</paragraph> + </bascode> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id641627157912647">Dim s as String : s = "abc def"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431586594750461">Dim svc : svc = CreateScriptService("String")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471586594758689">s = svc.Capitalize(s) ' Abc Def</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <paragraph role="paragraph" id="par_id761627158463235">The code snippet below illustrates how to invoke methods from the <literal>String</literal> service in Python scripts. The <literal>IsIPv4</literal> method is used as an example.</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id171627158604379">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id101627158604648">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id171627158604858">ip_address = '192.168.0.14'</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id551627158605138">svc.IsIPv4(ip_address) # True</paragraph> + </pycode> + + <h2 id="hd_id651584978211886">Properties</h2> + <paragraph role="paragraph" id="par_id241611950267068">The <literal>SF_String</literal> object provides the following properties for Basic scripts:</paragraph> + <table id="tab_id761584978211275"> + <tablerow> + <tablecell> + <paragraph id="par_id271584978211792" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id241584978211550" role="tablehead">ReadOnly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621584978211403" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id581584978715552" role="tablecontent" localize="false">sfCR</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71584978715562" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581584978715701" role="tablecontent">Carriage return: Chr(13)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id91584978211231" role="tablecontent" localize="false">sfCRLF</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211584978211383" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691584978211774" role="tablecontent">Carriage return + Linefeed: Chr(13) & Chr(10)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id1001584978666440" role="tablecontent" localize="false">sfLF</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id671584978666689" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951584978666296" role="tablecontent">Linefeed: Chr(10)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311584978666162" role="tablecontent" localize="false">sfNEWLINE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421584978666327" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id901584978666158" role="tablecontent">Carriage return + Linefeed, which can be<br/>1) Chr(13) & Chr(10) or + <br/>2) Linefeed: Chr(10) + <br/>depending on the operating system.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id371584978666469" role="tablecontent" localize="false">sfTAB</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541584978666991" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741584978666508" role="tablecontent">Horizontal tabulation: Chr(9)</paragraph> + </tablecell> + </tablerow> + </table> + <tip id="par_id461584978880380">You can use the properties above to identify or insert the corresponding characters inside strings. For example, the Linefeed can be replaced by <literal>SF_String.sfLF</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 String Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_string.xhp#Capitalize" name="Capitalize method">Capitalize</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#Count" name="Count method">Count</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#EndsWith" name="EndsWith method">EndsWith</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#Escape" name="Escape method">Escape</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#ExpandTabs" name="ExpandTabs method">ExpandTabs</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#FilterNotPrintable" name="FilterNotPrintable method">FilterNotPrintable</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#FindRegex" name="FindRegex method">FindRegex</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#HashStr" name="HashStr method">HashStr</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#HtmlEncode" name="HtmlEncode method">HtmlEncode</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsADate" name="IsADate method">IsADate</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsAlpha" name="IsAlpha method">IsAlpha</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsAlphaNum" name="IsAlphaNum method">IsAlphaNum</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsAscii" name="IsAscii method">IsAscii</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsDigit" name="IsDigit method">IsDigit</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsEmail" name="IsEmail method">IsEmail</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_string.xhp#IsFileName" name="IsFileName method">IsFileName</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsHexDigit" name="IsHexDigit method">IsHexDigit</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsIBAN" name="IsIBAN method">IsIBAN</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsIPv4" name="IsIPv4 method">IsIPv4</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsLike" name="IsLike method">IsLike</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsLower" name="IsLower method">IsLower</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsPrintable" name="IsPrintable method">IsPrintable</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsRegex" name="IsRegex method">IsRegex</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsSheetName" name="IsSheetName method">IsSheetName</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsTitle" name="IsTitle method">IsTitle</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsUpper" name="IsUpper method">IsUpper</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsUrl" name="IsUrl method">IsUrl</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#IsWhitespace" name="IsWhitespace method">IsWhitespace</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#JustifyCenter" name="JustifyCenter method">JustifyCenter</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#JustifyLeft" name="JustifyLeft method">JustifyLeft</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_string.xhp#JustifyRight" name="JustifyRight method">JustifyRight</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#Quote" name="Quote method">Quote</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#ReplaceChar" name="ReplaceChar method">ReplaceChar</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#ReplaceRegex" name="ReplaceRegex method">ReplaceRegex</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#ReplaceStr" name="ReplaceStr method">ReplaceStr</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#Represent" name="Represent method">Represent</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#Reverse" name="Reverse method">Reverse</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#SplitLines" name="SplitLines method">SplitLines</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#SplitNotQuoted" name="SplitNotQuoted method">SplitNotQuoted</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#StartsWith" name="StartsWith method">StartsWith</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#TrimExt" name="TrimExt method">TrimExt</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#Unescape" name="Unescape method">Unescape</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#Unquote" name="Unquote method">Unquote</link><br/> + <link href="text/sbasic/shared/03/sf_string.xhp#Wrap" name="Wrap method">Wrap</link><br/><br/> + </paragraph> + </tablecell> + </tablerow> +</table> + <note id="par_id151611951803163">The first argument of most methods is the string to be considered. It is always passed by reference and left unchanged. Methods such as <literal>Capitalize</literal>, <literal>Escape</literal>, etc return a new string after their execution.</note> + <warning id="par_id371627158142730">Because Python has comprehensive built-in string support, most of the methods in the <literal>String</literal> service are available for Basic scripts only. The methods available for Basic and Python are: <literal>HashStr</literal>, <literal>IsADate</literal>, <literal>IsEmail</literal>, <literal>IsFileName</literal>, <literal>IsIBAN</literal>, <literal>IsIPv4</literal>, <literal>IsLike</literal>, <literal>IsSheetName</literal>, <literal>IsUrl</literal>, <literal>SplitNotQuoted</literal> and <literal>Wrap</literal>.</warning> + +<section id="Capitalize"> + <comment> Capitalize -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id121582203710297"> + <bookmark_value>String service;Capitalize</bookmark_value> + </bookmark> + <h2 id="hd_id791579683635979" localize="false">Capitalize</h2> + <paragraph role="paragraph" id="par_id271579683706571">Capitalizes the first character from each word in the input string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id121627158901416"> + <input>svc.Capitalize(inputstr: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id941582304592013"><emph>inputstr</emph>: The string to be capitalized.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id631579688532444">Dim sName as String : sName = "john smith"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id451579686015963">Dim sCapitalizedName as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id41579785318230">sCapitalizedName = SF_String.Capitalize(sName)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801579688542131">MsgBox sCapitalizedName 'John Smith</paragraph> + </bascode> +</section> + +<section id="Count"> + <comment> Count ------------------------------------------------------------------------------------------------- </comment> + <bookmark branch="index" id="bm_id421582384432626" localize="false"> + <bookmark_value>String service;Count</bookmark_value> + </bookmark> + <h2 id="hd_id1001582384527265" localize="false">Count</h2> + <paragraph role="paragraph" id="par_id891582384556756">Counts the number of occurrences of a substring or a regular expression within a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id421627159083108"> + <input>svc.Count(inputstr: str, substring: str, [isregex: bool], [casesensitive: bool]): int</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id571582384689863"><emph>inputstr</emph>: The input string to be examined</paragraph> + <paragraph role="paragraph" id="par_id601582384696486"><emph>substring</emph>: The substring or the regular expression to be used during search</paragraph> + <paragraph role="paragraph" id="par_id451582384703719"><emph>isregex</emph>: Use <literal>True</literal> if the substring is a regular expression (Default = <literal>False</literal>)</paragraph> + <paragraph role="paragraph" id="par_id141582384726168"><emph>casesensitive</emph>: The search can be case sensitive or not (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="bas_id371582384749769">'Counts the occurrences of the substring "or" inside the input string (returns 2)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281582384809689">MsgBox SF_String.Count("Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "or", CaseSensitive := False)</paragraph> + <paragraph role="bascode" id="bas_id561582384801586">'Counts the number of words with only lowercase letters (returns 7)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631582384780777">MsgBox SF_String.Count("Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "\b[a-z]+\b", IsRegex := True, CaseSensitive := True)</paragraph> + </bascode> + <tip id="par_id131612223767126">To learn more about regular expressions, refer to the Python's documentation on <link href="https://docs.python.org/3/library/re.html" name="Regular expressions">Regular Expression Operations</link>.</tip> +</section> + +<section id="EndsWith"> + <comment> EndsWith ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id771582203795803"> + <bookmark_value>String service;EndsWith</bookmark_value> + </bookmark> + <h2 id="hd_id801579687630238" localize="false">EndsWith</h2> + <paragraph role="paragraph" id="par_id581579687739629">Returns <literal>True</literal> if a string ends with a specified substring.</paragraph> + <paragraph role="paragraph" id="par_id21612306392239">The function returns <literal>False</literal> when either the string or the substring have a length = 0 or when the substring is longer than the string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id551627159333520"> + <input>svc.EndsWith(inputstr: str, substring: str, [casesensitive: bool]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id191579861552201"><emph>inputstr</emph>: The string to be tested.</paragraph> + <paragraph role="paragraph" id="par_id211579861561473"><emph>substring</emph>: The substring to be searched at the end of <literal>inputstr</literal>.</paragraph> + <paragraph role="paragraph" id="par_id801579861574009"><emph>casesensitive</emph>: The search can be case sensitive or not (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="bas_id811579862998452">'Returns True because the method was called with the default CaseSensitive = False</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581579863063364">MsgBox SF_String.EndsWith("abcdefg", "EFG")</paragraph> + <paragraph role="bascode" id="bas_id231579863168747">'Returns False due to the CaseSensitive parameter</paragraph> + <paragraph role="bascode" localize="false" id="bas_id221579863071644">MsgBox SF_String.EndsWith("abcdefg", "EFG", CaseSensitive := True)</paragraph> + </bascode> +</section> + +<section id="Escape"> + <comment> Escape ------------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id731585921441446"> + <bookmark_value>String service;Escape</bookmark_value> + </bookmark> + <h2 id="hd_id821585921441213" localize="false">Escape</h2> + <paragraph role="paragraph" id="par_id921585921441429">Converts linebreaks and tabs contained in the input string to their equivalent escaped sequence (\\, \n, \r, \t).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id151627159520587"> + <input>svc.Escape(inputstr: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id9158592144110"><emph>inputstr</emph>: The string to be converted.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="bas_id901585921441483">'Returns the string "abc\n\tdef\\n"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741585921441977">MsgBox SF_String.Escape("abc" & Chr(10) & Chr(9) & "def\n")</paragraph> + </bascode> +</section> + +<section id="ExpandTabs"> + <comment> ExpandTabs -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id161582203880251"> + <bookmark_value>String service;ExpandTabs</bookmark_value> + </bookmark> + <h2 id="hd_id761579868039113" localize="false">ExpandTabs</h2> + <paragraph role="paragraph" id="par_id271579868053137">Replaces Tab characters <literal>Chr(9)</literal> by space characters to replicate the behavior of tab stops.</paragraph> + <paragraph role="paragraph" id="par_id951579868064344">If a line break is found, a new line is started and the character counter is reset.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id821627159598950"> + <input>svc.ExpandTabs(inputstr: str, [tabsize: int]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id231579868290408"><emph>inputstr</emph>: The string to be expanded</paragraph> + <paragraph role="paragraph" id="par_id281579868299807"><emph>tabsize</emph>: This parameter is used to determine the Tab stops using the formula: TabSize + 1, 2 * TabSize + 1 , ... N * TabSize + 1 (Default = 8)</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id611579868690878">Dim myText as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931585922081615">myText = "100" & SF_String.sfTAB & "200" & SF_String.sfTAB & "300" & SF_String.sfNEWLINE & _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311579868703742"> "X" & SF_String.sfTAB & "Y" & SF_String.sfTAB & "Z"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841585921966229">MsgBox SF_String.ExpandTabs(myText)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461579868714135">'100 200 300</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461579868714136">'X Y Z</paragraph> + </bascode> +</section> + +<section id="FilterNotPrintable"> + <comment> FilterNotPrintable ------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id231582204001536"> + <bookmark_value>String service;FilterNotPrintable</bookmark_value> + </bookmark> + <h2 id="hd_id581579874537114" localize="false">FilterNotPrintable</h2> + <paragraph role="paragraph" id="par_id161579874552729">Replaces all non-printable characters in the input string by a given character.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id271627159754299"> + <input>svc.FilterNotPrintable(inputstr: str, [replacedby: str]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id431579874633865"><emph>inputstr</emph>: The string to be searched</paragraph> + <paragraph role="paragraph" id="par_id31579874656437"><emph>replacedby</emph>: Zero, one or more characters that will replace all non-printable characters in <literal>inputstr</literal> (Default = "")</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id481579874686887">Dim LF : LF = Chr(10)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id41579874696422">Dim myText as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611579874737551">myText = "àén ΣlPµ" & LF & " Русский" & "\n"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271579874750894">MsgBox SF_String.FilterNotPrintable(myText)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81612308364024">' "àén ΣlPµ Русский\n"</paragraph> + </bascode> +</section> + +<section id="FindRegex"> + <comment> FindRegex --------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id491582204303825"> + <bookmark_value>String service;FindRegex</bookmark_value> + </bookmark> + <h2 id="hd_id471579876212449" localize="false">FindRegex</h2> + <paragraph role="paragraph" id="par_id1001579876228707">Finds in a string a substring matching a given regular expression.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591627159907982"> + <input>svc.FindRegex(inputstr: str, regex: str, [start: int], [casesensitive: bool], [forward: bool]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id131579876314120"><emph>inputstr</emph>: The string to be searched</paragraph> + <paragraph role="paragraph" id="par_id751579876371545"><emph>regex</emph>: The regular expression</paragraph> + <paragraph role="paragraph" id="par_id881579876394584"><emph>start</emph>: The position in the string where the search will begin. This parameter is passed by reference, so after execution the value of <literal>start</literal> will point to the first character of the found substring. If no matching substring is found, <literal>start</literal> will be set to 0.</paragraph> + <paragraph role="paragraph" id="par_id251579876403831"><emph>casesensitive</emph>: The search can be case sensitive or not (Default = <literal>False</literal>).</paragraph> + <paragraph role="paragraph" id="par_id841579876412287"><emph>forward</emph>: Determines the direction of the search. If <literal>True</literal>, search moves forward. If <literal>False</literal> search moves backwards (Default = <literal>True</literal>)</paragraph> + <paragraph role="paragraph" id="par_id451612309155653">At the first iteration, if <literal>forward = True</literal>, then <literal>start</literal> should be equal to 1, whereas if <literal>forward = False</literal> then <literal>start</literal> should be equal to <literal>Len(inputstr)</literal></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id621579876463377">Dim lStart As Long : lStart = 1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001579876429088">Dim result as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571579876474344">result = SF_String.FindRegex("abCcdefghHij", "C.*H", lStart, CaseSensitive := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671579876511592">MsgBox lStart & ": " & result</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51579876497768">'3: CcdefghH</paragraph> + </bascode> + <tip id="par_id221612309579001">In the example above, the new value of <literal>lStart</literal> can be used to keep searching the same input string by setting the <literal>Start</literal> parameter to <literal>lStart + Len(result)</literal> at the next iteration.</tip> +</section> + +<section id="HashStr"> + <comment> HashStr ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id24160104898372"> + <bookmark_value>String service;HashStr</bookmark_value> + </bookmark> + <h2 id="hd_id871601048983883" localize="false">HashStr</h2> + <paragraph role="paragraph" id="par_id471601048983628">Hash functions are used inside some cryptographic algorithms, in digital signatures, message authentication codes, manipulation detection, fingerprints, checksums (message integrity check), hash tables, password storage and much more.</paragraph> + <paragraph role="paragraph" id="par_id301601048983765">The <literal>HashStr</literal> method returns the result of a hash function applied on a given string and using a specified algorithm, as a string of lowercase hexadecimal digits.</paragraph> + <paragraph role="paragraph" id="par_id631601048983149">The hash algorithms supported are: <literal>MD5</literal>, <literal>SHA1</literal>, <literal>SHA224</literal>, <literal>SHA256</literal>, <literal>SHA384</literal> and <literal>SHA512</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id741627160211210"> + <input>svc.HashStr(inputstr: str, algorithm: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id621601048983210"><emph>inputstr</emph>: The string to hash. It is presumed to be encoded in UTF-8. The hashing algorithm will consider the string as a stream of bytes.</paragraph> + <paragraph role="paragraph" id="par_id941601048983822"><emph>algorithm</emph>: One of the supported algorithms listed above, passed as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id721601048983555">MsgBox SF_String.HashStr("œ∑¡™£¢∞§¶•ªº–≠œ∑´®†¥¨ˆøπ‘åß∂ƒ©˙∆˚¬", "MD5")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891612351766467">' c740ccc2e201df4b2e2b4aa086f35d8a</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id201627248048720">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id101627248049176">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id401627248049343">a_string = "œ∑¡™£¢∞§¶•ªº–≠œ∑´®†¥¨ˆøπ‘åß∂ƒ©˙∆˚¬"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id611627248049495">hash_value = svc.HashStr(a_string, "MD5")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id471627248049687">bas.MsgBox(hash_value)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121627248049991"># c740ccc2e201df4b2e2b4aa086f35d8a</paragraph> + </pycode> +</section> + +<section id="HtmlEncode"> + <comment> HtmlEncode -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id561582204334292"> + <bookmark_value>String service;HtmlEncode</bookmark_value> + </bookmark> + <h2 id="hd_id771579879504956" localize="false">HtmlEncode</h2> + <paragraph role="paragraph" id="par_id221579879516929">Encodes the input string into the HTML character codes, replacing special characters by their <literal>&</literal> counterparts.</paragraph> + <paragraph role="paragraph" id="par_id341612351999692">For example, the character <literal>é</literal> would be replaced by <literal>&eacute;</literal> or an equivalent numerical HTML code.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id601627160353326"> + <input>svc.HtmlEncode(inputstr: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="bas_id501579879570781"><emph>inputstr</emph>: The string to encode.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671579879597547">MsgBox SF_String.HtmlEncode("<a href=""https://a.b.com"">From α to ω</a>")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461579879607044">' "&lt;a href=&quot;https://a.b.com&quot;&gt;From &#945; to &#969;&lt;/a&gt;"</paragraph> + </bascode> +</section> + +<section id="IsADate"> + <comment> IsADate ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id11582204732653"> + <bookmark_value>String service;IsADate</bookmark_value> + </bookmark> + <h2 id="hd_id141579880967392" localize="false">IsADate</h2> + <paragraph role="paragraph" id="par_id171579880990533">Returns <literal>True</literal> if the input string is a valid date according to a specified date format.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id191627160586821"> + <input>svc.IsADate(inputstr: str, [dateformat: str]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id151579881091821"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal></paragraph> + <paragraph role="paragraph" id="par_id991579881107670"><emph>dateformat</emph>: The date format, as a string. It can be either "YYYY-MM-DD" (default), "DD-MM-YYYY" or "MM-DD-YYYY"</paragraph> + <paragraph role="paragraph" id="par_id291579881117126">The dash (-) may be replaced by a dot (.), a slash (/) or a space.</paragraph> + <paragraph role="paragraph" id="par_id51579881125801"> If the format is invalid, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id811579881155015">MsgBox SF_String.IsADate("2020-12-31", "YYYY-MM-DD") ' True</paragraph> + </bascode> + <note id="par_id211612370427721">This method checks the format of the input string without performing any calendar-specific checks. Hence it does not test the input string for leap years or months with 30 or 31 days. For that, refer to the <link href="text/sbasic/shared/03102300.xhp" name="IsDate function"><literal>IsDate</literal> built-in function</link>.</note> + <paragraph role="paragraph" id="par_id181612371147364">The example below shows the difference between the methods <literal>IsADate</literal> (ScriptForge) and the <literal>IsDate</literal> (built-in) function.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id531612371248704">Dim myDate as String : myDate = "2020-02-30"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id731612371253577">MsgBox SF_String.IsADate(myDate, "YYYY-MM-DD") 'True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821612371254969">MsgBox IsDate(myDate) ' False</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831627248497889">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id121627248498619">s_date = "2020-12-31"</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id621627248498786">result = svc.IsADate(s_date) # True</paragraph> + </pycode> +</section> + +<section id="IsAlpha"> + <comment> IsAlpha ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id491582204781995"> + <bookmark_value>String service;IsAlpha</bookmark_value> + </bookmark> + <h2 id="hd_id231579881589037" localize="false">IsAlpha</h2> + <paragraph role="paragraph" id="par_id161579881600317">Returns <literal>True</literal> if all characters in the string are alphabetic.</paragraph> + <paragraph role="paragraph" id="par_id251579881615469">Alphabetic characters are those characters defined in the <link href="https://unicode.org/reports/tr44/" name="Unicode documentation">Unicode Character Database</link> as <literal>Letter</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711627160772668"> + <input>svc.IsAlpha(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id11579881691826"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="par_id381579881735058">MsgBox SF_String.IsAlpha("àénΣlPµ") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331579881743363">MsgBox SF_String.IsAlpha("myVar3") ' False</paragraph> + </bascode> +</section> + +<section id="IsAlphaNum"> + <comment> IsAlphaNum -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id581582204814414"> + <bookmark_value>String service;IsAlphanum</bookmark_value> + </bookmark> + <h2 id="hd_id711579883155335" localize="false">IsAlphaNum</h2> + <paragraph role="paragraph" id="par_id421579883181382">Returns <literal>True</literal> if all characters in the string are alphabetic, digits or "_" (underscore). The first character must not be a digit.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id981627160850954"> + <input>svc.IsAlphaNum(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id31579884464101"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id611579884379482">MsgBox SF_String.IsAlphaNum("_ABC_123456_abcàénΣlPµ") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id551612445915119">MsgBox SF_String.IsAlphaNum("123ABC") ' False</paragraph> + </bascode> +</section> + +<section id="IsAscii"> + <comment> IsAscii ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id991582204833033"> + <bookmark_value>String service;IsAscii</bookmark_value> + </bookmark> + <h2 id="hd_id891580039448798" localize="false">IsAscii</h2> + <paragraph role="paragraph" id="par_id671580039484786">Returns <literal>True</literal> if all characters in the string are Ascii characters.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id931627160994922"> + <input>svc.IsAscii(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id791580039528838"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41580039556401">MsgBox SF_String.IsAscii("a%?,25") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841580039565265">MsgBox SF_String.IsAscii("abcàénΣlPµ") ' False</paragraph> + </bascode> +</section> + +<section id="IsDigit"> + <comment> IsDigit ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id741582204858557"> + <bookmark_value>String service;IsDigit</bookmark_value> + </bookmark> + <h2 id="hd_id321580044756464" localize="false">IsDigit</h2> + <paragraph role="paragraph" id="par_id861580044805749">Returns <literal>True</literal> if all characters in the string are digits.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id491627161075258"> + <input>svc.IsDigit(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id41580044873043"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id821580044929100">MsgBox SF_String.IsDigit("123456") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id601580044939971">MsgBox SF_String.IsDigit("_12a") ' False</paragraph> + </bascode> +</section> + +<section id="IsEmail"> + <comment> IsEmail ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id721582204903245"> + <bookmark_value>String service;IsEmail</bookmark_value> + </bookmark> + <h2 id="hd_id601580045208963" localize="false">IsEmail</h2> + <paragraph role="paragraph" id="par_id521580045221758">Returns <literal>True</literal> if the string is a valid email address.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id561627161153727"> + <input>svc.IsEmail(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id841580045280071"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id351580045300802">MsgBox SF_String.IsEmail("first.last@something.org") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id511580045308668">MsgBox SF_String.IsEmail("first.last@something.com.br") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621580045319466">MsgBox SF_String.IsEmail("first.last@something.123") ' False</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id921627248625925">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id671627248629820">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651627248630083">bas.MsgBox(svc.IsEmail("first.last@something.org")) # True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id451627248630275">bas.MsgBox(svc.IsEmail("first.last@something.com.br")) # True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id491627248630514">bas.MsgBox(svc.IsEmail("first.last@something.123")) # False</paragraph> + </pycode> +</section> + +<section id="IsFileName"> + <comment> IsFileName -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id601582204928759"> + <bookmark_value>String service;IsFileName</bookmark_value> + </bookmark> + <h2 id="hd_id941580047025136" localize="false">IsFileName</h2> + <paragraph role="paragraph" id="par_id41580047039666">Returns <literal>True</literal> if the string is a valid filename in a given operating system.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id521627161235397"> + <input>svc.IsFileName(inputstr: str, [osname: str]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id801580047079938"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id781580047088954"><emph>osname</emph>: The operating system name, as a string. It can be "WINDOWS", "LINUX", "MACOSX" or "SOLARIS".</paragraph> + <paragraph role="paragraph" id="par_id991612372824234">The default value is the current operating system on which the script is running.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id291580047101783">MsgBox SF_String.IsFileName("/home/user/Documents/a file name.odt", "LINUX") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id761580047111201">MsgBox SF_String.IsFileName("C:\home\a file name.odt", "LINUX") ' False</paragraph> + <paragraph role="bascode" localize="false" id="bas_id901580047128532">MsgBox SF_String.IsFileName("C:\home\a file name.odt", "WINDOWS") ' True</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id921627248625144">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id671627248629099">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id651627248630165">bas.MsgBox(svc.IsFileName("/home/user/Documents/a file name.odt", "LINUX")) # True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id451627248630094">bas.MsgBox(svc.IsFileName(r"C:\home\a file name.odt", "LINUX")) # False</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id491627248630255">bas.MsgBox(svc.IsFileName(r"C:\home\a file name.odt", "WINDOWS")) # True</paragraph> + </pycode> +</section> + +<section id="IsHexDigit"> + <comment> IsHexDigit ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id1001582204955266"> + <bookmark_value>String service;IsHexDigit</bookmark_value> + </bookmark> + <h2 id="hd_id441580047541078" localize="false">IsHexDigit</h2> + <paragraph role="paragraph" id="par_id911580047551929">Returns <literal>True</literal> if all characters in the string are hexadecimal digits.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id141627161371952"> + <input>svc.IsHexDigit(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id331580047594144"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id521612377109554">The hexadecimal digits may be prefixed with "0x" or "&H".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id51580047615488">MsgBox SF_String.IsHexDigit("&H00FF") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251580047624832">MsgBox SF_String.IsHexDigit("08AAFF10") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281580047636521">MsgBox SF_String.IsHexDigit("0x18LA22") ' False</paragraph> + </bascode> +</section> + +<section id="IsIBAN"> + <comment> IsIBAN ------------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id931582204907784"> + <bookmark_value>String service;IsIBAN</bookmark_value> + </bookmark> + <h2 id="hd_id431580840408317" localize="false">IsIBAN</h2> + <paragraph role="paragraph" id="par_id791584008420941">Returns <literal>True</literal> if the string is a valid International Bank Account Number (IBAN). The comparison is not case-sensitive.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id291627161741207"> + <input>svc.IsIBAN(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id951880048466565"> <emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id631619526542367"><literal>True</literal> if the string contains a valid IBAN number.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id71627249022958">' Basic</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571500848484444">MsgBox SF_String.IsIBAN("BR15 0000 0000 0000 1093 2840 814 P2") ' True</paragraph> + </bascode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id121627249045568"># Python</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id901627249045753">result = svc.IsIBAN("BR15 0000 0000 0000 1093 2840 814 P2") # True</paragraph> + </pycode> +</section> + +<section id="IsIPv4"> + <comment> IsIPv4 ------------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id931582204977084"> + <bookmark_value>String service;IsIPv4</bookmark_value> + </bookmark> + <h2 id="hd_id431580048408317" localize="false">IsIPv4</h2> + <paragraph role="paragraph" id="par_id791580048420941">Returns <literal>True</literal> if the string is a valid IP(v4) address.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id861627161817305"> + <input>svc.IsIPv4(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id981580048466565"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id571580048484444">MsgBox SF_String.IsIPv4("192.168.1.50") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871580048493061">MsgBox SF_String.IsIPv4("192.168.50") ' False</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201580048501038">MsgBox SF_String.IsIPv4("255.255.255.256") ' False</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831627249268171">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981627249268449">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871627249268596">bas.MsgBox(svc.IsIPv4("192.168.1.50")) # True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211627249268763">bas.MsgBox(svc.IsIPv4("192.168.50")) # False</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id571627249268932">bas.MsgBox(svc.IsIPv4("255.255.255.256")) # False</paragraph> + </pycode> +</section> + +<section id="IsLike"> + <comment> IsLike ------------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id721582205008767"> + <bookmark_value>String service;IsLike</bookmark_value> + </bookmark> + <h2 id="hd_id791580049073672" localize="false">IsLike</h2> + <paragraph role="paragraph" id="par_id831580049093038">Returns <literal>True</literal> if the whole input string matches a given pattern containing wildcards.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id951627161917563"> + <input>svc.IsLike(inputstr: str, pattern: str, [casesensitive: bool]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id141580049142548"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id31580049154551"><emph>pattern</emph>: The pattern as a string. Wildcards are:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id181612441703306" role="listitem">"?" represents any single character;</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id861612377611438">"*" represents zero, one, or multiple characters.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id991580049206617"><emph>casesensitive</emph>: The search can be case sensitive or not (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id541580049238484">MsgBox SF_String.IsLike("aAbB", "?A*") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821580049249434">MsgBox SF_String.IsLike("C:\a\b\c\f.odb", "?:*.*") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981580049258743">MsgBox SF_String.IsLike("name:host", "?*@?*") ' False</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821612378053774">MsgBox SF_String.IsLike("@host", "?*@?*") ' False</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831627249268227">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981627249268238">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871627249268903">bas.MsgBox(svc.IsLike("aAbB", "?A*")) # True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211627249268144">bas.MsgBox(svc.IsLike(r"C:\a\b\c\f.odb", "?:*.*")) # True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id571627249268752">bas.MsgBox(svc.IsLike("name:host", "?*@?*")) # False</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id661627249433231">bas.MsgBox(svc.IsLike("@host", "?*@?*")) # False</paragraph> + </pycode> +</section> + +<section id="IsLower"> + <comment> IsLower ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id91582205043650"> + <bookmark_value>String service;IsLower</bookmark_value> + </bookmark> + <h2 id="hd_id621580050021403" localize="false">IsLower</h2> + <paragraph role="paragraph" id="par_id581580050048679">Returns <literal>True</literal> if all characters in the string are in lowercase. Non-alphabetic characters are ignored.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id901627162072714"> + <input>svc.IsLower(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id751580050122938"><emph>InputStr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id731580050158022">MsgBox SF_String.IsLower("abc'(-xy4z") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881580050187982">MsgBox SF_String.IsLower("1234") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741580050198046">MsgBox SF_String.IsLower("abcDefg") ' False</paragraph> + </bascode> +</section> + +<section id="IsPrintable"> + <comment> IsPrintable ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id71582205064134"> + <bookmark_value>String service;IsPrintable</bookmark_value> + </bookmark> + <h2 id="hd_id51580051636185" localize="false">IsPrintable</h2> + <paragraph role="paragraph" id="par_id231580051650488">Returns <literal>True</literal> if all characters in the string are printable.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id581627162139952"> + <input>svc.IsPrintable(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id721580051706431"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id341580051737598">MsgBox SF_String.IsPrintable("àén ΣlPµ Русский") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791580051747813">MsgBox SF_String.IsPrintable("First line." & Chr(10) & "Second Line.") ' False</paragraph> + </bascode> +</section> + +<section id="IsRegex"> + <comment> IsRegex ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id561582205088656"> + <bookmark_value>String service;IsRegex</bookmark_value> + </bookmark> + <h2 id="hd_id11580052383614" localize="false">IsRegex</h2> + <paragraph role="paragraph" id="par_id281580052400960">Returns <literal>True</literal> if the whole input string matches a given regular expression.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id581627162222687"> + <input>svc.IsRegex(inputstr: str, regex: str, [casesensitive: bool]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id161580052454770"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id581580052467973"><emph>regex</emph>: The regular expression. If empty, the method returns <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id621580052654341"><emph>casesensitive</emph>: The search can be case sensitive or not (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id711580052523722">MsgBox SF_String.IsRegex("aAbB", "[A-Za-z]+") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431580052508625">MsgBox SF_String.IsRegex("John;100", "[A-Za-z]+;[0-9]+") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71580052534405">MsgBox SF_String.IsRegex("John;100;150", "[A-Za-z]+;[0-9]+") ' False</paragraph> + </bascode> +</section> + +<section id="IsSheetName"> + <comment> IsSheetName ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id901589460240654"> + <bookmark_value>String service;IsSheetName</bookmark_value> + </bookmark> + <h2 id="hd_id791589460240472" localize="false">IsSheetName</h2> + <paragraph role="paragraph" id="par_id1001589460240467">Returns <literal>True</literal> if the input string is a valid Calc sheet name.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id171627162339798"> + <input>svc.IsSheetName(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id671589460240552"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id391589460240928">MsgBox SF_String.IsSheetName("1àbc + ""déf""") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681589460240214">MsgBox SF_String.IsSheetName("[MySheet]") ' False</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831627249268323">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981627249268455">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871627249268018">bas.MsgBox(svc.IsSheetName("1àbc + ""déf""")) # True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211627249268278">bas.MsgBox(svc.IsSheetName("[MySheet]")) # False</paragraph> + </pycode> + <note id="par_id551612442002823">A sheet name must not contain the characters [ ] * ? : / \ or the character ' (apostrophe) as first or last character.</note> +</section> + +<section id="IsTitle"> + <comment> IsTitle ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id461582205108468"> + <bookmark_value>String service;IsTitle</bookmark_value> + </bookmark> + <h2 id="hd_id571580293080317" localize="false">IsTitle</h2> + <paragraph role="paragraph" id="par_id371580293093655">Returns <literal>True</literal> if the first character of every word is in uppercase and the other characters are in lowercase.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id741627162408971"> + <input>svc.IsTitle(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id471580293142283"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id701580293163557">MsgBox SF_String.IsTitle("This Is The Title Of My Book") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371580293175037">MsgBox SF_String.IsTitle("This is the Title of my Book") ' False</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001580293184622">MsgBox SF_String.IsTitle("Result Number 100") ' True</paragraph> + </bascode> +</section> + +<section id="IsUpper"> + <comment> IsUpper ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id31582205124227"> + <bookmark_value>String service;IsUpper</bookmark_value> + </bookmark> + <h2 id="hd_id341580128661190" localize="false">IsUpper</h2> + <paragraph role="paragraph" id="par_id801580128672004">Returns <literal>True</literal> if all characters in the string are in uppercase. Non alphabetic characters are ignored.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id271627162484974"> + <input>svc.IsUpper(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id391580128736809"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id81580128769670">MsgBox SF_String.IsUpper("ABC'(-XYZ") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id951580128785698">MsgBox SF_String.IsUpper("A Title") ' False</paragraph> + </bascode> +</section> + +<section id="IsUrl"> + <comment> IsUrl ------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id431582205169135"> + <bookmark_value>String service;IsUrl</bookmark_value> + </bookmark> + <h2 id="hd_id211580132006615" localize="false">IsUrl</h2> + <paragraph role="paragraph" id="par_id531580132067813">Returns <literal>True</literal> if the string is a valid absolute URL (Uniform Resource Locator) address. Only the http, https and ftp protocols are supported.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id301627162561225"> + <input>svc.IsUrl(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id321580132113593"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id41580132143630">MsgBox SF_String.IsUrl("http://foo.bar/?q=Test%20URL-encoded%20stuff") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811580132160302">MsgBox SF_String.IsUrl("www.somesite.org") ' False</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831627249268852">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981627249268254">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871627249268007">bas.MsgBox(svc.IsUrl("http://foo.bar/?q=Test%20URL-encoded%20stuff")) # True</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211627249268997">bas.MsgBox(svc.IsUrl("www.somesite.org")) # False</paragraph> + </pycode> +</section> + +<section id="IsWhitespace"> + <comment> IsWhitespace ----------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id551582205196046"> + <bookmark_value>String service;IsWhitespace</bookmark_value> + </bookmark> + <h2 id="hd_id401580132462319" localize="false">IsWhitespace</h2> + <paragraph role="paragraph" id="par_id41580132491698">Returns <literal>True</literal> if all characters in the string are whitespaces</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id981627162624424"> + <input>svc.IsWhitespace(inputstr: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id801580132535511"><emph>inputstr</emph>: The string to be checked. If empty, the method returns <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id71580132555742">MsgBox SF_String.IsWhitespace(" ") ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191580132564154">MsgBox SF_String.IsWhitespace(" " & Chr(9) & Chr(10)) ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531580132571745">MsgBox SF_String.IsWhitespace("") ' False</paragraph> + </bascode> +</section> + +<section id="JustifyCenter"> + <comment> JustifyCenter ----------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id421582205214600"> + <bookmark_value>String service;JustifyCenter</bookmark_value> + </bookmark> + <h2 id="hd_id291580133287288" localize="false">JustifyCenter</h2> + <paragraph role="paragraph" id="par_id891580133307100">Returns the input string center-justified.</paragraph> + <paragraph role="paragraph" id="par_id571612380829021">The leading and trailing white spaces are stripped and the remaining characters are completed left and right up to a specified total <literal>length</literal> with the character <literal>padding</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id911627162696565"> + <input>svc.JustifyCenter(inputstr: str, [length: int], [padding: str]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id911580133391827"><emph>inputstr</emph>: The string to be center-justified. If empty, the method returns an empty string.</paragraph> + <paragraph role="paragraph" id="par_id671580133694946"><emph>length</emph>: The length of the resulting string (default = the length of the input string).</paragraph> + <paragraph role="paragraph" id="par_id511612381090109">If the specified length is shorter than the center-justified input string, then the returned string is truncated.</paragraph> + <paragraph role="paragraph" id="par_id101580133705268"><emph>padding</emph>: The single character to be used as padding (default = the Ascii space " ").</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id121580133437963">MsgBox SF_String.JustifyCenter("Title", Length := 11) ' " Title "</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701580133452083">MsgBox SF_String.JustifyCenter(" ABCDEF", Padding := "_") ' "__ABCDEF__"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841580133480737">MsgBox SF_String.JustifyCenter("A Long Title", Length := 5) ' "ong T"</paragraph> + </bascode> +</section> + +<section id="JustifyLeft"> + <comment> JustifyLeft ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id351582205243403"> + <bookmark_value>String service;JustifyLeft</bookmark_value> + </bookmark> + <h2 id="hd_id51580135447561" localize="false">JustifyLeft</h2> + <paragraph role="paragraph" id="par_id911580135466348">Returns the input string left-justified.</paragraph> + <paragraph role="paragraph" id="par_id431612381917641">The leading white spaces are stripped and the remaining characters are completed to the right up to a specified total <literal>length</literal> with the character <literal>padding</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id551627162821330"> + <input>svc.JustifyLeft(inputstr: str, [length: int], [padding: str]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id281580135523448"><emph>inputstr</emph>: The string to be left-justified. If empty, the method returns an empty string.</paragraph> + <paragraph role="paragraph" id="par_id431580135534910"><emph>length</emph>: The length of the resulting string (default = the length of the input string).</paragraph> + <paragraph role="paragraph" id="par_id161612381664182">If the specified length is shorter than the left-justified input string, then the returned string is truncated.</paragraph> + <paragraph role="paragraph" id="par_id221580135568475"><emph>padding</emph>: The single character to be used as padding (default = the Ascii space " ").</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id611580135592267">MsgBox SF_String.JustifyLeft("Title", Length := 10) ' "Title "</paragraph> + <paragraph role="bascode" localize="false" id="bas_id131580135610150">MsgBox SF_String.JustifyLeft(" ABCDEF", Padding := "_") ' "ABCDEF____"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441580135619176">MsgBox SF_String.JustifyLeft("A Long Title", Length := 5) ' "A Lon"</paragraph> + </bascode> +</section> + +<section id="JustifyRight"> + <comment> JustifyRight ------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id401582205265380"> + <bookmark_value>String service;JustifyRight</bookmark_value> + </bookmark> + <h2 id="hd_id651580136079149" localize="false">JustifyRight</h2> + <paragraph role="paragraph" id="par_id821580136091225">Returns the input string right-justified.</paragraph> + <paragraph role="paragraph" id="par_id771612382000293">The leading white spaces are stripped and the remaining characters are completed to the left up to a specified total <literal>length</literal> with the character <literal>padding</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id161627162950390"> + <input>svc.JustifyRight(inputstr: str, [length: int], [padding: str]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id201580136154170"><emph>inputstr</emph>: The string to be right-justified. If empty, the method returns an empty string.</paragraph> + <paragraph role="paragraph" id="par_id71580136164632"><emph>length</emph>: The length of the resulting string (default = the length of the input string).</paragraph> + <paragraph role="paragraph" id="par_id191612381732163">If the specified length is shorter than the right-justified input string, then the returned string is truncated.</paragraph> + <paragraph role="paragraph" id="par_id751580136200680"><emph>padding</emph>: The single character to be used as padding (default = the Ascii space " ").</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id791580136219992">MsgBox SF_String.JustifyRight("Title", Length := 10) ' " Title"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id751580136242414">MsgBox SF_String.JustifyRight(" ABCDEF ", Padding := "_") ' "____ABCDEF"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id861580136253164">MsgBox SF_String.JustifyRight("A Long Title", Length := 5) ' "Title"</paragraph> + </bascode> +</section> + +<section id="Quote"> + <comment> Quote ------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id241582205281048"> + <bookmark_value>String service;Quote</bookmark_value> + </bookmark> + <h2 id="hd_id741580136875363" localize="false">Quote</h2> + <paragraph role="paragraph" id="par_id251580136888958">Returns the input string enclosed in single or double quotes. Existing quotes are left unchanged, including leading and/or trailing quotes.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id321627163052678"> + <input>svc.Quote(inputstr: str, [quotechar: str]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id811580136944674"><emph>inputstr</emph>: The string to quote.</paragraph> + <paragraph role="paragraph" id="par_id581599129397412"><emph>quotechar</emph>: Either the single (') or double (") quote (default).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id171580136967087">MsgBox SF_String.Quote("Text Value")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331612442671018">' "Text Value"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291580136977341">MsgBox SF_String.Quote("Book Title: ""The Arabian Nights""", "'")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id111612442632444">' 'Book Title: "The Arabian Nights"'</paragraph> + </bascode> + <tip id="par_id911612382537087">This method can be useful while preparing a string field to be stored in a csv-like file, which requires that text values be enclosed with single or double quotes.</tip> +</section> + +<section id="ReplaceChar"> + <comment> ReplaceChar ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id971582205313633"> + <bookmark_value>String service;ReplaceChar</bookmark_value> + </bookmark> + <h2 id="hd_id171580139110167" localize="false">ReplaceChar</h2> + <paragraph role="paragraph" id="par_id951580139124650">Replaces all occurrences of the characters specified in the <literal>Before</literal> parameter by the corresponding characters specified in <literal>After</literal>.</paragraph> + <paragraph role="paragraph" id="par_id1001612384040018">If the length of <literal>Before</literal> is greater than the length of <literal>After</literal>, the residual characters in <literal>Before</literal> are replaced by the last character in <literal>After</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id191627163199236"> + <input>svc.ReplaceChar(inputstr: str, before: str, after: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id11580139160633"><emph>inputstr</emph>: The input string on which replacements will occur.</paragraph> + <paragraph role="paragraph" id="par_id111580139169795"><emph>before</emph>: A string with the characters that will be searched in the input string for replacement.</paragraph> + <paragraph role="paragraph" id="par_id851580139182113"><emph>after</emph>: A string with the new characters that will replace those defined in <literal>before</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="bas_id921580139218457">' Replaces accented characters</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281580139228929">MsgBox SF_String.ReplaceChar("Protégez votre vie privée", "àâãçèéêëîïôöûüýÿ", "aaaceeeeiioouuyy")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361612384219658">' "Protegez votre vie privee"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201580139288120">MsgBox SF_String.ReplaceChar("Protégez votre vie privée", "àâãçèéêëîïôöûüýÿ", "")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401612443219105">' "Protgez votre vie prive"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661580139301417">MsgBox SF_String.ReplaceChar("àâãçèéêëîïôöûüýÿ", "àâãçèéêëîïôöûüýÿ", "aaaceeeeiioouuyy")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621612443248643">' "aaaceeeeiioouuyy"</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id151612442904499">The <literal>SF_String</literal> service provides useful public constants for the Latin character sets, as shown in the example below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id621580139272513">MsgBox SF_String.ReplaceChar("Protégez votre vie privée", SF_String.CHARSWITHACCENT, SF_String.CHARSWITHOUTACCENT)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id551612443170894">' "Protegez votre vie privee"</paragraph> + </bascode> +</section> + +<section id="ReplaceRegex"> + <comment> ReplaceRegex ------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id541582205335970"> + <bookmark_value>String service;ReplaceRegex</bookmark_value> + </bookmark> + <h2 id="hd_id491580140260181" localize="false">ReplaceRegex</h2> + <paragraph role="paragraph" id="par_id671580140272818">Replaces all occurrences of a given regular expression by a new string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id21627163307092"> + <input>svc.ReplaceRegex(inputstr: str, regex: str, newstr: str, [casesensitive: bool]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id471580140311626"><emph>inputstr</emph>: The input string on which replacements will occur.</paragraph> + <paragraph role="paragraph" id="par_id651580140322666"><emph>regex</emph>: The regular expression.</paragraph> + <paragraph role="paragraph" id="par_id891580140334754"><emph>newstr</emph>: The replacing string.</paragraph> + <paragraph role="paragraph" id="par_id581580140345221"><emph>casesensitive</emph>: The search can be case sensitive or not (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id151580140386767">MsgBox SF_String.ReplaceRegex("Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "[a-z]", "x", CaseSensitive := True)</paragraph> + <paragraph role="bascode" id="bas_id961612384647003">' "Lxxxx xxxxx xxxxx xxx xxxx, xxxxxxxxxxx xxxxxxxxxx xxxx." (each lowercase letter is replaced by "x")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id11580140400163">MsgBox SF_String.ReplaceRegex("Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "\b[a-z]+\b", "x", CaseSensitive := False)</paragraph> + <paragraph role="bascode" id="bas_id751612384623936">' "x x x x x, x x x." (each word is replaced by "x")</paragraph> + </bascode> +</section> + +<section id="ReplaceStr"> + <comment> ReplaceStr -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id751582205356816"> + <bookmark_value>String service;ReplaceStr</bookmark_value> + </bookmark> + <h2 id="hd_id701580146458127" localize="false">ReplaceStr</h2> + <paragraph role="paragraph" id="par_id51580146471894">Replaces in a string some or all occurrences of an array of strings by an array of new strings.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id521627163432097"> + <input>svc.ReplaceStr(inputstr: str, oldstr: str, newstr: str, [occurrences: int], [casesensitive: bool]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id831580146504326"><emph>inputstr</emph>: The input string on which replacements will occur.</paragraph> + <paragraph role="paragraph" id="par_id411580146514927"><emph>oldstr</emph>: A single string or an array of strings. Zero-length strings are ignored.</paragraph> + <paragraph role="paragraph" id="par_id591580146532966"><emph>newstr</emph>: The replacing string or the array of replacing strings.</paragraph> + <paragraph role="paragraph" id="par_id611612384873347">If <literal>oldstr</literal> is an array, each occurrence of any of the items in <literal>oldstr</literal> is replaced by <literal>newstr</literal>.</paragraph> + <paragraph role="paragraph" id="par_id611612384880820">If <literal>oldstr</literal> and <literal>newstr</literal> are arrays, replacements occur one by one up to the <literal>UBound(newstr)</literal>.</paragraph> + <paragraph role="paragraph" id="par_id241612385058264">If <literal>oldstr</literal> has more entries than <literal>newstr</literal>, then the residual elements in <literal>oldstr</literal> are replaced by the last element in <literal>newstr</literal>.</paragraph> + <paragraph role="paragraph" id="par_id701580146547619"><emph>occurrences</emph>: The maximum number of replacements. The default value is 0, meaning that all occurrences will be replaced.</paragraph> + <paragraph role="paragraph" id="par_id741612385380533">When <literal>oldstr</literal> is an array, the <literal>occurrence</literal> parameter is computed separately for each item in the array.</paragraph> + <paragraph role="paragraph" id="par_id301580146556599"><emph>casesensitive</emph>: The search can be case sensitive or not (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id481580146574037">MsgBox SF_String.ReplaceStr("100 xxx 200 yyy", Array("xxx", "yyy"), Array("(1)", "(2)"), CaseSensitive := False)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id511612385563994">' "100 (1) 200 (2)"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151580146611738">MsgBox SF_String.ReplaceStr("abCcdefghHij", Array("c", "h"), Array("Y", "Z"), CaseSensitive := False)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491612385543543">' "abYYdefgZZij"</paragraph> + </bascode> +</section> + +<section id="Represent"> + <comment> Represent --------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id151582205374090"> + <bookmark_value>String service;Represent</bookmark_value> + </bookmark> + <h2 id="hd_id581580147543150" localize="false">Represent</h2> + <paragraph role="paragraph" id="par_id901580147558931">Returns a string with a readable representation of the argument, truncated at a given length. This is useful mainly for debugging or logging purposes.</paragraph> + <paragraph role="paragraph" id="par_id11612386054691">If the <literal>anyvalue</literal> parameter is an object, it will be enclosed with square brackets "[" and "]".</paragraph> + <paragraph role="paragraph" id="par_id491612386081802">In strings, tabs and line breaks are replaced by \t, \n or \r.</paragraph> + <paragraph role="paragraph" id="par_id921612386089103">If the final length exceeds the <literal>maxlength</literal> parameter, the latter part of the string is replaced by " ... (N)" where N is the total length of the original string before truncation.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711627163695452"> + <input>svc.Represent(anyvalue: any, [maxlength: int]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id91580147593626"><emph>anyvalue</emph>: The input value to be represented. It can be any value, such as a string, an array, a Basic object, a UNO object, etc.</paragraph> + <paragraph role="paragraph" id="par_id811580147609322"><emph>maxlength</emph>: The maximum length of the resulting string. The default value is 0, meaning there is no limit to the length of the resulting representation.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id931580147637178">MsgBox SF_String.Represent("this is a usual string") ' "this is a usual string"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701580147646290">MsgBox SF_String.Represent("this is a usual string", 15) ' "this i ... (22)"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001580147656762">MsgBox SF_String.Represent("this is a" & Chr(10) & " 2-lines string") ' "this is a\n 2-lines string"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661580147668170">MsgBox SF_String.Represent(Empty) ' "[EMPTY]"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941580147685721">MsgBox SF_String.Represent(Null) ' "[NULL]"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531580147702074">MsgBox SF_String.Represent(Pi) ' "3.142"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461580147719545">MsgBox SF_String.Represent(CreateUnoService("com.sun.star.util.PathSettings")) ' "[com.sun.star.comp.framework.PathSettings]"</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id641612386659292">Note that the representation of data types such as Arrays and <literal>ScriptForge.Dictionary</literal> object instances include both the data type and their values:</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id971612386906463">' An example with a Basic built-in Array</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401580147734722">MsgBox SF_String.Represent(Array(1, 2, "Text" & Chr(9) & "here"))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311612386778843">' "[ARRAY] (0:2) (1, 2, Text\there)"</paragraph> + <paragraph role="bascode" id="bas_id401612386876329">' An example with a ScriptForge Array</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621612386824731">Dim aValues as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771612386825586">aValues = SF_Array.RangeInit(1, 5)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841612386825825">MsgBox SF_String.Represent(aValues)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121612386864144">' "[ARRAY] (0:4) (1.0, 2.0, 3.0, 4.0, 5.0)"</paragraph> + <paragraph role="bascode" id="bas_id551612386931680">' An example with a ScriptForge Dictionary</paragraph> + <paragraph role="bascode" localize="false" id="bas_id951580147750109">Dim myDict As Variant : myDict = CreateScriptService("Dictionary")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701580147765158">myDict.Add("A", 1) : myDict.Add("B", 2)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921580147782281">MsgBox SF_String.Represent(myDict)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911612386800415">' "[Dictionary] ("A":1, "B":2)"</paragraph> + </bascode> +</section> + +<section id="Reverse"> + <comment> Reverse ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id111582205394632"> + <bookmark_value>String service;Reverse</bookmark_value> + </bookmark> + <h2 id="hd_id781580312915849" localize="false">Reverse</h2> + <paragraph role="paragraph" id="par_id411580312925741">Returns the input string in reversed order.</paragraph> + <paragraph role="paragraph" id="par_id141612387177873">This method is equivalent to the built-in <link href="text/sbasic/shared/03120412.xhp" name="StrReverse function"><literal>StrReverse</literal> Basic function</link>.</paragraph> + <note id="par_id961612387463144">To use the <literal>StrReverse</literal> function, the statement <literal>Option VBASupport 1</literal> must be present in the module.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id951627163820097"> + <input>svc.Reverse(inputstr: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id241580312964497"><emph>inputstr</emph>: The string to be reversed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671580313005541">MsgBox SF_String.Reverse("abcdefghij") ' "jihgfedcba"</paragraph> + </bascode> +</section> + +<section id="SplitLines"> + <comment> SplitLines -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id681582205412371"> + <bookmark_value>String service;SplitLines</bookmark_value> + </bookmark> + <h2 id="hd_id111580210751549" localize="false">SplitLines</h2> + <paragraph role="paragraph" id="par_id721580210762286">Returns a zero-based array of strings with the lines in the input string. Each item in the array is obtained by splitting the input string at newline characters.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id491627163897526"> + <input>svc.SplitLines(inputstr: str, [keepbreaks: int]): str[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481580210806878"><emph>inputstr</emph>: The string to be split.</paragraph> + <paragraph role="paragraph" id="par_id231580210820309"><emph>keepbreaks</emph>: When <literal>True</literal>, line breaks are preserved in the output array (default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id301580210850100">Dim a as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561580210860646">a = SF_String.SplitLines("Line1" & Chr(10) & "Line2" & Chr(13) & "Line3")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661612387860556">' a = Array("Line1", "Line2", "Line3")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791580210888116">a = SF_String.SplitLines("Line1" & Chr(10) & "Line2" & Chr(13) & "Line3" & Chr(10))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id701612387837745">' a = Array("Line1", "Line2", "Line3", "")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id451580210958405">a = SF_String.SplitLines("Line1" & Chr(10) & "Line2" & Chr(13) & "Line3" & Chr(10), KeepBreaks := True)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591612387824058">' a = Array("Line1\n", "Line2\r", "Line3\n", "")</paragraph> + </bascode> +</section> + +<section id="SplitNotQuoted"> + <comment> SplitNotQuoted ---------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id531582205451718"> + <bookmark_value>String service;SplitNotQuoted</bookmark_value> + </bookmark> + <h2 id="hd_id131580211748939" localize="false">SplitNotQuoted</h2> + <paragraph role="paragraph" id="par_id471580211762739">Splits a string into an array of elements using a specified delimiter.</paragraph> + <paragraph role="paragraph" id="par_id281612388034501">If a quoted substring contains a delimiter, it is ignored. This is useful when parsing CSV-like records that contain quoted strings.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id261627164043199"> + <input>svc.SplitNotQuoted(inputstr: str, [delimiter: str], [occurrences: int], [quotechar: str]): str[0..*]</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id881580211809490"><emph>inputstr</emph>: The string to be split.</paragraph> + <paragraph role="paragraph" id="par_id811580211821162"><emph>delimiter</emph>: A string of one or more characters that will be used as delimiter. The default delimiter is the Ascii space " " character.</paragraph> + <paragraph role="paragraph" id="par_id181580211833778"><emph>occurrences</emph>: The maximum number of substrings to return. The default value is 0, meaning that there is no limit to the number of returned strings.</paragraph> + <paragraph role="paragraph" id="par_id421599123777334"><emph>quotechar</emph>: Either the single (') or double (") quote.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id511580211876156">arr1 = SF_String.SplitNotQuoted("abc def ghi")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581580211857403">' arr1 = Array("abc", "def", "ghi")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711580211886107">arr2 = SF_String.SplitNotQuoted("abc,""def,ghi""", ",")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id111580211865432">' arr2 = Array("abc", """def,ghi""")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101580211896350">arr3 = SF_String.SplitNotQuoted("abc,""def\"",ghi""", ",")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351612388312049"> ' arr3 = Array("abc", """def\"",ghi""")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591580211905379">arr4 = SF_String.SplitNotQuoted("abc,""def\"",ghi"""",", ",")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691580211914228">' arr4 = Array("abc", """def\"",ghi""", "")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id831627249262582">svc = CreateScriptService("String")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981627249260364">arr1 = svc.SplitNotQuoted('abc def ghi')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871627249262177"># arr1 = ('abc', 'def', 'ghi')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211627249269827">arr2 = svc.SplitNotQuoted('abc,"def,ghi"', ",")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id11627251280871"># arr2 = ('abc', '"def,ghi"')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id681627251281232">arr3 = svc.SplitNotQuoted(r'abc,"def\",ghi"', ",")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id291627251281439"># arr3 = ('abc', '"def\\",ghi"')</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id81627251281671">arr4 = svc.SplitNotQuoted(r'abc,"def\",ghi"",', ",")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id601627251281871"># arr4 = ('abc', '"def\\",ghi""', '')</paragraph> + </pycode> + <note id="par_id661627251379676">Beware of the differences between Basic and Python when representing strings. For example, in Basic two "" characters inside a string are interpreted as a single " character. In Python, strings enclosed with single quotes can contain " characters without having to double them.</note> +</section> + +<section id="StartsWith"> + <comment> StartsWith -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id521582205468821"> + <bookmark_value>String service;StartsWith</bookmark_value> + </bookmark> + <h2 id="hd_id121580212826111" localize="false">StartsWith</h2> + <paragraph role="paragraph" id="par_id771580212837884">Returns <literal>True</literal> if the first characters of a string are identical to a given substring.</paragraph> + <paragraph role="paragraph" id="par_id781612393174350">This method returns <literal>False</literal> if either the input string or the substring have a length = 0 or when the substring is longer than the input string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id211627164196721"> + <input>svc.StartsWith(inputstr: str, substring: str, [casesensitive: bool]): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id271580212876135"><emph>inputstr</emph>: The string to be tested.</paragraph> + <paragraph role="paragraph" id="par_id571580212889462"><emph>substring</emph>: The substring to be searched at the start of <literal>inputstr</literal>.</paragraph> + <paragraph role="paragraph" id="par_id811580212900799"><emph>casesensitive</emph>: The search can be case sensitive or not (Default = <literal>False</literal>).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id581580212931342">MsgBox SF_String.StartsWith("abcdefg", "ABC") 'True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491580212940539">MsgBox SF_String.StartsWith("abcdefg", "ABC", CaseSensitive := True) 'False</paragraph> + </bascode> +</section> + +<section id="TrimExt"> + <comment> TrimExt ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id461582205488207"> + <bookmark_value>String service;TrimExt</bookmark_value> + </bookmark> + <h2 id="hd_id191580295988498" localize="false">TrimExt</h2> + <paragraph role="paragraph" id="par_id911580295999690">Returns the input string without its leading and trailing whitespaces.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id241627164299510"> + <input>svc.TrimExt(inputstr: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id541580296044377"><emph>inputstr</emph>: The string to trim.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id231580296079929">MsgBox SF_String.TrimExt(" Some text. ") ' "Some text."</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871580296091857">MsgBox SF_String.TrimExt(" ABCDEF" & Chr(9) & Chr(10) & Chr(13) & " ") ' "ABCDEF"</paragraph> + </bascode> +</section> + +<section id="Unescape"> + <comment> Unescape ---------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id651582205521725"> + <bookmark_value>String service;Unescape</bookmark_value> + </bookmark> + <h2 id="hd_id831580483080098" localize="false">Unescape</h2> + <paragraph role="paragraph" id="par_id61580483096936">Converts any escaped sequence (\\, \n, \r, \t) in the input string to their corresponding Ascii character.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id51627164365699"> + <input>svc.Unescape(inputstr: str): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id971580483124743"><emph>inputstr</emph>: The string to be converted.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id601580483196328">MsgBox SF_String.Unescape("abc\n\tdef\\n")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261580483205906">' "abc" & Chr(10) & Chr(9) & "def\n"</paragraph> + </bascode> +</section> + +<section id="Unquote"> + <comment> Unquote ----------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id471582205541341"> + <bookmark_value>String service;Unquote</bookmark_value> + </bookmark> + <h2 id="hd_id481580213622428" localize="false">Unquote</h2> + <paragraph role="paragraph" id="par_id831580213634029">Removes the single or double quotes enclosing the input string.</paragraph> + <paragraph role="paragraph" id="par_id811612393585600">This is useful when parsing CSV-like records that contain quoted strings.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id391627164432930"> + <input>svc.Unquote(inputstr: str, [quotechar: str]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id761580213677493"><emph>inputstr</emph>: The string to unquote.</paragraph> + <paragraph role="paragraph" id="par_id211599129509890"><emph>quotechar</emph>: Either the single (') or double (") quote (default).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id371580213703732">Dim s as String</paragraph> + <paragraph role="bascode" id="bas_id371580213702598">' s = "Some text" (without enclosing quotes)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981580213799125">s = SF_String.Unquote("""Some text""")</paragraph> + <paragraph role="bascode" id="bas_id51580213693694">' The string below does not have enclosing quotes, so it remains unchanged</paragraph> + <paragraph role="bascode" id="bas_id961612393917830">' s = "Some text" (unchanged)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961612393917927">s = SF_String.Unquote("Some text")</paragraph> + <paragraph role="bascode" id="bas_id461612394182689">' Quotes inside the string are not removed</paragraph> + <paragraph role="bascode" id="bas_id961612394171208">' s = "The ""true"" meaning" (unchanged)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961612394171186">s = SF_String.Unquote("The ""true"" meaning")</paragraph> + </bascode> +</section> + +<section id="Wrap"> + <comment> Wrap ------------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id321585834468367"> + <bookmark_value>String service;Wrap</bookmark_value> + </bookmark> + <h2 id="hd_id911585834468456" localize="false">Wrap</h2> + <paragraph role="paragraph" id="par_id871585834468102">Converts the input string into an array of substrings so that each item in the array has at most a given number of characters.</paragraph> + <paragraph role="paragraph" id="par_id21612394465120">In practice, this method returns a zero-based array of output lines, without newlines at the end, except for the pre-existing line-breaks.</paragraph> + <paragraph role="paragraph" id="par_id601612395193333">Tabs are expanded using the same procedure performed by the <link href="text/sbasic/shared/03/sf_string.xhp#ExpandTabs" name="ExpandTabs method">ExpandTabs</link> method.</paragraph> + <paragraph role="paragraph" id="par_id641612394826616"> Symbolic line breaks are replaced by their equivalent Ascii characters.</paragraph> + <paragraph role="paragraph" id="par_id361612394859733">If the wrapped output has no content, the returned array is empty.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id41627164529595"> + <input>svc.Wrap(inputstr: str, [width: int], [tabsize: int]): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id251585834468498"><emph>inputstr</emph>: The string to wrap.</paragraph> + <paragraph role="paragraph" id="par_id351585834773177"><emph>width</emph>: The maximum number of characters in each line (Default = 70).</paragraph> + <paragraph role="paragraph" id="par_id741585834874500"><emph>tabsize</emph>: Before wrapping the text, the existing TAB <literal>Chr(9)</literal> characters are replaced with spaces. The argument <literal>tabsize</literal> defines the TAB stops at TabSize + 1, 2 * TabSize + 1 , ... N * TabSize + 1 (Default = 8).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id461585835162853">a = "Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..."</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891585835170534">b = SF_String.Wrap(a, 20)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191585835179883">' Array("Neque porro ", "quisquam est qui ", "dolorem ipsum quia ", "dolor sit amet, ", "consectetur, ", "adipisci velit...")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id221627251731306">a = "Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..."</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id411627251731572">b = svc.Wrap(a, 20)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id921627251731739"># ('Neque porro ', 'quisquam est qui ', 'dolorem ipsum quia ', 'dolor sit amet, ', 'consectetur, ', 'adipisci velit...')</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_array.xhp#ArrayService"/> + <embed href="text/sbasic/shared/03120202.xhp#String_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_textstream.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_textstream.xhp new file mode 100644 index 000000000..7505f09c2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_textstream.xhp @@ -0,0 +1,376 @@ +<?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_TextStream" indexer="include" status="PUBLISH"> + <title id="tit">ScriptForge.TextStream service</title> + <filename>/text/sbasic/shared/03/sf_textstream.xhp</filename> + </topic> + </meta> + +<body> + +<section id="ScriptForge-SF_TextStream"> + <bookmark localize="false" branch="index" id="bm_id50158533078781"> + <bookmark_value>TextStream service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="bm_id351585330787295"><variable id="TextStreamService"><link href="text/sbasic/shared/03/sf_textstream.xhp" name="TextStream service"><literal>ScriptForge</literal>.<literal>TextStream</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id511585330787205">The <literal>TextStream</literal> service is used to sequentially read from and write to files opened or created using the <literal>ScriptForge.FileSystem</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id41613596903894">The methods <literal>OpenTextFile</literal> and <literal>CreateTextFile</literal> from the <literal>FileSystem</literal> service return an instance of the <literal>TextStream</literal> service.</paragraph> +</section> + <paragraph role="paragraph" id="par_id161585330787262">Line delimiters may be specified by the user. In input operations CR, LF or CR+LF are supported. In output operations, the default line delimiter is the one used by the operating system.</paragraph> + <paragraph role="paragraph" id="par_id831613598137669">The line delimiter for the operating system where the macro is being executed can be accessed using the <literal>SF_String.sfNEWLINE</literal> property.</paragraph> + <note id="par_id851613597445432">All operations needed to read from or write to a file (open, read/write and close) are presumed to happen during the same macro run.</note> + + <h2 id="hd_id83158533078741">Service invocation</h2> + <paragraph role="paragraph" id="par_id351613598192725">The examples below in Basic and Python use the <literal>OpenTextFile</literal> method to create an instance of the <literal>TextStream</literal> Service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id77158533078783">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971585330787275">Dim FSO As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id11585330787585">FSO = CreateScriptService("FileSystem")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891585330787374">Set myFile = FSO.OpenTextFile("C:\Temp\ThisFile.txt", FSO.ForReading)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id371585330787197">The file must be closed with the <literal>CloseFile</literal> method after all read or write operations have been executed:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id91613599192241">myFile.CloseFile()</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id891582733781994">Optionally, the resources used by the <literal>TextStream</literal> instance can be released using the <literal>Dispose</literal> method:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id761613599333614">Set myFile = myFile.Dispose()</paragraph> + </bascode> + <note id="par_id121612917368946">The methods in the <literal>TextStream</literal> service are mostly based on the <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1io_1_1XTextInputStream.html" name="XTextInputStream API"><literal>XTextInputStream</literal></link> and <link href="https://api.libreoffice.org/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1io_1_1XTextOutputStream.html" name="XTextOutputStream API"><literal>XTextOutputStream</literal></link> UNO interfaces.</note> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id841626893320674">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981626893320923">fs = CreateScriptService("FileSystem")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id851626893321150">myFile = fs.OpenTextFile(r"C:\Temp\ThisFile.txt", fs.ForReading)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id131626893321309"># ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id231626893321491">myFile.CloseFile()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id871626893321683">myFile = myFile.Dispose()</paragraph> + </pycode> + + <h2 id="hd_id941585330787948">Properties</h2> + <bookmark branch="index" id="bm_id1001613600572485" localize="false"> + <bookmark_value>TextStream service;AtEndOfStream</bookmark_value> + <bookmark_value>TextStream service;Encoding</bookmark_value> + <bookmark_value>TextStream service;FileName</bookmark_value> + <bookmark_value>TextStream service;IOMode</bookmark_value> + <bookmark_value>TextStream service;Line</bookmark_value> + <bookmark_value>TextStream service;NewLine</bookmark_value> + </bookmark> + <table id="tab_id81585330787547"> + <tablerow> + <tablecell> + <paragraph id="par_id631585330787267" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401585330787370" role="tablehead">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581585330787700" role="tablehead">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id551585330787608" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id941585330787832" role="tablecontent" localize="false">AtEndOfStream</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id181585330787752" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471585330787948" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id901585330787680" role="tablecontent">Used in read mode. A <literal>True</literal> value indicates that the end of the file has been reached. A test using this property should precede calls to the <literal>ReadLine</literal> method.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id501585330787895" role="tablecontent" localize="false">Encoding</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561585330787568" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731585330787673" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741585330787777" role="tablecontent">The character set to be used. The default encoding is "UTF-8".</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id361585330787241" role="tablecontent" localize="false">FileName</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id641585330787207" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id9158533078741" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id281585330787614" role="tablecontent">Returns the name of the current file either in URL format or in the native operating system's format, depending on the current value of the <literal>FileNaming</literal> property of the <literal>FileSystem</literal> service.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id451585330787745" role="tablecontent" localize="false">IOMode</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111585330787410" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id981585330787716" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861585330787417" role="tablecontent">Indicates the input/output mode. Possible values are "READ", "WRITE" or "APPEND".</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721585330787688" role="tablecontent" localize="false">Line</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id87158533078795" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601585330787171" role="tablecontent" localize="false">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561585330787741" role="tablecontent">Returns the number of lines read or written so far.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id12158533078767" role="tablecontent" localize="false">NewLine</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531585330787157" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id9415853307876" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691585330787279" role="tablecontent">Sets or returns the current delimiter to be inserted between two successive written lines. The default value is the native line delimiter in the current operating system.</paragraph> + </tablecell> + </tablerow> + </table> + <note id="par_id141613001281573">To learn more about the names of character sets, visit <link href="https://www.iana.org/assignments/character-sets/character-sets.xhtml" name="Character Sets">IANA's Character Set</link> page. Beware that %PRODUCTNAME does not implement all existing character sets.</note> +<table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead">List of Methods in the TextStream Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_textstream.xhp#CloseFile" name="CloseFile method">CloseFile</link><br/> + <link href="text/sbasic/shared/03/sf_textstream.xhp#ReadAll" name="ReadAll method">ReadAll</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_textstream.xhp#ReadLine" name="ReadLine method">ReadLine</link><br/> + <link href="text/sbasic/shared/03/sf_textstream.xhp#SkipLine" name="SkipLine method">SkipLine</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_textstream.xhp#WriteBlankLines" name="WriteBlankLines method">WriteBlankLines</link><br/> + <link href="text/sbasic/shared/03/sf_textstream.xhp#WriteLine" name="WriteLine method">WriteLine</link><br/> + </paragraph> + </tablecell> + </tablerow> +</table> + +<section id="CloseFile"> + <comment> CloseFile ------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id21585330787288"> + <bookmark_value>TextStream service;CloseFile</bookmark_value> + </bookmark> + <h2 id="hd_id901585330787252" localize="false">CloseFile</h2> + <paragraph role="paragraph" id="par_id421585330787675">Closes the current input or output stream and empties the output buffer if relevant. Returns <literal>True</literal> if the file was successfully closed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id971626891612501"> + <input>myFile.CloseFile(): bool</input> + </paragraph> +</section> + +<section id="ReadAll"> + <comment> ReadAll -------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id311585330787690"> + <bookmark_value>TextStream service;ReadAll</bookmark_value> + </bookmark> + <h2 id="hd_id311585330787335" localize="false">ReadAll</h2> + <paragraph role="paragraph" id="par_id65158533078799">Returns all the remaining lines in the text stream as a single string. Line breaks are not removed.</paragraph> + <paragraph role="paragraph" id="par_id71613600347125">The resulting string can be split in lines either by using the <literal>Split</literal> built-in Basic function if the line delimiter is known, or with the <literal>SF_String.SplitLines</literal> method.</paragraph> + <paragraph role="paragraph" id="par_id91585330787373">For large files, using the <literal>ReadAll</literal> method wastes memory resources. In such cases it is recommended to read the file line by line using the <literal>ReadLine</literal> method.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id501626891694491"> + <input>myFile.ReadAll(): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id921613595637851">Consider the text file "Students.txt" with the following contents (a name in each line):</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id921613595638140">Herbie Peggy</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61613595639028">Hardy Jarrett</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711613595639379">Edith Lorelle</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331613595639605">Roderick Rosamund</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641613595639909">Placid Everette</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id391613596019750">The examples below in Basic and Python use the <literal>ReadAll</literal> and <literal>SplitLines</literal> methods to read the contents of the file into an array of strings:</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" id="bas_id251613595640550">'Loads the FileSystem service</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931613595640789">Dim FSO : FSO = CreateScriptService("FileSystem")</paragraph> + <paragraph role="bascode" id="bas_id181613595641087">'Opens the text file with the names to be read</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291613595641480">Dim inputFile as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651613595641754">Set inputFile = FSO.OpenTextFile("/home/user/Documents/Students.txt")</paragraph> + <paragraph role="bascode" id="bas_id711613595642109">'Reads all the contents in the input file as a single string</paragraph> + <paragraph role="bascode" localize="false" id="bas_id81613595642474">Dim allData as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191613595642766">allData = inputFile.ReadAll()</paragraph> + <paragraph role="bascode" id="bas_id961613595643093">'Splits the string into an array</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51613595643398">Dim arrNames as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151613595643675">arrNames = SF_String.SplitLines(allData)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211613595928948">' (...)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31613600104976">inputFile.CloseFile()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id641626893916915">fs = CreateScriptService("FileSystem")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id751626893917578">inputFile = fs.OpenTextFile("/home/user/Documents/Students.txt")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id771626893917826">allData = inputFile.ReadAll()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id951626893918067">arrNames = allData.split(inputFile.NewLine)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id391626893918273"># ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id241626893918515">inputFile.CloseFile()</paragraph> + </pycode> +</section> + +<section id="ReadLine"> + <comment> ReadLine ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id161585330787462"> + <bookmark_value>TextStream service;ReadLine</bookmark_value> + </bookmark> + <h2 id="hd_id111585330787998" localize="false">ReadLine</h2> + <paragraph role="paragraph" id="par_id871585330787885">Returns the next line in the text stream as a string. Line breaks are removed from the returned string.</paragraph> + <paragraph role="paragraph" id="par_id431613600221626">The <literal>AtEndOfStream</literal> test should precede the <literal>ReadLine</literal> method like in the example below.</paragraph> + <paragraph role="paragraph" id="par_id171585330787774">An error will be raised if the <literal>AtEndOfStream</literal> was reached during the previous <literal>ReadLine</literal> or <literal>SkipLine</literal> method call.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id431626892013564"> + <input>myFile.ReadLine(): str</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id321585330787499">Dim sLine As String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791585330787376">Do While Not myFile.AtEndOfStream</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461585330787206"> sLine = myFile.ReadLine()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id521585330787673"> ' (...)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id715853307876">Loop</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id21626894253022">while not myFile.AtEndOfStream:</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381626894253384"> sLine = myFile.ReadLine()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id931626894253567"> # ...</paragraph> + </pycode> +</section> + +<section id="SkipLine"> + <comment> SkipLine ------------------------------------------------------------------------------------------- </comment> + <bookmark localize="false" branch="index" id="bm_id381585330787551"> + <bookmark_value>TextStream service;SkipLine</bookmark_value> + </bookmark> + <h2 id="hd_id241585330787168" localize="false">SkipLine</h2> + <paragraph role="paragraph" id="par_id11585330787847">Skips the next line in the input stream when reading a <literal>TextStream</literal> file.</paragraph> + <paragraph role="paragraph" id="par_id441613600704766">This method can result in <literal>AtEndOfStream</literal> being set to <literal>True</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id41626892171105"> + <input>myFile.SkipLine()</input> + </paragraph> +</section> + +<section id="WriteBlankLines"> + <comment> WriteBlankLines ------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id61585330787548"> + <bookmark_value>TextStream service;WriteBlankLines</bookmark_value> + </bookmark> + <h2 id="hd_id241585330787109" localize="false">WriteBlankLines</h2> + <paragraph role="paragraph" id="par_id141585330787657">Writes a specified number of empty lines to the output stream.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id531626892281078"> + <input>myFile.WriteBlankLines(lines: int)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id291585330787357"><emph>lines</emph>: The number of empty lines to write to the file.</paragraph> +</section> + +<section id="WriteLine"> + <comment> WriteLine ------------------------------------------------------------------------------------------ </comment> + <bookmark localize="false" branch="index" id="bm_id371585330787255"> + <bookmark_value>TextStream service;WriteLine</bookmark_value> + </bookmark> + <h2 id="hd_id611585330787877" localize="false">WriteLine</h2> + <paragraph role="paragraph" id="par_id101585330787215">Writes the given string to the output stream as a single line.</paragraph> + <paragraph role="paragraph" id="par_id421613601002074">The character defined in the <literal>NewLine</literal> property is used as the line delimiter.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id791626892414752"> + <input>myFile.WriteLine(line: str)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id491585330787650"><emph>line</emph>: The line to write, may be empty.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id821626894480105">The examples below in Basic and Python create a text file in CSV format in which each line contains a value and its square until <literal>lastValue</literal> is reached.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id171613321461620">Sub SquaredValuesFile(lastValue as Integer)</paragraph> + <paragraph role="bascode" id="bas_id21613321528612"> 'Instantiates the FileSystem Service</paragraph> + <paragraph role="bascode" localize="false" id="bas_id711613321529004"> Dim FSO as Variant : FSO = CreateScriptService("FileSystem")</paragraph> + <paragraph role="bascode" id="bas_id191613321529277"> 'Creates a text file</paragraph> + <paragraph role="bascode" localize="false" id="bas_id861613321529684"> Dim myFile as Variant : myFile = FSO.CreateTextFile("/home/user/Documents/squares.csv")</paragraph> + <paragraph role="bascode" id="bas_id641613321530181"> 'Writes the Value and Value squared, separated by ";"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331613321530548"> Dim value as Integer</paragraph> + <paragraph role="bascode" id="bas_id141613321530960"> myFile.WriteLine("Value;Value Squared")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891613321531342"> For value = 1 To lastValue</paragraph> + <paragraph role="bascode" localize="false" id="bas_id951613321531798"> myFile.WriteLine(value & ";" & value ^ 2)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621613321532215"> Next value</paragraph> + <paragraph role="bascode" id="bas_id881613321532598"> 'Closes the file and free resources</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671613321532919"> myFile.CloseFile()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51613321533150"> Set myFile = myFile.Dispose()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id861613321645821">End Sub</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id191626894577635">def squared_values_file(lastValue):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id71626894577912"> fs = CreateScriptService("FileSystem")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id681626894578108"> myFile = fs.CreateTextFile("/home/user/Documents/squares.csv")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id411626894578332"> myFile.WriteLine("Value;Value Squared")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id541626894578572"> for value in range(1, lastValue + 1):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id551626894578859"> myFile.WriteLine("{};{}".format(value, value ** 2))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id711626894579141"> myFile.CloseFile()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id251626894579421"> myFile = myFile.Dispose()</paragraph> + </pycode> +</section> + +<embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/> + <embed href="text/sbasic/shared/03160000.xhp#Input_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_timer.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_timer.xhp new file mode 100644 index 000000000..b3c2ea2dd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_timer.xhp @@ -0,0 +1,315 @@ +<?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_Timer" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.Timer service</title> + <filename>/text/sbasic/shared/03/sf_timer.xhp</filename> + </topic> +</meta> +<body> + +<section id="ScriptForge-sf_timer"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id261582733781987"> + <bookmark_value>Timer service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="hd_id731582733781114" xml-lang="en-US"><variable id="TimerService"><link href="text/sbasic/shared/03/sf_timer.xhp" name="ScriptForge.Timer service"><literal>ScriptForge</literal>.<literal>Timer</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id961582733781662" xml-lang="en-US">The <literal>Timer</literal> service measures the amount of time it takes to run user scripts.</paragraph> + <paragraph role="paragraph" id="par_id181582733781323" xml-lang="en-US">A <literal>Timer</literal> measures <emph>durations</emph>. It can be:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id711582733781252" role="listitem" xml-lang="en-US">Started, to indicate when to start measuring time.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id631582733781431" role="listitem" xml-lang="en-US">Suspended, to pause measuring running time.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id691582733781498" role="listitem" xml-lang="en-US">Resumed, to continue tracking running time after the Timer has been suspended.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id31582733781344" role="listitem" xml-lang="en-US">Restarted, which will cancel previous measurements and start the <literal>Timer</literal> at zero.</paragraph> + </listitem> + </list> +</section> + <paragraph role="tip" id="par_id991582733781280" xml-lang="en-US">Durations are expressed in seconds with a precision of 3 decimal digits (milliseconds). A duration value of 12.345 means 12 seconds and 345 milliseconds</paragraph> + + <h2 id="hd_id201582733781265" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Timer</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id891610734806133">The example below creates a <literal>Timer</literal> object named <literal>myTimer</literal> and starts it immediately.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id551610734764343">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id11582733781672">Dim myTimer As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31582733781292">myTimer = CreateScriptService("Timer", True)</paragraph> + <paragraph role="bascode" id="bas_id681582733781715">'The timer starts immediately when the second argument = True, default = False</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id891582733781994" xml-lang="en-US">It is recommended to free resources after use:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id61582733781413">Set myTimer = myTimer.Dispose()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id351626871397672">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id851626871397921">myTimer = CreateScriptService("Timer", start = True)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id301626871398065"># ...</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id661626871405884">myTimer = myTimer.Dispose()</paragraph> + </pycode> + + <h2 id="hd_id521582733781450" xml-lang="en-US">Properties</h2> + <table id="tab_id761582733781447"> + <tablerow> + <tablecell> + <paragraph id="par_id71582733781260" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711582733781103" role="tablehead" xml-lang="en-US">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id76158273378122" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id751582733781926" role="tablehead" xml-lang="en-US" >Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id561582733781781" role="tablecontent" xml-lang="en-US" localize="false">Duration</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621582733781588" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521582733781943" role="tablecontent" xml-lang="en-US" localize="false">Double</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731582733781476" role="tablecontents" xml-lang="en-US" >The actual running time elapsed since start or between start and stop (does not consider suspended time)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181582733781163" role="tablecontent" xml-lang="en-US" localize="false">IsStarted</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301582733781498" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591582733781696" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401582733781608" role="tablecontents" xml-lang="en-US" ><literal>True</literal> when timer is started or suspended</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id371582733781716" role="tablecontent" xml-lang="en-US" localize="false">IsSuspended</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id181582733781551" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411582733781116" role="tablecontent" xml-lang="en-US" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161582733781328" role="tablecontents" xml-lang="en-US" ><literal>True</literal> when timer is started and suspended</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id691582733781260" role="tablecontent" xml-lang="en-US" localize="false">SuspendDuration</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651582733781874" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581582733781213" role="tablecontent" xml-lang="en-US" localize="false">Double</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id171582733781456" role="tablecontents" xml-lang="en-US" >The actual time elapsed while suspended since start or between start and stop</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id411582733781943" role="tablecontent" xml-lang="en-US" localize="false">TotalDuration</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141582733781303" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451582733781978" role="tablecontent" xml-lang="en-US" localize="false">Double</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411582733781932" role="tablecontents" xml-lang="en-US" >The actual time elapsed since start or between start and stop (including suspensions and running time)</paragraph> + </tablecell> + </tablerow> + </table> + <paragraph role="tip" id="par_id9158273378151" xml-lang="en-US">Note that the <literal>TotalDuration</literal> property is equivalent to summing the <literal>Duration</literal> and <literal>SuspendDuration</literal> properties.</paragraph> + + <h2 id="hd_id141582734141895" xml-lang="en-US">Methods</h2> + <paragraph role="paragraph" id="par_id291582734377752" xml-lang="en-US">All methods do not require arguments and return a <literal>Boolean</literal> value.</paragraph> + <paragraph role="paragraph" id="par_id311582734894257" xml-lang="en-US">If the returned value is <literal>False</literal>, then nothing happened.</paragraph> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id911610740799006"> + <bookmark_value>Timer service;Continue</bookmark_value> + <bookmark_value>Timer service;Restart</bookmark_value> + <bookmark_value>Timer service;Start</bookmark_value> + <bookmark_value>Timer service;Suspend</bookmark_value> + <bookmark_value>Timer service;Terminate</bookmark_value> + </bookmark> + <table id="tab_id231582734180676"> + <tablerow> + <tablecell> + <paragraph id="par_id871582734180676" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971582734180676" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911582734180676" role="tablehead" xml-lang="en-US">Returned value</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id31582734180676" localize="False" role="tablecontent" xml-lang="en-US">Continue</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301582734180676" role="tablecontent" xml-lang="en-US">Resumes the <literal>Timer</literal> if it has been suspended</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661582734180676" role="tablecontent" xml-lang="en-US"><literal>False</literal> if the timer is not suspended</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id881582734649304" localize="False" role="tablecontent" xml-lang="en-US">Restart</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821582734649305" role="tablecontent" xml-lang="en-US">Terminates the <literal>Timer</literal> and discards its current property values, restarting as a new clean <literal>Timer</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761582734649305" role="tablecontent" xml-lang="en-US"><literal>False</literal> if the timer is inactive</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id201582734802443" localize="False" role="tablecontent" xml-lang="en-US">Start</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id641582734802443" role="tablecontent" xml-lang="en-US">Starts a new clean timer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id921582734802443" role="tablecontent" xml-lang="en-US"><literal>False</literal> if the timer is already started</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id781582734905507" localize="False" role="tablecontent" xml-lang="en-US">Suspend</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81582734905507" role="tablecontent" xml-lang="en-US">Suspends a running timer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661582734905507" role="tablecontent" xml-lang="en-US"><literal>False</literal> if the timer is not started or already suspended</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id771582734996722" localize="False" role="tablecontent" xml-lang="en-US">Terminate</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861582734996722" role="tablecontent" xml-lang="en-US">Stops a running timer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381582734996722" role="tablecontent" xml-lang="en-US"><literal>False</literal> if the timer is neither started nor suspended</paragraph> + </tablecell> + </tablerow> + </table> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id731626871820490">The examples below in Basic and Python illustrate the use of the methods and properties in the <literal>Timer</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id711582735902164">myTimer.Start()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371582735909094">Wait 500</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691582735916493">myTimer.Suspend()</paragraph> + <paragraph role="bascode" id="bas_id141582735926821">'The time elapsed while the Dialog box is open will be counted as suspended time</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001582735936992">MsgBox myTimer.Duration & " " & myTimer.SuspendDuration & " " & myTimer.TotalDuration</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361582735943749">myTimer.Continue()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71582735950518">Wait 500</paragraph> + <paragraph role="bascode" id="bas_id901582735961725">'The time elapsed while the Dialog box is open will be counted as running time</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621610739916646">MsgBox myTimer.Duration & " " & myTimer.SuspendDuration & " " & myTimer.TotalDuration</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51610739919950">myTimer.Terminate()</paragraph> + <paragraph role="bascode" id="bas_id941610739926687">'Shows the final time measurements</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291610739929200">MsgBox myTimer.Duration & " " & myTimer.SuspendDuration & " " & myTimer.TotalDuration</paragraph> + </bascode> + <note id="par_id281610740093006">If you call the <literal>Terminate</literal> method, subsequent calls for the <literal>Continue</literal> method will not resume time measurement. Similarly, after a Timer has been terminated, calling the <literal>Start</literal> method will restart it as if it were a clean new Timer.</note> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id731626871933079">from time import sleep</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id921626871933367">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id101626871933551">myTimer.Start()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id961626871933734">sleep(0.5)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id351626871933894">myTimer.Suspend()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id761626871934072">bas.MsgBox("{} {} {}".format(myTimer.Duration, myTimer.SuspendDuration, myTimer.TotalDuration))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id411626871934239">myTimer.Continue()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id941626871934407">sleep(0.5)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id521626871934590">bas.MsgBox("{} {} {}".format(myTimer.Duration, myTimer.SuspendDuration, myTimer.TotalDuration))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id921626871934776">myTimer.Terminate()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id531626872457511">bas.MsgBox("{} {} {}".format(myTimer.Duration, myTimer.SuspendDuration, myTimer.TotalDuration))</paragraph> + </pycode> + <note id="par_id391626872019832">Beware that the <literal>Wait</literal> function in Basic takes in a duration argument in milliseconds whereas the <literal>sleep</literal> function in Python uses seconds in its argument.</note> + + <h2 id="hd_id431610989623086">Working with Multiple Timers</h2> + <paragraph role="paragraph" id="par_id741610989639201">It is possible to instantiate multiple <literal>Timer</literal> services in parallel, which gives flexibility in measuring time in different parts of the code.</paragraph> + <paragraph role="paragraph" id="par_id921610989722908">The following example illustrates how to create two <literal>Timer</literal> objects and start them separately.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id771610989793244">Dim myTimerA as Variant, myTimerB as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261610989825466">myTimerA = CreateScriptService("Timer")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931610989829730">myTimerB = CreateScriptService("Timer")</paragraph> + <paragraph role="bascode" id="bas_id481610989853679">'Starts myTimerA</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911610989839892">myTimerA.Start()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871610989842236">Wait 1000 'Wait 1 second (1,000 milliseconds)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571610989855742">MsgBox myTimerA.Duration & " " & myTimerB.Duration</paragraph> + <paragraph role="bascode" id="bas_id331610989849501">'Starts myTimerB</paragraph> + <paragraph role="bascode" localize="false" id="bas_id341610989847112">myTimerB.Start()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571610989851550">Wait 1000</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51610989832354">MsgBox myTimerA.Duration & " " & myTimerB.Duration</paragraph> + <paragraph role="bascode" id="bas_id931610989837747">'Terminate both timers</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631610989844852">myTimerA.Terminate()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id411610989835115">myTimerB.Terminate()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id711626872551380">from time import sleep</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id541626872551709">myTimerA = CreateScriptService("Timer")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id581626872551876">myTimerB = CreateScriptService("Timer")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441626872552076">myTimerA.Start()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id631626872552268">sleep(1)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id41626872552468">bas.MsgBox("{} {}".format(myTimerA.Duration, myTimerB.Duration))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id891626872552670">myTimerB.Start()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id321626872552868">sleep(1)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id11626872553077">bas.MsgBox("{} {}".format(myTimerA.Duration, myTimerB.Duration))</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id441626872553324">myTimerA.Terminate()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id161626872553821">myTimerB.Terminate()</paragraph> + </pycode> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03030203.xhp#Now_H1"/> + <embed href="text/sbasic/shared/03030303.xhp#Timer_H1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_ui.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_ui.xhp new file mode 100644 index 000000000..313577f48 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_ui.xhp @@ -0,0 +1,704 @@ +<?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_UI" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ScriptForge.UI service</title> + <filename>/text/sbasic/shared/03/sf_ui.xhp</filename> + </topic> +</meta> +<body> +<section id="abstract"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id151587913266190"> + <bookmark_value>UI service</bookmark_value> + </bookmark> + +<h1 id="hd_id371587913266310" xml-lang="en-US"><variable id="UIService"><link href="text/sbasic/shared/03/sf_ui.xhp" name="ScriptForge.UI service"><literal>ScriptForge</literal>.<literal>UI</literal> service</link></variable></h1> + +<paragraph role="paragraph" xml-lang="en-US" id="par_id31587913266153">The UI (User Interface) service simplifies the identification and the manipulation of the different windows composing the whole %PRODUCTNAME application:</paragraph> +<list type="unordered"> + <listitem> + <paragraph role="listitem" id="par_id591587913266547" xml-lang="en-US">Windows selection</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id511587913266292" xml-lang="en-US">Windows moving and resizing</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id51587913266596" xml-lang="en-US">Statusbar settings</paragraph> + </listitem> + <listitem> + <paragraph id="par_id401599404339702" role="listitem" xml-lang="en-US">Display of a floating progress bar</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id761587913266388" xml-lang="en-US">Creation of new windows</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id591587913266489" xml-lang="en-US">Access to the underlying "documents"</paragraph> + </listitem> +</list> +</section> + +<tip id="par_id181620312953395">The UI service is the starting point to open, create or access to the content of new or existing documents from a user script.</tip> + +<h2 id="hd_id881587913266307">Definitions</h2> + +<section id="WindowName"> + <h3 id="hd_id761587913266887" localize="false">WindowName</h3> + <paragraph role="paragraph" id="par_id741587913266919">A window can be designated using various ways:</paragraph> + <list type="unordered"> + <listitem> + <paragraph role="listitem" id="par_id291587913946648" xml-lang="en-US">a full path and file name</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id991587914045862" xml-lang="en-US">the last component of the full file name or even only the last component without its suffix</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id541587914079744" xml-lang="en-US">the title of the window</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id191587914134221" xml-lang="en-US">for new documents, something like "Untitled 1"</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id911587914185746" xml-lang="en-US">one of the special windows "<literal>BASICIDE</literal>" and "<literal>WELCOMESCREEN</literal>"</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id181587914255236" xml-lang="en-US">The window name is case-sensitive.</paragraph> + <h3 id="hd_id541588520711430" xml-lang="en-US">Document object</h3> +</section> + <paragraph role="paragraph" id="par_id841588521238711" xml-lang="en-US">The methods <literal>CreateDocument</literal>, <literal>CreateBaseDocument</literal>, <literal>GetDocument</literal>, <literal>OpenBaseDocument</literal> and <literal>OpenDocument</literal>, described below, generate document objects. When a window contains a document, an instance of the <literal>Document</literal> class represents that document. A counterexample the Basic IDE is not a document but is a window in our terminology. Additionally a document has a type: <literal>Calc</literal>, <literal>Impress</literal>, <literal>Writer</literal>, ...</paragraph> + <paragraph role="paragraph" id="par_id331588521254916" xml-lang="en-US">The specific properties and methods applicable on documents are implemented in a document class.</paragraph> + <tip id="par_id971588521292976" xml-lang="en-US">The implementation of the document objects class is done in the <literal>SFDocuments</literal> associated library. See its "<literal>Document</literal>" service.</tip> + +<h2 id="hd_id91587913266988" xml-lang="en-US">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>UI</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id391587913266269">Dim ui As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851582897798335">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001587913266355">Set ui = CreateScriptService("UI")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id61620310677393">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id601620310674922">ui = CreateScriptService("UI")</paragraph> + </pycode> + +<h2 id="hd_id841587913266618" xml-lang="en-US">Properties</h2> + <table id="tab_id291587913266435"> + <tablerow> + <tablecell> + <paragraph id="par_id521587913266568" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587913266368" role="tablehead" xml-lang="en-US">ReadOnly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id631587914939732" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951587913266220" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161587913266162" role="tablecontent" localize="false">ActiveWindow</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651587913266754" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587914989890" role="tablecontent" localize="false">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351587913266349" role="tablecontent" xml-lang="en-US">a valid and unique <literal>WindowName</literal> for the currently active window. When the window cannot be identified, a zero-length string is returned.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161597813266162" role="tablecontent" localize="false">Documents</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id658517913266754" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587994189890" role="tablecontent" localize="false">String array</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id153587913266349" role="tablecontent" xml-lang="en-US">The list of the currently open documents. Special windows are ignored. This list consists of a zero-based one dimensional array either of filenames (in SF_FileSystem.FileNaming notation) or of window titles for unsaved documents.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161587913266563" role="tablecontent" localize="false">Height</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651587913266945" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587914989732" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351587913266211" role="tablecontent" xml-lang="en-US">Returns the height of the active window in pixels.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161587913266574" role="tablecontent" localize="false">Width</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651587913266645" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587914989935" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351587913266036" role="tablecontent" xml-lang="en-US">Returns the width of the active window in pixels.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161587913266096" role="tablecontent" localize="false">X</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651587913266312" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587914989789" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351587913266296" role="tablecontent" xml-lang="en-US">Returns the X coordinate of the active window, which is the distance to the left edge of the screen in pixels.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161587913266323" role="tablecontent" localize="false">Y</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651587913266670" role="tablecontent" xml-lang="en-US">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421587914989902" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351587913266216" role="tablecontent" xml-lang="en-US">Returns the Y coordinate of the active window, which is the distance to the top edge of the screen in pixels. This value does not consider window decorations added by your operating system, so even when the window is maximized this value may not be zero.</paragraph> + </tablecell> + </tablerow> + </table> + +<section id="Constants"> +<h2 id="hd_id511620762163390">Constants</h2> +<table id="tab_id51620761856238"> + <tablerow> + <tablecell> + <paragraph id="par_id761620761856238" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591620761856238" role="tablehead">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711620761856238" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id511620761856238" localize="false" role="tablecontent">MACROEXECALWAYS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761620761856107" localize="false" role="tablecontent">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id341620761856238" role="tablecontent">Macros are always executed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id661620761881513" localize="false" role="tablecontent">MACROEXECNEVER</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661620761891082" localize="false" role="tablecontent">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id101620761893011" role="tablecontent">Macros are never executed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311620761888379" localize="false" role="tablecontent">MACROEXECNORMAL</paragraph> + </tablecell> + <tablecell> + <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> + </tablecell> + </tablerow> +</table> +</section> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id311620312548992">The examples below show a <literal>MsgBox</literal> with the names of all currently open documents.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id201587985861232">Dim openDocs as Object, strDocs as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261587985839734">Set openDocs = ui.Documents()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621587985950181">strDocs = openDocs(0)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id11587985956383">For i = 1 to UBound(openDocs)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981620312219531"> strDocs = strDocs & Chr(10) & openDocs(i)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id341587985962974">Next i</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191620312244070">MsgBox strDocs</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id21620312350189">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id631620312351013">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id141620312351286">openDocs = ui.Documents()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id661620312351500">strDocs = "\n".join(openDocs)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801620312351676">bas.MsgBox(strDocs)</paragraph> + </pycode> + + <table id="tab_id891606472825856"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id881608131596153" role="tablehead">List of Methods in the UI Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id381606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_ui.xhp#Activate" name="Activate method">Activate</link><br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#CreateBaseDocument" name="CreateBaseDocument method">CreateBaseDocument</link><br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#CreateDocument" name="CreateDocument method">CreateDocument</link> (*)<br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#GetDocument" name="GetDocument method">GetDocument</link><br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#Maximize" name="Maximize method">Maximize</link> + </paragraph></tablecell> + <tablecell><paragraph id="par_id451606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_ui.xhp#Minimize" name="Minimize method">Minimize</link><br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#OpenBaseDocument" name="OpenBaseDocument method">OpenBaseDocument</link><br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#OpenDocument" name="OpenDocument method">OpenDocument</link> (*)<br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#Resize" name="Resize method">Resize</link><br/><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id161606472825856" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_ui.xhp#RunCommand" name="RunCommand method">RunCommand</link><br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#SetStatusBar" name="SetStatusBar method">SetStatusBar</link> (*)<br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#ShowProgressBar" name="ShowProgressBar method">ShowProgressBar</link><br/> + <link href="text/sbasic/shared/03/sf_ui.xhp#WindowExists" name="WindowExists method">WindowExists</link><br/><br/> + </paragraph></tablecell> + </tablerow> + </table> +<warning id="par_id431620322170443">Note, as an exception, that the methods marked <emph>(*)</emph> are <emph>not applicable to Base documents</emph>.</warning> + +<section id="Activate"> + <comment> Activate -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id991587913266189"> + <bookmark_value>UI service;Activate</bookmark_value> + </bookmark> + <h2 id="hd_id76158791326673" localize="false">Activate</h2> + <paragraph role="paragraph" id="par_id201587913266596">Make the specified window active. The method returns <literal>True</literal> if the given window is found and can be activated. There is no change in the actual user interface if no window matches the selection.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id331620319796672"> + <input>svc.Activate(windowname: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id381587913266946"><emph>windowname</emph>: see the definitions above.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id201587913266745">ui.Activate("C:\Documents\My file.odt")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id941620322846267">ui.Activate(r"C:\Documents\My file.odt")</paragraph> + </pycode> +</section> + +<section id="CreateBaseDocument"> + <comment> CreateBaseDocument -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id871596554849122"> + <bookmark_value>UI service;CreateBaseDocument</bookmark_value> + </bookmark> + <h2 id="hd_id281596554849363" localize="false">CreateBaseDocument</h2> + <paragraph role="paragraph" id="par_id13159655484952">Creates and stores a new %PRODUCTNAME Base document embedding an empty database of the given type. The method returns a <literal>Document</literal> service instance.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id461620320014911"> + <input>svc.CreateBaseDocument(filename: str, embeddeddatabase: str = 'HSQLDB', registrationname: str = '', opt calcfilename: str): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441596554849949"><emph>filename</emph> : Identifies the file to create. 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_id381596554849698" xml-lang="en-US"><emph>embeddeddatabase</emph> : Either "HSQLDB" (default), "FIREBIRD" or "CALC".</paragraph> + <paragraph role="paragraph" id="par_id521596554849185" xml-lang="en-US"><emph>registrationname</emph> : The name used to store the new database in the databases register. When = "" (default), no registration takes place. If the name already exists it is overwritten without warning.</paragraph> + <paragraph role="paragraph" id="par_id181629364905056" xml-lang="en-US"><emph>calcfilename</emph> : Only when <literal>embeddeddatabase</literal> = "CALC", <literal>calcfilename</literal> represents the file containing the tables as Calc sheets. The file must exist or an error is raised.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id631596554849994">Dim myBase As Object, myCalcBase As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id921596554849612">Set myBase = ui.CreateBaseDocument("C:\Databases\MyBaseFile.odb", "FIREBIRD")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51629365306345">Set myCalcBase = ui.CreateBaseDocument("C:\Databases\MyCalcBaseFile.odb", _</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911629365353801"> "CALC", , "C:\Databases\MyCalcFile.ods")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id361620323808010">myBase = ui.CreateBaseDocument(r"C:\Databases\MyBaseFile.odb", "FIREBIRD")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id251629365641121">myCalcBase = ui.CreateBaseDocument(r"C:\Databases\MyCalcBaseFile.odb", \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id431629366045258"> "CALC", calcfilename = r"C:\Databases\MyCalcFile.ods")</paragraph> + </pycode> +</section> + +<section id="CreateDocument"> + <comment> CreateDocument -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id461588521753429"> + <bookmark_value>UI service;CreateDocument</bookmark_value> + </bookmark> + <h2 id="hd_id45158852175376" localize="false">CreateDocument (*)</h2> + <paragraph role="paragraph" id="par_id651588521753997">Create a new %PRODUCTNAME document of a given type or based on a given template. The method returns a document object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id401620320696126"> + <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_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"/> + <paragraph role="paragraph" id="par_id701620762417802">In both examples below, the first call to <literal>CreateDocument</literal> method creates a blank Calc document, whereas the second creates a document from a template file.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id201588522371030">Dim myDoc1 As Object, myDoc2 As Object, FSO As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id931588522377598">Set myDoc1 = ui.CreateDocument("Calc")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821588522387111">Set FSO = CreateScriptService("FileSystem")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id661588522393007">Set myDoc2 = ui.CreateDocument(, FSO.BuildPath(FSO.TemplatesFolder, "personal/CV.ott"))</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id901620324433095">myDoc1 = ui.CreateDocument("Calc")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id361620324544381">fs = CreateScriptService("FileSystem")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id161620324434583">myDoc2 = ui.CreateDocument(templatefile = fs.BuildPath(fs.TemplatesFolder, "personal/CV.ott"))</paragraph> + </pycode> +</section> + +<section id="GetDocument"> + <comment> GetDocument -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id351588520551838"> + <bookmark_value>UI service;GetDocument</bookmark_value> + </bookmark> + <h2 id="hd_id171588520551515" localize="false">GetDocument</h2> + <paragraph role="paragraph" id="par_id201588520551463">Returns an open document object referring to either the active window, a given window or the active document.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id811620320778478"> <input>svc.GetDocument(windowname: str = ''): svc</input></paragraph> + <paragraph role="paragraph" localize="false" id="par_id251624026292796"><input>svc.GetDocument(windowname: uno): svc</input></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id851588520551368"><emph>windowname</emph>: See the definitions <link href="text/sbasic/shared/03/sf_ui.xhp#WindowName" name="WindowName section">above</link>. If this argument is absent, the active window is used. UNO objects of types <literal>com.sun.star.lang.XComponent</literal> or <literal>com.sun.star.comp.dba.ODatabaseDocument</literal> are also accepted. Thus passing <literal>ThisComponent</literal> or <literal>ThisDatabaseDocument</literal> as argument creates a new <link href="text/sbasic/shared/03/sf_document.xhp" name="Document service">SFDocuments.Document</link>, <link href="text/sbasic/shared/03/sf_base.xhp" name="Base service">Base</link> or <link href="text/sbasic/shared/03/sf_calc.xhp" name="Calc service">Calc</link> service. +</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id191588522924110">Dim myDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591588520551682">Set myDoc = ui.GetDocument("C:\Documents\My file.odt")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651624025734467">Set myBase = ui.GetDocument(ThisDatabaseDocument)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id931624025986035">from scriptforge import CreateScriptService</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id641624026031595">bas = CreateScriptService("Basic")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id831620330074037">myDoc = ui.GetDocument(r"C:\Documents\My file.odt")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id601624025839840">myDoc = ui.GetDocument(bas.ThisComponent)</paragraph> + </pycode> + <tip id="par_id521620330287071">To access the name of the currently active window, refer to the <literal>ActiveWindow</literal> property.</tip> +</section> + +<section id="Maximize"> + <comment> Maximize -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id441587986441397"> + <bookmark_value>UI service;Maximize</bookmark_value> + </bookmark> + <h2 id="hd_id261587986441738" localize="false">Maximize</h2> + <paragraph role="paragraph" id="par_id24158798644169">Maximizes the active window or the given window.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id631620320925633"> + <input>svc.Maximize(windowname: str)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id951587986441954"><emph>windowname</emph>: see the definitions <link href="text/sbasic/shared/03/sf_ui.xhp#WindowName" name="WindowName section">above</link>. If this argument is absent, the active window is maximized.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id891587986441319">ui.Maximize("Untitled 1")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id181620330373220">ui.Maximize("Untitled 1")</paragraph> + </pycode> +</section> + +<section id="Minimize"> + <comment> Minimize -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id2315879865929"> + <bookmark_value>UI service;Minimize</bookmark_value> + </bookmark> + <h2 id="hd_id21158798659210" localize="false">Minimize</h2> + <paragraph role="paragraph" id="par_id871587986592696">Minimizes the active window or the given window.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id201620321224368"> + <input>svc.Minimize(windowname: str)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id751587986592626"><emph>windowname</emph>: see the definitions <link href="text/sbasic/shared/03/sf_ui.xhp#WindowName" name="WindowName section">above</link>. If this argument is absent, the active window is minimized.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671587986592107">ui.Minimize()</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id481620330501644">ui.Minimize()</paragraph> + </pycode> +</section> + +<section id="OpenBaseDocument"> + <comment> OpenBaseDocument -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id291596555746452"> + <bookmark_value>UI service;OpenBaseDocument</bookmark_value> + </bookmark> + <h2 id="hd_id671596555746148" localize="false">OpenBaseDocument</h2> + <paragraph role="paragraph" id="par_id691596555746539">Open an existing %PRODUCTNAME Base document. The method returns a document object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id21620321395150"> + <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 <literal>SF_FileSystem.FileNaming</literal> notation.</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> <> "".</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"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id761596555746795">Dim myBase As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91596555746449">Set myBase = ui.OpenBaseDocument("C:\Documents\myDB.odb", MacroExecution := ui.MACROEXECALWAYS)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id431620331254271">ui.OpenBaseDocument(r"C:\Documents\myDB.odb", macroexecution = ui.MACROEXECALWAYS)</paragraph> + </pycode> + <tip id="par_id941620762989833">To improve code readability you can use <link href="text/sbasic/shared/03/sf_ui.xhp#Constants" name="CHANGE ME">predefined constants</link> for the <literal>macroexecution</literal> argument, as in the examples above.</tip> +</section> + +<section id="OpenDocument"> + <comment> OpenDocument -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id141588523635836"> + <bookmark_value>UI service;OpenDocument</bookmark_value> + </bookmark> + <h2 id="hd_id451588523635719" localize="false">OpenDocument (*)</h2> + <paragraph role="paragraph" id="par_id541588523635283">Opens an existing %PRODUCTNAME document with the given options. Returns a document object or one of its subclasses. The method returns <literal>Nothing</literal> (in Basic) / <literal>None</literal> (in Python) if the opening failed, even when the failure is caused by a user decision.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id271620321692960"> + <input>svc.Opendocument(filename: str, password: str = '', readonly: bool = False, hidden: bool = False, macroexecution: int = 0, filtername: str = '', filteroptions: str = ''): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481588523635890"><emph>filename</emph>: Identifies the file to open. It must follow the <literal>FileNaming</literal> notation of the <literal>FileSystem</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id451588523635507" xml-lang="en-US"><emph>password</emph>: To use when the document is protected. If wrong or absent while the document is protected, the user will be prompted to enter a password.</paragraph> + <paragraph role="paragraph" id="par_id611588524329781" xml-lang="en-US"><emph>readonly</emph>: Default = <literal>False</literal>.</paragraph> + <paragraph role="paragraph" id="par_id641588523635497" 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> + <paragraph role="paragraph" id="par_id981588524474719" 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> + <paragraph role="paragraph" id="par_id611588524584693" xml-lang="en-US"><emph>filtername</emph>: The name of a filter that should be used for loading the document. If present, the filter must exist.</paragraph> + <paragraph role="paragraph" id="par_id191588524634348" xml-lang="en-US"><emph>filteroptions</emph>: An optional string of options associated with the filter.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id811588523635720">Dim myDoc As Object, FSO As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391588523635826">Set myDoc = ui.OpenDocument("C:\Documents\myFile.odt", ReadOnly := True)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id891620331804571">ui.OpenDocument(r"C:\Documents\myFile.odt", readonly = True)</paragraph> + </pycode> +</section> + +<section id="Resize"> + <comment> Resize -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id951587986945259"> + <bookmark_value>UI service;Resize</bookmark_value> + </bookmark> + <h2 id="hd_id551587986945514" localize="false">Resize</h2> + <paragraph role="paragraph" id="par_id751587986945965">Resizes and/or moves the active window. Absent and negative arguments are ignored. If the window is minimized or maximized, calling <literal>Resize</literal> without arguments restores it.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id411620321819387"> + <input>svc.Resize(left: int = -1, top: int = -1, width: int = -1, height: int = -1)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441587986945696"><emph>left, top</emph>: Distances of the top-left corner from top and left edges of the screen, in pixels.</paragraph> + <paragraph role="paragraph" id="par_id601587987453825" xml-lang="en-US"><emph>width, height</emph>: New dimensions of the window, in pixels.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id801587987507028">In the following examples, the <literal>width</literal> and <literal>height</literal> of the window are changed while <literal>top</literal> and <literal>left</literal> are left unchanged.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id171587986945392">ui.Resize(, ,500, 500)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id971620331945744">ui.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> + +<section id="RunCommand"> + <comment> RunCommand --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id601589202413561"> + <bookmark_value>UI service;RunCommand</bookmark_value> + </bookmark> + <h2 id="hd_id611589202413141" localize="false">RunCommand</h2> + <paragraph role="paragraph" id="par_id991589202413257">Runs a UNO command on the current window. A few typical commands are: Save, SaveAs, ExportToPDF, Undo, Copy, Paste, etc.</paragraph> + <paragraph role="paragraph" id="par_id921611152932311">Commands can be run with or without arguments. Arguments are not validated before running the command. If the command or its arguments are invalid, then nothing will happen.</paragraph> + <tip id="par_id31644182402479">For a complete list of UNO commands that can be run in %PRODUCTNAME, refer to the Wiki page <link href="https://wiki.documentfoundation.org/Development/DispatchCommands" name="Commands_Wiki">Development/DispatchCommands</link>.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id521622828226683"> + <input>svc.RunCommand(command: str, [args: any])</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id401589202413575"><emph>command</emph>: Case-sensitive string containing the UNO command name. The inclusion of the prefix ".uno:" in the command is optional. The command itself is not checked for correctness. If nothing happens after the command call, then the command is probably wrong.</paragraph> + <paragraph role="paragraph" id="par_id521644182774710"><emph>args</emph>: For each argument to be passed to the command, specify a pair containing the argument name and value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id721611153068137">The following example runs the <literal>.uno:About</literal> command in the current window.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id401611153339973">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121589202413630">ui.RunCommand("About")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id371644184276886">Below is an example that runs the UNO command <literal>.uno:BasicIDEAppear</literal> and passes the arguments required to open the Basic IDE at a specific line of a module.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id631644184414955">' Arguments passed to the command:</paragraph> + <paragraph role="bascode" localize="false" id="bas_id621644184336024">' Document = "LibreOffice Macros & Dialogs"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id516441843364240">' LibName = "ScriptForge"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id721644186851722">' Name = "SF_Session"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231644186851949">' Line = 600</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391644184337449">ui.RunCommand(".uno:BasicIDEAppear", "Document", "LibreOffice Macros & Dialogs", _ </paragraph> + <paragraph role="bascode" localize="false" id="bas_id971644186963686"> "LibName", "ScriptForge", "Name", "SF_Session", "Line", 600)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id41644184549167">Note that calling the command <literal>BasicIDEAppear</literal> without arguments will simply open the <menuitem>Basic IDE</menuitem>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821622828361025">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id211622828361293">ui.RunCommand("About")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id661644184648102">ui.RunCommand(".uno:BasicIDEAppear", "Document", "LibreOffice Macros & Dialogs", \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id981644187044060"> "LibName", "ScriptForge", "Name", "SF_Session", "Line", 600)</paragraph> + </pycode> + <paragraph role="paragraph" id="par_id311644243516674">In Python it is also possible to call <literal>RunCommand</literal> using keyword arguments:</paragraph> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821644243549887">ui.RunCommand(".uno:BasicIDEAppear", Document = "LibreOffice Macros & Dialogs", \</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id681644243592324"> LibName = "ScriptForge", Name = "SF_Session", Line = 600)</paragraph> + </pycode> + <tip id="par_id191611153511038">Each %PRODUCTNAME component has its own set of commands available. One easy way to learn commands is going to <emph>Tools - Customize - Keyboard</emph>. When you position your mouse over a function in the <emph>Function</emph> list, a tooltip will appear with the corresponding UNO command.</tip> +</section> + +<section id="SetStatusBar"> + <comment> SetStatusbar -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id25158799642119"> + <bookmark_value>UI service;SetStatusbar</bookmark_value> + </bookmark> + <h2 id="hd_id171587996421550" localize="false">SetStatusbar (*)</h2> + <paragraph role="paragraph" id="par_id281587996421580">Display a text and a progressbar in the status bar of the active window. Any subsequent calls in the same macro run refer to the same status bar of the same window, even if the window is not visible anymore. A call without arguments resets the status bar to its normal state.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id461620321923929"> + <input>svc.SetStatusbar(text: str = '', percentage: int = -1)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id71587996421829"><emph>text</emph>: An optional text to be displayed in front of the progress bar.</paragraph> + <paragraph role="paragraph" id="par_id881587996421777" xml-lang="en-US"><emph>percentage</emph>: an optional degree of progress between 0 and 100.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id61587996791867">Dim i As Integer</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291587996799353">For i = 0 To 100</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331587996806267"> ui.SetStatusbar("Progress ...", i)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id491587996813628"> Wait 50</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841587996820714">Next i</paragraph> + <paragraph role="bascode" id="bas_id651620332601083">' Resets the statusbar</paragraph> + <paragraph role="bascode" localize="false" id="bas_id141587996829242">ui.SetStatusbar</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <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"> ui.SetStatusbar("Test:", i)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id181620332715974"> sleep(0.05)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id381620332733373">ui.SetStatusbar()</paragraph> + </pycode> +</section> + +<section id="ShowProgressBar"> + <comment> ShowProgressBar -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id91159886425573"> + <bookmark_value>UI service;ShowProgressBar</bookmark_value> + </bookmark> + <h2 id="hd_id31598864255380" localize="false">ShowProgressBar</h2> + <paragraph role="paragraph" id="par_id571598864255776">Displays a non-modal dialog box. Specify its title, an explicatory text and a percentage of progress to be represented on a progressbar. The dialog will remain visible until a call to the method without arguments or until the user manually closes the dialog.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id41620322016943"> + <input>svc.ShowProgressBar(title: str = '', text: str = '', percentage: str = -1)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441598864535695" xml-lang="en-US"><emph>title</emph> : The title appearing on top of the dialog box. Default = "ScriptForge".</paragraph> + <paragraph role="paragraph" id="par_id311598864255297"><emph>text</emph>: An optional text to be displayed above the progress bar.</paragraph> + <paragraph role="paragraph" id="par_id881598864255424" xml-lang="en-US"><emph>percentage</emph>: an optional degree of progress between 0 and 100.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id931598864255666">Dim i As Integer</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211598864255731">For i = 0 To 100</paragraph> + <paragraph role="bascode" localize="false" id="bas_id341598864255351"> ui.ShowProgressBar("Window Title", "Progress ..." & i & "/100", i)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id34159886425576"> Wait 50</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541598864255593">Next i</paragraph> + <paragraph role="bascode" id="bas_id651620333289753">' Closes the Progress Bar window</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21598864255428">ui.ShowProgressBar</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id821620333264948">from time import sleep</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id611620333268146">for i in range(101):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id331620333268525"> ui.ShowProgressBar("Window Title", "Progress ... " + str(i) + "/100", i)</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id451620333268900"> sleep(0.05)</paragraph> + <paragraph role="pycode" id="pyc_id761620333269236"># Closes the Progress Bar window</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id81620333269484">ui.ShowProgressBar()</paragraph> + </pycode> +</section> + +<section id="WindowExists"> + <comment> WindowExists -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id431588587119136"> + <bookmark_value>UI service;WindowExists</bookmark_value> + </bookmark> + <h2 id="hd_id21588587119344" localize="false">WindowExists</h2> + <paragraph role="paragraph" id="par_id431588587119925">Returns <literal>True</literal> if the given window could be identified.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id521620322090015"> + <input>svc.WindowExists(windowname: str): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id45158858711917"><emph>windowname</emph>: see the definitions above.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id941588587119772">If ui.WindowExists("C:\Document\My file.odt") Then</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871588587295216"> ' ...</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id441620333481074">if ui.WindowExists(r"C:\Document\My file.odt"):</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id801620333495532"> # ...</paragraph> + </pycode> +</section> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_basic.xhp#BasicService"/> + <embed href="text/sbasic/shared/03/sf_calc.xhp#CalcService"/> + <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_unittest.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_unittest.xhp new file mode 100644 index 000000000..80ce5c834 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_unittest.xhp @@ -0,0 +1,818 @@ +<?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_UnitTest" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFUnitTests.UnitTest service</title> + <filename>/text/sbasic/shared/03/sf_unittest.xhp</filename> + </topic> + </meta> +<body> +<section id="ScriptForge-sf_unittest"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id501600788079507"> + <bookmark_value>UnitTest service</bookmark_value> + </bookmark> +</section> +<section id="abstract"> + <h1 id="bm_id681600788076499"><variable id="UnitTestService"><link href="text/sbasic/shared/03/sf_unittest.xhp" name="UnitTest service"><literal>SFUnitTests</literal>.<literal>UnitTest</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id181600788076612">The <literal>UnitTest</literal> service provides a framework for automating unit tests using the Basic language, including the ability to:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id301600788076785" role="listitem">Aggregate test cases into test suites and unit tests.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id1001600788076848" role="listitem">Share setup and shutdown code among test cases.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id67160078807676" role="listitem">Report test results using the <literal>Console</literal>.</paragraph> + </listitem> + </list> +</section> + <note id="par_id411656351918942">Both the unit tests and the code to be tested must be written in Basic. The code being tested may call functions written in other languages.</note> + <warning id="par_id601656621416963">The <literal>UnitTest</literal> service is not available for Python scripts.</warning> + + <h2 id="hd_id491656351958796">Definitions</h2> + <h3 id="hd_id31656351967453">Test Case</h3> + <paragraph role="paragraph" id="par_id571656351977812">A test case is the individual unit of testing. It checks for a specific response to a particular set of inputs.</paragraph> + <paragraph role="paragraph" id="par_id391656352078166">In the <literal>UnitTest</literal> service, a test case is represented by a single Basic <literal>Sub</literal> whose name starts with a common prefix (the default is "Test_").</paragraph> + <paragraph role="paragraph" id="par_id701656352338645">The test case fails if one of the <literal>AssertX</literal> methods returns <literal>False</literal>.</paragraph> + <h3 id="hd_id431656352497598">Test Suite</h3> + <paragraph role="paragraph" id="par_id771656352513789">A test suite is a collection of test cases that should be executed together.</paragraph> + <paragraph role="paragraph" id="par_id941656352597973">All test cases of a test suite are stored in a single Basic module.</paragraph> + <paragraph role="paragraph" id="par_id51656352696989">A test suite may implement the <literal>SetUp</literal> and <literal>TearDown</literal> methods to prepare for test cases in its module.</paragraph> + <h3 id="hd_id351656352884283">Unit Test</h3> + <paragraph role="paragraph" id="par_id461656352894003">A full unit test consists of a set of test suites in the same Basic library.</paragraph> + + <h2 id="hd_id991656353328287">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>UnitTest</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + <h3 id="hd_id941656357981021">Simple mode</h3> + <paragraph role="paragraph" id="par_id381656357996613">Invoke the service in <emph>simple mode</emph> to call <literal>AssertX</literal> functions without having to build the full hierarchy of test suites and test cases.</paragraph> + <paragraph role="paragraph" id="par_id331656358092318">In simple mode, the service is invoked inside the test case, as shown in the example below:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id561656358185215">Sub SimpleTest</paragraph> + <paragraph role="bascode" localize="false" id="bas_id116563581854320"> On Local Error GoTo CatchError</paragraph> + <paragraph role="bascode" localize="false" id="bas_id221656358185634"> Dim myTest As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801656358185805"> myTest = CreateScriptService("UnitTest")</paragraph> + <paragraph role="bascode" id="bas_id501656358186053"> ' A few dummy tests</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791656421185689"> myTest.AssertEqual(1 + 1, 2)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id961656421186032"> myTest.AssertEqual(1 - 1, 0)</paragraph> + <paragraph role="bascode" id="bas_id981656421186233"> MsgBox("All tests passed")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691656421186433"> Exit Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id591656421186681">CatchError:</paragraph> + <paragraph role="bascode" id="bas_id971656421186872"> myTest.ReportError("A test failed")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391656421284881">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id321656421319505">In this example, if any of the <literal>AssertEqual</literal> calls fail, the interpreter will go to the <literal>CatchError</literal> label and report the error by calling the <literal>ReportError</literal> method.</paragraph> + <h3 id="hd_id341656353807950">Full mode</h3> + <paragraph role="paragraph" id="par_id881656353390116">When invoked in <emph>full mode</emph>, the service creation is external to the test code and all tests are organized into test cases and test suites inside a single library.</paragraph> + <paragraph role="paragraph" id="par_id41656354017140">The following example creates a <literal>UnitTest</literal> instance whose tests are located inside the current document (<literal>ThisComponent</literal>) in the "Tests" library.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id171656354156234">GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id641656354156652">Dim myUnitTest As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611656354156951">myUnitTest = CreateScriptService("UnitTest", ThisComponent, "Tests")</paragraph> + </bascode> + <h3 id="hd_id731656421609300">A minimalist example in full mode</h3> + <paragraph role="paragraph" id="par_id721656421629357">Consider that a ODS file has a module named "MathUtils" in its "Standard" library with the following code:</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id821656421926586">' Code in module Standard.MathUtils</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791656421927279">Function Sum(a, b) As Double</paragraph> + <paragraph role="bascode" localize="false" id="bas_id791656421927530"> Sum = a + b</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321656421927738">End Function</paragraph> + <paragraph role="bascode" localize="false" id="bas_id141656421927930"></paragraph> + <paragraph role="bascode" localize="false" id="bas_id611656421928122">Function Multiply(a, b) As Double</paragraph> + <paragraph role="bascode" localize="false" id="bas_id581656421928322"> Multiply = a * b</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101656421928786">End Function</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id871656422027581">To create a full test suite, consider that a new library named "Tests" is created in the file with a single module "AllTests" containing the code below:</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id731656422341011">' Code in module Tests.AllTests</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241656422341227">Sub Main()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121656422341403"> GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401656422341627"> Dim test As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id841656422341836"> test = CreateScriptService("UnitTest", ThisComponent, "Tests")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id616564223542052"> test.RunTest("AllTests")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821656422342284"> test.Dispose()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id681656422342516">End Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781656422342732"></paragraph> + <paragraph role="bascode" localize="false" id="bas_id451656422342948">Sub Setup(test)</paragraph> + <paragraph role="bascode" id="bas_id671656422476689"> ' Preparation code ran prior to the first test case</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151656422476955"> Dim exc As Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981656422477190"> exc = CreateScriptService("Exception")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991656422477719"> exc.Console(Modal := False)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151656422477959">End Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611656422478230"></paragraph> + <paragraph role="bascode" localize="false" id="bas_id316564223478487">Sub TearDown(test)</paragraph> + <paragraph role="bascode" id="bas_id621656422479007"> ' Optional cleanup code called after the last test case</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991656422479239">End Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811656422683092"></paragraph> + <paragraph role="bascode" localize="false" id="bas_id711656422683636">Sub Test_Sum(test)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id816564522683844"> On Local Error GoTo CatchError</paragraph> + <paragraph role="bascode" id="bas_id141656422684085"> test.AssertEqual(Sum(1, 1), 2, "Sum two positive integers")</paragraph> + <paragraph role="bascode" id="bas_id491656422684324"> test.AssertEqual(Sum(-10, 20), 10, "Sum of negative and positive integers")</paragraph> + <paragraph role="bascode" id="bas_id201656422684556"> test.AssertEqual(Sum(1.5, 1), 2.5, "Sum of float and integer values")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211656422684772"> Exit Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id601656422684988">CatchError:</paragraph> + <paragraph role="bascode" id="bas_id716356422685228"> test.ReportError("Sum method is broken")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181656422685436">End Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id951656422832165"></paragraph> + <paragraph role="bascode" localize="false" id="bas_id271656422832448">Sub Test_Multiply(test)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531656422832728"> On Local Error GoTo CatchError</paragraph> + <paragraph role="bascode" id="bas_id416564228330400"> test.AssertEqual(Multiply(2, 2), 4, "Multiply two positive integers")</paragraph> + <paragraph role="bascode" id="bas_id231656422833240"> test.AssertEqual(Multiply(-4, 2), -8, "Multiply negative and positive integers")</paragraph> + <paragraph role="bascode" id="bas_id931656422833480"> test.AssertEqual(Multiply(1.5, 3), 4.5, "Multiply of float and integer values")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471656422833729"> Exit Sub</paragraph> + <paragraph role="bascode" localize="false" id="bas_id616564228334928">CatchError:</paragraph> + <paragraph role="bascode" id="bas_id151656422834184"> test.ReportError("Multiply method is broken")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271656422834376">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id681656423030706">The test suite above consists of two test cases <literal>Test_Sum</literal> and <literal>Test_Multiply</literal>. To run all tests simply run the <literal>Main</literal> method from the "AllTests" module.</paragraph> + <paragraph role="paragraph" id="par_id681656423146183">The <link href="text/sbasic/shared/03/sf_exception.xhp#Console" name="Console"><literal>Console</literal></link> from the <literal>Exception</literal> service is used as the default output to print test results. After running the example above, the following output will be displayed in the console:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id471656424558171">' RUNTEST ENTER testsuite='Tests.AllTests', pattern='Test_*'</paragraph> + <paragraph role="bascode" localize="false" id="bas_id881656424560234">' SETUP Tests.AllTests.Setup() ENTER</paragraph> + <paragraph role="bascode" localize="false" id="bas_id816565423395738">' SETUP Tests.AllTests.Setup() EXIT</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981656423396035">' TESTCASE Tests.AllTests.Test_Multiply() ENTER</paragraph> + <paragraph role="bascode" localize="false" id="bas_id416564233956290">' TESTCASE Tests.AllTests.Test_Multiply() EXIT (0,017 sec)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id731656423396546">' TESTCASE Tests.AllTests.Test_Sum() ENTER</paragraph> + <paragraph role="bascode" localize="false" id="bas_id781656423396778">' TESTCASE Tests.AllTests.Test_Sum() EXIT (0,016 sec)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321656423397506">' TEARDOWN Tests.AllTests.TearDown() ENTER</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441656423397714">' TEARDOWN Tests.AllTests.TearDown() EXIT</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151656423492374">' RUNTEST EXIT testsuite='Tests.AllTests' (0,223 sec)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id161656423510879">If any of the <literal>AssertEqual</literal> methods fails during these tests, an error message is added to the console.</paragraph> + + <bookmark xml-lang="en-US" branch="index" localize="false" id="bm_id11161490151416"> + <bookmark_value>Region service;LongMessage</bookmark_value> + <bookmark_value>Region service;ReturnCode</bookmark_value> + <bookmark_value>Region service;Verbose</bookmark_value> + <bookmark_value>Region service;WhenAssertionFails</bookmark_value> + </bookmark> + + <h2 id="hd_id711600788076834">Properties</h2> + <table id="tab_id701600788076583"> + <tablerow> + <tablecell> + <paragraph id="par_id461600788076917" role="tablehead">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221600788076591" role="tablehead">Readonly</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076328" role="tablehead">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id67160078807636" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id491600788076621" role="tablecontent" localize="false">LongMessage</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311600788076756" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831600788076785" role="tablecontent" localize="false">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id441600788076826" role="tablecontent">When set to <literal>True</literal> (default) the console shows the standard message appended to the message provided by the tester. When <literal>False</literal>, only the message defined by the tester is used.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id941600788076595" role="tablecontent" localize="false">ReturnCode</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id49160078807654" role="tablecontent">Yes</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961600788076376" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81600788076419" role="tablecontent">Value returned by <literal>RunTest</literal> after the unit test is finished. Next is a list of possible values:</paragraph> + <paragraph role="paragraph" id="par_id141656425588260">0 - Test finished without errors or test not started<br/> + 1 - An assertion within a test case returned <literal>False</literal><br/> + 2 - A <literal>SkipTest</literal> was issued by the <literal>Setup</literal> method or by one of the test cases.<br/> + 3 - Abnormal end of test</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721600788076638" role="tablecontent" localize="false">Verbose</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711600788076534" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911600788076842" localize="false" role="tablecontent">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541600788076645" role="tablecontent">When set to <literal>True</literal>, all assertions are reported in the console (failing or not). When <literal>False</literal> (default), only failing assertions are reported.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id961600788076890" role="tablecontent" localize="false">WhenAssertionFails</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891600788076190" role="tablecontent">No</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761600788076562" role="tablecontent" localize="false">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91600788076674" role="tablecontent">Defines what is done when an assertion fails. Next is a list of possible values:</paragraph> + <paragraph role="paragraph" id="par_id671656425606077">0 - Ignore the failure and continue running the test<br/> + 1 - The <literal>TearDown</literal> method in the module is executed in the current test suite and the next suite is started (default in full mode).<br/> + 2 - Stop immediately (default in simple mode)</paragraph> + </tablecell> + </tablerow> + </table> + + <table id="tab_id901611086279902"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id651606319520519" role="tablehead">List of Methods in the UnitTest Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertAlmostEqual" name="AssertAlmostEqual method">AssertAlmostEqual</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertEqual" name="AssertEqual method">AssertEqual</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertFalse" name="AssertFalse method">AssertFalse</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertGreater" name="AssertGreater method">AssertGreater</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertGreaterEqual" name="AssertGreaterEqual method">AssertGreaterEqual</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertIn" name="AssertIn method">AssertIn</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertIsInstance" name="AssertIsInstance method">AssertIsInstance</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertIsNothing" name="AssertIsNothing method">AssertIsNothing</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertLike" name="AssertLike method">AssertLike</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141611086279902" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertNotRegex" name="AssertNotRegex method">AssertNotRegex</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertIsNull" name="AssertIsNull method">AssertIsNull</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertLess" name="AssertLess method">AssertLess</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertLessEqual" name="AssertLessEqual method">AssertLessEqual</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertNotAlmostEqual" name="AssertNotAlmostEqual method">AssertNotAlmostEqual</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertNotEqual" name="AssertNotEqual method">AssertNotEqual</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertNotIn" name="AssertNotIn method">AssertNotIn</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertNotInstance" name="AssertNotInstance method">AssertNotInstance</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertNotLike" name="AssertNotLike method">AssertNotLike</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761611086279903" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertNotNothing" name="AssertNotNothing method">AssertNotNothing</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertNotNull" name="AssertNotNull method">AssertNotNull</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertRegex" name="AssertRegex method">AssertRegex</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertTrue" name="AssertTrue method">AssertTrue</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#Fail" name="Fail method">Fail</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#Log" name="Log method">Log</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#ReportError" name="ReportError method">ReportError</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#RunTest" name="RunTest method">RunTest</link><br/> + <link href="text/sbasic/shared/03/sf_unittest.xhp#SkipTest" name="SkipTest method">SkipTest</link><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + + <h2 id="hd_id201656428230690">Arguments of the AssertX methods</h2> + <paragraph role="paragraph" id="par_id591656428251124">All assertions test one or two expressions, referred in the remainder of this help page as <emph>A</emph> and <emph>B</emph>. They are always the first one or two arguments in the <literal>AssertX</literal> method.</paragraph> + <paragraph role="paragraph" id="par_id231656428367462">All <literal>AssertX</literal> methods accept a <literal>message</literal> argument specifying a custom message to be reported in the console regarding the assertion. By default an empty string is used. This argument is always in the last position of the assertion.</paragraph> + <paragraph role="paragraph" id="par_id91656451227291">Some <literal>AssertX</literal> methods also accept additional arguments, as described by their syntaxes below.</paragraph> + + <section id="AssertAlmostEqual"> + <comment> AssertAlmostEqual -------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919665187"> + <bookmark_value>UnitTest service;AssertAlmostEqual</bookmark_value> + </bookmark> + <h2 id="hd_id201589199698020" localize="false">AssertAlmostEqual</h2> + <paragraph role="paragraph" id="par_id71621894833351">Returns <literal>True</literal> when <emph>A</emph> and <emph>B</emph> are numerical values and are considered to be close to each other, given a relative tolerance.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897232817"> + <input>svc.AssertAlmostEqual(a: any, b: any, tolerance: double = 1E-09, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id241656426318310">This assertion returns <literal>True</literal> if the two conditions below are met:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id861656426361793" role="listitem">A and B can be converted to the <literal>Double</literal> type.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851656426362072" role="listitem">The absolute difference between A and B divided by the largest absolute value of A or B is <emph>lower</emph> than the value specified in <literal>tolerance</literal>.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertEqual"> + <comment> AssertEqual -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919960367"> + <bookmark_value>UnitTest service;AssertEqual</bookmark_value> + </bookmark> + <h2 id="hd_id2015891996965210" localize="false">AssertEqual</h2> + <paragraph role="paragraph" id="par_id71621894830182">Returns <literal>True</literal> when <emph>A</emph> and <emph>B</emph> are considered to be equal.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897208117"> + <input>svc.AssertEqual(a: any, b: any, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id241656426317440">When A and B are scalars, <literal>True</literal> is returned if:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id861656426361808" role="listitem">Both expressions have the same <literal>VarType</literal> or are both numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851656426362362" role="listitem">Booleans and numeric values are compared with the = operator.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id201656427500186" role="listitem">Strings are compared with the builtin <literal>StrComp</literal> function. The comparison is case-sensitive.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id861656427531067" role="listitem">Dates and times are compared up to the second.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id361656427557940" role="listitem"><literal>Null</literal>, <literal>Empty</literal> and <literal>Nothing</literal> are not equal, but <literal>AssertEqual(Nothing, Nothing)</literal> returns <literal>True</literal>.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id31656427624016" role="listitem">UNO objects are compared with the builtin <literal>EqualUnoObjects</literal> method.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id301656427695507" role="listitem">Note that Basic objects are never equal.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id691656427837518">When A and B are arrays, <literal>True</literal> is returned if:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id831656427894608" role="listitem">Both arrays have the same number of dimensions (up to 2 dimensions) and their lower and upper bounds are identical for all dimensions.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851656427895040" role="listitem">All items in both arrays are equal, one by one.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id571656427895400" role="listitem">Two empty arrays are considered to be equal.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertFalse"> + <comment> AssertFalse -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969204"> + <bookmark_value>UnitTest service;AssertFalse</bookmark_value> + </bookmark> + <h2 id="hd_id201589199693690" localize="false">AssertFalse</h2> + <paragraph role="paragraph" id="par_id71621894830071">Returns <literal>True</literal> when the type of A is <literal>Boolean</literal> and its value is <literal>False</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897203045"> + <input>svc.AssertFalse(a: any, message: str = ""): bool</input> + </paragraph> + </section> + + <section id="AssertGreater"> + <comment> AssertGreater ------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969108"> + <bookmark_value>UnitTest service;AssertGreater</bookmark_value> + </bookmark> + <h2 id="hd_id201589199665410" localize="false">AssertGreater</h2> + <paragraph role="paragraph" id="par_id71621894830337">Returns <literal>True</literal> when A is greater than B.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897207037"> + <input>svc.AssertGreater(a: any, b: any, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id991656428670110">The comparison between A and B assumes the following:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id591656428689390" role="listitem">Eligible data types are <literal>String</literal>, <literal>Date</literal> or numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id516564286489629" role="listitem">Both expressions must have the same <literal>VarType</literal> or both must be numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id211656428689774" role="listitem">String comparisons are case-sensitive.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertGreaterEqual"> + <comment> AssertGreaterEqual ------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919963398"> + <bookmark_value>UnitTest service;AssertGreaterEqual</bookmark_value> + </bookmark> + <h2 id="hd_id201589199666322" localize="false">AssertGreaterEqual</h2> + <paragraph role="paragraph" id="par_id71621894838548">Returns <literal>True</literal> when A is greater than or equal to B.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897203210"> + <input>svc.AssertGreaterEqual(a: any, b: any, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id991656428670202">The comparison between A and B assumes the following:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id591656428689207" role="listitem">Eligible data types are <literal>String</literal>, <literal>Date</literal> or numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id516564286455529" role="listitem">Both expressions must have the same <literal>VarType</literal> or both must be numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id211656428663284" role="listitem">String comparisons are case-sensitive.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertIn"> + <comment> AssertIn ----------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919964658"> + <bookmark_value>UnitTest service;AssertIn</bookmark_value> + </bookmark> + <h2 id="hd_id201589199666309" localize="false">AssertIn</h2> + <paragraph role="paragraph" id="par_id71621894831448">Returns <literal>True</literal> when A is found in B.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897203344"> + <input>svc.AssertIn(a: any, b: any, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id991656428677632">This assertion assumes the following:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id591656428688858" role="listitem">Expression B may be a 1D array, a ScriptForge <literal>Dictionary</literal> object or a string.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id516564286454219" role="listitem">When expression B is a 1D array, expression A may be a date or a numeric value.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id51656678140228" role="listitem">When expression B is a ScriptForge <literal>Dictionary</literal> object, then string A is searched for among the keys in B.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id211656428663299" role="listitem">String comparisons are case-sensitive.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertIsInstance"> + <comment> AssertIsInstance --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919963087"> + <bookmark_value>UnitTest service;AssertIsInstance</bookmark_value> + </bookmark> + <h2 id="hd_id201589199666212" localize="false">AssertIsInstance</h2> + <paragraph role="paragraph" id="par_id71621894831399">Returns <literal>True</literal> when A is an instance of a specified object type, specified as a string containing the type name.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897201284"> + <input>svc.AssertIsInstance(a: any, objecttype: str, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id991656428676302">Expression A may be one of the following:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id591656428676428" role="listitem">A ScriptForge object. In this case, the <literal>objecttype</literal> argument is a string such as "DICTIONARY", "calc", "Dialog", etc.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id516564286456619" role="listitem">A UNO object. In this case, the <literal>objecttype</literal> argument must be a string identical to the value returned by the <literal>SF_Session.UnoObjectType()</literal> method.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id211656428680559" role="listitem">An Array. In this case, the <literal>objecttype</literal> argument is expected to be "array".</paragraph> + </listitem> + <listitem> + <paragraph id="par_id891656439858783" role="listitem">Any other variable (neither an <literal>Object</literal> nor an <literal>Array</literal>). In this case, <literal>objecttype</literal> is a string matching the value returned by the builtin <literal>TypeName</literal> function.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertIsNothing"> + <comment> AssertIsNothing ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919936404"> + <bookmark_value>UnitTest service;AssertIsNothing</bookmark_value> + </bookmark> + <h2 id="hd_id201589199693766" localize="false">AssertIsNothing</h2> + <paragraph role="paragraph" id="par_id71621894830197">Returns <literal>True</literal> when A is an object that has the <literal>Nothing</literal> value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897221145"> + <input>svc.AssertIsNothing(a: any, message: str = ""): bool</input> + </paragraph> + </section> + + <section id="AssertIsNull"> + <comment> AssertIsNull ------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919969366"> + <bookmark_value>UnitTest service;AssertIsNull</bookmark_value> + </bookmark> + <h2 id="hd_id201589199693825" localize="false">AssertIsNull</h2> + <paragraph role="paragraph" id="par_id71621894863251">Returns <literal>True</literal> when A has the <literal>Null</literal> value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897202545"> + <input>svc.AssertIsNull(a: any, message: str = ""): bool</input> + </paragraph> + </section> + + <section id="AssertLess"> + <comment> AssertLess --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919964338"> + <bookmark_value>UnitTest service;AssertLess</bookmark_value> + </bookmark> + <h2 id="hd_id201589199663022" localize="false">AssertLess</h2> + <paragraph role="paragraph" id="par_id71621894838018">Returns <literal>True</literal> when A is less than B.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id59162189726574"> + <input>svc.AssertLess(a: any, b: any, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id991656428672332">The comparison between A and B assumes the following:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id591656428689311" role="listitem">Eligible data types are <literal>String</literal>, <literal>Date</literal> or numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id516564286265809" role="listitem">Both expressions must have the same <literal>VarType</literal> or both must be numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id211656428660996" role="listitem">String comparisons are case-sensitive.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertLessEqual"> + <comment> AssertLessEqual ---------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919964174"> + <bookmark_value>UnitTest service;AssertLessEqual</bookmark_value> + </bookmark> + <h2 id="hd_id201589199661992" localize="false">AssertLessEqual</h2> + <paragraph role="paragraph" id="par_id71621894208818">Returns <literal>True</literal> when A is less than or equal to B.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id59162189720864"> + <input>svc.AssertLessEqual(a: any, b: any, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id991656428606322">The comparison between A and B assumes the following:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id591656428682251" role="listitem">Eligible data types are <literal>String</literal>, <literal>Date</literal> or numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id516564286265711" role="listitem">Both expressions must have the same <literal>VarType</literal> or both must be numeric.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id211656428660176" role="listitem">String comparisons are case-sensitive.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertLike"> + <comment> AssertLike --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919968226"> + <bookmark_value>UnitTest service;AssertLike</bookmark_value> + </bookmark> + <h2 id="hd_id201589199611825" localize="false">AssertLike</h2> + <paragraph role="paragraph" id="par_id71621894862651">Returns <literal>True</literal> if string A matches a given pattern containing wildcards.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897207315"> + <input>svc.AssertLike(a: any, pattern: str = "", message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id51656446203238">The following wildcards are accepted:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id661656446233484" role="listitem">? - Represents any single character.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id681656446233831" role="listitem">* - Represents zero, one, or multiple characters.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertNotAlmostEqual"> + <comment> AssertNotAlmostEqual ----------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919665187"> + <bookmark_value>UnitTest service;AssertNotAlmostEqual</bookmark_value> + </bookmark> + <h2 id="hd_id2015891996638414" localize="false">AssertNotAlmostEqual</h2> + <paragraph role="paragraph" id="par_id71621894832641">Returns <literal>True</literal> when <emph>A</emph> and <emph>B</emph> are numerical values and are <emph>not</emph> considered to be close to each other, given a relative tolerance.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id5916218972331205"> + <input>svc.AssertNotAlmostEqual(a: any, b: any, tolerance: double = 1E-09, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id241656426317970">This assertion returns <literal>True</literal> if the two conditions below are met:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id861656426361686" role="listitem">A and B can be converted to the <literal>Double</literal> type.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851656426332052" role="listitem">The absolute difference between A and B divided by the largest absolute value of A or B is <emph>greater</emph> than the value specified in <literal>tolerance</literal>.</paragraph> + </listitem> + </list> + </section> + + <section id="AssertNotEqual"> + <comment> AssertNotEqual ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919961047"> + <bookmark_value>UnitTest service;AssertNotEqual</bookmark_value> + </bookmark> + <h2 id="hd_id2015891996963410" localize="false">AssertNotEqual</h2> + <paragraph role="paragraph" id="par_id71621894862842">Returns <literal>True</literal> when <emph>A</emph> and <emph>B</emph> are <emph>not</emph> considered to be equal.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897227497"> + <input>svc.AssertNotEqual(a: any, b: any, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id581656446598206">This method works both for scalars and arrays. Read the instructions in <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertEqual" name="AssertEqual"><literal>AssertEqual</literal></link> for more information on what equality means in this assertion.</paragraph> + </section> + + <section id="AssertNotIn"> + <comment> AssertNotIn -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919932358"> + <bookmark_value>UnitTest service;AssertNotIn</bookmark_value> + </bookmark> + <h2 id="hd_id201589199617409" localize="false">AssertNotIn</h2> + <paragraph role="paragraph" id="par_id71621894832638">Returns <literal>True</literal> when A (a string) is <emph>not</emph> found in B.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897212544"> + <input>svc.AssertNotIn(a: any, b: any, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id271656446302516">Read the instructions in <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertIn" name="AssertIn"><literal>AssertIn</literal></link> for more information on the assumptions of this method.</paragraph> + </section> + + <section id="AssertNotInstance"> + <comment> AssertNotInstance -------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919963186"> + <bookmark_value>UnitTest service;AssertNotInstance</bookmark_value> + </bookmark> + <h2 id="hd_id201589199676312" localize="false">AssertNotInstance</h2> + <paragraph role="paragraph" id="par_id71621894831403">Returns <literal>True</literal> when A is <emph>not</emph> an instance of a specified object type.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897136284"> + <input>svc.AssertNotInstance(a: any, objecttype: str, message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id271656446949396">Read the instructions in <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertIsInstance" name="AssertIsInstance"><literal>AssertIsInstance</literal></link> for more information on the assumptions of this method.</paragraph> + </section> + + <section id="AssertNotLike"> + <comment> AssertNotLike ------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919967256"> + <bookmark_value>UnitTest service;AssertNotLike</bookmark_value> + </bookmark> + <h2 id="hd_id201589199612225" localize="false">AssertNotLike</h2> + <paragraph role="paragraph" id="par_id71621894863961">Returns <literal>True</literal> if string A <emph>does not</emph> match a given pattern containing wildcards.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897237415"> + <input>svc.AssertNotLike(a: any, pattern: str = "", message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id271656446258396">Read the instructions in <link href="text/sbasic/shared/03/sf_unittest.xhp#AssertLike" name="AssertLike"><literal>AssertLike</literal></link> for more information on the assumptions of this method.</paragraph> + </section> + + <section id="AssertNotNothing"> + <comment> AssertNotNothing --------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158914467256"> + <bookmark_value>UnitTest service;AssertNotNothing</bookmark_value> + </bookmark> + <h2 id="hd_id201589199743855" localize="false">AssertNotNothing</h2> + <paragraph role="paragraph" id="par_id71621894420261">Returns <literal>True</literal> except when A is an object that has the <literal>Nothing</literal> value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621843337415"> + <input>svc.AssertNotNothing(a: any, message: str = ""): bool</input> + </paragraph> + </section> + + <section id="AssertNotNull"> + <comment> AssertNotNull ------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919966555"> + <bookmark_value>UnitTest service;AssertNotNull</bookmark_value> + </bookmark> + <h2 id="hd_id201589199602825" localize="false">AssertNotNull</h2> + <paragraph role="paragraph" id="par_id71621894876551">Returns <literal>True</literal> except when A has the <literal>Null</literal> value.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621897223945"> + <input>svc.AssertNotNull(a: any, message: str = ""): bool</input> + </paragraph> + </section> + + <section id="AssertNotRegex"> + <comment> AssertNotRegex ----------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919964125"> + <bookmark_value>UnitTest service;AssertNotRegex</bookmark_value> + </bookmark> + <h2 id="hd_id201589199602432" localize="false">AssertNotRegex</h2> + <paragraph role="paragraph" id="par_id71621894860331">Returns <literal>True</literal> when A is <emph>not</emph> a string or <emph>does not</emph> match the given regular expression.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621898163945"> + <input>svc.AssertNotRegex(a: any, regex: str = "", message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id931656448163772">The comparison is case-sensitive.</paragraph> + </section> + + <section id="AssertRegex"> + <comment> AssertRegex -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919933525"> + <bookmark_value>UnitTest service;AssertRegex</bookmark_value> + </bookmark> + <h2 id="hd_id201589199601132" localize="false">AssertRegex</h2> + <paragraph role="paragraph" id="par_id71621894836031">Returns <literal>True</literal> when string A matches the given regular expression.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621898142945"> + <input>svc.AssertRegex(a: any, regex: str = "", message: str = ""): bool</input> + </paragraph> + <paragraph role="paragraph" id="par_id931656448163625">The comparison is case-sensitive.</paragraph> + </section> + + <section id="AssertTrue"> + <comment> AssertTrue --------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919986595"> + <bookmark_value>UnitTest service;AssertTrue</bookmark_value> + </bookmark> + <h2 id="hd_id20158919962312" localize="false">AssertTrue</h2> + <paragraph role="paragraph" id="par_id71621894063449">Returns <literal>True</literal> when expression A is a <literal>Boolean</literal> and its value is <literal>True</literal>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621898125645"> + <input>svc.AssertTrue(a: any, message: str = ""): bool</input> + </paragraph> + </section> + + <section id="Fail"> + <comment> Fail --------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919986595"> + <bookmark_value>UnitTest service;Fail</bookmark_value> + </bookmark> + <h2 id="hd_id20158919736312" localize="false">Fail</h2> + <paragraph role="paragraph" id="par_id71621894086431">Forces a test case to fail.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621890114545"> + <input>svc.Fail(message: str = "")</input> + </paragraph> + <paragraph role="paragraph" id="par_id751656448550854">A message can be provided to be reported in the console.</paragraph> + </section> + + <section id="Log"> + <comment> Log ---------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919986595"> + <bookmark_value>UnitTest service;Log</bookmark_value> + </bookmark> + <h2 id="hd_id20158919909612" localize="false">Log</h2> + <paragraph role="paragraph" id="par_id71621894063631">Writes the specified <literal>message</literal> in the console.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621898149545"> + <input>svc.Log(message: str = "")</input> + </paragraph> + <paragraph role="paragraph" id="par_id751656448510894">A message can be provided to be reported in the console.</paragraph> + </section> + + <section id="ReportError"> + <comment> ReportError -------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919949695"> + <bookmark_value>UnitTest service;ReportError</bookmark_value> + </bookmark> + <h2 id="hd_id20158919658972" localize="false">ReportError</h2> + <paragraph role="paragraph" id="par_id71621894199311">Displays a message box with a message and the current property values of the <literal>Exception</literal> service.</paragraph> + <paragraph role="paragraph" id="par_id851656622819891">This method is commonly used in the exception handling section of the <literal>Sub</literal> containing the test case, which is reached when an assertion fails or when the <literal>Fail</literal> method is called.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591639698323545"> + <input>svc.ReportError(message: str = "")</input> + </paragraph> + <paragraph role="paragraph" id="par_id291656448892783">Depending on the value of the property <literal>WhenAssertionFails</literal>, the test execution may continue or be interrupted.</paragraph> + <paragraph role="paragraph" id="par_id551656448951538">When writing test cases it is recommended to include a call to the <literal>ReportError</literal> method in the exception handling section of the <literal>Sub</literal>.</paragraph> + <paragraph role="paragraph" id="par_id711656449128572">If the property <literal>LongMessage</literal> is equal to <literal>True</literal>, the specified <literal>message</literal> is followed by the standard error message description. Otherwise only the <literal>message</literal> is displayed.</paragraph> + </section> + + <section id="RunTest"> + <comment> RunTest ------------------------------------------------------------------------------------------------ </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919984145"> + <bookmark_value>UnitTest service;RunTest</bookmark_value> + </bookmark> + <h2 id="hd_id20158919960992" localize="false">RunTest</h2> + <paragraph role="paragraph" id="par_id71621894063361">Executes the complete test suite implemented in the specified module. Each test case is run independently from each other.</paragraph> + <paragraph role="paragraph" id="par_id201656449688023">Running a test suite consists of:</paragraph> + <list type="ordered"> + <listitem> + <paragraph id="par_id751656449718279" role="listitem">Executing the optional <literal>Setup</literal> method present in the module.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id611656449718505" role="listitem">Executing once each test case, in no specific order.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id461656449718687" role="listitem">Executing the optional <literal>TearDown</literal> method present in the module.</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591621898140525"> + <input>svc.RunTest(testsuite: str, testcasepattern: str = "", message: str = ""): int</input> + </paragraph> + <paragraph role="paragraph" id="par_id751656448521144">The argument <literal>testcasepattern</literal> specifies a pattern composed of "?" and "*" wildcards to select which test cases will be run. The comparison is not case-sensitive.</paragraph> + <paragraph role="paragraph" id="par_id81656448858455">If a <literal>message</literal> is provided, it is written to the console when the test starts.</paragraph> + </section> + + <section id="SkipTest"> + <comment> SkipTest ----------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id92158919949695"> + <bookmark_value>UnitTest service;SkipTest</bookmark_value> + </bookmark> + <h2 id="hd_id20158919952512" localize="false">SkipTest</h2> + <paragraph role="paragraph" id="par_id71621894064311">Interrupts the running test suite without calling the <literal>TearDown</literal> method.</paragraph> + <paragraph role="paragraph" id="par_id781656450313544">Skipping a test is usually meaningful during the <literal>Setup</literal> method when not all conditions to run the test are met.</paragraph> + <paragraph role="paragraph" id="par_id531656450405799">It is up to the <literal>Setup</literal> method to exit the <literal>Sub</literal> shortly after the <literal>SkipTest</literal> call.</paragraph> + <paragraph role="paragraph" id="par_id581656450504005">If <literal>SkipTest</literal> is called from within a test case, the execution of the test suite is interrupted and the remaining test cases are not run. Keep in mind that the order in which test cases are run is arbitrary within a test suite.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id591639698149545"> + <input>svc.SkipTest(message: str = "")</input> + </paragraph> + <paragraph role="paragraph" id="par_id81656449618455">If a <literal>message</literal> is provided, it is written to the console.</paragraph> + </section> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_exception.xhp#ExceptionService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03/sf_writer.xhp b/helpcontent2/source/text/sbasic/shared/03/sf_writer.xhp new file mode 100644 index 000000000..d4ea1bdfc --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03/sf_writer.xhp @@ -0,0 +1,189 @@ +<?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_writer" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SFDocuments.Writer service</title> + <filename>/text/sbasic/shared/03/sf_writer.xhp</filename> + </topic> +</meta> + +<body> +<section id="SFDocuments-sf_writer"> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id261582733781987"> + <bookmark_value>Writer service</bookmark_value> + </bookmark> +</section> + +<section id="abstract"> + <h1 id="hd_id731582733781114" xml-lang="en-US"><variable id="WriterService"><link href="text/sbasic/shared/03/sf_writer.xhp" name="Writer service"><literal>SFDocuments</literal>.<literal>Writer</literal> service</link></variable></h1> + <paragraph role="paragraph" id="par_id381589189355849" xml-lang="en-US">The <literal>SFDocuments</literal> shared library provides a number of methods and properties to facilitate the management and handling of %PRODUCTNAME documents.</paragraph> + <paragraph role="paragraph" id="par_id351591014177269" xml-lang="en-US">Some methods are generic for all types of documents and are inherited from the <literal>SF_Document</literal> module, whereas other methods that are specific for Writer documents are defined in the <literal>SF_Writer</literal> module.</paragraph> + <comment>To be done: list with the main features of the Writer service.</comment> +</section> + + <h2 id="hd_id581582885621841">Service invocation</h2> + <paragraph role="paragraph" id="par_id141609955500101">Before using the <literal>Writer</literal> service the <literal>ScriptForge</literal> library needs to be loaded or imported:</paragraph> + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/> + + <paragraph role="paragraph" id="par_id591589191059889" xml-lang="en-US">The <literal>Writer</literal> service is closely related to the <literal>UI</literal> service of the <literal>ScriptForge</literal> library. Below are a few examples of how the <literal>Writer</literal> service can be invoked.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <paragraph role="paragraph" id="par_id551621623999947">The code snippet below creates a <literal>Writer</literal> service instance that corresponds to the currently active Writer document.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id651631197152830">Dim oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id431621624078370">Set oDoc = CreateScriptService("SFDocuments.Writer", "Untitled 1") ' Default = ActiveWindow</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id341621467500466">Another way to create an instance of the <literal>Writer</literal> service is using the <literal>UI</literal> service. In the following example, a new Writer document is created and <literal>oDoc</literal> is a <literal>Writer</literal> service instance:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id371582885621964">Dim ui As Object, oDoc As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201582885621287">Set ui = CreateScriptService("UI")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id561589191748697">Set oDoc = ui.CreateDocument("Writer")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id921621467621019">Or using the <literal>OpenDocument</literal> method from the <literal>UI</literal> service:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671621467660766">Set oDoc = ui.OpenDocument("C:\Me\MyFile.odt")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id741621467697967">It is also possible to instantiate the <literal>Writer</literal> service using 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.Writer", "MyFile.odt")</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id271621467810774">In the example above, "MyFile.odt" 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_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> + </bascode> + <paragraph role="paragraph" id="par_id231611610666018">However, if the document was closed using the <literal>CloseDocument</literal> method, it becomes unnecessary to free resources using the command described above.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id911621624242302">myDoc = CreateScriptService("Writer") ' Default = ActiveWindow</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id201621531742824">ui = CreateScriptService("UI")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id661621531772444">myDoc = ui.CreateDocument("Writer")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id401621531828705">myDoc = ui.OpenDocument(r"C:\Documents\MyFile.odt")</paragraph> + </pycode> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id701621532481401">myDoc = CreateScriptService("SFDocuments.Writer", "MyFile.odt")</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id951621532568918">myDoc.Dispose()</paragraph> + </pycode> + <tip id="par_id71611090922315">The use of the prefix "<literal>SFDocuments.</literal>" while calling the service is optional.</tip> + + <h2 id="hd_id291631196803182">Definitions</h2> + <comment>TBD</comment> + + <h2 id="hd_id351582885195476" xml-lang="en-US">Properties</h2> + + <h2 id="hd_id501582887473754" xml-lang="en-US">Methods</h2> + <table id="tab_id501611613601554"> + <tablerow> + <tablecell colspan="3"><paragraph id="par_id891611613601554" role="tablehead" xml-lang="en-US">List of Methods in the Writer Service</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891611613601556" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_writer.xhp#Forms" name="Forms method">Forms</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_writer.xhp#PrintOut" name="PrintOut method">PrintOut</link><br/> + </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701611613601554" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/03/sf_writer.xhp#MoveRange" name="MoveRange method">…</link><br/> + </paragraph> + </tablecell> + </tablerow> + </table> + +<section id="Forms"> + <comment> Forms --------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id721589200121336"> + <bookmark_value>Document service;Forms</bookmark_value> + </bookmark> + <h2 id="hd_id261589200120884" localize="false">Forms</h2> + <paragraph role="paragraph" id="par_id501623063693649">Depending on the parameters provided this method will return:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id611623063742045" role="listitem">A zero-based Array (or a tuple in Python) with the names of all the forms contained in the document (if the <literal>form</literal> argument is absent)</paragraph> + </listitem> + <listitem> + <paragraph id="par_id641623063744536" role="listitem">A <literal>SFDocuments.Form</literal> service instance representing the form specified as argument.</paragraph> + </listitem> + </list> + <note id="par_id821623076570573">This method is applicable only for Writer documents. Calc and Base documents have their own <literal>Forms</literal> method in the <link href="text/sbasic/shared/03/sf_calc.xhp#Forms" name="Calc_Forms">Calc</link> and <link href="text/sbasic/shared/03/sf_base.xhp#Forms" name="Base_Forms">Base</link> services, respectively.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id371623063588699"> + <input>svc.Forms(): str[0..*]</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id471623151738791"> + <input>svc.Forms(form: str = ''): svc</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id751623151751397"> + <input>svc.Forms(form: int): svc</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id451623063459286"><emph>form</emph>: The name or index corresponding to a form stored in the document. If this argument is absent, the method will return a list with the names of all forms available in the document.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id251623063305557">In the following examples, the first line gets the names of all forms in the document and the second line retrieves the <literal>Form</literal> object of the form named "Form_A".</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id191623063399519">Set FormNames = oDoc.Forms()</paragraph> + <paragraph role="bascode" localize="false" id="bas_id691623063399711">Set FormA = oDoc.Forms("Form_A")</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id271623063215023">form_names = doc.Forms()</paragraph> + <paragraph role="pycode" localize="false" id="pyc_id961623063234990">form_A = doc.Forms("Form_A")</paragraph> + </pycode> +</section> + +<section id="PrintOut"> + <comment> PrintOut -------------------------------------------------------------------------------------------------------------------------- </comment> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id231592919577434"> + <bookmark_value>Writer service;PrintOut</bookmark_value> + </bookmark> + <h2 id="hd_id921592919577158" localize="false">PrintOut</h2> + <paragraph role="paragraph" id="par_id31592919577984">Send the contents of the document to the printer. The printer may be previously defined by default, by the user or by the <link href="text/sbasic/03/sf_document.xhp#SetPrinter" name="SetPrinter method"><literal>SetPrinter</literal></link> method of the <link href="text/sbasic/03/sf_document.xhp" name="Document service">Document</link> service. Returns <literal>True</literal> when successful.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id441621534763020"> + <input>svc.PrintOut(opt pages: str = "", opt copies: num = 1, opt printbackground: bool = True, opt printblankpages: bool = False, opt printevenpages: bool = True, opt printoddpages: bool = True, opt printimages: bool = True): bool</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id441592919577809"><emph>pages</emph>: The pages to print as a string, like in the user interface. Example: "1-4;10;15-18". Default = all pages</paragraph> + <paragraph role="paragraph" id="par_id221636020923278"><emph>copies</emph>: The number of copies, default is 1.</paragraph> + <paragraph role="paragraph" id="par_id121636020926764"><emph>printbackground</emph>: Prints the background image when <literal>True</literal> (default).</paragraph> + <paragraph role="paragraph" id="par_id261636020927276"><emph>printblankpages</emph>: When <literal>False</literal> (default), omits empty pages.</paragraph> + <paragraph role="paragraph" id="par_id021636020927484"><emph>printevenpages</emph>: Prints even pages when <literal>True</literal> (default).</paragraph> + <paragraph role="paragraph" id="par_id391636020927676"><emph>printoddpages</emph>: Print odd pages when <literal>True</literal> (default).</paragraph> + <paragraph role="paragraph" id="par_id121636021103996"><emph>printimages</emph>: Print graphic objects when <literal>True</literal> (default).</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <embed href="text/sbasic/shared/00000003.xhp#In_Basic"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id521592919577626">oDoc.PrintOut("1-4;10;15-18", Copies := 2, PrintImages := False)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#In_Python"/> + <pycode> + <paragraph role="pycode" localize="false" id="pyc_id211621536212144">doc.PrintOut(printblankpages = True, copies = 3)</paragraph> + </pycode> +</section> + + <embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#SF_InternalUse"/> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_document.xhp#DocumentService"/> + <embed href="text/sbasic/shared/03/sf_ui.xhp#UIService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03000000.xhp b/helpcontent2/source/text/sbasic/shared/03000000.xhp new file mode 100644 index 000000000..b9f2c0ad2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03000000.xhp @@ -0,0 +1,50 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03000000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Run-Time Functions</title> + <filename>/text/sbasic/shared/03000000.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="runtime"> + +<h1 id="hd_id3152895"><variable id="doc_title"><link href="text/sbasic/shared/03000000.xhp" name="Run-Time Functions">Run-Time Functions</link></variable></h1> +<paragraph id="par_id3148983" role="paragraph" xml-lang="en-US">This section describes the Runtime Functions of %PRODUCTNAME Basic.</paragraph> +</section> +<embed href="text/sbasic/shared/03040000.xhp#basic_constants"/> +<embed href="text/sbasic/shared/03100000.xhp#variables"/> +<embed href="text/sbasic/shared/03060000.xhp#logi"/> +<embed href="text/sbasic/shared/03110100.xhp#operators"/> +<embed href="text/sbasic/shared/03120000.xhp#strings"/> +<embed href="text/sbasic/shared/03030000.xhp#date_time"/> +<embed href="text/sbasic/shared/03070000.xhp#math"/> +<embed href="text/sbasic/shared/03080000.xhp#numeric"/> +<embed href="text/sbasic/shared/03010000.xhp#screen_IO"/> +<embed href="text/sbasic/shared/03020000.xhp#file_IO"/> +<embed href="text/sbasic/shared/03090000.xhp#prog_execution"/> +<embed href="text/sbasic/shared/03050000.xhp#errorhandling"/> +<embed href="text/sbasic/shared/03130000.xhp#other"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010000.xhp b/helpcontent2/source/text/sbasic/shared/03010000.xhp new file mode 100644 index 000000000..f885f1846 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010000.xhp @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03010000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Screen I/O Functions</title> +<filename>/text/sbasic/shared/03010000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + <section id="screen_IO"> + <h1 id="hd_id3156280"><variable id="BasicScreenIO"><link href="text/sbasic/shared/03010000.xhp" name="Screen I/O Functions">Screen I/O Functions</link></variable></h1> + <paragraph role="paragraph" id="par_id3153770" xml-lang="en-US">This section describes the Runtime Functions used to call dialogs for the input and output of user entries.</paragraph> + </section> + <embed href="text/sbasic/shared/03010100.xhp#output"/> + <embed href="text/sbasic/shared/03010200.xhp#input"/> + <embed href="text/sbasic/shared/03010300.xhp#color"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010100.xhp b/helpcontent2/source/text/sbasic/shared/03010100.xhp new file mode 100644 index 000000000..42f45eb1d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010100.xhp @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03010100xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Display Functions</title> +<filename>/text/sbasic/shared/03010100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="output"> + <paragraph id="hd_id3151384" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010100.xhp" name="Display Functions">Display Functions</link></paragraph> + <paragraph role="paragraph" id="par_id3149346" xml-lang="en-US">This section describes Runtime functions used to output information to the screen display.</paragraph> + </section> + <embed href="text/sbasic/shared/03010101.xhp#msgbox"/> + <embed href="text/sbasic/shared/03010102.xhp#msgbox"/> + <embed href="text/sbasic/shared/03010103.xhp#print"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010101.xhp b/helpcontent2/source/text/sbasic/shared/03010101.xhp new file mode 100644 index 000000000..9eed147d5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010101.xhp @@ -0,0 +1,227 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010101xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">MsgBox Statement</title> + <filename>/text/sbasic/shared/03010101.xhp</filename> + </topic> +</meta> + +<body> +<section id="msgbox"> +<bookmark xml-lang="en-US" branch="index" id="bm_id1807916"> + <bookmark_value>MsgBox statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3154927" xml-lang="en-US"><link href="text/sbasic/shared/03010101.xhp">MsgBox Statement</link></h1> +<paragraph id="par_id3148947" role="paragraph" xml-lang="en-US">Displays a dialog box containing a message.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph id="par_id3148664" role="bascode" localize="false">MsgBox prompt As String [,buttons = MB_OK [,title As String]]</paragraph> + <paragraph role="bascode" id="bas_id551634909184049" localize="false">response = MsgBox( prompt As String [,buttons = MB_OK [,title As String]])</paragraph> +</bascode> + +<section id="MsgBox_statement"> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<section id="parameters"> +<paragraph id="par_id3148798" role="paragraph" xml-lang="en-US"> <emph>prompt</emph>: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13).</paragraph> +<paragraph id="par_id3150769" role="paragraph" xml-lang="en-US"> <emph>title</emph>: String expression displayed in the title bar of the dialog. If omitted, the title bar displays the name of the respective application.</paragraph> +<paragraph id="par_id3147228" role="paragraph" xml-lang="en-US"> <emph>buttons</emph>: Any integer expression that specifies the dialog type, as well as the number and type of buttons to display, and the icon type. <emph>buttons</emph> represents a combination of bit patterns, that is, a combination of elements can be defined by adding their respective values:</paragraph> +</section> + +<section id="MsgBox_constants"> +<table id="tbl_051220170220345412"> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241588881" role="tablehead" xml-lang="en-US">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241585541" role="tablehead" xml-lang="en-US">Integer value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241585124" role="tablehead" xml-lang="en-US">Definition</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241588348" role="tablecontent" localize="false" xml-lang="en-US">MB_OK</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241583191" role="tablecontent" localize="false" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3147397" role="paragraph" xml-lang="en-US">Display OK button only.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241583930" role="tablecontent" localize="false" xml-lang="en-US">MB_OKCANCEL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241598544" role="tablecontent" localize="false" xml-lang="en-US">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145646" role="paragraph" xml-lang="en-US">Display OK and Cancel buttons.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241591470" role="tablecontent" localize="false" xml-lang="en-US">MB_ABORTRETRYIGNORE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241592832" role="tablecontent" localize="false" xml-lang="en-US">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3149410" role="paragraph" xml-lang="en-US">Display Abort, Retry, and Ignore buttons.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241594311" role="tablecontent" localize="false" xml-lang="en-US">MB_YESNOCANCEL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241594996" role="tablecontent" localize="false" xml-lang="en-US">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3151075" role="paragraph" xml-lang="en-US">Display Yes, No, and Cancel buttons.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241596937" role="tablecontent" localize="false" xml-lang="en-US">MB_YESNO</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241592706" role="tablecontent" localize="false" xml-lang="en-US">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153878" role="paragraph" xml-lang="en-US">Display Yes and No buttons.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241591119" role="tablecontent" localize="false" xml-lang="en-US">MB_RETRYCANCEL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241595093" role="tablecontent" localize="false" xml-lang="en-US">5</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155601" role="paragraph" xml-lang="en-US">Display Retry and Cancel buttons.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id05122017024159933" role="tablecontent" localize="false" xml-lang="en-US">MB_ICONSTOP</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id05122017024159655" role="tablecontent" localize="false" xml-lang="en-US">16</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3150716" role="paragraph" xml-lang="en-US">Add the Stop icon to the dialog.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241591424" role="tablecontent" localize="false" xml-lang="en-US">MB_ICONQUESTION</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170241593191" role="tablecontent" localize="false" xml-lang="en-US">32</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153837" role="paragraph" xml-lang="en-US">Add the Question icon to the dialog.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170241598357" role="tablecontent" localize="false" xml-lang="en-US">MB_ICONEXCLAMATION</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170242002870" role="tablecontent" localize="false" xml-lang="en-US">48</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3150751" role="paragraph" xml-lang="en-US">Add the Exclamation Point icon to the dialog.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170242001511" role="tablecontent" localize="false" xml-lang="en-US">MB_ICONINFORMATION</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170242008091" role="tablecontent" localize="false" xml-lang="en-US">64</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3146915" role="paragraph" xml-lang="en-US">Add the Information icon to the dialog.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170242003564" role="tablecontent" localize="false" xml-lang="en-US"> </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170242001398" role="tablecontent" localize="false" xml-lang="en-US">128</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145640" role="paragraph" xml-lang="en-US">First button in the dialog as default button.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170242007839" role="tablecontent" localize="false" xml-lang="en-US">MB_DEFBUTTON2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170242005589" role="tablecontent" localize="false" xml-lang="en-US">256</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153765" role="paragraph" xml-lang="en-US">Second button in the dialog as default button.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170242005074" role="tablecontent" localize="false" xml-lang="en-US">MB_DEFBUTTON3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170242001655" role="tablecontent" localize="false" xml-lang="en-US">512</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153715" role="paragraph" xml-lang="en-US">Third button in the dialog as default button.</paragraph> + </tablecell> + </tablerow> +</table> +</section> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340869408" role="bascode" localize="false" xml-lang="en-US">Sub ExampleMsgBox</paragraph> +<paragraph id="par_id3150327" role="bascode" xml-lang="en-US"> Const sText1 = "An unexpected error occurred."</paragraph> +<paragraph id="par_id3146912" role="bascode" xml-lang="en-US"> Const sText2 = "The program execution will continue, however."</paragraph> +<paragraph id="par_id3154757" role="bascode" xml-lang="en-US"> Const sText3 = "Error"</paragraph> +<paragraph id="par_idm1340862944" role="bascode" localize="false" xml-lang="en-US"> MsgBox(sText1 + Chr(13) + sText2,16,sText3)</paragraph> +<paragraph id="par_id051220170312352138" role="bascode" localize="false" xml-lang="en-US"> MsgBox(sText1 + Chr(13) + sText2, MB_ICONSTOP, sText3)</paragraph> +<paragraph id="par_idm1340861680" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010102.xhp b/helpcontent2/source/text/sbasic/shared/03010102.xhp new file mode 100644 index 000000000..3317c1192 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010102.xhp @@ -0,0 +1,156 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010102xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">MsgBox Function</title> + <filename>/text/sbasic/shared/03010102.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="msgbox"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153379"> + <bookmark_value>MsgBox function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3153379"><link href="text/sbasic/shared/03010102.xhp" name="MsgBox Function">MsgBox Function</link></h1> +<paragraph id="par_id3145171" role="paragraph" xml-lang="en-US">Displays a dialog box containing a message and returns a value.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3148664" role="bascode" localize="false">MsgBox (Prompt As String [,Buttons = MB_OK [,Title As String]]) As Integer</paragraph> +</bascode> + +<embed href="text/sbasic/shared/03010101.xhp#MsgBox_statement"/> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3146985" role="paragraph" xml-lang="en-US">Integer</paragraph> +<table id="tbl_051220170325378371"> + <tablerow> + <tablecell> + <paragraph id="par_id051220170330379805" role="tablehead" xml-lang="en-US">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170330387072" role="tablehead" xml-lang="en-US">Integer value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170330387973" role="tablehead" xml-lang="en-US">Definition</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170330388585" role="tablecontent" localize="false" xml-lang="en-US">IDOK</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170330389516" role="tablecontent" localize="false" xml-lang="en-US">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145230" role="paragraph" xml-lang="en-US"> OK</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170330381793" role="tablecontent" localize="false" xml-lang="en-US">IDCANCEL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170330388083" role="tablecontent" localize="false" xml-lang="en-US">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3149567" role="paragraph" xml-lang="en-US"> Cancel</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170330387992" role="tablecontent" localize="false" xml-lang="en-US">IDABORT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id05122017033038256" role="tablecontent" localize="false" xml-lang="en-US">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id4056825" role="paragraph" xml-lang="en-US"> Abort</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170330383300" role="tablecontent" localize="false" xml-lang="en-US">IDRETRY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170330382200" role="tablecontent" localize="false" xml-lang="en-US">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155335" role="paragraph" xml-lang="en-US"> Retry</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id0512201703303859" role="tablecontent" localize="false" xml-lang="en-US">IDIGNORE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170330388644" role="tablecontent" localize="false" xml-lang="en-US">5</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3146918" role="paragraph" xml-lang="en-US"> Ignore</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170330386652" role="tablecontent" localize="false" xml-lang="en-US">IDYES</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170330387211" role="tablecontent" localize="false" xml-lang="en-US">6</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155961" role="paragraph" xml-lang="en-US"> Yes</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170330381656" role="tablecontent" localize="false" xml-lang="en-US">IDNO</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170330383819" role="tablecontent" localize="false" xml-lang="en-US">7</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3148488" role="paragraph" xml-lang="en-US"> No</paragraph> + </tablecell> + </tablerow> +</table> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3150090" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340837456" role="bascode" localize="false" xml-lang="en-US">Sub ExampleMsgBox</paragraph> +<paragraph id="par_idm1340836224" role="bascode" localize="false" xml-lang="en-US">Dim sVar As Integer</paragraph> +<paragraph id="par_id3151278" role="bascode" xml-lang="en-US"> sVar = MsgBox("Las Vegas")</paragraph> +<paragraph id="par_id3149034" role="bascode" xml-lang="en-US"> sVar = MsgBox("Las Vegas",1)</paragraph> +<paragraph id="par_id3166424" role="bascode" xml-lang="en-US"> sVar = MsgBox( "Las Vegas",256 + 16 + 2,"Dialog title")</paragraph> +<paragraph id="par_id051220170242005479" role="bascode" xml-lang="en-US"> sVar = MsgBox("Las Vegas", MB_DEFBUTTON2 + MB_ICONSTOP + MB_ABORTRETRYIGNORE, "Dialog title")</paragraph> +<paragraph id="par_idm1340829728" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010103.xhp b/helpcontent2/source/text/sbasic/shared/03010103.xhp new file mode 100644 index 000000000..c60a4925f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010103.xhp @@ -0,0 +1,97 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010103xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Print# Statement</title> + <filename>/text/sbasic/shared/03010103.xhp</filename> + </topic> +</meta> + +<body> + +<section id="print"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147230"> + <bookmark_value>Print statement</bookmark_value> + <bookmark_value>Print statement; Tab function</bookmark_value> + <bookmark_value>Print statement; Spc function</bookmark_value> + <bookmark_value>Spc function; in Print statement</bookmark_value> + <bookmark_value>Tab function; in Print statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3147230" xml-lang="en-US"><variable id="Print_h1"><link href="text/sbasic/shared/03010103.xhp" name="Print# Statement">Print# Statement</link></variable></h1> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">Outputs the specified strings or numeric expressions to the screen or to a sequential file.</paragraph> +</section> + +<tip id="par_id461596463969009">Use <link href="text/sbasic/shared/03020201.xhp">Put#</link> statement to write data to a binary or a random file. Use <link href="text/sbasic/shared/03020205.xhp">Write#</link> statement to write data to a sequential text file with delimiting characters.</tip> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="image" id="par_id841588605629842"><image src="media/helpimg/sbasic/Print_statement.svg" id="img_id931588605629842"><alt id="alt_id931588605629842">Print syntax</alt></image></paragraph> +<bascode> +<paragraph id="par_id3153188" role="bascode">Print [#filenum,] expression1[{;|,} [Spc(number As Integer);] [Tab(pos As Integer);] [expression2[...]] </paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id2508621" role="paragraph"> <emph>filenum:</emph> Any numeric expression that contains the file number that was set by the <literal>Open</literal> statement for the respective file.<comment>see i61758</comment></paragraph> +<paragraph id="par_id3163712" role="paragraph"> <emph>expression</emph>: Any numeric or string expression to be printed. Multiple expressions can be separated by a semicolon. If separated by a comma, the expressions are indented to the next tab stop. The tab stops cannot be adjusted.</paragraph> +<paragraph id="par_id3153092" role="paragraph"> <emph>number</emph>: Number of spaces to be inserted by the <emph>Spc</emph> function.</paragraph> +<paragraph id="par_id3145364" role="paragraph"> <emph>pos</emph>: Spaces are inserted until the specified position.</paragraph> +<paragraph id="par_id3154319" role="paragraph">If a semicolon or comma appears after the last expression to be printed, $[officename] Basic stores the text in an internal buffer and continues program execution without printing. When another Print statement without a semicolon or comma at the end is encountered, all text to be printed is printed at once.</paragraph> +<paragraph id="par_id3145272" role="paragraph">Positive numeric expressions are printed with a leading space. Negative expressions are printed with a leading minus sign. If a certain range is exceeded for floating-point values, the respective numeric expression is printed in exponential notation.</paragraph> +<paragraph id="par_id3154011" role="paragraph">If the expression to be printed exceeds a certain length, the display will automatically wrap to the next line.</paragraph> +<paragraph id="par_id3146969" role="note">You can insert the <emph>Tab</emph> function, enclosed by semicolons, between arguments to indent the output to a specific position, or you can use the <emph>Spc</emph> function to insert a specified number of spaces.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<switch select="sys"> +<case select="WIN"> +<bascode> +<paragraph id="par_idm1073161760" role="bascode" localize="false">Sub ExamplePrint</paragraph> +<paragraph id="par_idm1073160528" role="bascode" localize="false"> Print "ABC"</paragraph> +<paragraph id="par_idm1073159296" role="bascode" localize="false"> Print "ABC","123"</paragraph> +<paragraph id="par_idm1073129856" role="bascode" localize="false"> i = FreeFile()</paragraph> +<paragraph id="par_idm1073128624" role="bascode" localize="false"> Open "C:\Users\ThisUser\Temp.txt" For Output As i</paragraph> +<paragraph id="par_idm1073127376" role="bascode" localize="false"> Print #i, "ABC"</paragraph> +<paragraph id="par_idm1073126144" role="bascode" localize="false"> Close #i</paragraph> +<paragraph id="par_idm1073124912" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</case> +<default> +<bascode> +<paragraph id="par_idm1073122912" role="bascode" localize="false">Sub ExamplePrint</paragraph> +<paragraph id="par_idm1073121680" role="bascode" localize="false"> Print "ABC"</paragraph> +<paragraph id="par_idm1073120448" role="bascode" localize="false"> Print "ABC","123"</paragraph> +<paragraph id="par_idm1073119216" role="bascode" localize="false"> i = FreeFile()</paragraph> +<paragraph id="par_idm1073117984" role="bascode" localize="false"> Open "~/temp.txt" For Output As i</paragraph> +<paragraph id="par_idm1073116736" role="bascode" localize="false"> Print #i, "ABC"</paragraph> +<paragraph id="par_idm1073115504" role="bascode" localize="false"> Close #i</paragraph> +<paragraph id="par_idm1073114272" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</default> +</switch> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03020204.xhp#Put_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03020205.xhp#Write_h1"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010200.xhp b/helpcontent2/source/text/sbasic/shared/03010200.xhp new file mode 100644 index 000000000..73ea6aca3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010200.xhp @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03010200xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Functions for Screen Input</title> +<filename>/text/sbasic/shared/03010200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="input"> + <paragraph id="hd_id3149456" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010200.xhp" name="Functions for Screen Input">Functions for Screen Input</link></paragraph> + <paragraph role="paragraph" id="par_id3150398" xml-lang="en-US">This section describes Runtime functions used to control screen input.</paragraph> + </section> + <embed href="text/sbasic/shared/03010201.xhp#inputbox"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010201.xhp b/helpcontent2/source/text/sbasic/shared/03010201.xhp new file mode 100644 index 000000000..598129fc4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010201.xhp @@ -0,0 +1,69 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010201xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">InputBox Function</title> + <filename>/text/sbasic/shared/03010201.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="inputbox"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148932"> + <bookmark_value>InputBox function</bookmark_value> +</bookmark> + +<h1 id="hd_id3148932" xml-lang="en-US"><link href="text/sbasic/shared/03010201.xhp" name="InputBox Function">InputBox Function</link></h1> +<paragraph id="par_id3151262" role="paragraph" xml-lang="en-US">Displays a prompt in a dialog at which the user can input text. The input is assigned to a variable.</paragraph> +</section> +<paragraph id="par_id3151100" role="paragraph" xml-lang="en-US">The <emph>InputBox</emph> statement is a convenient method of entering text through a dialog. Confirm the input by clicking OK or pressing Return. The input is returned as the function return value. If you close the dialog with Cancel, <emph>InputBox</emph> returns a zero-length string ("").</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3159201" role="bascode" localize="false">InputBox (Prompt As String[, Title As String[, Default As String[, xpostwips As Integer, ypostwips As Integer]]]) As String</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<section id="parameters"> +<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US"> <emph>prompt</emph>: String expression displayed as the message in the dialog box.</paragraph> +<paragraph id="par_id3145315" role="paragraph" xml-lang="en-US"> <emph>title</emph>: String expression displayed in the title bar of the dialog box.</paragraph> +<paragraph id="par_id3154307" role="paragraph" xml-lang="en-US"> <emph>default</emph>: String expression displayed in the text box as default if no other input is given.</paragraph> +<paragraph id="par_id3147573" role="paragraph" xml-lang="en-US"> <emph>xpostwips</emph>: Integer expression that specifies the horizontal position of the dialog. The position is an absolute coordinate and does not refer to the window of %PRODUCTNAME.</paragraph> +<paragraph id="par_id3156024" role="paragraph" xml-lang="en-US"> <emph>ypostwips</emph>: Integer expression that specifies the vertical position of the dialog. The position is an absolute coordinate and does not refer to the window of %PRODUCTNAME.</paragraph> +<paragraph id="par_id3153897" role="paragraph" xml-lang="en-US">If <literal>xpostwips</literal> and <literal>ypostwips</literal> are omitted, the dialog is centered on the screen. The position is specified in <link href="text/sbasic/shared/00000002.xhp#twips" name="twips">twips</link>.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3145090" role="paragraph" xml-lang="en-US">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341285584" role="bascode" localize="false" xml-lang="en-US">Sub ExampleInputBox</paragraph> +<paragraph id="par_idm1341284352" role="bascode" localize="false" xml-lang="en-US">Dim sText As String</paragraph> +<paragraph id="par_id3154367" role="bascode" xml-lang="en-US"> sText = InputBox ("Please enter a phrase:","Dear User")</paragraph> +<paragraph id="par_id3151042" role="bascode" xml-lang="en-US"> MsgBox ( sText , 64, "Confirmation of phrase")</paragraph> +<paragraph id="par_idm1341279568" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03010300.xhp b/helpcontent2/source/text/sbasic/shared/03010300.xhp new file mode 100644 index 000000000..ee93251cd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010300.xhp @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03010300xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Color Functions</title> +<filename>/text/sbasic/shared/03010300.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="color"> + <h1 id="hd_id3157896"><link href="text/sbasic/shared/03010300.xhp" name="Color Functions">Color Functions</link></h1> + <paragraph role="paragraph" id="par_id3155555" xml-lang="en-US">This section describes Runtime functions used to define colors.</paragraph> + </section> + <embed href="text/sbasic/shared/03010301.xhp#blue"/> + <embed href="text/sbasic/shared/03010302.xhp#green"/> + <embed href="text/sbasic/shared/03010303.xhp#red"/> + <embed href="text/sbasic/shared/03010304.xhp#qbcolor"/> + <embed href="text/sbasic/shared/03010305.xhp#rgb"/> + <embed href="text/sbasic/shared/03010306.xhp#rgbvba"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010301.xhp b/helpcontent2/source/text/sbasic/shared/03010301.xhp new file mode 100644 index 000000000..c7a824885 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010301.xhp @@ -0,0 +1,69 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010301xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Blue Function</title> + <filename>/text/sbasic/shared/03010301.xhp</filename> + </topic> +</meta> + +<body> + +<section id="blue"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149180"> + <bookmark_value>Blue function</bookmark_value> +</bookmark> + +<h1 id="hd_id3149180"><link href="text/sbasic/shared/03010301.xhp" name="Blue Function">Blue Function</link></h1> +<paragraph id="par_id3156343" role="paragraph" xml-lang="en-US">Returns the blue component of the specified composite color code.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3149457" role="bascode" xml-lang="en-US">Blue (Color As Long)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3154365" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>Color value</emph>: Long integer expression that specifies any composite color code for which to return the blue component.</paragraph> +<warning id="par_id671639922129017">Under VBA compatibility mode (<link href="text/sbasic/shared/03103350.xhp" name="vbasupport"><literal>Option VBASupport 1</literal></link>), the function Blue() is incompatible with VBA colors, when color from previous call to <link href="text/sbasic/shared/03010306.xhp" name="linkrgbvba"><literal>function RGB [VBA]</literal></link> is passed. +</warning> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/03010303.xhp#ColorPickerDialog"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1073171488" role="bascode" localize="false" xml-lang="en-US">Sub ExampleColor</paragraph> +<paragraph id="par_idm1073170256" role="bascode" localize="false" xml-lang="en-US">Dim lVar As Long</paragraph> +<paragraph id="par_idm1073169024" role="bascode" localize="false" xml-lang="en-US"> lVar = rgb(128,0,200)</paragraph> +<paragraph id="par_id3154012" role="bascode" xml-lang="en-US"> MsgBox "The color " & lVar & " consists of:" & Chr(13) &_</paragraph> +<paragraph id="par_id3148645" role="bascode" xml-lang="en-US"> "red= " & Red(lVar) & Chr(13)&_</paragraph> +<paragraph id="par_id3159155" role="bascode" xml-lang="en-US"> "green= " & Green(lVar) & Chr(13)&_</paragraph> +<paragraph id="par_id3147319" role="bascode" xml-lang="en-US"> "blue= " & Blue(lVar) & Chr(13) , 64,"colors"</paragraph> +<paragraph id="par_idm1073160528" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010302.xhp b/helpcontent2/source/text/sbasic/shared/03010302.xhp new file mode 100644 index 000000000..752ffc517 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010302.xhp @@ -0,0 +1,68 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010302xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Green Function</title> + <filename>/text/sbasic/shared/03010302.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="green"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148947"> + <bookmark_value>Green function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3148947"><link href="text/sbasic/shared/03010302.xhp" name="Green Function">Green Function</link></h1> +<paragraph id="par_id3153361" role="paragraph" xml-lang="en-US">Returns the Green component of the given composite color code.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3153969" role="bascode" xml-lang="en-US">Green (Color As Long)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3153194" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153770" role="paragraph" xml-lang="en-US"> <emph>Color</emph>: Long integer expression that specifies a composite color code for which to return the Green component.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/03010303.xhp#ColorPickerDialog"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341170976" role="bascode" localize="false" xml-lang="en-US">Sub ExampleColor</paragraph> +<paragraph id="par_idm1341169744" role="bascode" localize="false" xml-lang="en-US">Dim lVar As Long</paragraph> +<paragraph id="par_idm1341168512" role="bascode" localize="false" xml-lang="en-US"> lVar = rgb(128,0,200)</paragraph> +<paragraph id="par_id3151117" role="bascode" xml-lang="en-US"> MsgBox "The color " & lVar & " contains the components:" & Chr(13) &_</paragraph> +<paragraph id="par_id3153951" role="bascode" xml-lang="en-US"> "red = " & red(lVar) & Chr(13)&_</paragraph> +<paragraph id="par_id3152462" role="bascode" xml-lang="en-US"> "green = " & green(lVar) & Chr(13)&_</paragraph> +<paragraph id="par_id3154730" role="bascode" xml-lang="en-US"> "blue = " & blue(lVar) & Chr(13) , 64,"colors"</paragraph> +<paragraph id="par_idm1341159952" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010303.xhp b/helpcontent2/source/text/sbasic/shared/03010303.xhp new file mode 100644 index 000000000..361a1e747 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010303.xhp @@ -0,0 +1,72 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010303xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Red Function</title> + <filename>/text/sbasic/shared/03010303.xhp</filename> + </topic> +</meta> + +<body> + +<section id="red"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148947"> + <bookmark_value>Red function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3148947"><link href="text/sbasic/shared/03010303.xhp" name="Red Function">Red Function</link></h1> +<paragraph id="par_id3149656" role="paragraph" xml-lang="en-US">Returns the Red component of the specified composite color code.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3150448" role="bascode" xml-lang="en-US">Red (ColorNumber As Long)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3145173" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150440" role="paragraph" xml-lang="en-US"> <emph>ColorNumber</emph>: Long integer expression that specifies any composite color code for which to return the Red component.</paragraph> +<warning id="par_id671639922129017">Under VBA compatibility mode (<link href="text/sbasic/shared/03103350.xhp" name="vbasupport"><literal>Option VBASupport 1</literal></link>), the function Red() is incompatible with VBA colors, when color from previous call to <link href="text/sbasic/shared/03010306.xhp" name="linkrgbvba"><literal>function RGB [VBA]</literal></link> is passed. +</warning> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<section id="ColorPickerDialog"> + <tip id="par_id961588421825749">The <link href="text/shared/optionen/01010501.xhp" name="color picker dialog">color picker dialog</link> details the red, green and blue components of a composite color code, as well as its hexadecimal expression. <link href="text/shared/guide/text_color.xhp" name="Changing the color of text">Changing the color of text</link> and selecting <emph>Custom color</emph> displays the color picker dialog.</tip> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341092848" role="bascode" localize="false" xml-lang="en-US">Sub ExampleColor</paragraph> +<paragraph id="par_idm1341091616" role="bascode" localize="false" xml-lang="en-US">Dim lVar As Long</paragraph> +<paragraph id="par_idm1341090384" role="bascode" localize="false" xml-lang="en-US"> lVar = rgb(128,0,200)</paragraph> +<paragraph id="par_id3147435" role="bascode" xml-lang="en-US"> MsgBox "The color " & lVar & " consists of:" & Chr(13) &_</paragraph> +<paragraph id="par_id3155306" role="bascode" xml-lang="en-US"> "red= " & red(lVar) & Chr(13)&_</paragraph> +<paragraph id="par_id3149262" role="bascode" xml-lang="en-US"> "green= " & green(lVar) & Chr(13)&_</paragraph> +<paragraph id="par_id3147397" role="bascode" xml-lang="en-US"> "blue= " & blue(lVar) & Chr(13) , 64,"colors"</paragraph> +<paragraph id="par_idm1341081888" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010304.xhp b/helpcontent2/source/text/sbasic/shared/03010304.xhp new file mode 100644 index 000000000..78ad9233d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010304.xhp @@ -0,0 +1,80 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010304xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">QBColor Function</title> + <filename>/text/sbasic/shared/03010304.xhp</filename> + </topic> +</meta> + +<body> + +<section id="qbcolor"> +<bookmark xml-lang="en-US" branch="index" id="bm_id201546205404067"> + <bookmark_value>QBColor function</bookmark_value> +</bookmark> + +<h1 id="hd_id3149670"><link href="text/sbasic/shared/03010304.xhp" name="QBColor Function">QBColor Function</link></h1> +<paragraph id="par_id3150359" role="paragraph" xml-lang="en-US">Returns the <link href="text/sbasic/shared/03010305.xhp" name="RGB">RGB</link> color code of the color passed as a color value through an older MS-DOS based programming system.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3151042" role="code" xml-lang="en-US">QBColor (ColorNumber As Integer)</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3154685" localize="false" role="paragraph" xml-lang="en-US">Long</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3161832" role="paragraph" xml-lang="en-US"> <emph>ColorNumber</emph>: Any integer expression that specifies the color value of the color passed from an older MS-DOS based programming system.</paragraph> +<paragraph id="par_id3147318" role="paragraph" xml-lang="en-US"> <emph>ColorNumber</emph> can be assigned the following values:</paragraph> +<paragraph id="par_id3152576" role="paragraph" xml-lang="en-US">0 : Black</paragraph> +<paragraph id="par_id3146975" role="paragraph" xml-lang="en-US">1 : Blue</paragraph> +<paragraph id="par_id3151116" role="paragraph" xml-lang="en-US">2 : Green</paragraph> +<paragraph id="par_id3155412" role="paragraph" xml-lang="en-US">3 : Cyan</paragraph> +<paragraph id="par_id3155306" role="paragraph" xml-lang="en-US">4 : Red</paragraph> +<paragraph id="par_id3153364" role="paragraph" xml-lang="en-US">5 : Magenta</paragraph> +<paragraph id="par_id3146119" role="paragraph" xml-lang="en-US">6 : Yellow</paragraph> +<paragraph id="par_id3154730" role="paragraph" xml-lang="en-US">7 : White</paragraph> +<paragraph id="par_id3153877" role="paragraph" xml-lang="en-US">8 : Gray</paragraph> +<paragraph id="par_id3147124" role="paragraph" xml-lang="en-US">9 : Light Blue</paragraph> +<paragraph id="par_id3145646" role="paragraph" xml-lang="en-US">10 : Light Green</paragraph> +<paragraph id="par_id3149958" role="paragraph" xml-lang="en-US">11 : Light Cyan</paragraph> +<paragraph id="par_id3154943" role="paragraph" xml-lang="en-US">12 : Light Red</paragraph> +<paragraph id="par_id3150715" role="paragraph" xml-lang="en-US">13 : Light Magenta</paragraph> +<paragraph id="par_id3146970" role="paragraph" xml-lang="en-US">14 : Light Yellow</paragraph> +<paragraph id="par_id3150750" role="paragraph" xml-lang="en-US">15 : Bright White</paragraph> +<paragraph id="par_id3146914" role="paragraph" xml-lang="en-US">This function is used only to convert from older MS-DOS based BASIC applications that use the above color codes. The function returns a long integer value indicating the color to be used in the $[officename] IDE.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341247424" role="bascode" localize="false" xml-lang="en-US">Sub ExampleQBColor</paragraph> +<paragraph id="par_idm1341246192" role="bascode" localize="false" xml-lang="en-US">Dim iColor As Integer</paragraph> +<paragraph id="par_idm1341244960" role="bascode" localize="false" xml-lang="en-US">Dim sText As String</paragraph> +<paragraph id="par_idm1341243728" role="bascode" localize="false" xml-lang="en-US"> iColor = 7</paragraph> +<paragraph id="par_idm1341242496" role="bascode" localize="false" xml-lang="en-US"> sText = "RGB= " & Red(QBColor( iColor) ) & ":" & Blue(QBColor( iColor) ) & ":" & Green(QBColor( iColor) )</paragraph> +<paragraph id="par_id3149566" role="bascode" xml-lang="en-US"> MsgBox stext,0,"Color " & iColor</paragraph> +<paragraph id="par_idm1341239392" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010305.xhp b/helpcontent2/source/text/sbasic/shared/03010305.xhp new file mode 100644 index 000000000..6978f49a7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010305.xhp @@ -0,0 +1,81 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010305xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">RGB Function</title> + <filename>/text/sbasic/shared/03010305.xhp</filename> + </topic> +</meta> + +<body> +<section id="rgb"> +<bookmark xml-lang="en-US" branch="index" id="bm_id851576768070903"> + <bookmark_value>RGB function</bookmark_value> +</bookmark> + +<h1 id="hd_id3150792"><link href="text/sbasic/shared/03010305.xhp" name="RGB Function">RGB Function</link></h1> + <paragraph id="par_id3150447" role="paragraph" xml-lang="en-US">Returns a <literal>Long</literal> integer color value consisting of red, green, and blue components.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3155132" role="bascode" xml-lang="en-US">RGB (Red, Green, Blue)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3159153" localize="false" role="paragraph" xml-lang="en-US">Long</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<section id="parameters"> +<section id="parameters1"> +<paragraph id="par_id3152597" role="paragraph" xml-lang="en-US"> <emph>red</emph>: Any integer expression that represents the red component (0-255) of the composite color.</paragraph> +<paragraph id="par_id3146974" role="paragraph" xml-lang="en-US"> <emph>green</emph>: Any integer expression that represents the green component (0-255) of the composite color.</paragraph> +<paragraph id="par_id3151113" role="paragraph" xml-lang="en-US"> <emph>blue</emph>: Any integer expression that represents the blue component (0-255) of the composite color.</paragraph> +</section> +<paragraph role="paragraph" id="par_id101639922410794">The resulting <literal>Long</literal> value is calculated with the following formula:<br/> +<literal>Result = red×65536 + green×256 + blue</literal>. +</paragraph> +<warning id="par_id671639922129017">Under VBA compatibility mode (<link href="text/sbasic/shared/03103350.xhp" name="vbasupport"><literal>Option VBASupport 1</literal></link>), the <literal>Long</literal> value is calculated as +<br/> +<literal>Result = red + green×256 + blue×65536</literal><br/> +See <link href="text/sbasic/shared/03010306.xhp" name="rgbvba">RGB Function [VBA]</link> +</warning> + +<tip id="par_id211587653651037">The <link href="text/shared/optionen/01010501.xhp" name="color picker dialog">color picker dialog</link> helps computing red, green and blue components of a composite color. <link href="text/shared/guide/text_color.xhp" name="Changing the color of text">Changing the color of text</link> and selecting <emph>Custom color</emph> displays the color picker dialog.</tip> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340938032" role="bascode" localize="false" xml-lang="en-US">Sub ExampleColor</paragraph> +<paragraph id="par_idm1340936800" role="bascode" localize="false" xml-lang="en-US">Dim lVar As Long</paragraph> +<paragraph id="par_idm1340935568" role="bascode" localize="false" xml-lang="en-US"> lVar = rgb(128,0,200)</paragraph> +<paragraph id="par_id3145647" role="bascode" xml-lang="en-US"> MsgBox "The color " & lVar & " consists of:" & Chr(13) &_</paragraph> +<paragraph id="par_id3154491" role="bascode" xml-lang="en-US"> "red= " & red(lVar) & Chr(13)&_</paragraph> +<paragraph id="par_id3149401" role="bascode" xml-lang="en-US"> "green= " & green(lVar) & Chr(13)&_</paragraph> +<paragraph id="par_id3150716" role="bascode" xml-lang="en-US"> "blue= " & blue(lVar) & Chr(13) , 64,"colors"</paragraph> +<paragraph id="par_idm1340927072" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03010306.xhp b/helpcontent2/source/text/sbasic/shared/03010306.xhp new file mode 100644 index 000000000..9dacef585 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03010306.xhp @@ -0,0 +1,68 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03010305xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">RGB Function [VBA]</title> + <filename>/text/sbasic/shared/03010306.xhp</filename> + </topic> +</meta> + +<body> + +<section id="rgbvba"> +<bookmark xml-lang="en-US" branch="index" id="bm_id851576768070903"> + <bookmark_value>RGB function [VBA]</bookmark_value> +</bookmark> + +<h1 id="hd_id3150792"><link href="text/sbasic/shared/03010305.xhp" name="RGB Function">RGB Function [VBA]</link></h1> +<paragraph id="par_id3150447" role="paragraph" xml-lang="en-US">Returns a <literal>Long</literal> integer color value consisting of red, green, and blue components, according to VBA color formula.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3155132" localize="false" role="bascode" xml-lang="en-US">RGB (Red, Green, Blue)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3159153" localize="false" role="paragraph" xml-lang="en-US">Long</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<embed href="text/sbasic/shared/03010305.xhp#parameters1"/> +<warning id="par_id671639922129017">Because of the VBA compatibility mode (<link href="text/sbasic/shared/03103350.xhp" name="vbasupport"><literal>Option VBASupport 1</literal></link>), the <literal>Long</literal> value is calculated as<br/> +<literal>Result = red + green×256 + blue×65536</literal>. +</warning> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="par_id551639925302816" xml-lang="en-US" localize="false">Option VBASupport 1</paragraph> +<paragraph id="par_idm1340938032" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRGBVBA</paragraph> +<paragraph id="par_idm1340936800" role="bascode" localize="false" xml-lang="en-US">Dim lVar As Long</paragraph> +<paragraph id="par_idm1340935568" role="bascode" localize="false" xml-lang="en-US"> lVar = rgb(128,0,200)</paragraph> +<paragraph role="bascode" id="par_id621639924528952" xml-lang="en-US" > Print lVar; ' returns 13107328</paragraph> +<paragraph id="par_idm1340927072" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020000.xhp b/helpcontent2/source/text/sbasic/shared/03020000.xhp new file mode 100644 index 000000000..e036d774f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020000.xhp @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> + <topic id="textsbasicshared03020000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">File I/O Functions</title> + <filename>/text/sbasic/shared/03020000.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> +</meta> +<body> +<section id="file_IO"> + <paragraph role="heading" id="hd_id3156344" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03020000.xhp" name="File I/O Functions">File I/O Functions</link></paragraph> + <paragraph role="paragraph" id="par_id3153360" xml-lang="en-US">Use File I/O functions to create and manage user-defined (data) files.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3150398" xml-lang="en-US">You can use these functions to support the creation of "relative" files, so that you can save and reload certain records by specifying their record number. File I/O functions can also help you manage your files by providing you with information such as file size, current path settings, or the creation date of a file or a directory.</paragraph> +<embed href="text/sbasic/shared/03020401.xhp#SF_FileSystem_Note"/> +<embed href="text/sbasic/shared/03020100.xhp#opening"/> +<embed href="text/sbasic/shared/03020200.xhp#file_IO"/> +<embed href="text/sbasic/shared/03020400.xhp#organisation"/> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/> + <embed href="text/sbasic/shared/03/sf_textstream.xhp#TextStreamService"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020100.xhp b/helpcontent2/source/text/sbasic/shared/03020100.xhp new file mode 100644 index 000000000..762a63e80 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020100.xhp @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03020100xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Opening and Closing Files</title> +<filename>/text/sbasic/shared/03020100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="opening"> +<paragraph role="heading" id="hd_id3152924" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03020100.xhp" name="Opening and Closing Files">Opening and Closing Files</link></paragraph> +</section> +<embed href="text/sbasic/shared/03020101.xhp#close"/> +<embed href="text/sbasic/shared/03020102.xhp#freefile"/> +<embed href="text/sbasic/shared/03020103.xhp#open"/> +<embed href="text/sbasic/shared/03020104.xhp#reset"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020101.xhp b/helpcontent2/source/text/sbasic/shared/03020101.xhp new file mode 100644 index 000000000..78cb1907f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020101.xhp @@ -0,0 +1,60 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020101xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Close Statement</title> + <filename>/text/sbasic/shared/03020101.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="close"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3157896"> + <bookmark_value>Close statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3157896"><variable id="Close_h1"><link href="text/sbasic/shared/03020101.xhp" name="Close Statement">Close Statement</link></variable></h1> +<paragraph id="par_id3147573" role="paragraph" xml-lang="en-US">Closes a specified file that was opened with the Open statement.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Close_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Close Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3147265" role="bascode" xml-lang="en-US">Close [[#]fileNum [, [#]fileNum2 [,...]]]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150791" role="paragraph" xml-lang="en-US"> <emph>fileNum:</emph> Any integer expression that specifies the number of the data channel that was opened with the <emph>Open</emph> statement.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03020103.xhp#FileExample"/> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03020102.xhp#FreeFile_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020102.xhp b/helpcontent2/source/text/sbasic/shared/03020102.xhp new file mode 100644 index 000000000..d906b6319 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020102.xhp @@ -0,0 +1,64 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020102xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FreeFile Function</title> + <filename>/text/sbasic/shared/03020102.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="freefile"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150400"> + <bookmark_value>FreeFile function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150400" role="heading" level="1" xml-lang="en-US"><variable id="FreeFile_h1"><link href="text/sbasic/shared/03020102.xhp" name="FreeFile Function">FreeFile Function</link></variable></paragraph> +<paragraph id="par_id3154366" role="paragraph" xml-lang="en-US">Returns the next available file number for opening a file. Use this function to open a file using a file number that is not already in use by a currently open file.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_idm1341602048" role="bascode" localize="false" xml-lang="en-US">FreeFile</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150440" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3155854" role="paragraph" xml-lang="en-US">This function can only be used immediately in front of an Open statement. FreeFile returns the next available file number, but does not reserve it.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err67"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03020103.xhp#FileExample"/> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020103.xhp b/helpcontent2/source/text/sbasic/shared/03020103.xhp new file mode 100644 index 000000000..ddf55d217 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020103.xhp @@ -0,0 +1,128 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020103xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Open Statement</title> + <filename>/text/sbasic/shared/03020103.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="open"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150791"> + <bookmark_value>Open statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3150791"><variable id="Open_h1"><link href="text/sbasic/shared/03020103.xhp" name="Open Statement">Open Statement</link></variable></h1> +<paragraph id="par_id3150769" role="paragraph" xml-lang="en-US">Opens a data channel.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Open_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Open Statement diagram</alt></image> +</paragraph> +<paragraph role="paragraph" id="par_id971587473488702"> + <image src="media/helpimg/sbasic/access_fragment.svg" id="img_id4156296484515"><alt xml-lang="en-US" id="alt_id15152796484515">access fragment diagram</alt></image> +</paragraph> +<paragraph role="paragraph" id="par_id971587473488703"> + <image src="media/helpimg/sbasic/locking_fragment.svg" id="img_id4156296484516"><alt xml-lang="en-US" id="alt_id15152796484516">locking fragment diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3154124" localize="false" role="bascode">Open pathname For mode [Access io] [locking] As [#]filenum [Len=recLen]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3155132" role="paragraph" xml-lang="en-US"> <emph>pathname: </emph>Path and name of the file to open. If you try to read a file that does not exist (Access = Read), an error message appears. If you try to write to a file that does not exist (Access = Write), a new file is created.</paragraph> +<paragraph id="par_id3149262" role="paragraph" xml-lang="en-US"> <emph>mode:</emph> Keyword that specifies the file mode. Valid values: <literal>Append</literal> (append to sequential file), <literal>Binary</literal> (data can be accessed by bytes using Get and Put), <literal>Input</literal> (opens data channel for reading), <literal>Output</literal> (opens data channel for writing), and <literal>Random</literal> (edits relative files).</paragraph> +<paragraph id="par_id3154014" role="paragraph" xml-lang="en-US"> <emph>io:</emph> Keyword that defines the access type. Valid values: <literal>Read</literal> (read-only), <literal>Write</literal> (write-only), <literal>Read Write</literal> (both).</paragraph> +<paragraph id="par_id3150011" role="paragraph" xml-lang="en-US"> <emph>locking:</emph> Keyword that defines the security status of a file after opening. Valid values: <literal>Shared</literal> (file may be opened by other applications), <literal>Lock Read</literal> (file is protected against reading), <literal>Lock Write</literal> (file is protected against writing), <literal>Lock Read Write</literal> (denies file access).</paragraph> +<paragraph id="par_id3153190" role="paragraph" xml-lang="en-US"> <emph>filenum:</emph> Any integer expression from 0 to 511 to indicate the number of a free data channel. You can then pass commands through the data channel to access the file. The file number must be determined by the FreeFile function immediately before the Open statement.</paragraph> + <paragraph id="par_id3151115" role="paragraph" xml-lang="en-US"> <emph>recLen:</emph> For <literal>Random</literal> access files, set the length of the records.<comment>#61736</comment></paragraph> +<note id="par_id3153418">You can only modify the contents of a file that was opened with the Open statement. If you try to open a file that is already open, an error message appears.</note> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<section id="FileExample"> +<switch select="sys"> +<case select="WIN"> + <bascode> + <paragraph id="par_idm1341597584" role="bascode" localize="false">Sub ExampleWorkWithAFile</paragraph> + <paragraph id="par_idm1341596336" role="bascode" localize="false"> Dim iNumber As Integer</paragraph> + <paragraph id="par_idm1341595104" role="bascode" localize="false"> Dim sLine As String</paragraph> + <paragraph id="par_idm1341593872" role="bascode" localize="false"> Dim aFile As String</paragraph> + <paragraph id="par_idm1341592640" role="bascode" localize="false"> Dim sMsg As String</paragraph> + <paragraph id="par_idm1341591408" role="bascode" localize="false"> aFile = "C:\Users\ThisUser\data.txt"</paragraph> + <paragraph id="par_idm1341590160" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1341588928" role="bascode" localize="false"> Open aFile For Output As #iNumber</paragraph> + <paragraph id="par_id3154705" role="bascode" xml-lang="en-US"> Print #iNumber, "This is a line of text"</paragraph> + <paragraph id="par_id3146916" role="bascode" xml-lang="en-US"> Print #iNumber, "This is another line of text"</paragraph> + <paragraph id="par_idm1341584144" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1341582912" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1341581680" role="bascode" localize="false"> Open aFile For Input As iNumber</paragraph> + <paragraph id="par_idm1341580432" role="bascode" localize="false"> While Not eof(iNumber)</paragraph> + <paragraph id="par_idm1341579184" role="bascode" localize="false"> Line Input #iNumber, sLine</paragraph> + <paragraph id="par_idm1341577936" role="bascode" localize="false"> If sLine <>"" Then</paragraph> + <paragraph id="par_idm1341576688" role="bascode" localize="false"> sMsg = sMsg & sLine & chr(13)</paragraph> + <paragraph id="par_idm1341575424" role="bascode" localize="false"> End If</paragraph> + <paragraph id="par_idm1341574192" role="bascode" localize="false"> Wend</paragraph> + <paragraph id="par_idm1341572960" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1341571728" role="bascode" localize="false"> MsgBox sMsg</paragraph> + <paragraph id="par_idm1341570496" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</case> +<default> + <bascode> + <paragraph id="par_idm1341597147" role="bascode" localize="false">Sub ExampleWorkWithAFile</paragraph> + <paragraph id="par_idm1341596754" role="bascode" localize="false"> Dim iNumber As Integer</paragraph> + <paragraph id="par_idm1341542504" role="bascode" localize="false"> Dim sLine As String</paragraph> + <paragraph id="par_idm1341593122" role="bascode" localize="false"> Dim aFile As String</paragraph> + <paragraph id="par_idm1340442640" role="bascode" localize="false"> Dim sMsg As String</paragraph> + <paragraph id="par_idm1341591014" role="bascode" localize="false"> aFile = "~/data.txt"</paragraph> + <paragraph id="par_idm1341255160" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1341581338" role="bascode" localize="false"> Open aFile For Output As #iNumber</paragraph> + <paragraph id="par_id3154705125" role="bascode" xml-lang="en-US"> Print #iNumber, "This is a line of text"</paragraph> + <paragraph id="par_id3146916877" role="bascode" xml-lang="en-US"> Print #iNumber, "This is another line of text"</paragraph> + <paragraph id="par_idm1341584244" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1341583242" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1341587410" role="bascode" localize="false"> Open aFile For Input As iNumber</paragraph> + <paragraph id="par_idm1341598532" role="bascode" localize="false"> While Not eof(iNumber)</paragraph> + <paragraph id="par_idm1341572054" role="bascode" localize="false"> Line Input #iNumber, sLine</paragraph> + <paragraph id="par_idm1341906936" role="bascode" localize="false"> If sLine <>"" Then</paragraph> + <paragraph id="par_idm1341514488" role="bascode" localize="false"> sMsg = sMsg & sLine & chr(13)</paragraph> + <paragraph id="par_idm1341233424" role="bascode" localize="false"> End If</paragraph> + <paragraph id="par_idm1341575882" role="bascode" localize="false"> Wend</paragraph> + <paragraph id="par_idm1341906960" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1341576638" role="bascode" localize="false"> MsgBox sMsg</paragraph> + <paragraph id="par_idm1341514496" role="bascode" localize="false">End Sub</paragraph> + </bascode> +</default> +</switch> +</section> +<note id="par_id211617107328022">If the <literal>Open</literal> statement tries to open a file to which the current user does not have read/write permissions, an I/O error will be raised.</note> +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03020102.xhp#FreeFile_h1"/> + <embed href="text/sbasic/shared/03020202.xhp#Input_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020104.xhp b/helpcontent2/source/text/sbasic/shared/03020104.xhp new file mode 100644 index 000000000..9d09da144 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020104.xhp @@ -0,0 +1,81 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020104xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Reset Statement</title> + <filename>/text/sbasic/shared/03020104.xhp</filename> + </topic> +</meta> + +<body> + +<section id="reset"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154141"> + <bookmark_value>Reset statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3154141"><variable id="Reset_h1"><link href="text/sbasic/shared/03020104.xhp">Reset Statement</link></variable></h1> +<paragraph id="par_id3156423" role="paragraph" xml-lang="en-US">Closes all open files and writes the contents of all file buffers to the harddisk.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Reset_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Reset Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_idm1207263392" role="bascode" localize="false">Reset</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1207260032" role="bascode" localize="false">Sub ExampleReset</paragraph> +<paragraph id="par_idm1207243568" role="bascode" localize="false">On Error GoTo ErrorHandler</paragraph> +<paragraph id="par_idm1207242464" role="bascode" localize="false"> Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1207241360" role="bascode" localize="false"> Dim iCount As Integer</paragraph> +<paragraph id="par_idm1207240256" role="bascode" localize="false"> Dim sLine As String</paragraph> +<paragraph id="par_idm1207239152" role="bascode" localize="false"> Dim aFile As String</paragraph> +<paragraph id="par_idm1207238048" role="bascode" localize="false"> aFile = "C:\Users\ThisUser\data.txt"</paragraph> +<paragraph id="par_idm1207236896" role="bascode" localize="false"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1207235792" role="bascode" localize="false"> Open aFile For Output As #iNumber</paragraph> +<paragraph id="par_id3148455" role="bascode" xml-lang="en-US"> Print #iNumber, "This is a new line of text"</paragraph> +<paragraph id="par_idm1207232992" role="bascode" localize="false"> Close #iNumber</paragraph> +<paragraph id="par_idm1207231888" role="bascode" localize="false"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1207230784" role="bascode" localize="false"> Open aFile For Input As iNumber</paragraph> +<paragraph id="par_idm1207229632" role="bascode" localize="false"> For iCount = 1 To 5</paragraph> +<paragraph id="par_idm1207228528" role="bascode" localize="false"> Line Input #iNumber, sLine</paragraph> +<paragraph id="par_idm1207227376" role="bascode" localize="false"> If sLine <>"" Then</paragraph> +<paragraph id="par_idm1207226224" role="bascode" localize="false"> Rem</paragraph> +<paragraph id="par_idm1207225120" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1207224016" role="bascode" localize="false"> Next iCount</paragraph> +<paragraph id="par_idm1207222912" role="bascode" localize="false"> Close #iNumber</paragraph> +<paragraph id="par_idm1207221808" role="bascode" localize="false"> Exit Sub</paragraph> +<paragraph id="par_idm1207220704" role="bascode" localize="false">ErrorHandler:</paragraph> +<paragraph id="par_idm1207219600" role="bascode" localize="false"> Reset</paragraph> +<paragraph id="par_id3163805" role="bascode" xml-lang="en-US"> MsgBox "All files will be closed", 0, "Error"</paragraph> +<paragraph id="par_idm1207216848" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020200.xhp b/helpcontent2/source/text/sbasic/shared/03020200.xhp new file mode 100644 index 000000000..2ae72fee0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020200.xhp @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03020200xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">File Input/Output Functions</title> +<filename>/text/sbasic/shared/03020200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="file_IO"> +<paragraph role="heading" id="hd_id3150791" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03020200.xhp" name="File Input/Output Functions">File Input/Output Functions</link></paragraph> +</section> +<embed href="text/sbasic/shared/03020201.xhp#get"/> +<embed href="text/sbasic/shared/03020202.xhp#input"/> +<embed href="text/sbasic/shared/03020203.xhp#lineinput"/> +<embed href="text/sbasic/shared/03020204.xhp#put"/> +<embed href="text/sbasic/shared/03020205.xhp#write"/> +<embed href="text/sbasic/shared/03020302.xhp#loc"/> +<embed href="text/sbasic/shared/03020304.xhp#seek"/> +<embed href="text/sbasic/shared/03020301.xhp#eof"/> +<embed href="text/sbasic/shared/03020303.xhp#lof"/><comment>see i61245</comment> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020201.xhp b/helpcontent2/source/text/sbasic/shared/03020201.xhp new file mode 100644 index 000000000..300451363 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020201.xhp @@ -0,0 +1,125 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020201xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Get Statement</title> + <filename>/text/sbasic/shared/03020201.xhp</filename> + </topic> +</meta> + +<body> + +<section id="get"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154927"> + <bookmark_value>Get statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3154927"><variable id="Get_h1"><link href="text/sbasic/shared/03020201.xhp">Get Statement</link></variable></h1> +<paragraph id="par_id3145069" role="paragraph" xml-lang="en-US">Reads a record from a relative file, or a sequence of bytes from a binary file, into a variable.</paragraph> +</section> +<paragraph id="par_id3154346" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03020204.xhp" name="PUT"><item type="literal">PUT</item></link> Statement</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Get_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Get Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3150792" role="bascode" xml-lang="en-US">Get [#]fileNum, [recordNum|filePos], variable</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>fileNum:</emph> Any integer expression that determines the file number.</paragraph> +<paragraph id="par_id3154684" role="paragraph" xml-lang="en-US"> <emph>recordNum:</emph> For files opened in Random mode, <emph>recordNum</emph> is the number of the record that you want to read.</paragraph> +<paragraph id="par_id3153768" role="paragraph" xml-lang="en-US">For files opened in Binary mode, <emph>filePos</emph> is the byte position in the file where the reading starts.</paragraph> +<paragraph id="par_id3147319" role="paragraph" xml-lang="en-US">If <emph>recordNum</emph> and <emph>filePos</emph> are omitted, the current position or the current data record of the file is used.</paragraph> +<paragraph id="par_id3149484" role="paragraph" xml-lang="en-US"><emph>variable:</emph> Name of the variable to be read. With the exception of object variables, you can use any variable type.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<section id="ExampleRandomAccess"> +<switch select="sys"> +<case select="WIN"> + <bascode> + <paragraph id="par_idm1340774864" role="bascode" localize="false">Sub ExampleRandomAccess</paragraph> + <paragraph id="par_idm1340773632" role="bascode" localize="false"> Dim iNumber As Integer</paragraph> + <paragraph id="par_id3155307" role="bascode" xml-lang="en-US"> Dim sText As Variant ' Must be a variant</paragraph> + <paragraph id="par_idm1340770608" role="bascode" localize="false"> Dim aFile As String</paragraph> + <paragraph id="par_idm1340769376" role="bascode" localize="false"> aFile = "C:\Users\ThisUser\data.txt"</paragraph> + <paragraph id="par_idm1340768128" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1340766896" role="bascode" localize="false"> Open aFile For Random As #iNumber Len=32</paragraph> + <paragraph id="par_id3149411" role="bascode" xml-lang="en-US"> Seek #iNumber,1 ' Position at beginning</paragraph> + <paragraph id="par_id3153158" role="bascode" xml-lang="en-US"> Put #iNumber, , "This is the first line of text" ' Fill line with text</paragraph> + <paragraph id="par_id3148457" role="bascode" xml-lang="en-US"> Put #iNumber, , "This is the second line of text"</paragraph> + <paragraph id="par_id3150715" role="bascode" xml-lang="en-US"> Put #iNumber, , "This is the third line of text"</paragraph> + <paragraph id="par_idm1340758576" role="bascode" localize="false"> Seek #iNumber,2</paragraph> + <paragraph id="par_idm1340757344" role="bascode" localize="false"> Get #iNumber, , sText</paragraph> + <paragraph id="par_idm1340756112" role="bascode" localize="false"> Print sText</paragraph> + <paragraph id="par_idm1340754880" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1340753648" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1340752416" role="bascode" localize="false"> Open aFile For Random As #iNumber Len=32</paragraph> + <paragraph id="par_idm1340751152" role="bascode" localize="false"> Get #iNumber, 2, sText</paragraph> + <paragraph id="par_id3155938" role="bascode" xml-lang="en-US"> Put #iNumber, , "This is a new text"</paragraph> + <paragraph id="par_idm1340748176" role="bascode" localize="false"> Get #iNumber, 1, sText</paragraph> + <paragraph id="par_idm1340746928" role="bascode" localize="false"> Get #iNumber, 2, sText</paragraph> + <paragraph id="par_id3146916" role="bascode" xml-lang="en-US"> Put #iNumber, 20, "This is the text in record 20"</paragraph> + <paragraph id="par_idm1340743936" role="bascode" localize="false"> Print Lof(#iNumber)</paragraph> + <paragraph id="par_idm1340742704" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1340741472" role="bascode" localize="false">End Sub</paragraph> + </bascode> +</case> +<default> + <bascode> + <paragraph id="par_idm1340774104" role="bascode" localize="false">Sub ExampleRandomAccess</paragraph> + <paragraph id="par_idm1340773774" role="bascode" localize="false"> Dim iNumber As Integer</paragraph> + <paragraph id="par_id31553071450" role="bascode" xml-lang="en-US"> Dim sText As Variant ' Must be a variant</paragraph> + <paragraph id="par_idm1340770200" role="bascode" localize="false"> Dim aFile As String</paragraph> + <paragraph id="par_idm1340769147" role="bascode" localize="false"> aFile = "~/data.txt"</paragraph> + <paragraph id="par_idm1340768732" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1340766055" role="bascode" localize="false"> Open aFile For Random As #iNumber Len=32</paragraph> + <paragraph id="par_id31494111458" role="bascode" xml-lang="en-US"> Seek #iNumber,1 ' Position at beginning</paragraph> + <paragraph id="par_id31531583325" role="bascode" xml-lang="en-US"> Put #iNumber, , "This is the first line of text" ' Fill line with text</paragraph> + <paragraph id="par_id31484574785" role="bascode" xml-lang="en-US"> Put #iNumber, , "This is the second line of text"</paragraph> + <paragraph id="par_id31507151145" role="bascode" xml-lang="en-US"> Put #iNumber, , "This is the third line of text"</paragraph> + <paragraph id="par_idm1340758225" role="bascode" localize="false"> Seek #iNumber,2</paragraph> + <paragraph id="par_idm1340757001" role="bascode" localize="false"> Get #iNumber, , sText</paragraph> + <paragraph id="par_idm1340756855" role="bascode" localize="false"> Print sText</paragraph> + <paragraph id="par_idm1340754987" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1340753695" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1340752334" role="bascode" localize="false"> Open aFile For Random As #iNumber Len=32</paragraph> + <paragraph id="par_idm1340751547" role="bascode" localize="false"> Get #iNumber, 2, sText</paragraph> + <paragraph id="par_id31559382236" role="bascode" xml-lang="en-US"> Put #iNumber, , "This is a new text"</paragraph> + <paragraph id="par_idm1340748447" role="bascode" localize="false"> Get #iNumber, 1, sText</paragraph> + <paragraph id="par_idm1340746658" role="bascode" localize="false"> Get #iNumber, 2, sText</paragraph> + <paragraph id="par_id31469165876" role="bascode" xml-lang="en-US"> Put #iNumber, 20, "This is the text in record 20"</paragraph> + <paragraph id="par_idm1340743004" role="bascode" localize="false"> Print Lof(#iNumber)</paragraph> + <paragraph id="par_idm1340742125" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1340741288" role="bascode" localize="false">End Sub</paragraph> + </bascode> +</default> +</switch> +</section> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03020204.xhp#Put_h1"/> + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020202.xhp b/helpcontent2/source/text/sbasic/shared/03020202.xhp new file mode 100644 index 000000000..63adaa36d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020202.xhp @@ -0,0 +1,90 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020202xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Input# Statement</title> + <filename>/text/sbasic/shared/03020202.xhp</filename> + </topic> +</meta> + +<body> + +<section id="input"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154908"> + <bookmark_value>Input statement</bookmark_value> +</bookmark> + +<paragraph id="hd_id3154908" role="heading" level="1" xml-lang="en-US"><variable id="Input_h1"><link href="text/sbasic/shared/03020202.xhp" name="Input# Statement">Input# Statement</link></variable></paragraph> +<paragraph id="par_id3156424" role="paragraph" xml-lang="en-US">Reads data from an open sequential file.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Input_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Input Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3150440" role="bascode" xml-lang="en-US">Input #fileNum {,|;} var1 [, var2 [, ...]]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145749" role="paragraph"> <emph>fileNum</emph>: Number of the file that contains the data that you want to read. The file must be opened with the Open statement using the key word INPUT.</paragraph> +<paragraph id="par_id3150011" role="paragraph"> <emph>var</emph>: A numeric or string variable that you assign the values read from the opened file to.</paragraph> +<paragraph id="par_id3159153" role="paragraph">The <emph>Input#</emph> statement reads numeric values or strings from an open file and assigns the data to one or more variables. A numeric variable is read up to the first carriage return (Asc=13), line feed (Asc=10), space, or comma. String variables are read to up to the first carriage return (Asc=13), line feed (Asc=10), or comma.</paragraph> +<paragraph id="par_id3146984" role="paragraph">Data and data types in the opened file must appear in the same order as the variables that are passed in the "var" parameter. If you assign non-numeric values to a numeric variable, "var" is assigned a value of "0".</paragraph> +<paragraph id="par_id3156442" role="paragraph">Records that are separated by commas cannot be assigned to a string variable. Quotation marks (") in the file are disregarded as well. If you want to read these characters from the file, use the <emph>Line Input#</emph> statement to read pure text files (files containing only printable characters) line by line.</paragraph> +<paragraph id="par_id3147349" role="paragraph">If the end of the file is reached while reading a data element, an error occurs and the process is aborted.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm871097888" role="bascode" localize="false">Sub ExampleWorkWithAFile</paragraph> +<paragraph id="par_idm871096912" role="bascode" localize="false"> Dim iCount As Integer, sFileName As String</paragraph> +<paragraph id="par_idm871095952" role="bascode" localize="false"> Dim sName As String, sValue As Integer</paragraph> +<paragraph id="par_idm871092096" role="bascode" localize="false"> sFileName = "C:\Users\ThisUser\data.txt"</paragraph> +<paragraph id="par_idm871091120" role="bascode" localize="false"> iCount = Freefile</paragraph> +<paragraph id="par_id4144765" role="bascode" xml-lang="en-US"> ' Write data ( which we will read later with Input ) to file</paragraph> +<paragraph id="par_idm871087952" role="bascode" localize="false"> Open sFileName For Output As iCount</paragraph> +<paragraph id="par_idm871086976" role="bascode" localize="false"> sName = "Hamburg" : sValue = 200</paragraph> +<paragraph id="par_idm871085056" role="bascode" localize="false"> Write #iCount, sName, sValue</paragraph> +<paragraph id="par_idm871084080" role="bascode" localize="false"> sName = "New York" : sValue = 300</paragraph> +<paragraph id="par_idm871082160" role="bascode" localize="false"> Write #iCount; sName, sValue</paragraph> +<paragraph id="par_idm871081184" role="bascode" localize="false"> sName = "Miami" : sValue = 459</paragraph> +<paragraph id="par_idm871079264" role="bascode" localize="false"> Write #iCount, sName, sValue</paragraph> +<paragraph id="par_idm871078288" role="bascode" localize="false"> Close #iCount</paragraph> +<paragraph id="par_id4144766" role="bascode" xml-lang="en-US"> ' Read data file using Input</paragraph> +<paragraph id="par_idm871076400" role="bascode" localize="false"> iCount = Freefile</paragraph> +<paragraph id="par_idm871074192" role="bascode" localize="false"> Open sFileName For Input As iCount</paragraph> +<paragraph id="par_idm871073216" role="bascode" localize="false"> Input #iCount, sName, sValue</paragraph> +<paragraph id="par_idm871072240" role="bascode" localize="false"> MsgBox sName & " " & sValue</paragraph> +<paragraph id="par_idm871071264" role="bascode" localize="false"> Input #iCount; sName, sValue</paragraph> +<paragraph id="par_idm871070288" role="bascode" localize="false"> MsgBox sName & " " & sValue</paragraph> +<paragraph id="par_idm871069312" role="bascode" localize="false"> Input #iCount, sName, sValue</paragraph> +<paragraph id="par_idm871068336" role="bascode" localize="false"> MsgBox sName & " " & sValue</paragraph> +<paragraph id="par_idm871067360" role="bascode" localize="false"> Close #iCount</paragraph> +<paragraph id="par_idm871066400" role="bascode" localize="false">End Sub</paragraph> +</bascode> +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> + <embed href="text/sbasic/shared/03020205.xhp#Write_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020203.xhp b/helpcontent2/source/text/sbasic/shared/03020203.xhp new file mode 100644 index 000000000..117186268 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020203.xhp @@ -0,0 +1,61 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020203xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Line Input# Statement</title> + <filename>/text/sbasic/shared/03020203.xhp</filename> + </topic> +</meta> + +<body> + +<section id="lineinput"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153361"> + <bookmark_value>Line Input statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3153361"><variable id="LineInput_h1"><link href="text/sbasic/shared/03020203.xhp" name="Line Input# Statement">Line Input# Statement</link></variable></h1> +<paragraph id="par_id3156280" role="paragraph" xml-lang="en-US">Reads a line from a sequential file into a variable.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Line-Input_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Line Input Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3147229" role="bascode" localize="false">Line Input #fileNum, variable</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3161832" role="paragraph" xml-lang="en-US"> <emph>fileNum</emph>: Number of the file that contains the data that you want to read. The file must have been opened in advance with the Open statement using the key word INPUT.</paragraph> +<paragraph id="par_id3151119" role="paragraph" xml-lang="en-US"> <emph>variable</emph>: The name of the variable that stores the result.</paragraph> +<paragraph id="par_id3150010" role="paragraph" xml-lang="en-US">With the <emph>Line Input#</emph> statement, you can read strings from an open file into a variable. String variables are read line-by-line up to the first carriage return (Asc=13) or linefeed (Asc=10). Line end marks are not included in the resulting string.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03020103.xhp#FileExample"/> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> + <embed href="text/sbasic/shared/03020205.xhp#Write_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020204.xhp b/helpcontent2/source/text/sbasic/shared/03020204.xhp new file mode 100644 index 000000000..c8b6bd14f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020204.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020204xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Put# Statement</title> + <filename>/text/sbasic/shared/03020204.xhp</filename> + </topic> +</meta> + +<body> +<section id="put"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150360"> + <bookmark_value>Put statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3150360"><variable id="Put_h1"><link href="text/sbasic/shared/03020204.xhp" name="Put Statement">Put# Statement</link></variable></h1> +<paragraph id="par_id3154909" role="paragraph" xml-lang="en-US">Writes a record to a relative file or a sequence of bytes to a binary file.</paragraph> +</section> + +<tip id="par_id461596463969009">Use <link href="text/sbasic/shared/03010103.xhp">Print#</link> statement to print data to a sequential text file. Use <link href="text/sbasic/shared/03020205.xhp">Write#</link> statement to write data to a sequential text file with delimiting characters.</tip> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Put_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Put Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3155132" role="bascode" xml-lang="en-US">Put [#]fileNum, [recordNum|filePos], variable</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3146120" role="paragraph" xml-lang="en-US"> <emph>fileNum</emph>: Any integer expression that defines the file that you want to write to.</paragraph> +<paragraph id="par_id3155411" role="paragraph" xml-lang="en-US"> <emph>recordNum, filePos</emph>: For relative files (random access files), the number of the record that you want to write.</paragraph> +<paragraph id="par_id3148576" role="paragraph" xml-lang="en-US">For binary files (binary access), the position of the byte in the file where you want to start writing.</paragraph> +<paragraph id="par_id3153729" role="paragraph" xml-lang="en-US"> <emph>variable</emph>: Name of the variable that you want to write to the file.</paragraph> +<paragraph id="par_id3146974" role="paragraph" xml-lang="en-US">Note for relative files: If the contents of this variable does not match the length of the record that is specified in the <emph>Len</emph> clause of the <emph>Open</emph> statement, the space between the end of the newly written record and the next record is padded with existing data from the file that you are writing to.</paragraph> +<paragraph id="par_id3155855" role="paragraph" xml-lang="en-US">Note for binary files: The contents of the variables are written to the specified position, and the file pointer is inserted directly after the last byte. No space is left between the records.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03020201.xhp#ExampleRandomAccess"/> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03020201.xhp#Get_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020205.xhp b/helpcontent2/source/text/sbasic/shared/03020205.xhp new file mode 100644 index 000000000..f97195397 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020205.xhp @@ -0,0 +1,103 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020205xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Write Statement</title> + <filename>/text/sbasic/shared/03020205.xhp</filename> + </topic> +</meta> + +<body> + +<section id="write"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147229"> + <bookmark_value>Write statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3147229"><variable id="Write_h1"><link href="text/sbasic/shared/03020205.xhp" name="Write# Statement">Write# Statement</link></variable></h1> +<paragraph id="par_id3154685" role="paragraph" xml-lang="en-US">Writes data to a sequential text file with delimiting characters.</paragraph> +</section> + +<tip id="par_id461596463969009">Use <link href="text/sbasic/shared/03010103.xhp">Print#</link> statement to print data to a sequential text file. Use <link href="text/sbasic/shared/03020201.xhp">Put#</link> statement to write data to a binary or a random file.</tip> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Write_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Write Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3145785" role="bascode" localize="false">Write [#fileNum] {,|;} expression [, …]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153728" role="paragraph"> <emph>fileNum</emph>: Any numeric expression that contains the file number that was set by the Open statement for the respective file.</paragraph> +<paragraph id="par_id3146120" role="paragraph"> <emph>expression</emph> list: Variables or expressions that you want to enter in a file, separated by commas.</paragraph> +<paragraph id="par_id3150010" role="paragraph">If the expression list is omitted, the <emph>Write</emph> statement appends an empty line to the file.</paragraph> +<paragraph id="par_id3163713" role="paragraph">To add an expression list to a new or an existing file, the file must be opened in the <emph>Output</emph> or <emph>Append</emph> mode.</paragraph> +<paragraph id="par_id3147428" role="paragraph">Strings that you write are enclosed by quotation marks and separated by commas. You do not need to enter these delimiters in the expression list.</paragraph> +<paragraph id="par_id1002838" role="paragraph">Each <emph>Write</emph> statement outputs a line end symbol as last entry.</paragraph> +<paragraph id="par_id6618854" role="paragraph">Numbers with decimal delimiters are converted according to the locale settings.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<switch select="sys"> +<case select="WIN"> + <bascode> + <paragraph id="par_idm1340911536" role="bascode" localize="false">Sub ExampleWrite</paragraph> + <paragraph id="par_idm1340910304" role="bascode" localize="false"> Dim iCount As Integer</paragraph> + <paragraph id="par_idm1340909072" role="bascode" localize="false"> Dim sValue As String</paragraph> + <paragraph id="par_idm1340907840" role="bascode" localize="false"> iCount = Freefile</paragraph> + <paragraph id="par_idm1340906608" role="bascode" localize="false"> Open "C:\Users\ThisUser\data.txt" For Output As iCount</paragraph> + <paragraph id="par_idm1340905344" role="bascode" localize="false"> sValue = "Hamburg"</paragraph> + <paragraph id="par_idm1340904112" role="bascode" localize="false"> Write #iCount,sValue,200</paragraph> + <paragraph id="par_idm1340902864" role="bascode" localize="false"> sValue = "New York"</paragraph> + <paragraph id="par_idm1340901632" role="bascode" localize="false"> Write #iCount,sValue,300</paragraph> + <paragraph id="par_idm1340900384" role="bascode" localize="false"> sValue = "Miami"</paragraph> + <paragraph id="par_idm1340899152" role="bascode" localize="false"> Write #iCount,sValue,450</paragraph> + <paragraph id="par_idm1340897904" role="bascode" localize="false"> Close #iCount</paragraph> + <paragraph id="par_idm1340896672" role="bascode" localize="false">End Sub</paragraph> + </bascode> +</case> +<default> + <bascode> + <paragraph id="par_idm1340912556" role="bascode" localize="false">Sub ExampleWrite</paragraph> + <paragraph id="par_idm1340919854" role="bascode" localize="false"> Dim iCount As Integer</paragraph> + <paragraph id="par_idm1340912572" role="bascode" localize="false"> Dim sValue As String</paragraph> + <paragraph id="par_idm1340907125" role="bascode" localize="false"> iCount = Freefile</paragraph> + <paragraph id="par_idm1340906804" role="bascode" localize="false"> Open "~/data.txt" For Output As iCount</paragraph> + <paragraph id="par_idm1340905662" role="bascode" localize="false"> sValue = "Hamburg"</paragraph> + <paragraph id="par_idm1340904147" role="bascode" localize="false"> Write #iCount,sValue,200</paragraph> + <paragraph id="par_idm1340902258" role="bascode" localize="false"> sValue = "New York"</paragraph> + <paragraph id="par_idm1340901147" role="bascode" localize="false"> Write #iCount,sValue,300</paragraph> + <paragraph id="par_idm1340900203" role="bascode" localize="false"> sValue = "Miami"</paragraph> + <paragraph id="par_idm1340899330" role="bascode" localize="false"> Write #iCount,sValue,450</paragraph> + <paragraph id="par_idm1340897887" role="bascode" localize="false"> Close #iCount</paragraph> + <paragraph id="par_idm1340896654" role="bascode" localize="false">End Sub</paragraph> + </bascode> +</default> +</switch> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> + <embed href="text/sbasic/shared/03020204.xhp#Put_h1"/> + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020301.xhp b/helpcontent2/source/text/sbasic/shared/03020301.xhp new file mode 100644 index 000000000..2c681a0aa --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020301.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020301xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Eof Function</title> + <filename>/text/sbasic/shared/03020301.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="eof"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154598"> + <bookmark_value>Eof function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3154598" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020301.xhp" name="Eof Function">Eof Function</link></paragraph> +<paragraph id="par_id3147182" role="paragraph" xml-lang="en-US">Determines if the file pointer has reached the end of a file.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3147399" role="bascode" xml-lang="en-US">Eof (intexpression As Integer)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3156027" role="paragraph" xml-lang="en-US">Bool</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153990" role="paragraph" xml-lang="en-US"> <emph>Intexpression:</emph> Any integer expression that evaluates to the number of an open file.</paragraph> +<paragraph id="par_id3153527" role="paragraph" xml-lang="en-US">Use EOF to avoid errors when you attempt to get input past the end of a file. When you use the Input or Get statement to read from a file, the file pointer is advanced by the number of bytes read. When the end of a file is reached, EOF returns the value "True" (-1).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err52"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03020103.xhp#FileExample"/> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> + <embed href="text/sbasic/shared/03020202.xhp#Input_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020302.xhp b/helpcontent2/source/text/sbasic/shared/03020302.xhp new file mode 100644 index 000000000..cba83b1a6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020302.xhp @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03020302xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Loc Function</title> +<filename>/text/sbasic/shared/03020302.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="loc"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148663"><bookmark_value>Loc function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3148663" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03020302.xhp" name="Loc Function">Loc Function</link></paragraph> +<paragraph role="paragraph" id="par_id3154138" xml-lang="en-US">Returns the current position in an open file.</paragraph> +</section> +<paragraph role="heading" id="hd_id3156422" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3150768" xml-lang="en-US">Loc(FileNumber)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3150440" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" localize="false" id="par_id3152578" xml-lang="en-US">Long</paragraph> +<paragraph role="heading" id="hd_id3152462" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3153363" xml-lang="en-US"> +<emph>FileNumber:</emph> Any numeric expression that contains the file number that is set by the Open statement for the respective file.</paragraph> +<paragraph role="paragraph" id="par_id3154320" xml-lang="en-US">If the Loc function is used for an open random access file, it returns the number of the last record that was last read or written.</paragraph> +<paragraph role="paragraph" id="par_id3151115" xml-lang="en-US">For a sequential file, the Loc function returns the position in a file divided by 128. For binary files, the position of the last read or written byte is returned.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err52"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020303.xhp b/helpcontent2/source/text/sbasic/shared/03020303.xhp new file mode 100644 index 000000000..3741e50cf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020303.xhp @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03020303xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Lof Function</title> +<filename>/text/sbasic/shared/03020303.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="lof"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156024"><bookmark_value>Lof function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3156024" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03020303.xhp" name="Lof Function">Lof Function</link></paragraph> +<paragraph role="paragraph" id="par_id3146794" xml-lang="en-US">Returns the size of an open file in bytes.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_id3150359" xml-lang="en-US">Lof (FileNumber) As Long</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" localize="false" id="par_id3147230" xml-lang="en-US">Long</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3150869" xml-lang="en-US"> +<emph>FileNumber:</emph> Any numeric expression that contains the file number that is specified in the <literal>Open</literal> statement.</paragraph> +<paragraph role="tip" id="par_id3147349" xml-lang="en-US">To obtain the length of a file that is not open, use the <link href="text/sbasic/shared/03020408.xhp" name="FileLen function"><literal>FileLen</literal></link> function.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err52"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03020201.xhp#ExampleRandomAccess"/> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03020201.xhp#Get_h1"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020304.xhp b/helpcontent2/source/text/sbasic/shared/03020304.xhp new file mode 100644 index 000000000..464b09feb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020304.xhp @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03020304xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Seek Function</title> +<filename>/text/sbasic/shared/03020304.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="seek"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154367"><bookmark_value>Seek function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3154367" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03020304.xhp" name="Seek Function">Seek Function</link></paragraph> +<paragraph role="paragraph" id="par_id3156280" xml-lang="en-US">Returns the position for the next writing or reading in a file that was opened with the open statement.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3153194" xml-lang="en-US">For random access files, the Seek function returns the number of the next record to be read.</paragraph> +<paragraph role="paragraph" id="par_id3161831" xml-lang="en-US">For all other files, the function returns the byte position at which the next operation is to occur.</paragraph> +<paragraph role="paragraph" id="par_id3155854" xml-lang="en-US">See also: <link href="text/sbasic/shared/03020103.xhp" name="Open">Open</link>, <link href="text/sbasic/shared/03020305.xhp" name="Seek">Seek</link>.</paragraph> +<paragraph role="heading" id="hd_id3152460" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3145365" xml-lang="en-US">Seek (FileNumber)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3148575" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" localize="false" id="par_id3159156" xml-lang="en-US">Long</paragraph> +<paragraph role="heading" id="hd_id3149665" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3148645" xml-lang="en-US"> +<emph>FileNumber:</emph> The data channel number used in the Open statement.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020305.xhp b/helpcontent2/source/text/sbasic/shared/03020305.xhp new file mode 100644 index 000000000..9ff8727fd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020305.xhp @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03020305xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Seek# Statement</title> +<filename>/text/sbasic/shared/03020305.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id3159413"><bookmark_value>Seek statement</bookmark_value> +</bookmark> +<h1 id="hd_id3159413"><link href="text/sbasic/shared/03020305.xhp" name="Seek# Statement">Seek Statement</link></h1> +<paragraph role="paragraph" id="par_id3153381">Sets the position for the next writing or reading in a file that was opened with the Open statement.<comment>see #61751</comment></paragraph> +<paragraph role="paragraph" id="par_id2100589">For random access files, the Seek statement sets the number of the next record to be accessed.</paragraph> +<paragraph role="paragraph" id="par_id5444807">For all other files, the Seek statement sets the byte position at which the next operation is to occur.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Seek_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Seek Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3145273" xml-lang="en-US">Seek [#]filePos, {filePos|recordNum}</paragraph> +</bascode> + +<paragraph id="hd_id3153379" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3153952" xml-lang="en-US"> +<emph>fileNum</emph>: The data channel number used in the Open statement.</paragraph> +<paragraph role="paragraph" id="par_id3145366" xml-lang="en-US"> +<emph>filePos, recordNum</emph>: Position for the next writing or reading. Position can be a number between 1 and 2,147,483,647. According to the file type, the position indicates the number of the record (files in the Random mode) or the byte position (files in the Binary, Output, Append or Input mode). The first byte in a file is position 1, the second byte is position 2, and so on.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err52"/> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <paragraph role="paragraph" id="par_id491596468328575"><link href="text/sbasic/shared/03020304.xhp" name="Seek">Seek</link> function</paragraph> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020400.xhp b/helpcontent2/source/text/sbasic/shared/03020400.xhp new file mode 100644 index 000000000..27592c63a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020400.xhp @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03020400xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Managing Files</title> +<filename>/text/sbasic/shared/03020400.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="organisation"> + <paragraph id="hd_id3145136" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020400.xhp" name="Managing Files">Managing Files</link></paragraph> + <paragraph role="paragraph" id="par_id3147264" xml-lang="en-US">The functions and statements for managing files are described here.</paragraph> + </section> + <embed href="text/sbasic/shared/03020401.xhp#chdir"/> + <embed href="text/sbasic/shared/03020402.xhp#chdrive"/> + <embed href="text/sbasic/shared/03020403.xhp#curdir"/> + <embed href="text/sbasic/shared/03020404.xhp#dir"/> + <embed href="text/sbasic/shared/03020405.xhp#fileattr"/> + <embed href="text/sbasic/shared/03020406.xhp#filecopy"/> + <embed href="text/sbasic/shared/03020407.xhp#filedatetime"/> + <embed href="text/sbasic/shared/03020415.xhp#fileexists"/> + <embed href="text/sbasic/shared/03020408.xhp#filelen"/> + <embed href="text/sbasic/shared/03020409.xhp#getattr"/> + <embed href="text/sbasic/shared/GetPathSeparator.xhp#getpathseparator"/> + <embed href="text/sbasic/shared/03020410.xhp#kill"/> + <embed href="text/sbasic/shared/03020411.xhp#mkdir"/> + <embed href="text/sbasic/shared/03020412.xhp#name"/> + <embed href="text/sbasic/shared/03020413.xhp#rmdir"/> + <embed href="text/sbasic/shared/03020414.xhp#setattr"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020401.xhp b/helpcontent2/source/text/sbasic/shared/03020401.xhp new file mode 100644 index 000000000..42f721d4d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020401.xhp @@ -0,0 +1,77 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020401xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ChDir Statement</title> + <filename>/text/sbasic/shared/03020401.xhp</filename> + </topic> +</meta> + +<body> + +<section id="chdir"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150178"> + <bookmark_value>ChDir statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3150178" xml-lang="en-US"><link href="text/sbasic/shared/03020401.xhp" name="ChDir Statement">ChDir Statement</link></h1> +<paragraph id="par_id3153126" role="paragraph" xml-lang="en-US">Changes the current directory or drive.</paragraph> +</section> + +<section id="deprecated_inStarOffice7"> + <warning id="par_id461605879610611" xml-lang="en-US">Some DOS-specific file and directory functions are no longer provided in %PRODUCTNAME, or their function is only limited. For example, support for the <literal>ChDir</literal>, <literal>ChDrive</literal> and <literal>CurDir</literal> functions is not provided. Some DOS-specific properties are no longer used in functions that expect file properties as parameters (for example, to differentiate from concealed files and system files). This ensures the greatest possible level of platform independence for %PRODUCTNAME. Therefore this feature is subject to removal in a future release.</warning> +</section> + +<section id="SF_FileSystem_Note"> + <note id="par_id321620859565917">The <link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="SF_Lib">ScriptForge</link> library in %PRODUCTNAME 7.1 introduces the <link href="text/sbasic/shared/03/sf_filesystem.xhp" name="FileSystem_Service">FileSystem</link> service with methods to handle files and folders in user scripts.</note> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3153897" role="bascode" xml-lang="en-US">ChDir Text As String</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150543" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies the directory path or drive.</paragraph> +<paragraph id="par_id3152598" role="note" xml-lang="en-US">If you only want to change the current drive, enter the drive letter followed by a colon.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err76"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph id="par_idm1341266032" role="bascode" localize="false">Sub ExampleChDir</paragraph> + <paragraph id="par_idm1341264800" role="bascode" localize="false"> Dim sDir1 As String, sDir2 As String</paragraph> + <paragraph id="par_idm1341263552" role="bascode" localize="false"> sDir1 = "C:\Test"</paragraph> + <paragraph id="par_idm1341262320" role="bascode" localize="false"> sDir2 = "D:\Private"</paragraph> + <paragraph id="par_idm1341261072" role="bascode" localize="false"> ChDir( sDir1 )</paragraph> + <paragraph id="par_idm1341259840" role="bascode" localize="false"> MsgBox CurDir</paragraph> + <paragraph id="par_idm1341258608" role="bascode" localize="false"> ChDir( sDir2 )</paragraph> + <paragraph id="par_idm1341257376" role="bascode" localize="false"> MsgBox CurDir</paragraph> + <paragraph id="par_idm1341256144" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/> + <embed href="text/sbasic/shared/03/sf_textstream.xhp#TextStreamService"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020402.xhp b/helpcontent2/source/text/sbasic/shared/03020402.xhp new file mode 100644 index 000000000..780f9e204 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020402.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020402xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ChDrive Statement</title> + <filename>/text/sbasic/shared/03020402.xhp</filename> + </topic> +</meta> + +<body> + +<section id="chdrive"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145068"> + <bookmark_value>ChDrive statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3145068" xml-lang="en-US"><link href="text/sbasic/shared/03020402.xhp" name="ChDrive Statement">ChDrive Statement</link></h1> +<paragraph id="par_id3149656" role="paragraph" xml-lang="en-US">Changes the current drive.</paragraph> +</section> +<embed href="text/sbasic/shared/03020401.xhp#deprecated_inStarOffice7"/> +<embed href="text/sbasic/shared/03020401.xhp#SF_FileSystem_Note"/> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph id="par_id3154685" role="bascode" localize="false" xml-lang="en-US">ChDrive Text As String</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145172" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that contains the drive letter of the new drive. If you want, you can use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3145785" role="paragraph" xml-lang="en-US">The drive must be assigned a capital letter. Under Windows, the letter that you assign the drive is restricted by the settings in LASTDRV. If the drive argument is a multiple-character string, only the first letter is relevant. If you attempt to access a non-existent drive, an error occurs that you can respond to with the OnError statement.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err68"/> +<embed href="text/sbasic/shared/00000003.xhp#err76"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph id="par_idm1340928496" role="bascode" localize="false" xml-lang="en-US">Sub ExampleChDrive</paragraph> + <paragraph id="par_id3152576" role="bascode" xml-lang="en-US"> ChDrive "D" ' Only possible if a drive 'D' exists.</paragraph> + <paragraph id="par_idm1340925472" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/> + <embed href="text/sbasic/shared/03/sf_textstream.xhp#TextStreamService"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020403.xhp b/helpcontent2/source/text/sbasic/shared/03020403.xhp new file mode 100644 index 000000000..0929218d7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020403.xhp @@ -0,0 +1,78 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020403xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CurDir Function</title> + <filename>/text/sbasic/shared/03020403.xhp</filename> + </topic> +</meta> + +<body> + +<section id="curdir"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153126"> + <bookmark_value>CurDir function</bookmark_value> +</bookmark> + +<h1 id="hd_id3153126" xml-lang="en-US"><variable id="CurDir_h1"><link href="text/sbasic/shared/03020403.xhp">CurDir Function</link></variable></h1> +<paragraph id="par_id3156343" role="paragraph" xml-lang="en-US">Returns a variant string that represents the current path <switchinline select="sys"><caseinline select="WIN">or that of the specified Windows drive</caseinline></switchinline>.</paragraph> +</section> +<embed href="text/sbasic/shared/03020401.xhp#deprecated_inStarOffice7"/> +<embed href="text/sbasic/shared/03020401.xhp#SF_FileSystem_Note"/> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3153381" role="bascode" localize="false">CurDir [(Text As String)]</paragraph> +</bascode> + +<paragraph id="hd_id3154366" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies an existing drive, for example "C" for the first partition of the first hard drive. This parameter is used solely under Windows.</paragraph> +<paragraph id="par_id3155133" role="paragraph" xml-lang="en-US">If no drive is specified or if the drive is a zero-length string (""), <literal>CurDir</literal> returns the path for the current drive. %PRODUCTNAME Basic reports an error if the syntax of the drive description is incorrect or if the drive does not exist.</paragraph> + +<paragraph id="par_id3150010" role="paragraph" xml-lang="en-US">This function is not case-sensitive.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err68"/> +<embed href="text/sbasic/shared/00000003.xhp#err7"/> +<embed href="text/sbasic/shared/00000003.xhp#err51"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph id="par_idm1341570656" role="bascode" localize="false">Sub ExampleCurDir</paragraph> + <paragraph id="par_idm1341569424" role="bascode" localize="false"> Dim sDir1 As String, sDir2 As String</paragraph> + <paragraph id="par_idm1341568176" role="bascode" localize="false"> sDir1 = "C:\Test"</paragraph> + <paragraph id="par_idm1341566944" role="bascode" localize="false"> sDir2 = "D:\Private"</paragraph> + <paragraph id="par_idm1341565696" role="bascode" localize="false"> ChDir( sDir1 )</paragraph> + <paragraph id="par_idm1341564464" role="bascode" localize="false"> MsgBox CurDir</paragraph> + <paragraph id="par_idm1341563232" role="bascode" localize="false"> ChDir( sDir2 )</paragraph> + <paragraph id="par_idm1341562000" role="bascode" localize="false"> MsgBox CurDir</paragraph> + <paragraph id="par_idm1341560768" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/> + <embed href="text/sbasic/shared/03/sf_textstream.xhp#TextStreamService"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020404.xhp b/helpcontent2/source/text/sbasic/shared/03020404.xhp new file mode 100644 index 000000000..5416578ca --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020404.xhp @@ -0,0 +1,85 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020404xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Dir Function</title> + <filename>/text/sbasic/shared/03020404.xhp</filename> + </topic> +</meta> + +<body> + +<section id="dir"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154347"> + <bookmark_value>Dir function</bookmark_value> +</bookmark> + +<h1 id="hd_id3154347" xml-lang="en-US"><link href="text/sbasic/shared/03020404.xhp" name="Dir Function">Dir Function</link></h1> +<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US">Returns the name of a file, a directory, or all of the files and the directories on a drive or in a directory that match the specified search path.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3156282" role="bascode" localize="false">Dir [(Text As String [, Attrib As Integer])]</paragraph> +</bascode> + +<h2 id="hd_id3156424" xml-lang="en-US">Return value:</h2> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3161831" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies the search path, directory or file. This argument can only be specified the first time that you call the Dir function. If you want, you can enter the path in <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3146974" role="paragraph" xml-lang="en-US"> <emph>Attrib: </emph>Any integer expression that specifies bitwise file attributes. The Dir function only returns files or directories that match the specified attributes. You can combine several attributes by adding the attribute values:</paragraph> +<paragraph id="par_id3149666" role="paragraph" xml-lang="en-US">0 : Normal files.</paragraph> +<paragraph id="par_id3147427" role="paragraph" xml-lang="en-US">16 : Returns the name of the directory only.</paragraph> +<paragraph id="par_id3153952" role="paragraph" xml-lang="en-US">Use this attribute to check if a file or directory exists, or to determine all files and folders in a specific directory.</paragraph> +<paragraph id="par_id3159156" role="paragraph" xml-lang="en-US">To check if a file exists, enter the complete path and name of the file. If the file or directory name does not exist, the Dir function returns a zero-length string ("").</paragraph> +<paragraph id="par_id3154012" role="paragraph" xml-lang="en-US">To generate a list of all existing files in a specific directory, proceed as follows: The first time you call the Dir function, specify the complete search path for the files, for example, "D:\Files\*.ods". If the path is correct and the search finds at least one file, the Dir function returns the name of the first file that matches the search path. To return additional file names that match the path, call Dir again, but with no arguments.</paragraph> +<paragraph id="par_id3147348" role="paragraph" xml-lang="en-US">To return directories only, use the attribute parameter. The same applies if you want to determine the name of a volume (for example, a hard drive partition).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err53"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341562192" role="bascode" localize="false">Sub ExampleDir</paragraph> +<paragraph id="par_id3148455" role="bascode" xml-lang="en-US">' Displays all files and directories</paragraph> +<paragraph id="par_idm1341559232" role="bascode" localize="false">Dim sPath As String</paragraph> +<paragraph id="par_idm1341558000" role="bascode" localize="false">Dim sDir As String, sValue As String</paragraph> +<paragraph id="par_id3153416" role="bascode" xml-lang="en-US"> sDir="Directories:"</paragraph> +<paragraph id="par_idm1341555040" role="bascode" localize="false"> sPath = CurDir</paragraph> +<paragraph id="par_idm1341553808" role="bascode" localize="false"> sValue = Dir$(sPath + getPathSeparator + "*",16)</paragraph> +<paragraph id="par_idm1341552544" role="bascode" localize="false"> Do</paragraph> +<paragraph id="par_idm1341551312" role="bascode" localize="false"> If sValue <> "." And sValue <> ".." Then</paragraph> +<paragraph id="par_idm1341550000" role="bascode" localize="false"> If (GetAttr( sPath + getPathSeparator + sValue) And 16) >0 Then</paragraph> +<paragraph id="par_id3154253" role="bascode" xml-lang="en-US"> ' Get the directories</paragraph> +<paragraph id="par_idm1341546912" role="bascode" localize="false"> sDir = sDir & chr(13) & sValue</paragraph> +<paragraph id="par_idm1341545632" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1341544400" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1341543168" role="bascode" localize="false"> sValue = Dir$</paragraph> +<paragraph id="par_idm1341541936" role="bascode" localize="false"> Loop Until sValue = ""</paragraph> +<paragraph id="par_idm1341540688" role="bascode" localize="false"> MsgBox sDir,0,sPath</paragraph> +<paragraph id="par_idm1341539456" role="bascode" localize="false">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03020403.xhp#CurDir_h1"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020405.xhp b/helpcontent2/source/text/sbasic/shared/03020405.xhp new file mode 100644 index 000000000..d19d30546 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020405.xhp @@ -0,0 +1,89 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020405xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FileAttr Function</title> + <filename>/text/sbasic/shared/03020405.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="fileattr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153380"> + <bookmark_value>FileAttr function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3153380" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020405.xhp" name="FileAttr Function">FileAttr Function</link></paragraph> +<paragraph id="par_id3154366" role="paragraph" xml-lang="en-US">Returns the access mode or the file access number of a file that was opened with the Open statement. The file access number is dependent on the operating system (OSH = Operating System Handle).</paragraph> +</section> +<paragraph id="par_id3153364" role="note" xml-lang="en-US">If you use a 32-Bit operating system, you cannot use the FileAttr-Function to determine the file access number.</paragraph> +<paragraph id="par_id3163713" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03020103.xhp" name="Open">Open</link></paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3154012" role="bascode" xml-lang="en-US">FileAttr (FileNumber As Integer, Attribute As Integer)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3146974" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3151074" role="paragraph" xml-lang="en-US"> <emph>FileNumber:</emph> The number of the file that was opened with the Open statement.</paragraph> +<paragraph id="par_id3144766" role="paragraph" xml-lang="en-US"> <emph>Attribute:</emph> Integer expression that indicates the type of file information that you want to return. The following values are possible:</paragraph> +<paragraph id="par_id3147396" role="paragraph" xml-lang="en-US">1: The FileAttr-Function indicates the access mode of the file.</paragraph> +<paragraph id="par_id3149959" role="paragraph" xml-lang="en-US">2: The FileAttr-Function returns the file access number of the operating system.</paragraph> +<paragraph id="par_id3154018" role="paragraph" xml-lang="en-US">If you specify a parameter attribute with a value of 1, the following return values apply:</paragraph> +<paragraph id="par_id3149124" role="paragraph" xml-lang="en-US">1 - INPUT (file open for input)</paragraph> +<paragraph id="par_id3156275" role="paragraph" xml-lang="en-US">2 - OUTPUT (file open for output)</paragraph> +<paragraph id="par_id3155066" role="paragraph" xml-lang="en-US">4 - RANDOM (file open for random access)</paragraph> +<paragraph id="par_id3148406" role="paragraph" xml-lang="en-US">8 - APPEND (file open for appending)</paragraph> +<paragraph id="par_id3154757" role="paragraph" xml-lang="en-US">32 - BINARY (file open in binary mode).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err52"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341149504" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFileAttr</paragraph> +<paragraph id="par_idm1341148272" role="bascode" localize="false" xml-lang="en-US"> Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1341147040" role="bascode" localize="false" xml-lang="en-US"> Dim sLine As String</paragraph> +<paragraph id="par_idm1341145808" role="bascode" localize="false" xml-lang="en-US"> Dim aFile As String</paragraph> +<paragraph id="par_idm1341144576" role="bascode" localize="false" xml-lang="en-US"> aFile = "C:\Users\ThisUser\data.txt"</paragraph> +<paragraph id="par_idm1341143328" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341142096" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Output As #iNumber</paragraph> +<paragraph id="par_id3155607" role="bascode" xml-lang="en-US"> Print #iNumber, "This is a line of text"</paragraph> +<paragraph id="par_id3150361" role="bascode" xml-lang="en-US"> MsgBox FileAttr(#iNumber, 1), 0, "Access mode"</paragraph> +<paragraph id="par_id3149817" role="bascode" xml-lang="en-US"> MsgBox FileAttr(#iNumber, 2), 0, "File attribute"</paragraph> +<paragraph id="par_idm1341135568" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341134336" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03020102.xhp#FreeFile_h1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020406.xhp b/helpcontent2/source/text/sbasic/shared/03020406.xhp new file mode 100644 index 000000000..3fb2923e8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020406.xhp @@ -0,0 +1,62 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020406xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FileCopy Statement</title> + <filename>/text/sbasic/shared/03020406.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="filecopy"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154840"> + <bookmark_value>FileCopy statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3154840" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020406.xhp" name="FileCopy Statement">FileCopy Statement</link></paragraph> +<paragraph id="par_id3149497" role="paragraph" xml-lang="en-US">Copies a file.</paragraph> +</section> + +<paragraph id="hd_id3147443" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3146957" role="bascode" xml-lang="en-US">FileCopy TextFrom As String, TextTo As String</paragraph> +</bascode> + +<paragraph id="hd_id3153825" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3155390" role="paragraph" xml-lang="en-US"> <emph>TextFrom:</emph> Any string expression that specifies the name of the file that you want to copy. The expression can contain optional path and drive information. If you want, you can enter a path in <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3150669" role="paragraph" xml-lang="en-US"> <emph>TextTo:</emph> Any string expression that specifies where you want to copy the source file to. The expression can contain the destination drive, the path, and file name, or the path in URL notation.</paragraph> +<paragraph id="par_id3150791" role="note" xml-lang="en-US">You can only use the FileCopy statement to copy files that are not opened.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err76"/> + +<paragraph id="hd_id3125863" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340767600" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFileCopy</paragraph> +<paragraph id="par_idm1340766368" role="bascode" localize="false" xml-lang="en-US"> FileCopy "c:\autoexec.bat", "c:\Temp\Autoexec.sav"</paragraph> +<paragraph id="par_idm1340765104" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020407.xhp b/helpcontent2/source/text/sbasic/shared/03020407.xhp new file mode 100644 index 000000000..d198d3407 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020407.xhp @@ -0,0 +1,61 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020407xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FileDateTime Function</title> + <filename>/text/sbasic/shared/03020407.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="filedatetime"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153361"> + <bookmark_value>FileDateTime function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3153361" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020407.xhp" name="FileDateTime Function">FileDateTime Function</link></paragraph> +<paragraph id="par_id3156423" role="paragraph" xml-lang="en-US">Returns a string that contains the date and the time that a file was created or last modified.</paragraph> +</section> + +<paragraph id="hd_id3154685" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154124" role="bascode" xml-lang="en-US">FileDateTime (Text As String)</paragraph> +</bascode> + +<paragraph id="hd_id3150448" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3159153" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that contains an unambiguous (no wildcards) file specification. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3155306" role="paragraph" xml-lang="en-US">This function determines the exact time of creation or last modification of a file, returned in the format "MM.DD.YYYY HH.MM.SS".</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#languageformat"/> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3146119" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340766944" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFileDateTime</paragraph> +<paragraph id="par_idm1340765712" role="bascode" localize="false" xml-lang="en-US"> MsgBox FileDateTime("C:\autoexec.bat")</paragraph> +<paragraph id="par_idm1340764448" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020408.xhp b/helpcontent2/source/text/sbasic/shared/03020408.xhp new file mode 100644 index 000000000..bb3a030f2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020408.xhp @@ -0,0 +1,64 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020408xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FileLen Function</title> + <filename>/text/sbasic/shared/03020408.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="filelen"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153126"> + <bookmark_value>FileLen function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3153126" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020408.xhp" name="FileLen Function">FileLen Function</link></paragraph> +<paragraph id="par_id3145068" role="paragraph" xml-lang="en-US">Returns the length of a file in bytes.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3149656" role="bascode" localize="false">FileLen (Text As String) As Long</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3156282" localize="false" role="paragraph" xml-lang="en-US">Long</paragraph> +<tip id="par_id401651744449325">Use <link href="text/sbasic/shared/03/sf_filesystem.xhp" name="ScriptForge.FileSystem service">ScriptForge.FileSystem</link> service <link href="text/sbasic/shared/03/sf_filesystem.xhp#GetFileLen" name="GetFileLen method">GetFileLen()</link> method when size is expected to be over 2 gigabytes.</tip> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that contains an unambiguous file specification. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3150439" role="paragraph" xml-lang="en-US">This function determines the length of a file. If the <literal>FileLen</literal> function is called for an open file, it returns the file length before it was opened. To determine the current file length of an open file, use the <link href="text/sbasic/shared/03020303.xhp" name="Lof function"><literal>Lof</literal></link> function.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341573440" role="bascode" localize="false">Sub ExampleFileLen</paragraph> +<paragraph id="par_idm1341572208" role="bascode" localize="false"> MsgBox FileLen("C:\autoexec.bat")</paragraph> +<paragraph id="par_idm1341570960" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020409.xhp b/helpcontent2/source/text/sbasic/shared/03020409.xhp new file mode 100644 index 000000000..0eaf7067b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020409.xhp @@ -0,0 +1,171 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020409xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">GetAttr Function</title> + <filename>/text/sbasic/shared/03020409.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="getattr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150984"> + <bookmark_value>GetAttr function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150984" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020409.xhp" name="GetAttr Function">GetAttr Function</link></paragraph> +<paragraph id="par_id3154347" role="paragraph" xml-lang="en-US">Returns a bit pattern that identifies the file type or the name of a volume or a directory.</paragraph> +</section> + +<paragraph id="hd_id3149457" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150359" role="bascode" xml-lang="en-US">GetAttr (Text As String)</paragraph> +</bascode> + +<paragraph id="hd_id3151211" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154909" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3145172" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3151042" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that contains an unambiguous file specification. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3161831" role="paragraph" xml-lang="en-US">This function determines the attributes for a specified file and returns the bit pattern that can help you to identify the following file attributes:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err53"/> + +<paragraph id="hd_id3145364" role="heading" level="2" xml-lang="en-US">Value</paragraph> + +<section id="GetAttr_constants"> +<table id="Table1"> + <tablerow> + <tablecell> + <paragraph id="par_id051220170522586822" role="tablehead" xml-lang="en-US">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522583099" role="tablehead" xml-lang="en-US">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522583818" role="tablehead" xml-lang="en-US">Definition</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170522588740" role="tablecontent" localize="false" xml-lang="en-US">ATTR_NORMAL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522583733" role="tablecontent" localize="false" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3147349" role="paragraph" xml-lang="en-US"> Normal files.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170522587742" role="tablecontent" localize="false" xml-lang="en-US">ATTR_READONLY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522584092" role="tablecontent" localize="false" xml-lang="en-US">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3147434" role="paragraph" xml-lang="en-US"> Read-only files.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id05122017054654588" role="tablecontent" localize="false" xml-lang="en-US">ATTR_HIDDEN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170546549512" role="tablecontent" localize="false" xml-lang="en-US">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170546544550" role="paragraph" xml-lang="en-US"> Hidden file</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170546546528" role="tablecontent" localize="false" xml-lang="en-US">ATTR_SYSTEM</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170546548373" role="tablecontent" localize="false" xml-lang="en-US">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170546546496" role="paragraph" xml-lang="en-US"> System file</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170522588594" role="tablecontent" localize="false" xml-lang="en-US">ATTR_VOLUME</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522581431" role="tablecontent" localize="false" xml-lang="en-US">8</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3159154" role="paragraph" xml-lang="en-US"> Returns the name of the volume</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id05122017052258465" role="tablecontent" localize="false" xml-lang="en-US">ATTR_DIRECTORY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522585148" role="tablecontent" localize="false" xml-lang="en-US">16</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145271" role="paragraph" xml-lang="en-US"> Returns the name of the directory only.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170522585987" role="tablecontent" localize="false" xml-lang="en-US">ATTR_ARCHIVE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522583804" role="tablecontent" localize="false" xml-lang="en-US">32</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153953" role="paragraph" xml-lang="en-US"> File was changed since last backup (Archive bit).</paragraph> + </tablecell> + </tablerow> +</table> +</section> + +<paragraph id="par_id3156444" role="paragraph" xml-lang="en-US">If you want to know if a bit of the attribute byte is set, use the following query method:</paragraph> + +<paragraph id="hd_id3153094" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341566848" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSetGetAttr</paragraph> +<paragraph id="par_id3155415" role="bascode" xml-lang="en-US">On Error GoTo ErrorHandler ' Define target for error handler</paragraph> +<paragraph id="par_idm1341563936" role="bascode" localize="false" xml-lang="en-US"> If Dir("C:\test",16)="" Then MkDir "C:\test"</paragraph> +<paragraph id="par_idm1341562672" role="bascode" localize="false" xml-lang="en-US"> If Dir("C:\test\autoexec.sav")="" Then FileCopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph> +<paragraph id="par_idm1341561360" role="bascode" localize="false" xml-lang="en-US"> SetAttr "c:\test\autoexec.sav" ,0</paragraph> +<paragraph id="par_idm1341560096" role="bascode" localize="false" xml-lang="en-US"> FileCopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph> +<paragraph id="par_idm1341558816" role="bascode" localize="false" xml-lang="en-US"> SetAttr "c:\test\autoexec.sav" ,1</paragraph> +<paragraph id="par_idm1341557552" role="bascode" localize="false" xml-lang="en-US"> Print GetAttr( "c:\test\autoexec.sav" )</paragraph> +<paragraph id="par_idm1341556288" role="bascode" localize="false" xml-lang="en-US"> End</paragraph> +<paragraph id="par_idm1341555056" role="bascode" localize="false" xml-lang="en-US">ErrorHandler:</paragraph> +<paragraph id="par_idm1341553824" role="bascode" localize="false" xml-lang="en-US"> Print Error</paragraph> +<paragraph id="par_idm1341552592" role="bascode" localize="false" xml-lang="en-US"> End</paragraph> +<paragraph id="par_idm1341551360" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020410.xhp b/helpcontent2/source/text/sbasic/shared/03020410.xhp new file mode 100644 index 000000000..0c2214b17 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020410.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020410xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Kill Statement</title> + <filename>/text/sbasic/shared/03020410.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="kill"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153360"> + <bookmark_value>Kill statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3153360" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020410.xhp" name="Kill Statement">Kill Statement</link></paragraph> +<paragraph id="par_id3151211" role="paragraph" xml-lang="en-US">Deletes a file from a disk.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3154685" role="bascode" xml-lang="en-US">Kill File As String</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150440" role="paragraph" xml-lang="en-US"> <emph>File:</emph> Any string expression that contains an unambiguous file specification. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err76"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm871806352" role="bascode" localize="false">Sub ExampleKill</paragraph> +<paragraph id="par_id3163710" role="bascode" xml-lang="en-US"> Kill "C:\Users\ThisUser\datafile.dat" ' File must be created in advance</paragraph> +<paragraph id="par_idm871803312" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020411.xhp b/helpcontent2/source/text/sbasic/shared/03020411.xhp new file mode 100644 index 000000000..2051628f2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020411.xhp @@ -0,0 +1,104 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020411xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">MkDir Statement</title> + <filename>/text/sbasic/shared/03020411.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="mkdir"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156421"> + <bookmark_value>MkDir statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3156421" xml-lang="en-US"><link href="text/sbasic/shared/03020411.xhp" name="MkDir Statement">MkDir Statement</link></h1> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/MkDir_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">MkDir Statement diagram</alt></image> +</paragraph> +<paragraph id="par_id3147000" role="paragraph" xml-lang="en-US">Creates a new directory on a data medium.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3155150" role="bascode" xml-lang="en-US">MkDir path</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153750" role="paragraph" xml-lang="en-US"> <emph>path:</emph> Any string expression that specifies the name and path of the directory to be created. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US">If the path is not determined, the directory is created in the current directory.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err76"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341385136" role="bascode" localize="false">Sub ExampleFileIO</paragraph> +<paragraph id="par_id3149762" role="bascode" xml-lang="en-US">' Example for functions of the file organization</paragraph> +<paragraph id="par_idm1341382112" role="bascode" localize="false">Const sFile1 As String = "file://c|/autoexec.bat"</paragraph> +<paragraph id="par_idm1341380848" role="bascode" localize="false">Const sDir1 As String = "file://c|/Temp"</paragraph> +<paragraph id="par_id3149669" role="bascode" xml-lang="en-US">Const sSubDir1 As String ="Test"</paragraph> +<paragraph id="par_id3148663" role="bascode" xml-lang="en-US">Const sFile2 As String = "Copied.tmp"</paragraph> +<paragraph id="par_id3154071" role="bascode" xml-lang="en-US">Const sFile3 As String = "Renamed.tmp"</paragraph> +<paragraph id="par_idm1341374400" role="bascode" localize="false">Dim sFile As String</paragraph> +<paragraph id="par_idm1341373168" role="bascode" localize="false"> sFile = sDir1 + "/" + sSubDir1</paragraph> +<paragraph id="par_idm1341371920" role="bascode" localize="false"> ChDir( sDir1 )</paragraph> +<paragraph id="par_id3154217" role="bascode" xml-lang="en-US"> If Dir(sSubDir1,16)="" Then ' Does the directory exist?</paragraph> +<paragraph id="par_idm1341368880" role="bascode" localize="false"> MkDir sSubDir1</paragraph> +<paragraph id="par_id3147228" role="bascode" xml-lang="en-US"> MsgBox sFile,0,"Create directory"</paragraph> +<paragraph id="par_idm1341365904" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1341364672" role="bascode" localize="false"> sFile = sFile + "/" + sFile2</paragraph> +<paragraph id="par_idm1341363424" role="bascode" localize="false"> FileCopy sFile1 , sFile</paragraph> +<paragraph id="par_id3153770" role="bascode" xml-lang="en-US"> MsgBox fSysURL(CurDir()),0,"Current directory"</paragraph> +<paragraph id="par_id3159154" role="bascode" xml-lang="en-US"> MsgBox sFile & Chr(13) & FileDateTime( sFile ),0,"Creation time"</paragraph> +<paragraph id="par_id3149484" role="bascode" xml-lang="en-US"> MsgBox sFile & Chr(13)& FileLen( sFile ),0,"File length"</paragraph> +<paragraph id="par_id3152885" role="bascode" xml-lang="en-US"> MsgBox sFile & Chr(13)& GetAttr( sFile ),0,"File attributes"</paragraph> +<paragraph id="par_idm1341354896" role="bascode" localize="false"> Name sFile As sDir1 + "/" + sSubDir1 + "/" + sFile3</paragraph> +<paragraph id="par_id3153952" role="bascode" xml-lang="en-US"> ' Rename in the same directory</paragraph> +<paragraph id="par_idm1341351856" role="bascode" localize="false"> sFile = sDir1 + "/" + sSubDir1 + "/" + sFile3</paragraph> +<paragraph id="par_id3147426" role="bascode" xml-lang="en-US"> SetAttr( sFile, 0 ) 'Delete all attributes</paragraph> +<paragraph id="par_id3148647" role="bascode" xml-lang="en-US"> MsgBox sFile & Chr(13) & GetAttr( sFile ),0,"New file attributes"</paragraph> +<paragraph id="par_idm1341346992" role="bascode" localize="false"> Kill sFile</paragraph> +<paragraph id="par_idm1341345760" role="bascode" localize="false"> RmDir sDir1 + "/" + sSubDir1</paragraph> +<paragraph id="par_idm1341344512" role="bascode" localize="false">End Sub</paragraph> +<paragraph id="par_id3153157" role="bascode" localize="false"> </paragraph> +<paragraph id="par_id3150092" role="bascode" xml-lang="en-US">' Converts a system path in URL</paragraph> +<paragraph id="par_idm1341100304" role="bascode" localize="false">Function fSysURL( fSysFp As String ) As String</paragraph> +<paragraph id="par_idm1341099040" role="bascode" localize="false">Dim iPos As String</paragraph> +<paragraph id="par_idm1341097808" role="bascode" localize="false"> iPos = 1</paragraph> +<paragraph id="par_idm1341096576" role="bascode" localize="false"> iPos = Instr(iPos,fSysFp, getPathSeparator())</paragraph> +<paragraph id="par_idm1341095312" role="bascode" localize="false"> Do While iPos > 0</paragraph> +<paragraph id="par_idm1341093984" role="bascode" localize="false"> Mid( fSysFp, iPos , 1,"/")</paragraph> +<paragraph id="par_idm1341092768" role="bascode" localize="false"> iPos = Instr(iPos+1,fSysFp, getPathSeparator())</paragraph> +<paragraph id="par_idm1341091504" role="bascode" localize="false"> Loop</paragraph> +<paragraph id="par_id3156276" role="bascode" xml-lang="en-US"> ' the colon with DOS</paragraph> +<paragraph id="par_idm1341088544" role="bascode" localize="false"> iPos = Instr(1,fSysFp,":")</paragraph> +<paragraph id="par_idm1341087296" role="bascode" localize="false"> If iPos > 0 Then Mid( fSysFp, iPos , 1,"|")</paragraph> +<paragraph id="par_idm1341085952" role="bascode" localize="false"> fSysURL = "file://" & fSysFp</paragraph> +<paragraph id="par_idm1341084688" role="bascode" localize="false">End Function</paragraph> +</bascode> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03020412.xhp b/helpcontent2/source/text/sbasic/shared/03020412.xhp new file mode 100644 index 000000000..a754376d6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020412.xhp @@ -0,0 +1,65 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020412xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Name Statement</title> + <filename>/text/sbasic/shared/03020412.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="name"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143268"> + <bookmark_value>Name statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3143268" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020412.xhp" name="Name Statement">Name Statement</link></paragraph> +<paragraph id="par_id3154346" role="paragraph" xml-lang="en-US">Renames an existing file or directory.</paragraph> +</section> + +<paragraph id="hd_id3156344" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153381" role="bascode" xml-lang="en-US">Name OldName As String As NewName As String</paragraph> +</bascode> + +<paragraph id="hd_id3153362" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3151210" role="paragraph" xml-lang="en-US"> <emph>OldName, NewName:</emph> Any string expression that specifies the file name, including the path. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph><comment>see #i61074</comment> + +<paragraph id="hd_id3125863" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341617392" role="bascode" localize="false" xml-lang="en-US">Sub ExampleReName</paragraph> +<paragraph id="par_idm1341616160" role="bascode" localize="false" xml-lang="en-US">On Error GoTo Error</paragraph> +<paragraph id="par_idm1341614928" role="bascode" localize="false" xml-lang="en-US">FileCopy "c:\autoexec.bat", "c:\temp\autoexec.sav"</paragraph> +<paragraph id="par_idm1341613664" role="bascode" localize="false" xml-lang="en-US">Name "c:\temp\autoexec.sav" As "c:\temp\autoexec.bat"</paragraph> +<paragraph id="par_idm1341612400" role="bascode" localize="false" xml-lang="en-US">End</paragraph> +<paragraph id="par_idm1341611200" role="bascode" localize="false" xml-lang="en-US">Error:</paragraph> +<paragraph id="par_idm1341609968" role="bascode" localize="false" xml-lang="en-US">If err = 58 Then</paragraph> +<paragraph id="par_id3152462" role="bascode" xml-lang="en-US"> MsgBox "File already exists"</paragraph> +<paragraph id="par_idm1341607008" role="bascode" localize="false" xml-lang="en-US">End If</paragraph> +<paragraph id="par_idm1341605776" role="bascode" localize="false" xml-lang="en-US">End</paragraph> +<paragraph id="par_idm1341604576" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020413.xhp b/helpcontent2/source/text/sbasic/shared/03020413.xhp new file mode 100644 index 000000000..7d38f2cc3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020413.xhp @@ -0,0 +1,71 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020413xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">RmDir Statement</title> + <filename>/text/sbasic/shared/03020413.xhp</filename> + </topic> +</meta> + +<body> + +<section id="rmdir"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148947"> + <bookmark_value>RmDir statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3148947" xml-lang="en-US"><link href="text/sbasic/shared/03020413.xhp" name="RmDir Statement">RmDir Statement</link></h1> +<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US">Deletes an existing directory from a data medium.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/RmDir_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">RmDir Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3154367" role="bascode" xml-lang="en-US">RmDir Text As String</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3151042" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies the name and path of the directory that you want to delete. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3153192" role="paragraph" xml-lang="en-US">If the path is not determined, the <emph>RmDir Statement</emph> searches for the directory that you want to delete in the current path. If it is not found there, an error message appears.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err76"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341576272" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRmDir</paragraph> +<paragraph id="par_idm1341575040" role="bascode" localize="false" xml-lang="en-US"> MkDir "C:\Test2"</paragraph> +<paragraph id="par_idm1341573808" role="bascode" localize="false" xml-lang="en-US"> ChDir "C:\test2"</paragraph> +<paragraph id="par_idm1341572576" role="bascode" localize="false" xml-lang="en-US"> MsgBox Curdir</paragraph> +<paragraph id="par_idm1341571344" role="bascode" localize="false" xml-lang="en-US"> ChDir "\"</paragraph> +<paragraph id="par_idm1341570112" role="bascode" localize="false" xml-lang="en-US"> RmDir "C:\test2"</paragraph> +<paragraph id="par_idm1341568880" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/compatible.xhp#compatiblestatement"/> + <embed href="text/sbasic/shared/compatibilitymode.xhp#compatibilitymodeh1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020414.xhp b/helpcontent2/source/text/sbasic/shared/03020414.xhp new file mode 100644 index 000000000..e4cd4814d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020414.xhp @@ -0,0 +1,122 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020414xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SetAttr Statement</title> + <filename>/text/sbasic/shared/03020414.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="setattr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147559"> + <bookmark_value>SetAttr statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3147559" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020414.xhp" name="SetAttr Statement">SetAttr Statement</link></paragraph> +<paragraph id="par_id3147264" role="paragraph" xml-lang="en-US">Sets the attribute information for a specified file.</paragraph> +</section> + +<paragraph id="hd_id3150359" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154365" role="bascode" xml-lang="en-US">SetAttr FileName As String, Attribute As Integer</paragraph> +</bascode> + +<paragraph id="hd_id3125863" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154909" role="paragraph" xml-lang="en-US">FileName: Name of the file, including the path, that you want to test attributes of. If you do not enter a path, <emph>SetAttr</emph> searches for the file in the current directory. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<paragraph id="par_id3153192" role="paragraph" xml-lang="en-US"> <emph>Attribute:</emph> Bit pattern defining the attributes that you want to set or to clear:</paragraph> +<paragraph id="par_id3145786" role="paragraph" xml-lang="en-US"> <emph>Value</emph> </paragraph> + +<table id="Table1"> + <tablerow> + <tablecell> + <paragraph id="par_id051220170522586822" role="tablehead" xml-lang="en-US">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522583099" role="tablehead" xml-lang="en-US">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522583818" role="tablehead" xml-lang="en-US">Definition</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170522588740" role="tablecontent" localize="false" xml-lang="en-US">ATTR_NORMAL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522583733" role="tablecontent" localize="false" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3147349" role="paragraph" xml-lang="en-US"> Normal files.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051220170522587742" role="tablecontent" localize="false" xml-lang="en-US">ATTR_READONLY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170522584092" role="tablecontent" localize="false" xml-lang="en-US">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3147434" role="paragraph" xml-lang="en-US"> Read-only files.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id05122017054654588" role="tablecontent" localize="false" xml-lang="en-US">ATTR_HIDDEN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170546549512" role="tablecontent" localize="false" xml-lang="en-US">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051220170546544550" role="paragraph" xml-lang="en-US"> Hidden file</paragraph> + </tablecell> + </tablerow> +</table> + +<paragraph id="par_id3153093" role="paragraph" xml-lang="en-US">You can set multiple attributes by combining the respective values with a logic OR statement.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err53"/> +<embed href="text/sbasic/shared/00000003.xhp#err70"/> + +<paragraph id="hd_id3147434" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340803584" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSetGetAttr</paragraph> +<paragraph id="par_id3148645" role="bascode" xml-lang="en-US"> On Error GoTo ErrorHandler ' Define target for error handler</paragraph> +<paragraph id="par_idm1340800592" role="bascode" localize="false" xml-lang="en-US"> If Dir("C:\test",16)="" Then MkDir "C:\test"</paragraph> +<paragraph id="par_idm1340799328" role="bascode" localize="false" xml-lang="en-US"> If Dir("C:\test\autoexec.sav")="" Then FileCopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph> +<paragraph id="par_idm1340798016" role="bascode" localize="false" xml-lang="en-US"> SetAttr "c:\test\autoexec.sav" ,0</paragraph> +<paragraph id="par_idm1340796752" role="bascode" localize="false" xml-lang="en-US"> FileCopy "c:\autoexec.bat", "c:\test\autoexec.sav"</paragraph> +<paragraph id="par_idm1341620608" role="bascode" localize="false" xml-lang="en-US"> SetAttr "c:\test\autoexec.sav" , ATTR_READONLY</paragraph> +<paragraph id="par_idm1341619344" role="bascode" localize="false" xml-lang="en-US"> Print GetAttr( "c:\test\autoexec.sav" )</paragraph> +<paragraph id="par_idm1341618080" role="bascode" localize="false" xml-lang="en-US"> End</paragraph> +<paragraph id="par_idm1341616848" role="bascode" localize="false" xml-lang="en-US">ErrorHandler:</paragraph> +<paragraph id="par_idm1341615616" role="bascode" localize="false" xml-lang="en-US"> Print Error</paragraph> +<paragraph id="par_idm1341614384" role="bascode" localize="false" xml-lang="en-US"> End</paragraph> +<paragraph id="par_idm1341613152" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03020415.xhp b/helpcontent2/source/text/sbasic/shared/03020415.xhp new file mode 100644 index 000000000..162e1bf9b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020415.xhp @@ -0,0 +1,64 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03020415xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FileExists Function</title> + <filename>/text/sbasic/shared/03020415.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="fileexists"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148946"> + <bookmark_value>FileExists function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3148946" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020415.xhp" name="FileExists Function">FileExists Function</link></paragraph> +<paragraph id="par_id3153361" role="paragraph" xml-lang="en-US">Determines if a file or a directory is available on the data medium.</paragraph> +</section> + +<paragraph id="hd_id3150447" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154685" role="bascode" xml-lang="en-US">FileExists(FileName As String | DirectoryName As String)</paragraph> +</bascode> + +<paragraph id="hd_id3154126" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3150769" role="paragraph" xml-lang="en-US">Bool</paragraph> + +<paragraph id="hd_id3153770" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3147349" role="paragraph" xml-lang="en-US">FileName | DirectoryName: Any string expression that contains an unambiguous file specification. You can also use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3149664" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341149552" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFileExists</paragraph> +<paragraph id="par_idm1341148320" role="bascode" localize="false" xml-lang="en-US"> MsgBox FileExists("C:\autoexec.bat")</paragraph> +<paragraph id="par_idm1341147056" role="bascode" localize="false" xml-lang="en-US"> MsgBox FileExists("file:///d|/bookmark.htm")</paragraph> +<paragraph id="par_idm1341145760" role="bascode" localize="false" xml-lang="en-US"> MsgBox FileExists("file:///d|/Private")</paragraph> +<paragraph id="par_idm1341144496" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030000.xhp b/helpcontent2/source/text/sbasic/shared/03030000.xhp new file mode 100644 index 000000000..c9c3d5505 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030000.xhp @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Date and Time Functions</title> +<filename>/text/sbasic/shared/03030000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="date_time"> + <paragraph id="hd_id3150502" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030000.xhp" name="Date and Time Functions">Date and Time Functions</link></paragraph> + <paragraph role="paragraph" id="par_id3153255" xml-lang="en-US">Use the statements and functions described here to perform date and time calculations.</paragraph> + </section> + <paragraph role="paragraph" id="par_id3152363" xml-lang="en-US"><item type="productname">%PRODUCTNAME</item> Basic lets you calculate time or date differences by converting the time and date values to continuous numeric values. After the difference is calculated, special functions are used to reconvert the values to the standard time or date formats.</paragraph> + <paragraph xml-lang="en-US" role="tip" id="par_id3151054">You can combine date and time values into a single floating-decimal number. Dates are converted to integers, and times to decimal values. <item type="productname">%PRODUCTNAME</item> Basic also supports the variable type Date, which can contain a time specification consisting of both a date and time.</paragraph> + <embed href="text/sbasic/shared/03030100.xhp#datevalues"/> + <embed href="text/sbasic/shared/03030200.xhp#timevalues"/> + <embed href="text/sbasic/shared/03030300.xhp#determine"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030100.xhp b/helpcontent2/source/text/sbasic/shared/03030100.xhp new file mode 100644 index 000000000..bbc69eac4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030100.xhp @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030100xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Converting Date Values</title> +<filename>/text/sbasic/shared/03030100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="datevalues"> +<paragraph role="heading" id="hd_id3147573" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03030100.xhp" name="Converting Date Values">Converting Date Values</link></paragraph> +<paragraph role="paragraph" id="par_id3154760" xml-lang="en-US">The following functions convert date values to calculable numbers and back.</paragraph> +</section> +<embed href="text/sbasic/shared/03030101.xhp#dateserial"/> +<embed href="text/sbasic/shared/03030102.xhp#datevalue"/> +<embed href="text/sbasic/shared/03030103.xhp#day"/> +<embed href="text/sbasic/shared/03030104.xhp#month"/> +<embed href="text/sbasic/shared/03030105.xhp#weekday"/> +<embed href="text/sbasic/shared/03030106.xhp#year"/> +<embed href="text/sbasic/shared/03030107.xhp#cdatetoiso"/> +<embed href="text/sbasic/shared/03030108.xhp#cdatefromiso"/> +<embed href="text/sbasic/shared/03030111.xhp#cdatetounodate"/> +<embed href="text/sbasic/shared/03030112.xhp#cdatefromunodate"/> +<embed href="text/sbasic/shared/03030115.xhp#cdatetounodatetime"/> +<embed href="text/sbasic/shared/03030116.xhp#cdatefromunodatetime"/> +<embed href="text/sbasic/shared/03030110.xhp#dateadd"/> +<embed href="text/sbasic/shared/03030120.xhp#datediff"/> +<embed href="text/sbasic/shared/03030130.xhp#datepart"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030101.xhp b/helpcontent2/source/text/sbasic/shared/03030101.xhp new file mode 100644 index 000000000..2ee2203c3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030101.xhp @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030101xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">DateSerial Function</title> +<filename>/text/sbasic/shared/03030101.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="dateserial"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3157896"><bookmark_value>DateSerial function</bookmark_value> +</bookmark> +<h1 id="hd_id381619878817271"><variable id="DateSerial_H1"><link href="text/sbasic/shared/03030101.xhp" name="DateSerial Function">DateSerial Function</link></variable></h1> +<paragraph role="paragraph" id="par_id3143267" xml-lang="en-US">Returns a <emph>Date</emph> value for a specified year, month, or day.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_id3149670" xml-lang="en-US">DateSerial (year, month, day)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" id="par_id3150398" xml-lang="en-US">Date</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3147229" xml-lang="en-US"> +<emph>Year:</emph> Integer expression that indicates a year. All values between 0 and 99 are interpreted as the years 1900-1999. For years that fall outside this range, you must enter all four digits.</paragraph> +<paragraph role="paragraph" id="par_id3156280" xml-lang="en-US"> +<emph>Month:</emph> Integer expression that indicates the month of the specified year. The accepted range is from 1-12.</paragraph> +<paragraph role="paragraph" id="par_id3151043" xml-lang="en-US"> +<emph>Day:</emph> Integer expression that indicates the day of the specified month. The accepted range is from 1-31. No error is returned when you enter a non-existing day for a month shorter than 31 days.<comment>see i69463</comment></paragraph> +<paragraph role="paragraph" id="par_id3161832" xml-lang="en-US">The <emph>DateSerial function</emph> returns the number of days between December 30,1899 and the given date. You can use this function to calculate the difference between two dates.</paragraph> +<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US">The <emph>DateSerial function</emph> returns the data type Variant with VarType 7 (Date). Internally, this value is stored as a Double value, so that when the given date is 1.1.1900, the returned value is 2. Negative values correspond to dates before December 30, 1899 (not inclusive).</paragraph> +<paragraph role="paragraph" id="par_id3152576" xml-lang="en-US">If a date is defined that lies outside of the accepted range, $[officename] Basic returns an error message.</paragraph> +<paragraph role="paragraph" id="par_id3149481" xml-lang="en-US">Whereas you define the <emph>DateValue function</emph> as a string that contains the date, the <emph>DateSerial function</emph> evaluates each of the parameters (year, month, day) as separate numeric expressions.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" id="par_id3148646" localize="false">Sub ExampleDateSerial</paragraph> + <paragraph role="bascode" id="par_id3156441" localize="false">Dim lDate As Long</paragraph> + <paragraph role="bascode" id="par_id3154791" localize="false">Dim sDate As String</paragraph> + <paragraph role="bascode" id="par_id3155415" localize="false"> lDate = DateSerial(1964, 4, 9)</paragraph> + <paragraph role="bascode" id="par_id3147125" localize="false"> sDate = DateSerial(1964, 4, 9)</paragraph> + <paragraph role="bascode" id="par_id3154942"> MsgBox lDate ' returns 23476</paragraph> + <paragraph role="bascode" id="par_id3151074"> MsgBox sDate ' returns 04/09/1964</paragraph> + <paragraph role="bascode" id="par_id3153878" localize="false">End Sub</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030102.xhp b/helpcontent2/source/text/sbasic/shared/03030102.xhp new file mode 100644 index 000000000..aea6339a0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030102.xhp @@ -0,0 +1,73 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="textsbasicshared03030102xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DateValue Function</title> + <filename>/text/sbasic/shared/03030102.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + +<section id="datevalue"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3156344"><bookmark_value>DateValue function</bookmark_value> + </bookmark> + <h1 id="hd_id3156344"><variable id="DateValue_H1"><link href="text/sbasic/shared/03030102.xhp" name="DateValue Function">DateValue Function</link></variable></h1> + <paragraph role="paragraph" id="par_id3150542" xml-lang="en-US">Returns a <emph>Date</emph> object from a string representing a date.</paragraph> + <paragraph role="paragraph" id="par_id671643046319326">The returned object is represented internally as a single numeric value corresponding to the specified date. This value can be used to calculate the number of days between two dates.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph role="bascode" id="par_id3154910" xml-lang="en-US">DateValue(date As String)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<section id="parm1"> + <paragraph role="paragraph" id="par_id3153770"><emph>date</emph>: A string that contains the date that will be converted to a <emph>Date</emph> object.</paragraph> + <note id="par_id841643046880968">The string passed to <literal>DateValue</literal> must be expressed in one of the date formats defined by your locale setting (see <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><menuitem> - Language Settings - Languages</menuitem>) or using the ISO date format "yyyy-mm-dd" (year, month and day separated by hyphens).</note> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" localize="false" id="par_id3153194">Date.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" localize="false" id="par_id3155412">Sub ExampleDateValue</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671643047301348"> Dim aDate As Date</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291643047301592"> aDate = DateValue("2021-12-20")</paragraph> + <paragraph role="bascode" id="bas_id461643047301827"> ' Prints the localized date</paragraph> + <paragraph role="bascode" localize="false" id="bas_id551643047302107"> MsgBox aDate</paragraph> + <paragraph role="bascode" id="bas_id616430473023063"> ' Extracts the year, month and day from the date object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281643047302645"> MsgBox Year(aDate)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id391643047302940"> MsgBox Month(aDate)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201643047303163"> MsgBox Day(aDate)</paragraph> + <paragraph role="bascode" id="bas_id601643047303420"> ' Prints the numeric value corresponding to the date (as Long type)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id381643047303644"> MsgBox CLng(aDate)</paragraph> + <paragraph role="bascode" localize="false" id="par_id3149262">End Sub</paragraph> +</bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03030101.xhp#DateSerial_H1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030103.xhp b/helpcontent2/source/text/sbasic/shared/03030103.xhp new file mode 100644 index 000000000..b39292b03 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030103.xhp @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030103xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Day Function</title> +<filename>/text/sbasic/shared/03030103.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="day"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153345"><bookmark_value>Day function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03030103.xhp" name="Day Function">Day Function</link></paragraph> +<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US">Returns a value that represents the day of the month based on a serial date number generated by <emph>DateSerial</emph> or <emph>DateValue</emph>.</paragraph> +</section> +<paragraph role="heading" id="hd_id3149456" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3150358" xml-lang="en-US">Day (Number)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3148798" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3125865" xml-lang="en-US">Integer</paragraph> +<paragraph role="heading" id="hd_id3150448" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3156423" xml-lang="en-US"> +<emph>Number:</emph> A numeric expression that contains a serial date number from which you can determine the day of the month.</paragraph> +<paragraph role="paragraph" id="par_id3145786" xml-lang="en-US">This function is basically the opposite of the DateSerial function, returning the day of the month from a serial date number generated by the <emph>DateSerial</emph> or the <emph>DateValue</emph> function. For example, the expression</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3145364" xml-lang="en-US" localize="false">Print Day (DateSerial(1994, 12, 20))</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3153190" xml-lang="en-US">returns the value 20.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<paragraph role="heading" id="hd_id3149481" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3155413" xml-lang="en-US" localize="false">Sub ExampleDay</paragraph> +<paragraph role="bascode" id="par_id3149260" xml-lang="en-US"> Print "Day " & Day(DateSerial(1994, 12, 20)) & " of the month"</paragraph> +<paragraph role="bascode" id="par_id3148645" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03030104.xhp b/helpcontent2/source/text/sbasic/shared/03030104.xhp new file mode 100644 index 000000000..90e7d4754 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030104.xhp @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030104xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Month Function</title> +<filename>/text/sbasic/shared/03030104.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="month"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153127"><bookmark_value>Month function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3153127" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03030104.xhp" name="Month Function">Month Function</link></paragraph> +<paragraph role="paragraph" id="par_id3148550" xml-lang="en-US">Returns the month of a year from a serial date that is generated by the DateSerial or the DateValue function.</paragraph> +</section> +<paragraph role="heading" id="hd_id3145068" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3150398" xml-lang="en-US">Month (Number)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3154366" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3154125" xml-lang="en-US">Integer</paragraph> +<paragraph role="heading" id="hd_id3150768" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3156423" xml-lang="en-US"> +<emph>Number:</emph> Numeric expression that contains the serial date number that is used to determine the month of the year.</paragraph> +<paragraph role="paragraph" id="par_id3153770" xml-lang="en-US">This function is the opposite of the <emph>DateSerial </emph>function. It returns the month in the year that corresponds to the serial date that is generated by <emph>DateSerial</emph> or <emph>DateValue</emph>. For example, the expression</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3147426" xml-lang="en-US" localize="false">Print Month(DateSerial(1994, 12, 20))</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3145366" xml-lang="en-US">returns the value 12.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<paragraph role="heading" id="hd_id3146923" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3156442" xml-lang="en-US" localize="false">Sub ExampleMonth</paragraph> +<paragraph role="bascode" id="par_id3149664" xml-lang="en-US"> MsgBox "" & Month(Now) ,64,"The current month"</paragraph> +<paragraph role="bascode" id="par_id3150012" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03030105.xhp b/helpcontent2/source/text/sbasic/shared/03030105.xhp new file mode 100644 index 000000000..f2bd1dad4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030105.xhp @@ -0,0 +1,194 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> + <topic id="textsbasicshared03030105xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">WeekDay Function</title> + <filename>/text/sbasic/shared/03030105.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> +</meta> +<body> +<section id="weekday"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153127"> + <bookmark_value>WeekDay function</bookmark_value> +</bookmark> + +<h1 id="hd_id3153127"><variable id="WeekDay_H1"><link href="text/sbasic/shared/03030105.xhp" name="WeekDay Function">WeekDay Function</link></variable></h1> +<paragraph role="paragraph" id="par_id3146795" xml-lang="en-US">This function returns the number corresponding to the weekday represented by a serial date number that is generated by the <literal>DateSerial</literal> or the <literal>DateValue</literal> functions.</paragraph> +</section> +<note id="par_id91620239579003">This help page describes the <literal>WeekDay</literal> function used in Basic scripts. If you are interested in the <literal>WeekDay</literal> function used in %PRODUCTNAME Calc, refer to <link href="text/scalc/01/func_weekday.xhp" name="WeekDay_Calc Function">this help page</link>.</note> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph role="bascode" id="par_id3149655" xml-lang="en-US">WeekDay (SerialDate, [FirstDayOfWeek])</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3151042" xml-lang="en-US"> +<emph>SerialDate:</emph> Integer expression that contains the serial date number that is used to calculate the day of the week.</paragraph> +<paragraph role="paragraph" id="par_id351619718411921"> +<emph>FirstDayOfWeek:</emph> Integer value indicating which weekday should be considered as the first day of the week. The default value is <emph>0</emph>, meaning that the system locale settings are used to determine the first day of the week.</paragraph> +<paragraph role="paragraph" id="par_id411619718769819">The parameter <emph>FirstDayOfWeek</emph> accepts values ranging from 0 to 7. The table below describes the meaning of each possible value:</paragraph> +<section id="WeekDay_constants"> +<table id="tab_id191619718816238"> + <tablerow> + <tablecell> + <paragraph id="par_id651619719561092" role="tablehead">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251619718816238" role="tablehead">VBA Constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711619718816238" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731619718847838" role="tablecontent" localize="false">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619718847702" role="tablecontent" localize="false">vbUseSystemDayOfWeek</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521619718818972" role="tablecontent">Use system locale settings</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821619719164117" role="tablecontent" localize="false">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619718847885" role="tablecontent" localize="false">vbSunday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581619719174897" role="tablecontent">Sunday (default)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821619719164241" role="tablecontent" localize="false">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619718844633" role="tablecontent" localize="false">vbMonday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581619719173258" role="tablecontent">Monday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821619719168871" role="tablecontent" localize="false">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619718840122" role="tablecontent" localize="false">vbTuesday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581619719174633" role="tablecontent">Tuesday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821619719162897" role="tablecontent" localize="false">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619718843362" role="tablecontent" localize="false">vbWednesday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581619719173641" role="tablecontent">Wednesday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821619719168022" role="tablecontent" localize="false">5</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619718849336" role="tablecontent" localize="false">vbThursday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581619719170014" role="tablecontent">Thursday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821619719164776" role="tablecontent" localize="false">6</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619718849699" role="tablecontent" localize="false">vbFriday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581619719174271" role="tablecontent">Friday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821619719169044" role="tablecontent" localize="false">7</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id731619718849001" role="tablecontent" localize="false">vbSaturday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id581619719176055" role="tablecontent">Saturday</paragraph> + </tablecell> + </tablerow> +</table> +</section> +<note id="par_id451619720094202">The VBA constants listed above are only available if VBA support has been enabled. For more information, read the <link href="text/sbasic/shared/03103350.xhp" name="VBASupport_Statement">VBASupport Statement</link> help page.</note> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" id="par_id3154125" xml-lang="en-US">Integer</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<paragraph role="paragraph" id="par_id3159254" xml-lang="en-US">The following example uses the function <literal>Now()</literal> to determine the current weekday.</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3145749" localize="false">Sub ExampleWeekDay</paragraph> +<paragraph role="bascode" id="par_id3147426" localize="false"> Dim sDay As String</paragraph> +<paragraph role="bascode" id="par_id3148576"> ' Return And display the day of the week</paragraph> +<paragraph role="bascode" id="par_id3155412" localize="false"> Select Case WeekDay( Now )</paragraph> +<paragraph role="bascode" id="par_id3151117"> Case 1: sDay="Sunday"</paragraph> +<paragraph role="bascode" id="par_id3153952"> Case 2: sDay="Monday"</paragraph> +<paragraph role="bascode" id="par_id3153157"> Case 3: sDay="Tuesday"</paragraph> +<paragraph role="bascode" id="par_id3154942"> Case 4: sDay="Wednesday"</paragraph> +<paragraph role="bascode" id="par_id3155416"> Case 5: sDay="Thursday"</paragraph> +<paragraph role="bascode" id="par_id3154015"> Case 6: sDay="Friday"</paragraph> +<paragraph role="bascode" id="par_id3153707"> Case 7: sDay="Saturday"</paragraph> +<paragraph role="bascode" id="par_id3155065" localize="false"> End Select</paragraph> +<paragraph role="bascode" id="par_id3148993"> MsgBox "" + sDay,64,"Today Is"</paragraph> +<paragraph role="bascode" id="par_id3149019" localize="false">End Sub</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id891619721286262">The following example illustrates the use <emph>FirstDayOfWeek</emph> parameter, assuming that Tuesday is the first day of the week.</paragraph> +<bascode> + <paragraph role="bascode" localize="false" id="bas_id71619721723893">Dim someDay As Long</paragraph> + <paragraph role="bascode" id="bas_id791619721724107">' The date January 1st 2021 was a Friday</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441619721724360">someDay = DateSerial(2021, 01, 01)</paragraph> + <paragraph role="bascode" id="bas_id991619721724568">' Prints "6" assuming Sunday is the first day of the week</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291619721724784">MsgBox WeekDay(someDay)</paragraph> + <paragraph role="bascode" id="bas_id31619721725024">' Prints "4" assuming Tuesday is the first day of the week</paragraph> + <paragraph role="bascode" localize="false" id="bas_id301619721725289">MsgBox WeekDay(someDay, 3)</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03030101.xhp#DateSerial_H1"/> + <embed href="text/sbasic/shared/03030102.xhp#DateValue_H1"/> + <embed href="text/sbasic/shared/03030203.xhp#Now_H1"/> + <embed href="text/scalc/01/func_weekday.xhp#weekday"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030106.xhp b/helpcontent2/source/text/sbasic/shared/03030106.xhp new file mode 100644 index 000000000..6d99a611a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030106.xhp @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030106xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Year Function</title> +<filename>/text/sbasic/shared/03030106.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="year"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148664"><bookmark_value>Year function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3148664" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03030106.xhp" name="Year Function">Year Function</link></paragraph> +<paragraph role="paragraph" id="par_id3149655" xml-lang="en-US">Returns the year from a serial date number that is generated by the DateSerial or the DateValue function.</paragraph> +</section> +<paragraph role="heading" id="hd_id3154125" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3147229" xml-lang="en-US">Year (Number)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3154685" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3153970" xml-lang="en-US">Integer</paragraph> +<paragraph role="heading" id="hd_id3150440" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3163712" xml-lang="en-US"> +<emph>Number:</emph> Integer expression that contains the serial date number that is used to calculate the year.</paragraph> +<paragraph role="paragraph" id="par_id3152596" xml-lang="en-US">This function is the opposite of the <emph>DateSerial </emph>function, and returns the year of a serial date. For example, the expression:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3154319" xml-lang="en-US" localize="false">Print Year(DateSerial(1994, 12, 20))</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3149483" xml-lang="en-US">returns the value 1994.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<paragraph role="heading" id="hd_id3146985" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3153952" xml-lang="en-US" localize="false">Sub ExampleYear</paragraph> +<paragraph role="bascode" id="par_id3153363" xml-lang="en-US"> MsgBox "" & Year(Now) ,64,"Current year"</paragraph> +<paragraph role="bascode" id="par_id3145274" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03030107.xhp b/helpcontent2/source/text/sbasic/shared/03030107.xhp new file mode 100644 index 000000000..947b738f9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030107.xhp @@ -0,0 +1,62 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030107xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDateToIso Function</title> + <filename>/text/sbasic/shared/03030107.xhp</filename> + </topic> +</meta> + +<body> + +<section id="cdatetoiso"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150620"> + <bookmark_value>CdateToIso function</bookmark_value> +</bookmark> + +<paragraph id="hd_id3150620" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030107.xhp" name="CDateToIso Function">CDateToIso Function</link></paragraph> +<paragraph id="par_id3151097" role="paragraph" xml-lang="en-US">Returns the date in ISO format without separators (YYYYMMDD) from a serial date number that is generated by the DateSerial or the DateValue or the CDateFromIso function.</paragraph> +<paragraph id="par_id3151098" role="paragraph" xml-lang="en-US">The year part consists of at least four digits, with leading zeros if the absolute value is less than 1000, it can be negative with a leading minus sign if the date passed denotes a year before the common era (BCE) and it can have more than four digits if the absolute value is greater than 9999. The formatted string returned can be in the range "-327680101" to "327671231".</paragraph> +<paragraph id="par_id3151099" role="note" xml-lang="en-US">Years less than 100 and greater than 9999 are supported since %PRODUCTNAME 5.4.</paragraph> +</section> + +<paragraph id="hd_id3159224" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149497" role="bascode" xml-lang="en-US">CDateToIso(Number)</paragraph> +</bascode> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154422" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3147303" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Integer that contains the serial date number.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147243" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341132912" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCDateToIso</paragraph> +<paragraph id="par_id3153126" role="bascode" xml-lang="en-US"> MsgBox "" & CDateToIso(Now) ,64,"ISO Date"</paragraph> +<paragraph id="par_idm1341129856" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030108.xhp b/helpcontent2/source/text/sbasic/shared/03030108.xhp new file mode 100644 index 000000000..1662472af --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030108.xhp @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030108xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">CDateFromIso Function</title> +<filename>/text/sbasic/shared/03030108.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="cdatefromiso"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153127"><bookmark_value>CdateFromIso function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3153127" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03030108.xhp" name="CDateFromIso Function">CDateFromIso Function</link></paragraph> +<paragraph role="paragraph" id="par_id3148550" xml-lang="en-US">Returns the internal date number from a string that contains a date in ISO format (YYYYMMDD or YYYY-MM-DD).</paragraph> +<paragraph id="par_id3148551" role="paragraph" xml-lang="en-US">The year part must consist of either two (supported only in YYMMDD format without separators for compatibility) or at least four digits. With four digits leading zeros must be given if the absolute value is less than 1000, it can be negative with a leading minus sign if the date passed denotes a year before the common era (BCE) and it can have more than four digits if the absolute value is greater than 9999. The formatted string can be in the range "-327680101" to "327671231", or "-32768-01-01" to "32767-12-31".</paragraph> +<paragraph id="par_id3148552" role="paragraph" xml-lang="en-US">An invalid date results in an error. Year 0 is not accepted, the last day BCE is -0001-12-31 and the next day CE is 0001-01-01. Dates before 1582-10-15 are in the proleptic Gregorian calendar.</paragraph> +<paragraph id="par_id3148553" role="tip" xml-lang="en-US">When converting a date serial number to a printable string, for example for the Print or MsgBox command, the locale's default calendar is used and at that 1582-10-15 cutover date may switch to the Julian calendar, which can result in a different date being displayed than expected. Use the <link href="text/sbasic/shared/03030107.xhp" name="CDateToIso Function">CDateToIso Function</link> to convert such date number to a string representation in the proleptic Gregorian calendar.</paragraph> +<paragraph id="par_id3148554" role="note" xml-lang="en-US">The YYYY-MM-DD format with separators is supported since %PRODUCTNAME 5.3.4. Years less than 100 or greater than 9999 are accepted since %PRODUCTNAME 5.4 if not in VBA compatibility mode.</paragraph> +</section> +<paragraph role="heading" id="hd_id3148947" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" localize="false" id="par_id3150400" xml-lang="en-US">CDateFromIso(String)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3154367" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3156212" xml-lang="en-US">Internal date number</paragraph> +<paragraph role="heading" id="hd_id3125864" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3154685" xml-lang="en-US"> +<emph>String:</emph> A string that contains a date in ISO format.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<paragraph role="heading" id="hd_id3150439" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> + <paragraph role="bascode" localize="false" id="par_id3147318" xml-lang="en-US">dateval = CDateFromIso("20021231")</paragraph> + <paragraph role="bascode" localize="false" id="par_id3147319" xml-lang="en-US">dateval = CDateFromIso("2002-12-31")</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3146921" xml-lang="en-US">return both 12/31/2002 in the date format of your system</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030110.xhp b/helpcontent2/source/text/sbasic/shared/03030110.xhp new file mode 100644 index 000000000..f8768bd70 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030110.xhp @@ -0,0 +1,157 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030110xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DateAdd Function</title> + <filename>/text/sbasic/shared/03030110.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="dateadd"> +<bookmark xml-lang="en-US" branch="index" id="bm_id6269417"> + <bookmark_value>DateAdd function</bookmark_value> +</bookmark> + + +<h1 id="par_idN10548" xml-lang="en-US"><link href="text/sbasic/shared/03030110.xhp">DateAdd Function</link></h1> +<paragraph id="par_idN10558" role="paragraph" xml-lang="en-US">Adds a date or time interval to a given date a number of times and returns the resulting date.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_idN1055F" role="bascode" xml-lang="en-US">DateAdd (interval As String, number As Long, date As Date) As Date</paragraph> +</bascode> + +<paragraph id="par_idN1061E" role="heading" level="3" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_idN10622" role="paragraph" xml-lang="en-US">A Variant containing a date.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_idN10629" role="paragraph" xml-lang="en-US"><emph>interval</emph> - A string expression from the following table, specifying the date or time interval.</paragraph> + +<section id="datetable"> + +<table id="tbl_id7568285"> + <tablerow> + <tablecell> + <paragraph id="par_idN10636" role="tablehead" xml-lang="en-US">interval (string value)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN1063C" role="tablehead" xml-lang="en-US">Explanation</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10643" role="tablecontent" xml-lang="en-US">yyyy</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10649" role="tablecontent" xml-lang="en-US">Year</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10650" role="tablecontent" xml-lang="en-US">q</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10656" role="tablecontent" xml-lang="en-US">Quarter</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN1065D" role="tablecontent" xml-lang="en-US">m</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10663" role="tablecontent" xml-lang="en-US">Month</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN1066A" role="tablecontent" xml-lang="en-US">y</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10670" role="tablecontent" xml-lang="en-US">Day of year</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10677" role="tablecontent" xml-lang="en-US">w</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN1067D" role="tablecontent" xml-lang="en-US">Weekday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10684" role="tablecontent" xml-lang="en-US">ww</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN1068A" role="tablecontent" xml-lang="en-US">Week of year</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10691" role="tablecontent" xml-lang="en-US">d</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10697" role="tablecontent" xml-lang="en-US">Day</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN1069E" role="tablecontent" xml-lang="en-US">h</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106A4" role="tablecontent" xml-lang="en-US">Hour</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN106AB" role="tablecontent" xml-lang="en-US">n</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106B1" role="tablecontent" xml-lang="en-US">Minute</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN106B8" role="tablecontent" xml-lang="en-US">s</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106BE" role="tablecontent" xml-lang="en-US">Second</paragraph> + </tablecell> + </tablerow> +</table> + +</section> +<paragraph id="par_idN106C1" role="paragraph" xml-lang="en-US"><emph>number</emph> - A numerical expression specifying how many times the <literal>interval</literal> value will be added when positive or subtracted when negative.</paragraph> +<paragraph id="par_idN106C4" role="paragraph" xml-lang="en-US"><emph>date</emph> - A given date or the name of a Variant variable containing a date. The <literal>interval</literal> value will be added <literal>number</literal> times to this date.</paragraph> +<embed href="text/sbasic/shared/01020100.xhp#DateLiterals"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/><bascode> +<paragraph id="par_idm1340825424" role="bascode" localize="false">Sub example_dateadd</paragraph> +<paragraph id="par_idm1340824192" role="bascode" localize="false"> MsgBox DateAdd("m", 1, #1/31/2004#) &" - "& DateAdd(date:=#2005-01-31#, interval:="m", number:=1)</paragraph> +<paragraph id="par_idm1340822896" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030111.xhp b/helpcontent2/source/text/sbasic/shared/03030111.xhp new file mode 100644 index 000000000..748dfe0ed --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030111.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030111xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDateToUnoDate Function</title> + <filename>/text/sbasic/shared/03030111.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="cdatetounodate"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150620"> + <bookmark_value>CDateToUnoDate function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150620" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030111.xhp" name="CDateToUnoDate Function">CDateToUnoDate Function</link></paragraph> +<paragraph id="par_id3151097" role="paragraph" xml-lang="en-US">Returns the date as a UNO com.sun.star.util.Date struct.</paragraph> +</section> + +<paragraph id="hd_id3159224" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149497" role="bascode" xml-lang="en-US">CDateToUnoDate(aDate)</paragraph> +</bascode> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154422" role="paragraph" xml-lang="en-US">com.sun.star.util.Date</paragraph> + +<paragraph id="hd_id3147303" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US"> <emph>aDate:</emph> Date to convert</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147243" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341576768" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCDateToUnoDate</paragraph> +<paragraph id="par_id3153126" role="bascode" localize="false" xml-lang="en-US"> aDatabaseRow.updateDate(3, CDateToUnoDate(Now))</paragraph> +<paragraph id="par_id3153127" role="bascode" localize="false" xml-lang="en-US"> aDateControl.Date = CDateToUnoDate(Now)</paragraph> +<paragraph id="par_idm1341571968" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030112.xhp b/helpcontent2/source/text/sbasic/shared/03030112.xhp new file mode 100644 index 000000000..4bc61338a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030112.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030112xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDateFromUnoDate Function</title> + <filename>/text/sbasic/shared/03030112.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="cdatefromunodate"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150620"> + <bookmark_value>CDateFromUnoDate function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150620" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030112.xhp" name="CDateFromUnoDate Function">CDateFromUnoDate Function</link></paragraph> +<paragraph id="par_id3151097" role="paragraph" xml-lang="en-US">Converts a UNO com.sun.star.util.Date struct to a Date value.</paragraph> +</section> + +<paragraph id="hd_id3159224" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149497" localize="false" role="bascode">CDateFromUnoDate(aDate)</paragraph> +</bascode> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154422" role="paragraph" xml-lang="en-US">Date</paragraph> + +<paragraph id="hd_id3147303" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US"> <emph>aDate:</emph> Date to convert</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147243" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341052400" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCDateFromUnoDate</paragraph> +<paragraph id="par_id3153126" role="bascode" localize="false" xml-lang="en-US"> MsgBox(CDateFromUnoDate(aDatabaseRow.getDate(3)))</paragraph> +<paragraph id="par_id3153127" role="bascode" localize="false" xml-lang="en-US"> MsgBox(CDateFromUnoDate(aDateControl.Date))</paragraph> +<paragraph id="par_idm1341047600" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030113.xhp b/helpcontent2/source/text/sbasic/shared/03030113.xhp new file mode 100644 index 000000000..1a19ab689 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030113.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030113xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDateToUnoTime Function</title> + <filename>/text/sbasic/shared/03030113.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="cdatetounotime"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150620"> + <bookmark_value>CDateToUnoTime function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150620" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030113.xhp" name="CDateToUnoTime Function">CDateToUnoTime Function</link></paragraph> +<paragraph id="par_id3151097" role="paragraph" xml-lang="en-US">Returns the time part of the date as a UNO com.sun.star.util.Time struct.</paragraph> +</section> + +<paragraph id="hd_id3159224" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149497" role="bascode" xml-lang="en-US">CDateToUnoTime(aDate)</paragraph> +</bascode> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154422" role="paragraph" xml-lang="en-US">com.sun.star.util.Time</paragraph> + +<paragraph id="hd_id3147303" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US"> <emph>aDate:</emph> Date value to convert</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147243" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341576752" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCDateToUnoTime</paragraph> +<paragraph id="par_id3153126" role="bascode" localize="false" xml-lang="en-US"> aDatabaseRow.updateTime(3, CDateToUnoTime(Now))</paragraph> +<paragraph id="par_id3153127" role="bascode" localize="false" xml-lang="en-US"> aTimeControl.Time = CDateToUnoTime(Now)</paragraph> +<paragraph id="par_idm1341571952" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030114.xhp b/helpcontent2/source/text/sbasic/shared/03030114.xhp new file mode 100644 index 000000000..2c37d6778 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030114.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030114xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDateFromUnoTime Function</title> + <filename>/text/sbasic/shared/03030114.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="cdatefromunotime"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150620"> + <bookmark_value>CDateFromUnoTime function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150620" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030114.xhp" name="CDateFromUnoTime Function">CDateFromUnoTime Function</link></paragraph> +<paragraph id="par_id3151097" role="paragraph" xml-lang="en-US">Converts a UNO com.sun.star.util.Time struct to a Date value.</paragraph> +</section> + +<paragraph id="hd_id3159224" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149497" role="bascode" xml-lang="en-US">CDateFromUnoTime(aTime)</paragraph> +</bascode> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154422" role="paragraph" xml-lang="en-US">Date</paragraph> + +<paragraph id="hd_id3147303" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US"> <emph>aTime:</emph> Time to convert</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147243" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340912560" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCDateFromUnoTime</paragraph> +<paragraph id="par_id3153126" role="bascode" localize="false" xml-lang="en-US"> MsgBox(CDateFromUnoTime(aDatabaseRow.getTime(3)))</paragraph> +<paragraph id="par_id3153127" role="bascode" localize="false" xml-lang="en-US"> MsgBox(CDateFromUnoTime(aTimeControl.Time))</paragraph> +<paragraph id="par_idm1340907760" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030115.xhp b/helpcontent2/source/text/sbasic/shared/03030115.xhp new file mode 100644 index 000000000..7523d3264 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030115.xhp @@ -0,0 +1,62 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030115xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDateToUnoDateTime Function</title> + <filename>/text/sbasic/shared/03030115.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="cdatetounodatetime"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150620"> + <bookmark_value>CDateToUnoDateTime function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150620" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030115.xhp" name="CDateToUnoDateTime Function">CDateToUnoDateTime Function</link></paragraph> +<paragraph id="par_id3151097" role="paragraph" xml-lang="en-US">Returns the time part of the date as a UNO com.sun.star.util.DateTime struct.</paragraph> +</section> + +<paragraph id="hd_id3159224" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149497" role="bascode" xml-lang="en-US">CDateToUnoDateTime(aDate)</paragraph> +</bascode> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154422" role="paragraph" xml-lang="en-US">com.sun.star.util.DateTime</paragraph> + +<paragraph id="hd_id3147303" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US"> <emph>aDate:</emph> Date value to convert</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147243" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1206672048" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCDateToUnoDateTime</paragraph> +<paragraph id="par_id3153126" role="bascode" localize="false" xml-lang="en-US"> aDatabaseRow.updateTimestamp(3, CDateToUnoDateTime(Now))</paragraph> +<paragraph id="par_idm1206669312" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030116.xhp b/helpcontent2/source/text/sbasic/shared/03030116.xhp new file mode 100644 index 000000000..f46887f53 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030116.xhp @@ -0,0 +1,62 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030116xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDateFromUnoDateTime Function</title> + <filename>/text/sbasic/shared/03030116.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="cdatefromunodatetime"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150620"> + <bookmark_value>CDateFromUnoDateTime function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150620" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030116.xhp" name="CDateFromUnoDateTime Function">CDateFromUnoDateTime Function</link></paragraph> +<paragraph id="par_id3151097" role="paragraph" xml-lang="en-US">Converts a UNO com.sun.star.util.DateTime struct to a Date value.</paragraph> +</section> + +<paragraph id="hd_id3159224" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149497" role="bascode" xml-lang="en-US">CDateFromUnoDateTime(aDateTime)</paragraph> +</bascode> + +<paragraph id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154422" role="paragraph" xml-lang="en-US">Date</paragraph> + +<paragraph id="hd_id3147303" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US"> <emph>aDateTime:</emph> DateTime to convert</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147243" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1073172720" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCDateFromUnoDateTime</paragraph> +<paragraph id="par_id3153126" role="bascode" localize="false" xml-lang="en-US"> MsgBox(CDateFromUnoDateTime(aDatabaseRow.getTimestamp(3)))</paragraph> +<paragraph id="par_idm1073169680" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030120.xhp b/helpcontent2/source/text/sbasic/shared/03030120.xhp new file mode 100644 index 000000000..04f6fd4de --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030120.xhp @@ -0,0 +1,186 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030120xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DateDiff Function</title> + <filename>/text/sbasic/shared/03030120.xhp</filename> + </topic> +</meta> + +<body> + +<section id="datediff"> +<bookmark xml-lang="en-US" branch="index" id="bm_id6134830"> + <bookmark_value>DateDiff function</bookmark_value> +</bookmark> + +<h1 id="par_idN10542" xml-lang="en-US"><link href="text/sbasic/shared/03030120.xhp">DateDiff Function</link></h1> +<paragraph id="par_idN10546" role="paragraph" xml-lang="en-US">Returns the number of date or time intervals between two given date values.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_idN10648" role="bascode" xml-lang="en-US">DateDiff (interval As String, date1 As Date, date2 As Date [, firstDayOfWeek As Integer [, firstWeekOfYear As Integer]]) As Double</paragraph> +</bascode> + +<paragraph id="par_idN1064B" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_idN1064F" role="paragraph" xml-lang="en-US">A number.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_idN10656" role="paragraph" xml-lang="en-US"> <emph>interval</emph> - A string expression from the following table, specifying the date or time interval.</paragraph> +<embed href="text/sbasic/shared/03030110.xhp#datetable"/> +<paragraph id="par_idN10664" role="paragraph" xml-lang="en-US"> <emph>date1, date2</emph> - The two date values to be compared.</paragraph> +<embed href="text/sbasic/shared/01020100.xhp#DateLiterals"/> + +<section id="weekyear"> +<paragraph id="par_idN1066A" role="paragraph" xml-lang="en-US"> <emph>firstdayofweek</emph>: An optional parameter that specifies the starting day of a week. </paragraph> + +<table id="tbl_id8356883"> + <tablerow> + <tablecell> + <paragraph id="par_idN1067A" role="tablehead" xml-lang="en-US">firstdayofweek value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10680" role="tablehead" xml-lang="en-US">Explanation</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10687" role="tablecontent" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN1068D" role="tablecontent" xml-lang="en-US">Use system default value</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10694" role="tablecontent" xml-lang="en-US">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN1069A" role="tablecontent" xml-lang="en-US">Sunday (default)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN106A1" role="tablecontent" xml-lang="en-US">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106A7" role="tablecontent" xml-lang="en-US">Monday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN106AE" role="tablecontent" xml-lang="en-US">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106B4" role="tablecontent" xml-lang="en-US">Tuesday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN106BB" role="tablecontent" xml-lang="en-US">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106C1" role="tablecontent" xml-lang="en-US">Wednesday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN106C8" role="tablecontent" xml-lang="en-US">5</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106CE" role="tablecontent" xml-lang="en-US">Thursday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN106D5" role="tablecontent" xml-lang="en-US">6</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106DB" role="tablecontent" xml-lang="en-US">Friday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN106E2" role="tablecontent" xml-lang="en-US">7</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN106E8" role="tablecontent" xml-lang="en-US">Saturday</paragraph> + </tablecell> + </tablerow> +</table> + +<paragraph id="par_idN106EB" role="paragraph" xml-lang="en-US"> <emph>firstweekofyear</emph>: An optional parameter that specifies the starting week of a year. </paragraph> + +<table id="tbl_id1173436"> + <tablerow> + <tablecell> + <paragraph id="par_idN106FB" role="tablehead" xml-lang="en-US">firstweekofyear value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10701" role="tablehead" xml-lang="en-US">Explanation</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10708" role="tablecontent" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN1070E" role="tablecontent" xml-lang="en-US">Use system default value</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10715" role="tablecontent" xml-lang="en-US">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN1071B" role="tablecontent" xml-lang="en-US">Week 1 is the week with January, 1st (default)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN10722" role="tablecontent" xml-lang="en-US">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10728" role="tablecontent" xml-lang="en-US">Week 1 is the first week containing four or more days of that year</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_idN1072F" role="tablecontent" xml-lang="en-US">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_idN10735" role="tablecontent" xml-lang="en-US">Week 1 is the first week containing only days of the new year</paragraph> + </tablecell> + </tablerow> +</table> + +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341501344" role="bascode" localize="false" xml-lang="en-US">Sub example_datediff</paragraph> +<paragraph id="par_idm1341500112" role="bascode" localize="false" xml-lang="en-US"> MsgBox DateDiff("d", #1/1/2005#, #2005-12-31#)</paragraph> +<paragraph id="par_idm1341498848" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030130.xhp b/helpcontent2/source/text/sbasic/shared/03030130.xhp new file mode 100644 index 000000000..5934bb13b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030130.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030130xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DatePart Function</title> + <filename>/text/sbasic/shared/03030130.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="datepart"> +<bookmark xml-lang="en-US" branch="index" id="bm_id249946"> + <bookmark_value>DatePart function</bookmark_value> +</bookmark> + +<h1 id="par_idN10542" xml-lang="en-US"><link href="text/sbasic/shared/03030130.xhp">DatePart Function</link></h1> +<paragraph id="par_idN10546" role="paragraph" xml-lang="en-US">The DatePart function returns a specified part of a date.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_idN105E8" role="bascode" xml-lang="en-US">DatePart (interval As String, date As Date [, firstDayOfWeek As Integer [, firstWeekOfYear As Integer]]) As Long</paragraph> +</bascode> + +<paragraph id="par_idN105EB" role="heading" level="3" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_idN105EF" role="paragraph" xml-lang="en-US">The extracted part for the given date.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_idN105F6" role="paragraph" xml-lang="en-US"> <emph>interval</emph> - A string expression from the following table, specifying the date interval.</paragraph> +<embed href="text/sbasic/shared/03030110.xhp#datetable"/> +<paragraph id="par_idN10604" role="paragraph" xml-lang="en-US"> <emph>date</emph> - The date from which the result is calculated.</paragraph> +<embed href="text/sbasic/shared/01020100.xhp#DateLiterals"/> +<embed href="text/sbasic/shared/03030120.xhp#weekyear"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/><bascode> +<paragraph id="par_idm1341577504" role="bascode" localize="false">Sub example_datepart</paragraph> +<paragraph id="par_idm1341576272" role="bascode" localize="false"> MsgBox DatePart("ww", #12/31/2005#)</paragraph> +<paragraph id="par_idm1347516272" role="bascode" localize="false"> MsgBox DatePart(date:=#1999-12-30#, interval:="q")</paragraph> +<paragraph id="par_idm1341575024" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030200.xhp b/helpcontent2/source/text/sbasic/shared/03030200.xhp new file mode 100644 index 000000000..e12f26802 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030200.xhp @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030200xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Converting Time Values</title> +<filename>/text/sbasic/shared/03030200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="timevalues"> + <paragraph id="hd_id3147226" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030200.xhp" name="Converting Time Values">Converting Time Values</link></paragraph> + <paragraph role="paragraph" id="par_id3149415" xml-lang="en-US">The following functions convert time values to calculable numbers.</paragraph> + </section> + <embed href="text/sbasic/shared/03030201.xhp#hour"/> + <embed href="text/sbasic/shared/03030202.xhp#minute"/> + <embed href="text/sbasic/shared/03030204.xhp#second"/> + <embed href="text/sbasic/shared/03030205.xhp#timeserial"/> + <embed href="text/sbasic/shared/03030206.xhp#timevalue"/> + <embed href="text/sbasic/shared/03030113.xhp#cdatetounotime"/> + <embed href="text/sbasic/shared/03030114.xhp#cdatefromunotime"/> + <embed href="text/sbasic/shared/03030115.xhp#cdatetounodatetime"/> + <embed href="text/sbasic/shared/03030116.xhp#cdatefromunodatetime"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030201.xhp b/helpcontent2/source/text/sbasic/shared/03030201.xhp new file mode 100644 index 000000000..6d246b8e6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030201.xhp @@ -0,0 +1,56 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="textsbasicshared03030201xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">Hour Function</title> + <filename>/text/sbasic/shared/03030201.xhp</filename> + </topic> + </meta> + <body> + <section id="hour"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156042"><bookmark_value>Hour function</bookmark_value> +</bookmark> +<paragraph xml-lang="en-US" id="hd_id3156042" role="heading" level="1"><link href="text/sbasic/shared/03030201.xhp" name="Hour Function">Hour Function</link></paragraph> + <paragraph xml-lang="en-US" id="par_id3149346" role="paragraph">Returns the hour from a time value that is generated by the TimeSerial or the TimeValue function.</paragraph> + </section> + <paragraph xml-lang="en-US" id="hd_id3147574" role="heading" level="2">Syntax:</paragraph> + <bascode> +<paragraph xml-lang="en-US" id="par_id3147264" role="bascode">Hour (Number)</paragraph> +</bascode> + <paragraph xml-lang="en-US" id="hd_id3145069" role="heading" level="2">Return value:</paragraph> + <paragraph xml-lang="en-US" id="par_id3149670" role="paragraph">Integer</paragraph> + <paragraph xml-lang="en-US" id="hd_id3150359" role="heading" level="2">Parameters:</paragraph> + <paragraph xml-lang="en-US" id="par_id3154366" role="paragraph"> + <emph>Number:</emph> Numeric expression that contains the serial time value that is used to return the hour value.</paragraph> + <paragraph xml-lang="en-US" id="par_id3154909" role="paragraph">This function is the opposite of the <emph>TimeSerial</emph> function. It returns an integer value that represents the hour from a time value that is generated by the <emph>TimeSerial</emph> or the <emph>TimeValue </emph>function. For example, the expression</paragraph> + <paragraph id="par_id3163798" localize="false" role="paragraph">Print Hour(TimeSerial(12,30,41))</paragraph> + <paragraph xml-lang="en-US" id="par_id3155132" role="paragraph">returns the value 12.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <paragraph xml-lang="en-US" id="hd_id3147348" role="heading" level="2">Example:</paragraph> + <bascode> + <paragraph id="par_id3146985" localize="false" role="bascode">Sub ExampleHour</paragraph> + <paragraph xml-lang="en-US" id="par_id3156441" role="bascode">Print "The current hour is " & Hour( Now )</paragraph> + <paragraph id="par_id3153145" localize="false" role="bascode">End Sub</paragraph> + </bascode> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030202.xhp b/helpcontent2/source/text/sbasic/shared/03030202.xhp new file mode 100644 index 000000000..979e62808 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030202.xhp @@ -0,0 +1,58 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + <meta> + <topic id="textsbasicshared03030202xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">Minute Function</title> + <filename>/text/sbasic/shared/03030202.xhp</filename> + </topic> + </meta> + <body> + <section id="minute"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3155419"><bookmark_value>Minute function</bookmark_value> + </bookmark> + <h1 id="hd_id3155419"><link href="text/sbasic/shared/03030202.xhp" name="Minute Function">Minute Function (BASIC)</link></h1> + <paragraph xml-lang="en-US" id="par_id3156344" role="paragraph">Returns the minute of the hour that corresponds to the serial time value that is generated by the TimeSerial or the TimeValue function.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph xml-lang="en-US" id="par_id3149656" role="bascode">Minute (Number)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph xml-lang="en-US" id="par_id3150449" role="paragraph">Integer</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph xml-lang="en-US" id="par_id3153969" role="paragraph"> + <emph>Number:</emph> Numeric expression that contains the serial time value that is used to return the minute value.</paragraph> + <paragraph xml-lang="en-US" id="par_id3150869" role="paragraph">This function is the opposite of the <emph>TimeSerial </emph>function. It returns the minute of the serial time value that is generated by the <emph>TimeSerial</emph> or the <emph>TimeValue </emph>function. For example, the expression:</paragraph> +<bascode> + <paragraph id="par_id3149262" localize="false" role="bascode">Print Minute(TimeSerial(12,30,41))</paragraph> +</bascode> + <paragraph xml-lang="en-US" id="par_id3148576" role="paragraph">returns the value 30.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_id3159154" localize="false" role="bascode">Sub ExampleMinute</paragraph> + <paragraph xml-lang="en-US" id="par_id3146119" role="bascode">MsgBox "The current minute is "& Minute(Now)& "."</paragraph> + <paragraph id="par_id3153726" localize="false" role="bascode">End Sub</paragraph> + </bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030203.xhp b/helpcontent2/source/text/sbasic/shared/03030203.xhp new file mode 100644 index 000000000..4a9d7c632 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030203.xhp @@ -0,0 +1,62 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030203xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Now Function</title> + <filename>/text/sbasic/shared/03030203.xhp</filename> + </topic> +</meta> + +<body> + +<section id="now"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149416"> + <bookmark_value>Now function</bookmark_value> +</bookmark> + +<h1 id="hd_id641619720735711"><variable id="Now_H1"><link href="text/sbasic/shared/03030203.xhp" name="Now Function">Now Function</link></variable></h1> +<paragraph id="par_id3149670" role="paragraph" xml-lang="en-US">Returns the current system date and time as a <emph>Date</emph> value.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3149655" role="bascode" localize="false" xml-lang="en-US">Now</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3154909" role="paragraph" xml-lang="en-US">Date</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph id="par_idm1341594784" role="bascode" localize="false" xml-lang="en-US">Sub ExampleNow</paragraph> + <paragraph id="par_id3150870" role="bascode" xml-lang="en-US"> MsgBox "It is now " & Now</paragraph> + <paragraph id="par_idm1341591760" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<note id="par_id491610993401822">The <literal>Now</literal> function measures time in seconds. To measure time in milliseconds use the <link href="text/sbasic/shared/03/sf_timer.xhp" name="ScriptForge.Timer service"><literal>Timer</literal> service</link>.</note> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id531610970649205"><embedvar href="text/sbasic/shared/03/sf_timer.xhp#TimerService"/></paragraph> +</section> + +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03030204.xhp b/helpcontent2/source/text/sbasic/shared/03030204.xhp new file mode 100644 index 000000000..cf11c82da --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030204.xhp @@ -0,0 +1,65 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030204xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Second Function</title> + <filename>/text/sbasic/shared/03030204.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="second"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153346"> + <bookmark_value>Second function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3153346" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030204.xhp" name="Second Function">Second Function</link></paragraph> +<paragraph id="par_id3156023" role="paragraph" xml-lang="en-US">Returns an integer that represents the seconds of the serial time number that is generated by the TimeSerial or the TimeValue function.</paragraph> +</section> + +<paragraph id="hd_id3147264" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3146795" role="bascode" xml-lang="en-US">Second (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3150792" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154140" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3156280" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154124" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Numeric expression that contains the serial time number that is used to calculate the number of seconds.</paragraph> +<paragraph id="par_id3125864" role="paragraph" xml-lang="en-US">This function is the opposite of the <emph>TimeSerial </emph>function. It returns the seconds of a serial time value that is generated by the <emph>TimeSerial</emph> or <emph>TimeValue </emph>functions. For example, the expression:</paragraph> +<paragraph id="par_id3153951" localize="false" role="paragraph">Print Second(TimeSerial(12,30,41))</paragraph> +<paragraph id="par_id3151117" role="paragraph" xml-lang="en-US">returns the value 41.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3147426" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341619920" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSecond</paragraph> +<paragraph id="par_id3156441" role="bascode" xml-lang="en-US"> MsgBox "The exact second of the current time is "& Second( Now )</paragraph> +<paragraph id="par_idm1341616880" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030205.xhp b/helpcontent2/source/text/sbasic/shared/03030205.xhp new file mode 100644 index 000000000..c351bf9fd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030205.xhp @@ -0,0 +1,76 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030205xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">TimeSerial Function</title> + <filename>/text/sbasic/shared/03030205.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="timeserial"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143271"> + <bookmark_value>TimeSerial function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3143271" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030205.xhp" name="TimeSerial Function">TimeSerial Function</link></paragraph> +<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US">Calculates a serial time value for the specified hour, minute, and second parameters that are passed as numeric value. You can then use this value to calculate the difference between times.</paragraph> +</section> + +<paragraph id="hd_id3146794" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150792" role="bascode" xml-lang="en-US">TimeSerial (hour, minute, second)</paragraph> +</bascode> + +<paragraph id="hd_id3148797" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154908" role="paragraph" xml-lang="en-US">Date</paragraph> + +<paragraph id="hd_id3154124" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>hour:</emph> Any integer expression that indicates the hour of the time that is used to determine the serial time value. Valid values: 0-23.</paragraph> +<paragraph id="par_id3159252" role="paragraph" xml-lang="en-US"> <emph>minute:</emph> Any integer expression that indicates the minute of the time that is used to determine the serial time value. In general, use values between 0 and 59. However, you can also use values that lie outside of this range, where the number of minutes influence the hour value.</paragraph> +<paragraph id="par_id3161831" role="paragraph" xml-lang="en-US"> <emph>second:</emph> Any integer expression that indicates the second of the time that is used to determine the serial time value. In general, you can use values between 0 and 59. However, you can also use values that lie outside of this range, where the number seconds influences the minute value.</paragraph> +<paragraph id="par_id3155854" role="paragraph" xml-lang="en-US"> <emph>Examples:</emph> </paragraph> +<paragraph id="par_id3153952" role="paragraph" xml-lang="en-US">12, -5, 45 corresponds to 11, 55, 45</paragraph> +<paragraph id="par_id3147349" role="paragraph" xml-lang="en-US">12, 61, 45 corresponds to 13, 2, 45</paragraph> +<paragraph id="par_id3147426" role="paragraph" xml-lang="en-US">12, 20, -2 corresponds to 12, 19, 58</paragraph> +<paragraph id="par_id3153365" role="paragraph" xml-lang="en-US">12, 20, 63 corresponds to 12, 21, 4</paragraph> +<paragraph id="par_id3146985" role="paragraph" xml-lang="en-US">You can use the TimeSerial function to convert any time into a single value that you can use to calculate time differences.</paragraph> +<paragraph id="par_id3155308" role="paragraph" xml-lang="en-US">The TimeSerial function returns the type Variant with VarType 7 (Date). This value is stored internally as a double-precision number between 0 and 0.9999999999. As opposed to the DateSerial or DateValue function, where the serial date values are calculated as days relative to a fixed date, you can calculate with values returned by the TimeSerial function, but you cannot evaluate them.</paragraph> +<paragraph id="par_id3149482" role="paragraph" xml-lang="en-US">In the TimeValue function, you can pass a string as a parameter containing the time. For the TimeSerial function, however, you can pass the individual parameters (hour, minute, second) as separate numeric expressions.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3154790" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341318224" role="bascode" localize="false" xml-lang="en-US">Sub ExampleTimeSerial</paragraph> +<paragraph id="par_idm1341316992" role="bascode" localize="false" xml-lang="en-US">Dim dDate As Double, sDate As String</paragraph> +<paragraph id="par_idm1341315744" role="bascode" localize="false" xml-lang="en-US"> dDate = TimeSerial(8,30,15)</paragraph> +<paragraph id="par_idm1341314496" role="bascode" localize="false" xml-lang="en-US"> sDate = TimeSerial(8,30,15)</paragraph> +<paragraph id="par_id3155600" role="bascode" xml-lang="en-US"> MsgBox dDate,64,"Time as a number"</paragraph> +<paragraph id="par_id3153417" role="bascode" xml-lang="en-US"> MsgBox sDate,64,"Formatted time"</paragraph> +<paragraph id="par_idm1341309792" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030206.xhp b/helpcontent2/source/text/sbasic/shared/03030206.xhp new file mode 100644 index 000000000..baf4ee9ea --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030206.xhp @@ -0,0 +1,78 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030206xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">TimeValue Function</title> + <filename>/text/sbasic/shared/03030206.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="timevalue"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149670"> + <bookmark_value>TimeValue function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3149670" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030206.xhp" name="TimeValue Function">TimeValue Function</link></paragraph> +<paragraph id="par_id3153361" role="paragraph" xml-lang="en-US">Calculates a serial time value from the specified hour, minute, and second - parameters passed as strings - that represents the time in a single numeric value. This value can be used to calculate the difference between times.</paragraph> +</section> + +<paragraph id="hd_id3154138" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3156282" role="bascode" xml-lang="en-US">TimeValue (Text As String)</paragraph> +</bascode> + +<paragraph id="hd_id3153969" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156424" role="paragraph" xml-lang="en-US">Date</paragraph> + +<paragraph id="hd_id3145172" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145786" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that contains the time that you want to calculate in the format "HH:MM:SS".</paragraph> +<paragraph id="par_id3152578" role="paragraph" xml-lang="en-US">Use the TimeValue function to convert any time into a single value, so that you can calculate time differences.</paragraph> +<paragraph id="par_id3163710" role="paragraph" xml-lang="en-US">This TimeValue function returns the type Variant with VarType 7 (Date), and stores this value internally as a double-precision number between 0 and 0.9999999999.</paragraph> +<paragraph id="par_id3151117" role="paragraph" xml-lang="en-US">As opposed to the DateSerial or the DateValue function, where serial date values result in days relative to a fixed date, you can calculate with the values that are returned by the TimeValue function, but you cannot evaluate them.</paragraph> +<paragraph id="par_id3147426" role="paragraph" xml-lang="en-US">In the TimeSerial function, you can pass individual parameters (hour, minute, second) as separate numeric expressions. For the TimeValue function, however, you can pass a string as a parameter containing the time.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err13"/> + +<paragraph id="hd_id3145271" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340872288" role="bascode" localize="false" xml-lang="en-US">Sub ExampleTimerValue</paragraph> +<paragraph id="par_idm1340871056" role="bascode" localize="false" xml-lang="en-US">Dim daDT As Date</paragraph> +<paragraph id="par_idm1340869824" role="bascode" localize="false" xml-lang="en-US">Dim a1, b1, c1, a2, b2, c2 As String</paragraph> +<paragraph id="par_id3149378" role="bascode" xml-lang="en-US"> a1 = "start time"</paragraph> +<paragraph id="par_id3145800" role="bascode" xml-lang="en-US"> b1 = "end time"</paragraph> +<paragraph id="par_id3151074" role="bascode" xml-lang="en-US"> c1 = "total time"</paragraph> +<paragraph id="par_idm1340863440" role="bascode" localize="false" xml-lang="en-US"> a2 = "8:34"</paragraph> +<paragraph id="par_idm1340862208" role="bascode" localize="false" xml-lang="en-US"> b2 = "18:12"</paragraph> +<paragraph id="par_idm1340860976" role="bascode" localize="false" xml-lang="en-US"> daDT = TimeValue(b2) - TimeValue(a2)</paragraph> +<paragraph id="par_idm1340859712" role="bascode" localize="false" xml-lang="en-US"> c2 = a1 & ": " & a2 & chr(13)</paragraph> +<paragraph id="par_idm1340858432" role="bascode" localize="false" xml-lang="en-US"> c2 = c2 & b1 & ": " & b2 & chr(13)</paragraph> +<paragraph id="par_idm1340857152" role="bascode" localize="false" xml-lang="en-US"> c2 = c2 & c1 & ": " & trim(Str(Hour(daDT))) & ":" & trim(Str(Minute(daDT))) & ":" & trim(Str(Second(daDT)))</paragraph> +<paragraph id="par_idm1340855680" role="bascode" localize="false" xml-lang="en-US"> MsgBox c2</paragraph> +<paragraph id="par_idm1340854448" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030300.xhp b/helpcontent2/source/text/sbasic/shared/03030300.xhp new file mode 100644 index 000000000..4f64396e1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030300.xhp @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03030300xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">System Date and Time</title> +<filename>/text/sbasic/shared/03030300.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="determine"> + <paragraph id="hd_id3154923" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03030300.xhp" name="System Date and Time">System Date and Time</link></paragraph> + <paragraph role="paragraph" id="par_id3149457" xml-lang="en-US">The following functions and statements set or return the system date and time.</paragraph> + </section> + <embed href="text/sbasic/shared/03030301.xhp#date"/> + <embed href="text/sbasic/shared/03030203.xhp#now"/> + <embed href="text/sbasic/shared/03030302.xhp#time"/> + <embed href="text/sbasic/shared/03030303.xhp#timer"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03030301.xhp b/helpcontent2/source/text/sbasic/shared/03030301.xhp new file mode 100644 index 000000000..e561ac7d0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030301.xhp @@ -0,0 +1,54 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030301xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Date Function</title> + <filename>/text/sbasic/shared/03030301.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="date"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"> + <bookmark_value>Date function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3156027"><link href="text/sbasic/shared/03030301.xhp" name="Date Function">Date Function</link></h1> +<paragraph id="par_id3147291" role="paragraph">Returns the current system date as a string, or date variant.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3146794" role="bascode" localize="false">Date[$][()]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341306160" role="bascode" localize="false">Sub ExampleDate</paragraph> +<paragraph id="par_id3156424" role="bascode" xml-lang="en-US"> MsgBox "The date is " & Date</paragraph> +<paragraph id="par_idm1341303136" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03030302.xhp b/helpcontent2/source/text/sbasic/shared/03030302.xhp new file mode 100644 index 000000000..3d93aa166 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030302.xhp @@ -0,0 +1,53 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030302xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Time Function</title> + <filename>/text/sbasic/shared/03030302.xhp</filename> + </topic> +</meta> + +<body> + +<section id="time"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145090"> + <bookmark_value>Time function</bookmark_value> +</bookmark> + +<h1 id="hd_id3145090"><link href="text/sbasic/shared/03030302.xhp" name="Time Function">Time Function</link></h1> +<paragraph id="par_id3150984" role="paragraph">This function returns the current system time as a string in the format "HH:MM:SS".</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3149670" role="bascode" localize="false">Time[$][()]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341324032" role="bascode" localize="false">Sub ExampleTime</paragraph> +<paragraph id="par_id3150870" role="bascode" xml-lang="en-US"> MsgBox Time,0,"The time is"</paragraph> +<paragraph id="par_idm1341321024" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03030303.xhp b/helpcontent2/source/text/sbasic/shared/03030303.xhp new file mode 100644 index 000000000..d82375bc0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03030303.xhp @@ -0,0 +1,69 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03030303xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Timer Function</title> + <filename>/text/sbasic/shared/03030303.xhp</filename> + </topic> +</meta> + +<body> + +<section id="timer"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149346"> + <bookmark_value>Timer function</bookmark_value> +</bookmark> + +<h1 id="hd_id3149346"><variable id="Timer_H1"><link href="text/sbasic/shared/03030303.xhp" name="Timer Function">Timer Function</link></variable></h1> +<paragraph id="par_id3156023" role="paragraph">Returns a value that specifies the number of seconds that have elapsed since midnight.</paragraph> +</section> +<paragraph id="par_id3156212" role="note">You must first declare a variable to call the Timer function and assign it the "Long " data type, otherwise a Date value is returned.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph id="par_id3161831" role="bascode" localize="false">Timer</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3146984" role="paragraph">Date</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph id="par_idm1341580128" role="bascode" localize="false">Sub ExampleTimer</paragraph> + <paragraph id="par_idm1341578896" role="bascode" localize="false"> Dim lSec As Long,lMin As Long,lHour As Long</paragraph> + <paragraph id="par_idm1341577632" role="bascode" localize="false"> lSec = Timer</paragraph> + <paragraph id="par_id3145748" role="bascode"> MsgBox lSec, 0, "Seconds since midnight"</paragraph> + <paragraph id="par_idm1341574656" role="bascode" localize="false"> lMin = lSec / 60</paragraph> + <paragraph id="par_idm1341573424" role="bascode" localize="false"> lSec = lSec Mod 60</paragraph> + <paragraph id="par_idm1341572192" role="bascode" localize="false"> lHour = lMin / 60</paragraph> + <paragraph id="par_idm1341570960" role="bascode" localize="false"> lMin = lMin Mod 60</paragraph> +<paragraph id="par_id3156283" role="bascode"> MsgBox Right("00" & lHour , 2) & ":"& Right("00" & lMin , 2) & ":" & Right("00" & lSec , 2), 0, "The time is"</paragraph> +<paragraph id="par_idm1341567920" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<note id="par_id491610993401822">The <literal>Timer</literal> function measures time in seconds. To measure time in milliseconds use the <link href="text/sbasic/shared/03/sf_timer.xhp" name="Timer_link">Timer service</link> available in the <literal>ScriptForge</literal> library.</note> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03/sf_timer.xhp#TimerService"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03040000.xhp b/helpcontent2/source/text/sbasic/shared/03040000.xhp new file mode 100644 index 000000000..33dbd5af5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03040000.xhp @@ -0,0 +1,618 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + <meta> + <topic id="textsbasicshared03040000xml"> + <title id="tit" xml-lang="en-US">Basic Constants</title> + <filename>/text/sbasic/shared/03040000.xhp</filename> + </topic> + </meta> + + <body> + <section id="basic_constants"> + <bookmark xml-lang="en-US" branch="index" id="bm_id051720170831387233"> +<bookmark_value>Basic constants</bookmark_value> + </bookmark> + <h1 id="hd_id051620171022255424"><variable id="basicconstantsh1"><link href="text/sbasic/shared/03040000.xhp">Basic Constants</link></variable></h1> + <paragraph id="par_id051620171022384640" role="paragraph" xml-lang="en-US"><ahelp hid=".">Constants used in Basic programs</ahelp></paragraph> + </section> + + <section id="booleanconstants"> + <bookmark xml-lang="en-US" branch="index" id="bm_id871554200620243"> +<bookmark_value>Boolean Basic constants</bookmark_value> +<bookmark_value>Basic constant;False</bookmark_value> +<bookmark_value>Basic constant;True</bookmark_value> + </bookmark> + <h2 id="par_id051620171022382581">Boolean constants</h2> + + <table id="tbl_051620171030174631"> + <tablerow> + <tablecell> + <paragraph id="par_id051620171114565335" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114565484" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114563271" role="tablehead" xml-lang="en-US">Value</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051620171114567378" role="paragraph" localize="false" xml-lang="en-US"><literal>True</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114563299" role="paragraph" localize="false" xml-lang="en-US">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114565603" role="paragraph" localize="false" xml-lang="en-US">1</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051620171114564178" role="paragraph" localize="false" xml-lang="en-US"><literal>False</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114566455" role="paragraph" localize="false" xml-lang="en-US">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114563986" role="paragraph" localize="false" xml-lang="en-US">0</paragraph> + </tablecell> + </tablerow> + </table> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_id051620171114567539" role="bascode" localize="false">Dim bPositive as Boolean</paragraph> + <paragraph id="par_id051620171114574976" role="bascode" localize="false">bPositive = True</paragraph> + </bascode> + </section> + + <section id="mathconstants"> + <bookmark xml-lang="en-US" branch="index" id="bm_id131554200364170"> +<bookmark_value>Basic Mathematical constants</bookmark_value> +<bookmark_value>Pi;Basic constant</bookmark_value> +<bookmark_value>Basic constant;Pi</bookmark_value> + </bookmark> + + <h2 id="hd_id051620171114573549">Mathematical constant</h2> + + <table id="tbl_051620171031298215"> + <tablerow> + <tablecell> + <paragraph id="par_id051620171114576150" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114575122" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114574987" role="tablehead" xml-lang="en-US">Value</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051620171114574028" role="paragraph" localize="false"><literal>Pi</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114571506" role="paragraph" localize="false">Double</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114576361" role="paragraph" localize="false">3.14159265358979</paragraph> + </tablecell> + </tablerow> + </table> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_id051620171114575849" role="bascode" localize="false">Function Rad2Deg( aRad as Double) As Double</paragraph> + <paragraph id="par_id051620171114575132" role="bascode" localize="false"> Rad2Deg = aRad * 180.00 / Pi</paragraph> + <paragraph id="par_id051620171114571381" role="bascode" localize="false">End Function</paragraph> + </bascode> + </section> + + <section id="objectconstants"> + <bookmark xml-lang="en-US" branch="index" id="bm_id261554201061695"> +<bookmark_value>Basic Object constants</bookmark_value> +<bookmark_value>Empty;Basic constant</bookmark_value> +<bookmark_value>Null;Basic constant</bookmark_value> +<bookmark_value>Nothing;Basic constant</bookmark_value> +<bookmark_value>Basic constant;Nothing</bookmark_value> +<bookmark_value>Basic constant;Null</bookmark_value> +<bookmark_value>Basic constant;Empty</bookmark_value> + </bookmark> + + <h2 id="hd_id051620171114576454">Object Constants</h2> + + <table id="tbl_051620171033491648"> + <tablerow> + <tablecell> + <paragraph id="par_id051620171114576921" role="tablehead" xml-lang="en-US">Name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114578188" role="tablehead" xml-lang="en-US">Type</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051720170824099845" role="tablehead" xml-lang="en-US">Usage</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051620171114575052" role="paragraph" localize="false"><literal>Empty</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114576734" role="paragraph" localize="false">Variant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id05172017082409622" role="paragraph" xml-lang="en-US">The <emph>Empty</emph> value indicates that the variable is not initialized.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051620171114577892" role="paragraph" localize="false"><literal>Null</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620171114571232" role="paragraph" localize="false">null</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051720170824093395" role="paragraph" xml-lang="en-US">Indicates that the variable does not contain data.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051720170824091253" role="paragraph" localize="false"><literal>Nothing</literal></paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051720170824091966" role="paragraph" localize="false">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051720170824097935" role="paragraph" xml-lang="en-US">Assign the <emph>Nothing</emph> object to a variable to remove a previous assignment.</paragraph> + </tablecell> + </tablerow> + </table> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_id051620171114575772" role="bascode" localize="false">SubExampleEmpty</paragraph> + <paragraph id="par_id051620171114572075" role="bascode" localize="false"> Dim sVar As Variant</paragraph> + <paragraph id="par_id051620171114579662" role="bascode" localize="false"> sVar = Empty</paragraph> + <paragraph id="par_id051620171114577052" role="bascode" xml-lang="en-US"> Print IsEmpty(sVar) ' Returns True</paragraph> + <paragraph id="par_id051620171114576576" role="bascode" localize="false">End Sub</paragraph> + <paragraph id="par_id051620171114573781" role="bascode" localize="false">Sub ExampleNull</paragraph> + <paragraph id="par_id051620171114584136" role="bascode" localize="false"> Dim vVar As Variant</paragraph> + <paragraph id="par_id05162017111458231" role="bascode" localize="false"> MsgBox IsNull(vVar)</paragraph> + <paragraph id="par_id051620171114581488" role="bascode" localize="false">End Sub</paragraph> + <paragraph id="par_id051720170824102912" role="bascode" localize="false">Sub ExampleNothing</paragraph> + <paragraph id="par_id051720170824104202" role="bascode" localize="false"> Dim oDoc As Object</paragraph> + <paragraph id="par_id051720170824102971" role="bascode" localize="false"> Set oDoc = ThisComponent</paragraph> + <paragraph id="par_id051720170824104997" role="bascode" localize="false"> Print oDoc.Title</paragraph> + <paragraph id="par_id051720170824104443" role="bascode" localize="false"> oDoc = Nothing</paragraph> + <paragraph id="par_id051720170824106132" role="bascode" xml-lang="en-US"> Print oDoc ' Error</paragraph> + <paragraph id="par_id051720170824103527" role="bascode" localize="false">End Sub</paragraph> + </bascode> + </section> + + <h2 id="hd_id31634909394554">MsgBox Named Constants</h2> + <embed href="text/sbasic/shared/03010101.xhp#MsgBox_constants"/> + + <h2 id="hd_id881634911199058">GetAttr Named Constants</h2> + <embed href="text/sbasic/shared/03020409.xhp#GetAttr_constants"/> + + <h2 id="hd_id611634911996367">VarType Named Constants</h2> + <embed href="text/sbasic/shared/03103600.xhp#VarType_constants"/> + + <section id="addvbaconstants"> + <bookmark xml-lang="en-US" branch="index" id="bm_id101554201127393"> +<bookmark_value>Visual Basic constants</bookmark_value> +<bookmark_value>VBA Exclusive constants</bookmark_value> + </bookmark> + <h2 id="hd_id661512312593832">Additional VBA constants</h2> + <paragraph role="paragraph" id="par_id111512312705893" xml-lang="en-US">The following constants are available when VBA compatibility mode is enabled</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + + <section id="vbavartypeconstnts"> + <bookmark xml-lang="en-US" branch="index" id="bm_id391624288823741"> +<bookmark_value>VBA Variable Type Named Constants</bookmark_value> + </bookmark> + + +</section> + + <h3 id="hd_id941628842567829">VBA Color Named Constants</h3> + +<table id="tab_id691634907471277"> + <tablerow> + <tablecell> + <paragraph id="par_id611634907471277" role="tablehead">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861634907471277" role="tablehead">Red, Green, Blue<br/>composition</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id131634907471277" role="tablecontent" localize="false">vbBlack</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561634907471277" role="tablecontent" localize="false">RGB(0, 0, 0)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id421634907638611" role="tablecontent" localize="false">vbBlue</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611634907688162" role="tablecontent" localize="false">RGB(0, 0, 255)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id551634907874363" role="tablecontent" localize="false">vbCyan</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521634907949411" role="tablecontent" localize="false">RGB(0, 255, 255)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891634907875500" role="tablecontent" localize="false">vbGreen</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841634907957172" role="tablecontent" localize="false">RGB(0, 255, 0)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id971634907876196" role="tablecontent" localize="false">vbMagenta</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501634907977490" role="tablecontent" localize="false">RGB(255, 0, 255)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id941634907876844" role="tablecontent" localize="false">vbRed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501634907984434" role="tablecontent" localize="false">RGB(255, 0, 0)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id351634907877572" role="tablecontent" localize="false">vbYellow</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id681634907989235" role="tablecontent" localize="false">RGB(255, 255, 0)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431634907878140" role="tablecontent" localize="false">vbWhite</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621634907995939" role="tablecontent" localize="false">RGB(255, 255, 255)</paragraph> + </tablecell> + </tablerow> +</table> + + <h3 id="hd_id941624288567829">Variable Type Named Constants</h3> +<table id="tab_id761624288363725"> + <tablerow> + <tablecell> + <paragraph id="par_id31624288363725" role="tablehead" xml-lang="en-US">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951624288363725" role="tablehead" xml-lang="en-US">Decimal value</paragraph> + </tablecell> + </tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id151624288186788" role="tablecontent" localize="false" xml-lang="en-US" >vbArray</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961624288191678" role="tablecontent" localize="false" xml-lang="en-US" >8192</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id361624288198006" role="tablecontent" localize="false" xml-lang="en-US" >vbBoolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701624288202471" role="tablecontent" localize="false" xml-lang="en-US" >11</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id581624288207631" role="tablecontent" localize="false" xml-lang="en-US" >vbByte</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781624288212801" role="tablecontent" localize="false" xml-lang="en-US" >17</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id861624288218272" role="tablecontent" localize="false" xml-lang="en-US" >vbCurrency</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371624288223017" role="tablecontent" localize="false" xml-lang="en-US" >6</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id631624288229041" role="tablecontent" localize="false" xml-lang="en-US" >vbDataObject</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id641624288233002" role="tablecontent" localize="false" xml-lang="en-US" >13</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id571624288236875" role="tablecontent" localize="false" xml-lang="en-US" >vbDate</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001624288241059" role="tablecontent" localize="false" xml-lang="en-US" >7</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id571624288244739" role="tablecontent" localize="false" xml-lang="en-US" >vbDecimal</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991624288247923" role="tablecontent" localize="false" xml-lang="en-US" >14</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id391624288251107" role="tablecontent" localize="false" xml-lang="en-US" >vbDouble</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831624288256005" role="tablecontent" localize="false" xml-lang="en-US" >5</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id651624288258973" role="tablecontent" localize="false" xml-lang="en-US" >vbEmpty</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id681624288262413" role="tablecontent" localize="false" xml-lang="en-US" >0</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id541624288266590" role="tablecontent" localize="false" xml-lang="en-US" >vbError</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801624288270239" role="tablecontent" localize="false" xml-lang="en-US" >10</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id311624288273447" role="tablecontent" localize="false" xml-lang="en-US" >vbInteger</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661624288277319" role="tablecontent" localize="false" xml-lang="en-US" >2</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id261624288293466" role="tablecontent" localize="false" xml-lang="en-US" >vbLong</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id301624288282609" role="tablecontent" localize="false" xml-lang="en-US" >3</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id51624288297226" role="tablecontent" localize="false" xml-lang="en-US" >vbNull</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321624288301819" role="tablecontent" localize="false" xml-lang="en-US" >1</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id21624288307523" role="tablecontent" localize="false" xml-lang="en-US" >vbObject</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91624288311180" role="tablecontent" localize="false" xml-lang="en-US" >9</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id991624288314316" role="tablecontent" localize="false" xml-lang="en-US" >vbSingle</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131624288318340" role="tablecontent" localize="false" xml-lang="en-US" >4</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id561624288321052" role="tablecontent" localize="false" xml-lang="en-US" >vbString</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id41624288325309" role="tablecontent" localize="false" xml-lang="en-US" >8</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id951624288329278" role="tablecontent" localize="false" xml-lang="en-US" >vbUserDefinedType</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861624288332301" role="tablecontent" localize="false" xml-lang="en-US" >36</paragraph> + </tablecell> +</tablerow> +<tablerow> + <tablecell> + <paragraph id="par_id171624288336183" role="tablecontent" localize="false" xml-lang="en-US" >vbVariant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451624288339448" role="tablecontent" localize="false" xml-lang="en-US" >12</paragraph> + </tablecell> +</tablerow> +</table> + + <h3 id="hd_id881634911195890">FormatDateTime VBA Named Constants</h3> + <embed href="text/sbasic/shared/03150000.xhp#FormatDateTime_constants"/> + + <h3 id="hd_id801634912153888">StrConv VBA Named Constants</h3> + <embed href="text/sbasic/shared/strconv.xhp#StrConv_constants"/> + + <h3 id="hd_id131634910758620">WeekDayName VBA Named Constants</h3> + <embed href="text/sbasic/shared/03030105.xhp#WeekDay_constants"/> + + <h3 id="hd_id531634913323423">Miscellaneous VBA Named Constants</h3> + <table id="tab_id671512313939217"> + <tablerow> + <tablecell> + <paragraph role="tablehead" id="par_id901512312880723" xml-lang="en-US">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891512312916493" role="tablehead" xml-lang="en-US">Hexadecimal (decimal) value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991512312965968" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311542196872466" role="paragraph" localize="false">vbTrue</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151542196872467" role="paragraph" localize="false">-1</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id671542197262160" xml-lang="en-US">Part of vbTriState enumeration.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241542196923343" role="paragraph" localize="false">vbFalse</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611542196923343" role="paragraph" localize="false">0</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id351542197255532" xml-lang="en-US">Part of vbTriState enumeration.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id551542196949698" role="paragraph" localize="false">vbUseDefault</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831542196949698" role="paragraph" localize="false">-2</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id251542197274514" xml-lang="en-US">Part of vbTriState enumeration.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891512313266496" role="paragraph" localize="false">vbCr</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id241512313723033" localize="false">\x0D (13)</paragraph> + </tablecell> + <tablecell> + <paragraph role="paragraph" id="par_id611512313731233" xml-lang="en-US">CR - Carriage return</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471512313282257" role="paragraph" localize="false">vbCrLf</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691512313750520" role="paragraph" localize="false">\x0D\x0A (13 10)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id961512313881937" role="paragraph" xml-lang="en-US">CRLF - Carriage return and line feed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id11512313289164" role="paragraph" localize="false">vbFormFeed</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id341512313761295" role="paragraph" localize="false">\x0c (12)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221512313889077" role="paragraph" xml-lang="en-US">FF - Form feed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id501512313293989" role="paragraph" localize="false">vbLf</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311512313777558" role="paragraph" localize="false">\x0A (10)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621512313896169" role="paragraph" xml-lang="en-US">LF - Line feed</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id191512313300610" role="paragraph" localize="false">vbNewLine</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id521512319135830" role="listitem" xml-lang="en-US">\x0D\x0A (13 10) for Windows</paragraph> + <paragraph id="par_id61512319163913" role="listitem" xml-lang="en-US">\x0A (10) for other systems</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151512313904989" role="paragraph" xml-lang="en-US">LF or CRLF </paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id211512313306932" role="paragraph" xml-lang="en-US" localize="false">vbNullString</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141512313800110" role="paragraph" localize="false">""</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741512313911049" role="paragraph" xml-lang="en-US">Null string</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id931512313312621" role="paragraph" localize="false">vbTab</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id241512313810064" role="paragraph" localize="false">\x09 (9)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951512313918356" role="paragraph" xml-lang="en-US">HT - Horizontal tab</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id481512313318983" role="paragraph" localize="false">vbVerticalTab </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id991512313821414" role="paragraph" localize="false">\x0B (11)</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351512313924593" role="paragraph" xml-lang="en-US">VT - Vertical tab</paragraph> + </tablecell> + </tablerow> + </table> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03050000.xhp b/helpcontent2/source/text/sbasic/shared/03050000.xhp new file mode 100644 index 000000000..28820eec3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03050000.xhp @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> + <meta> + <topic id="textsbasicshared03050000xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">Error-Handling Functions</title> + <filename>/text/sbasic/shared/03050000.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> + </meta> +<body> + <section id="errorhandling"> + <h1 id="hd_id3143271"><variable id="ErrHandlingh1"><link href="text/sbasic/shared/03050000.xhp" name="Error-Handling Functions">Error-Handling Functions</link></variable></h1> + <paragraph role="paragraph" id="par_id3145068" xml-lang="en-US">Use the following statements and functions to define the way %PRODUCTNAME Basic reacts to run-time errors.</paragraph> + </section> + <paragraph role="paragraph" id="par_id3148946" xml-lang="en-US">%PRODUCTNAME Basic offers several methods to prevent the termination of a program when a run-time error occurs.</paragraph> + <embed href="text/sbasic/shared/03100080.xhp#cverr"/> + <embed href="text/sbasic/shared/03050100.xhp#erl"/> + <embed href="text/sbasic/shared/03050200.xhp#err"/> + <embed href="text/sbasic/shared/ErrVBA.xhp#VBAErrObject"/> + <embed href="text/sbasic/shared/03102450.xhp#iserror"/> + <embed href="text/sbasic/shared/03050300.xhp#errorf"/> + <embed href="text/sbasic/shared/03050500.xhp#onerrorgotoresume"/> + <embed href="text/sbasic/shared/Resume.xhp#Resume"/> + <embed href="text/sbasic/shared/03/sf_exception.xhp#abstract"/> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03050100.xhp b/helpcontent2/source/text/sbasic/shared/03050100.xhp new file mode 100644 index 000000000..e10ff2d81 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03050100.xhp @@ -0,0 +1,70 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03050100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Erl Function</title> + <filename>/text/sbasic/shared/03050100.xhp</filename> + </topic> +</meta> + +<body> + +<section id="erl"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3157896"> + <bookmark_value>Erl function</bookmark_value> +</bookmark> + +<paragraph id="hd_id3157896" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03050100.xhp" name="Erl Function">Erl Function</link></paragraph> +<paragraph id="par_id3153394" role="paragraph" xml-lang="en-US">Returns the line number where an error occurred during program execution.</paragraph> +</section> + +<paragraph id="hd_id3147574" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3146795" role="bascode" localize="false" xml-lang="en-US">Erl</paragraph> +</bascode> + +<paragraph id="hd_id3147265" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154924" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3150792" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153771" role="note" xml-lang="en-US">The Erl function only returns a line number, and not a line label.</paragraph> + +<paragraph id="hd_id3146921" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340990976" role="bascode" localize="false" xml-lang="en-US">Sub ExampleError</paragraph> +<paragraph id="par_id3150010" role="bascode" xml-lang="en-US">On Error GoTo ErrorHandler ' Set up error handler</paragraph> +<paragraph id="par_idm1340988000" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Integer</paragraph> +<paragraph id="par_idm1340986768" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_id3153188" role="bascode" xml-lang="en-US">' Error caused by non-existent file</paragraph> +<paragraph id="par_idm1340983808" role="bascode" localize="false" xml-lang="en-US"> iVar = Freefile</paragraph> +<paragraph id="par_idm1340982576" role="bascode" localize="false" xml-lang="en-US"> Open "\file9879.txt" For Input As #iVar</paragraph> +<paragraph id="par_idm1340981312" role="bascode" localize="false" xml-lang="en-US"> Line Input #iVar, sVar</paragraph> +<paragraph id="par_idm1340980064" role="bascode" localize="false" xml-lang="en-US"> Close #iVar</paragraph> +<paragraph id="par_idm1340978832" role="bascode" localize="false" xml-lang="en-US"> Exit Sub</paragraph> +<paragraph id="par_idm1340977600" role="bascode" localize="false" xml-lang="en-US">ErrorHandler:</paragraph> +<paragraph id="par_id3155416" role="bascode" xml-lang="en-US"> MsgBox "Error " & err & ": " & Error$ + chr(13) + "In Line : " + Erl + chr(13) + Now , 16 ,"An error occurred"</paragraph> +<paragraph id="par_idm1340974432" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03050000.xhp#ErrHandlingh1"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03050200.xhp b/helpcontent2/source/text/sbasic/shared/03050200.xhp new file mode 100644 index 000000000..a6ee49f82 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03050200.xhp @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03050200xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Err Function</title> +<filename>/text/sbasic/shared/03050200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="err"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156343"><bookmark_value>Err function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3156343" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03050200.xhp" name="Err Function">Err Function</link></paragraph> +<paragraph role="paragraph" id="par_id3150541" xml-lang="en-US">Returns an error code that identifies the error that occurred during program execution.</paragraph> +</section> +<paragraph role="heading" id="hd_id3149656" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" localize="false" id="par_id3154123" xml-lang="en-US">Err</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3147229" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3150869" xml-lang="en-US">Integer</paragraph> +<paragraph role="heading" id="hd_id3153193" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3149561" xml-lang="en-US">The Err function is used in error-handling routines to determine the error and the corrective action.</paragraph> +<paragraph role="heading" id="hd_id3147317" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3153727" xml-lang="en-US" localize="false">Sub ExampleError</paragraph> +<paragraph role="bascode" id="par_id3147426" xml-lang="en-US">On Error Goto ErrorHandler REM Set up error handler</paragraph> +<paragraph role="bascode" id="par_id3163710" xml-lang="en-US" localize="false">Dim iVar as Integer</paragraph> +<paragraph role="bascode" id="par_id3153093" xml-lang="en-US" localize="false">Dim sVar As String</paragraph> +<paragraph role="bascode" id="par_id3149481" xml-lang="en-US">REM Error occurs due to non-existent file</paragraph> +<paragraph role="bascode" id="par_id3153190" xml-lang="en-US" localize="false"> iVar = Freefile</paragraph> +<paragraph role="bascode" id="par_id3146120" xml-lang="en-US" localize="false"> Open "\file9879.txt" for Input as #iVar</paragraph> +<paragraph role="bascode" id="par_id3155308" xml-lang="en-US" localize="false"> Line Input #iVar, sVar</paragraph> +<paragraph role="bascode" id="par_id3153142" xml-lang="en-US" localize="false"> Close #iVar</paragraph> +<paragraph role="bascode" id="par_id3149665" xml-lang="en-US" localize="false">Exit Sub</paragraph> +<paragraph role="bascode" id="par_id3154942" xml-lang="en-US" localize="false">ErrorHandler:</paragraph> +<paragraph role="bascode" id="par_id3145646" xml-lang="en-US"> MsgBox "Error " & Err & ": " & Error$ + chr(13) + "At line : " + Erl + chr(13) + Now , 16 ,"an error occurred"</paragraph> +<paragraph role="bascode" id="par_id3155418" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03050000.xhp#ErrHandlingh1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03050300.xhp b/helpcontent2/source/text/sbasic/shared/03050300.xhp new file mode 100644 index 000000000..f3964172a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03050300.xhp @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03050300xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Error Function</title> +<filename>/text/sbasic/shared/03050300.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="errorf"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3159413"><bookmark_value>Error function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3159413" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03050300.xhp" name="Error Function">Error Function</link></paragraph> +<paragraph role="paragraph" id="par_id3148663" xml-lang="en-US">Returns the error message that corresponds to a value or raises a given error context.</paragraph> +</section> +<paragraph role="heading" id="hd_id3153379" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id631576404838377">Error</paragraph> +<paragraph role="bascode" id="par_id3154366" xml-lang="en-US">Error(expression)</paragraph> +<paragraph role="bascode" id="par_id231576404629080">Error err_code</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3145173" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_id3154125" xml-lang="en-US">String or raised error context</paragraph> +<paragraph role="heading" id="hd_id3150869" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3159254" xml-lang="en-US">If no argument is provided, the Error function returns the error message of the most recent error that occurred during program execution.</paragraph> +<paragraph role="paragraph" id="par_id3153193" xml-lang="en-US"> +<emph>expression:</emph> Any numeric expression whose error code can be mapped to an existing error message. An empty string is returned if the error code does not exist.</paragraph> +<paragraph role="paragraph" id="par_id351576405235602" xml-lang="en-US"><emph>err_code:</emph> Any value that corresponds to an existing error code.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#allerrors"/><comment>fixed i60953</comment> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03050000.xhp#ErrHandlingh1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03050500.xhp b/helpcontent2/source/text/sbasic/shared/03050500.xhp new file mode 100644 index 000000000..3d1e71c39 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03050500.xhp @@ -0,0 +1,86 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03050500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">On Error GoTo ... Resume Statement</title> + <filename>/text/sbasic/shared/03050500.xhp</filename> + </topic> +</meta> + +<body> +<section id="onerrorgotoresume"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3146795"> + <bookmark_value>Resume Next parameter</bookmark_value> + <bookmark_value>On Error GoTo ... Resume statement</bookmark_value> +</bookmark> +<paragraph id="hd_id3146795" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03050500.xhp" name="On Error GoTo ... Resume Statement">On Error GoTo ... Resume Statement</link></paragraph> +<paragraph id="par_id3150358" role="paragraph" xml-lang="en-US">Enables an error-handling routine after an error occurs, or resumes program execution.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id491585753339474"> + <image src="media/helpimg/sbasic/On-Error_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">On Error Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3145173" role="bascode" xml-lang="en-US">On [Local] Error {GoTo Labelname | GoTo 0 | Resume Next}</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150869" role="paragraph" xml-lang="en-US"><emph>GoTo Labelname:</emph> If an error occurs, enables the error-handling routine that starts at the line "Labelname".</paragraph> +<paragraph id="par_id3150439" role="paragraph" xml-lang="en-US"><emph>Resume Next:</emph> If an error occurs, program execution continues with the statement that follows the statement in which the error occurred.</paragraph> +<paragraph id="par_id3149482" role="paragraph" xml-lang="en-US"><emph>GoTo 0:</emph> Disables the error handler in the current procedure.</paragraph> +<paragraph id="par_id3149483" role="paragraph" xml-lang="en-US"><emph>Local:</emph> "On error" is global in scope, and remains active until canceled by another "On error" statement. "On Local error" is local to the routine which invokes it. Local error handling overrides any previous global setting. When the invoking routine exits, the local error handling is canceled automatically, and any previous global setting is restored.</paragraph> +<paragraph id="par_id3148619" role="paragraph" xml-lang="en-US">The On Error GoTo statement is used to react to errors that occur in a macro.<comment>see i112231: The statement must be inserted at the start of a procedure (in a local error-handling routine) or at the start of a module.</comment></paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341127952" role="bascode" localize="false" xml-lang="en-US">Sub ExampleReset</paragraph> +<paragraph id="par_idm1341126720" role="bascode" localize="false" xml-lang="en-US">On Error GoTo ErrorHandler</paragraph> +<paragraph id="par_idm1341125472" role="bascode" localize="false" xml-lang="en-US"> Dim iNumber As Integer</paragraph> +<paragraph id="par_idm1341124240" role="bascode" localize="false" xml-lang="en-US"> Dim iCount As Integer</paragraph> +<paragraph id="par_idm1341123008" role="bascode" localize="false" xml-lang="en-US"> Dim sLine As String</paragraph> +<paragraph id="par_idm1341121776" role="bascode" localize="false" xml-lang="en-US"> Dim aFile As String</paragraph> +<paragraph id="par_idm1341120544" role="bascode" localize="false" xml-lang="en-US"> aFile = "C:\Users\ThisUser\data.txt"</paragraph> +<paragraph id="par_idm1341119296" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341118064" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Output As #iNumber</paragraph> +<paragraph id="par_id3153876" role="bascode" xml-lang="en-US"> Print #iNumber, "This is a line of text"</paragraph> +<paragraph id="par_idm1341115072" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341113840" role="bascode" localize="false" xml-lang="en-US"> iNumber = Freefile</paragraph> +<paragraph id="par_idm1341112608" role="bascode" localize="false" xml-lang="en-US"> Open aFile For Input As iNumber</paragraph> +<paragraph id="par_idm1341111360" role="bascode" localize="false" xml-lang="en-US"> For iCount = 1 To 5</paragraph> +<paragraph id="par_idm1341110128" role="bascode" localize="false" xml-lang="en-US"> Line Input #iNumber, sLine</paragraph> +<paragraph id="par_idm1341108880" role="bascode" localize="false" xml-lang="en-US"> If sLine <>"" Then</paragraph> +<paragraph id="par_idm1341107632" role="bascode" localize="false" xml-lang="en-US"> Rem</paragraph> +<paragraph id="par_idm1341106400" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1341105168" role="bascode" localize="false" xml-lang="en-US"> Next iCount</paragraph> +<paragraph id="par_idm1341103936" role="bascode" localize="false" xml-lang="en-US"> Close #iNumber</paragraph> +<paragraph id="par_idm1341102704" role="bascode" localize="false" xml-lang="en-US"> Exit Sub</paragraph> +<paragraph id="par_idm1341101472" role="bascode" localize="false" xml-lang="en-US">ErrorHandler:</paragraph> +<paragraph id="par_idm1341100240" role="bascode" localize="false" xml-lang="en-US"> Reset</paragraph> +<paragraph id="par_id3146916" role="bascode" xml-lang="en-US"> MsgBox "All files will be closed", 0, "Error"</paragraph> +<paragraph id="par_idm1341097264" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03050000.xhp#ErrHandlingh1"/> + <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03060000.xhp b/helpcontent2/source/text/sbasic/shared/03060000.xhp new file mode 100644 index 000000000..2f67ded5d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03060000.xhp @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03060000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Logical Operators</title> +<filename>/text/sbasic/shared/03060000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + <section id="logi"> + <h1 id="hd_id3147559"><variable id="BoolOper_h1"><link href="text/sbasic/shared/03060000.xhp" name="Logical Operators">Logical Operators</link></variable></h1> + <paragraph role="paragraph" id="par_id3153379" xml-lang="en-US">The following logical operators are supported by $[officename] Basic.</paragraph> + </section> + + <paragraph role="paragraph" id="par_id3154138" xml-lang="en-US">Logical operators combine (bitwise) the contents of two expressions or variables, for example, to test if specific bits are set or not.</paragraph> + <embed href="text/sbasic/shared/03060100.xhp#and"/> + <embed href="text/sbasic/shared/03060200.xhp#eqv"/> + <embed href="text/sbasic/shared/03060300.xhp#imp"/> + <embed href="text/sbasic/shared/03060400.xhp#not"/> + <embed href="text/sbasic/shared/03060500.xhp#or"/> + <embed href="text/sbasic/shared/03060600.xhp#xor"/> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03070000.xhp#MathOper_h1"/> + <embed href="text/sbasic/shared/03110100.xhp#CompOper_h1"/> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03060100.xhp b/helpcontent2/source/text/sbasic/shared/03060100.xhp new file mode 100644 index 000000000..1c4bf0bc3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03060100.xhp @@ -0,0 +1,68 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03060100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">AND Operator</title> + <filename>/text/sbasic/shared/03060100.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="and"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3146117"> + <bookmark_value>AND operator (logical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3146117" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03060100.xhp" name="AND Operator">AND Operator</link></paragraph> +<paragraph id="par_id3143268" role="paragraph" xml-lang="en-US">Logically combines two expressions.</paragraph> +</section> + +<paragraph id="hd_id3147574" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3156344" role="bascode" xml-lang="en-US">Result = Expression1 And Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3148946" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric variable that records the result of the combination.</paragraph> +<paragraph id="par_id3150541" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any expressions that you want to combine.</paragraph> +<paragraph id="par_id3156215" role="paragraph" xml-lang="en-US">Boolean expressions combined with AND only return the value <emph>True</emph> if both expressions evaluate to <emph>True</emph>:</paragraph> +<paragraph id="par_id3150870" role="paragraph" xml-lang="en-US"> <emph>True</emph> AND <emph>True</emph> returns <emph>True</emph>; for all other combinations the result is <emph>False</emph>.</paragraph> +<paragraph id="par_id3153768" role="paragraph" xml-lang="en-US">The AND operator also performs a bitwise comparison of identically positioned bits in two numeric expressions.</paragraph> + +<paragraph id="hd_id3153727" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340824864" role="bascode" localize="false" xml-lang="en-US">Sub ExampleAnd</paragraph> +<paragraph id="par_idm1340823632" role="bascode" localize="false" xml-lang="en-US">Dim A As Variant, B As Variant, C As Variant, D As Variant</paragraph> +<paragraph id="par_idm1340822352" role="bascode" localize="false" xml-lang="en-US">Dim vVarOut As Variant</paragraph> +<paragraph id="par_idm1340821120" role="bascode" localize="false" xml-lang="en-US"> A = 10: B = 8: C = 6: D = Null</paragraph> +<paragraph id="par_id3146984" role="bascode" xml-lang="en-US"> vVarOut = A > B And B > C ' returns -1</paragraph> +<paragraph id="par_id3154014" role="bascode" xml-lang="en-US"> vVarOut = B > A And B > C ' returns 0</paragraph> +<paragraph id="par_id3149262" role="bascode" xml-lang="en-US"> vVarOut = A > B And B > D ' returns 0</paragraph> +<paragraph id="par_id3145751" role="bascode" xml-lang="en-US"> vVarOut = (B > D And B > A) ' returns 0</paragraph> +<paragraph id="par_id3147394" role="bascode" xml-lang="en-US"> vVarOut = B And A ' returns 8 due to the bitwise And combination of both arguments</paragraph> +<paragraph id="par_idm1340810864" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03060200.xhp b/helpcontent2/source/text/sbasic/shared/03060200.xhp new file mode 100644 index 000000000..4ba146ac9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03060200.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03060200xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Eqv Operator</title> + <filename>/text/sbasic/shared/03060200.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="eqv"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156344"> + <bookmark_value>Eqv operator (logical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156344" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03060200.xhp" name="Eqv Operator">Eqv Operator</link></paragraph> +<paragraph id="par_id3149656" role="paragraph" xml-lang="en-US">Calculates the logical equivalence of two expressions.</paragraph> +</section> + +<paragraph id="hd_id3154367" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3154910" role="bascode" xml-lang="en-US">Result = Expression1 Eqv Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3151043" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3150869" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric variable that contains the result of the comparison.</paragraph> +<paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any expressions that you want to compare.</paragraph> +<paragraph id="par_id3149562" role="paragraph" xml-lang="en-US">When testing for equivalence between Boolean expressions, the result is <emph>True</emph> if both expressions are either <emph>True</emph> or <emph>False</emph>.</paragraph> +<paragraph id="par_id3154319" role="paragraph" xml-lang="en-US">In a bit-wise comparison, the Eqv operator only sets the corresponding bit in the result if a bit is set in both expressions, or in neither expression.</paragraph> + +<paragraph id="hd_id3159154" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341574288" role="bascode" localize="false" xml-lang="en-US">Sub ExampleEqv</paragraph> +<paragraph id="par_idm1341573056" role="bascode" localize="false" xml-lang="en-US">Dim A As Variant, B As Variant, C As Variant, D As Variant<comment>see #i38265</comment></paragraph> +<paragraph id="par_idm1341571488" role="bascode" localize="false" xml-lang="en-US">Dim vOut As Variant</paragraph> +<paragraph id="par_idm1341570256" role="bascode" localize="false" xml-lang="en-US"> A = 10: B = 8: C = 6: D = Null</paragraph> +<paragraph id="par_id3152462" role="bascode" xml-lang="en-US"> vOut = A > B Eqv B > C ' returns -1</paragraph> +<paragraph id="par_id3153191" role="bascode" xml-lang="en-US"> vOut = B > A Eqv B > C ' returns 0</paragraph> +<paragraph id="par_id3145799" role="bascode" xml-lang="en-US"> vOut = A > B Eqv B > D ' returns 0</paragraph> +<paragraph id="par_id3149412" role="bascode" xml-lang="en-US"> vOut = (B > D Eqv B > A) ' returns -1</paragraph> +<paragraph id="par_id3149959" role="bascode" xml-lang="en-US"> vOut = B Eqv A ' returns -3</paragraph> +<paragraph id="par_idm1341560048" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03060300.xhp b/helpcontent2/source/text/sbasic/shared/03060300.xhp new file mode 100644 index 000000000..041eb2736 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03060300.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03060300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Imp Operator</title> + <filename>/text/sbasic/shared/03060300.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="imp"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156024"> + <bookmark_value>Imp operator (logical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156024" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03060300.xhp" name="Imp Operator">Imp Operator</link></paragraph> +<paragraph id="par_id3148947" role="paragraph" xml-lang="en-US">Performs a logical implication on two expressions.</paragraph> +</section> + +<paragraph id="hd_id3148664" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149656" role="bascode" xml-lang="en-US">Result = Expression1 Imp Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3151212" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154910" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric variable that contains the result of the implication.</paragraph> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any expressions that you want to evaluate with the Imp operator.</paragraph> +<paragraph id="par_id3150440" role="paragraph" xml-lang="en-US">If you use the Imp operator in Boolean expressions, False is only returned if the first expression evaluates to True and the second expression to False.</paragraph> +<paragraph id="par_id3163710" role="paragraph" xml-lang="en-US">If you use the Imp operator in bit expressions, a bit is deleted from the result if the corresponding bit is set in the first expression and the corresponding bit is deleted in the second expression.</paragraph> + +<paragraph id="hd_id3147318" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341575552" role="bascode" localize="false" xml-lang="en-US">Sub ExampleImp</paragraph> +<paragraph id="par_idm1341574320" role="bascode" localize="false" xml-lang="en-US">Dim A As Variant, B As Variant, C As Variant, D As Variant</paragraph> +<paragraph id="par_idm1341573040" role="bascode" localize="false" xml-lang="en-US">Dim vOut As Variant</paragraph> +<paragraph id="par_idm1341571808" role="bascode" localize="false" xml-lang="en-US"> A = 10: B = 8: C = 6: D = Null</paragraph> +<paragraph id="par_id3145750" role="bascode" xml-lang="en-US"> vOut = A > B Imp B > C ' returns -1</paragraph> +<paragraph id="par_id3156441" role="bascode" xml-lang="en-US"> vOut = B > A Imp B > C ' returns -1</paragraph> +<paragraph id="par_id3152596" role="bascode" xml-lang="en-US"> vOut = A > B Imp B > D ' returns 0</paragraph> +<paragraph id="par_id3154942" role="bascode" xml-lang="en-US"> vOut = (B > D Imp B > A) ' returns -1</paragraph> +<paragraph id="par_id3154492" role="bascode" xml-lang="en-US"> vOut = B Imp A ' returns -1</paragraph> +<paragraph id="par_idm1341561584" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03060400.xhp b/helpcontent2/source/text/sbasic/shared/03060400.xhp new file mode 100644 index 000000000..38bcd0123 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03060400.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03060400xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Not Operator</title> + <filename>/text/sbasic/shared/03060400.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="not"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156024"> + <bookmark_value>Not operator (logical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156024" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03060400.xhp" name="Not Operator">Not Operator</link></paragraph> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US">Negates an expression by inverting the bit values.</paragraph> +</section> + +<paragraph id="hd_id3149457" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150360" role="bascode" xml-lang="en-US">Result = Not Expression</paragraph> +</bascode> + +<paragraph id="hd_id3151211" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3147228" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric variable that contains the result of the negation.</paragraph> +<paragraph id="par_id3154124" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Any expression that you want to negate.</paragraph> +<paragraph id="par_id3150868" role="paragraph" xml-lang="en-US">When a Boolean expression is negated, the value True changes to False, and the value False changes to True.</paragraph> +<paragraph id="par_id3145785" role="paragraph" xml-lang="en-US">In a bitwise negation each individual bit is inverted.</paragraph> + +<paragraph id="hd_id3153093" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341144144" role="bascode" localize="false" xml-lang="en-US">Sub ExampleNot</paragraph> +<paragraph id="par_idm1341142912" role="bascode" localize="false" xml-lang="en-US">Dim vA As Variant, vB As Variant, vC As Variant, vD As Variant</paragraph> +<paragraph id="par_idm1341141632" role="bascode" localize="false" xml-lang="en-US">Dim vOut As Variant</paragraph> +<paragraph id="par_idm1341140400" role="bascode" localize="false" xml-lang="en-US"> vA = 10: vB = 8: vC = 6: vD = Null</paragraph> +<paragraph id="par_id3145749" role="bascode" xml-lang="en-US"> vOut = Not vA ' Returns -11</paragraph> +<paragraph id="par_id3148645" role="bascode" xml-lang="en-US"> vOut = Not(vC > vD) ' Returns -1</paragraph> +<paragraph id="par_id3156441" role="bascode" xml-lang="en-US"> vOut = Not(vB > vA) ' Returns -1</paragraph> +<paragraph id="par_id3152596" role="bascode" xml-lang="en-US"> vOut = Not(vA > vB) ' Returns 0</paragraph> +<paragraph id="par_idm1341132192" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03060500.xhp b/helpcontent2/source/text/sbasic/shared/03060500.xhp new file mode 100644 index 000000000..d4652e7a5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03060500.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03060500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Or Operator</title> + <filename>/text/sbasic/shared/03060500.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="or"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150986"> + <bookmark_value>Or operator (logical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150986" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03060500.xhp" name="Or Operator">Or Operator</link></paragraph> +<paragraph id="par_id3148552" role="paragraph" xml-lang="en-US">Performs a logical OR disjunction on two expressions.</paragraph> +</section> + +<paragraph id="hd_id3148664" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150358" role="bascode" xml-lang="en-US">Result = Expression1 Or Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3151211" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153192" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric variable that contains the result of the disjunction.</paragraph> +<paragraph id="par_id3147229" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any numeric expressions that you want to compare.</paragraph> +<paragraph id="par_id3154684" role="paragraph" xml-lang="en-US">A logical OR disjunction of two Boolean expressions returns the value True if at least one comparison expression is True.</paragraph> +<paragraph id="par_id3153768" role="paragraph" xml-lang="en-US">A bit-wise comparison sets a bit in the result if the corresponding bit is set in at least one of the two expressions.</paragraph> + +<paragraph id="hd_id3161831" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340848352" role="bascode" localize="false" xml-lang="en-US">Sub ExampleOr</paragraph> +<paragraph id="par_idm1340847120" role="bascode" localize="false" xml-lang="en-US">Dim vA As Variant, vB As Variant, vC As Variant, vD As Variant</paragraph> +<paragraph id="par_idm1340845840" role="bascode" localize="false" xml-lang="en-US">Dim vOut As Variant</paragraph> +<paragraph id="par_idm1340844608" role="bascode" localize="false" xml-lang="en-US"> vA = 10: vB = 8: vC = 6: vD = Null</paragraph> +<paragraph id="par_idm1340843360" role="bascode" localize="false" xml-lang="en-US"> vOut = vA > vB Or vB > vC ' -1</paragraph> +<paragraph id="par_idm1340842064" role="bascode" localize="false" xml-lang="en-US"> vOut = vB > vA Or vB > vC ' -1</paragraph> +<paragraph id="par_idm1340840768" role="bascode" localize="false" xml-lang="en-US"> vOut = vA > vB Or vB > vD ' -1</paragraph> +<paragraph id="par_idm1340839472" role="bascode" localize="false" xml-lang="en-US"> vOut = (vB > vD Or vB > vA) ' 0</paragraph> +<paragraph id="par_idm1340838176" role="bascode" localize="false" xml-lang="en-US"> vOut = vB Or vA ' 10</paragraph> +<paragraph id="par_idm1340836928" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03060600.xhp b/helpcontent2/source/text/sbasic/shared/03060600.xhp new file mode 100644 index 000000000..e2fa594dd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03060600.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03060600xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">XOR Operator</title> + <filename>/text/sbasic/shared/03060600.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="xor"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156024"> + <bookmark_value>XOR operator (logical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156024" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03060600.xhp" name="XOR Operator">XOR Operator</link></paragraph> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US">Performs a logical Exclusive-Or combination of two expressions.</paragraph> +</section> + +<paragraph id="hd_id3153381" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150400" role="bascode" xml-lang="en-US">Result = Expression1 XOR Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3153968" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric variable that contains the result of the combination.</paragraph> +<paragraph id="par_id3125864" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any numeric expressions that you want to combine.</paragraph> +<paragraph id="par_id3150439" role="paragraph" xml-lang="en-US">A logical Exclusive-Or conjunction of two Boolean expressions returns the value True only if both expressions are different from each other.</paragraph> +<paragraph id="par_id3153770" role="paragraph" xml-lang="en-US">A bitwise Exclusive-Or conjunction returns a bit if the corresponding bit is set in only one of the two expressions.</paragraph> + +<paragraph id="hd_id3153366" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341575648" role="bascode" localize="false" xml-lang="en-US">Sub ExampleXOR</paragraph> +<paragraph id="par_idm1341574416" role="bascode" localize="false" xml-lang="en-US">Dim vA As Variant, vB As Variant, vC As Variant, vD As Variant</paragraph> +<paragraph id="par_idm1341573136" role="bascode" localize="false" xml-lang="en-US">Dim vOut As Variant</paragraph> +<paragraph id="par_idm1341571904" role="bascode" localize="false" xml-lang="en-US"> vA = 10: vB = 8: vC = 6: vD = Null</paragraph> +<paragraph id="par_id3156442" role="bascode" xml-lang="en-US"> vOut = vA > vB XOR vB > vC ' returns 0</paragraph> +<paragraph id="par_id3153191" role="bascode" xml-lang="en-US"> vOut = vB > vA XOR vB > vC ' returns -1</paragraph> +<paragraph id="par_id3153144" role="bascode" xml-lang="en-US"> vOut = vA > vB XOR vB > vD ' returns -1</paragraph> +<paragraph id="par_id3154944" role="bascode" xml-lang="en-US"> vOut = (vB > vD XOR vB > vA) ' returns 0</paragraph> +<paragraph id="par_id3148455" role="bascode" xml-lang="en-US"> vOut = vB XOR vA ' returns 2</paragraph> +<paragraph id="par_idm1341561664" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03070000.xhp b/helpcontent2/source/text/sbasic/shared/03070000.xhp new file mode 100644 index 000000000..5b9919cb4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070000.xhp @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03070000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Mathematical Operators</title> +<filename>/text/sbasic/shared/03070000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + <section id="math"> + <h1 id="hd_id3149234"><variable id="MathOper_h1"><link href="text/sbasic/shared/03070000.xhp" name="Mathematical Operators">Mathematical Operators</link></variable></h1> + <paragraph role="paragraph" id="par_id3145068" xml-lang="en-US">The following mathematical operators are supported in $[officename] Basic.</paragraph> + </section> + <paragraph role="paragraph" id="par_id3148552" xml-lang="en-US">This chapter provides a short overview of all of the arithmetical operators that you may need for calculations within a program.</paragraph> + <embed href="text/sbasic/shared/03070100.xhp#subtraction"/> + <embed href="text/sbasic/shared/03070200.xhp#multiplikation"/> + <embed href="text/sbasic/shared/03070300.xhp#addition"/> + <embed href="text/sbasic/shared/03070400.xhp#division"/> + <embed href="text/sbasic/shared/03070700.xhp#IntegerDivision"/> + <embed href="text/sbasic/shared/03070500.xhp#power"/> + <embed href="text/sbasic/shared/03070600.xhp#mod"/> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03060000.xhp#BoolOper_h1"/> + <embed href="text/sbasic/shared/03110100.xhp#CompOper_h1"/> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03070100.xhp b/helpcontent2/source/text/sbasic/shared/03070100.xhp new file mode 100644 index 000000000..f54561edb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070100.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03070100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">"-" Operator</title> + <filename>/text/sbasic/shared/03070100.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="subtraction"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156042"> + <bookmark_value>"-" operator (mathematical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156042" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03070100.xhp">"-" Operator</link></paragraph> +<paragraph id="par_id3153345" role="paragraph" xml-lang="en-US">Subtracts two values.</paragraph> +</section> + +<paragraph id="hd_id3149416" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3156023" role="bascode" xml-lang="en-US">Result = Expression1 - Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3154760" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3147560" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numerical expression that contains the result of the subtraction.</paragraph> +<paragraph id="par_id3150398" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any numerical expressions that you want to subtract.</paragraph> + +<paragraph id="hd_id3154366" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341579664" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSubtraction1</paragraph> +<paragraph id="par_idm1341578432" role="bascode" localize="false" xml-lang="en-US"> Print 5 - 5</paragraph> +<paragraph id="par_idm1341577200" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1341575968" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341574720" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSubtraction2</paragraph> +<paragraph id="par_idm1341573488" role="bascode" localize="false" xml-lang="en-US">Dim iValue1 As Integer</paragraph> +<paragraph id="par_idm1341572256" role="bascode" localize="false" xml-lang="en-US">Dim iValue2 As Integer</paragraph> +<paragraph id="par_idm1341571024" role="bascode" localize="false" xml-lang="en-US"> iValue1 = 5</paragraph> +<paragraph id="par_idm1341569792" role="bascode" localize="false" xml-lang="en-US"> iValue2 = 10</paragraph> +<paragraph id="par_idm1341568560" role="bascode" localize="false" xml-lang="en-US"> Print iValue1 - iValue2</paragraph> +<paragraph id="par_idm1341567312" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03070200.xhp b/helpcontent2/source/text/sbasic/shared/03070200.xhp new file mode 100644 index 000000000..2f45997b5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070200.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03070200xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">"*" Operator</title> + <filename>/text/sbasic/shared/03070200.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="multiplikation"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147573"> + <bookmark_value>"*" operator (mathematical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3147573" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03070200.xhp">"*" Operator</link></paragraph> +<paragraph id="par_id3154347" role="paragraph" xml-lang="en-US">Multiplies two values.</paragraph> +</section> + +<paragraph id="hd_id3148946" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150358" role="bascode" xml-lang="en-US">Result = Expression1 * Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3150400" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154365" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric expression that records the result of a multiplication.</paragraph> +<paragraph id="par_id3154685" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any numeric expressions that you want to multiply.</paragraph> + +<paragraph id="hd_id3153968" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341058256" role="bascode" localize="false" xml-lang="en-US">Sub ExampleMultiplication1</paragraph> +<paragraph id="par_idm1341621360" role="bascode" localize="false" xml-lang="en-US"> Print 5 * 5</paragraph> +<paragraph id="par_idm1341620128" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1341618896" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341617696" role="bascode" localize="false" xml-lang="en-US">Sub ExampleMultiplication2</paragraph> +<paragraph id="par_idm1341616448" role="bascode" localize="false" xml-lang="en-US">Dim iValue1 As Integer</paragraph> +<paragraph id="par_idm1341615216" role="bascode" localize="false" xml-lang="en-US">Dim iValue2 As Integer</paragraph> +<paragraph id="par_idm1341613984" role="bascode" localize="false" xml-lang="en-US"> iValue1 = 5</paragraph> +<paragraph id="par_idm1341612752" role="bascode" localize="false" xml-lang="en-US"> iValue2 = 10</paragraph> +<paragraph id="par_idm1341611520" role="bascode" localize="false" xml-lang="en-US"> Print iValue1 * iValue2</paragraph> +<paragraph id="par_idm1341610272" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03070300.xhp b/helpcontent2/source/text/sbasic/shared/03070300.xhp new file mode 100644 index 000000000..ecfaa55d5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070300.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03070300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">"+" Operator</title> + <filename>/text/sbasic/shared/03070300.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="addition"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145316"> + <bookmark_value>"+" operator (mathematical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3145316" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03070300.xhp">"+" Operator</link></paragraph> +<paragraph id="par_id3145068" role="paragraph" xml-lang="en-US">Adds or combines two expressions.</paragraph> +</section> + +<paragraph id="hd_id3144500" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150358" role="bascode" xml-lang="en-US">Result = Expression1 + Expression2</paragraph> +</bascode> + +<paragraph id="hd_id3150400" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154123" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numerical expression that contains the result of the addition.</paragraph> +<paragraph id="par_id3150870" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any numerical expressions that you want to combine or to add.</paragraph> + +<paragraph id="hd_id3153969" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340484848" role="bascode" localize="false" xml-lang="en-US">Sub ExampleAddition1</paragraph> +<paragraph id="par_idm1340483616" role="bascode" localize="false" xml-lang="en-US"> Print 5 + 5</paragraph> +<paragraph id="par_idm1340482384" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1340481152" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1340479904" role="bascode" localize="false" xml-lang="en-US">Sub ExampleAddition2</paragraph> +<paragraph id="par_idm1340478672" role="bascode" localize="false" xml-lang="en-US">Dim iValue1 As Integer</paragraph> +<paragraph id="par_idm1340477440" role="bascode" localize="false" xml-lang="en-US">Dim iValue2 As Integer</paragraph> +<paragraph id="par_idm1340476208" role="bascode" localize="false" xml-lang="en-US"> iValue1 = 5</paragraph> +<paragraph id="par_idm1340474976" role="bascode" localize="false" xml-lang="en-US"> iValue2 = 10</paragraph> +<paragraph id="par_idm1340473744" role="bascode" localize="false" xml-lang="en-US"> Print iValue1 + iValue2</paragraph> +<paragraph id="par_idm1340472496" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03070400.xhp b/helpcontent2/source/text/sbasic/shared/03070400.xhp new file mode 100644 index 000000000..3e93644e4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070400.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03070400xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">"/" Operator</title> + <filename>/text/sbasic/shared/03070400.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="division"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150669"> + <bookmark_value>"/" operator (mathematical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150669" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03070400.xhp">"/" Operator</link></paragraph> +<paragraph id="par_id3149670" role="paragraph" xml-lang="en-US">Divides two values.</paragraph> +</section> + +<paragraph id="hd_id3148946" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153360" role="bascode" xml-lang="en-US">Result = Expression1 / Expression2 </paragraph> +</bascode> + +<paragraph id="hd_id3150359" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154141" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numerical value that contains the result of the division.</paragraph> +<paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any numerical expressions that you want to divide.</paragraph> + +<paragraph id="hd_id3154684" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341473008" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDivision1</paragraph> +<paragraph id="par_idm1341471776" role="bascode" localize="false" xml-lang="en-US"> Print 5 / 5</paragraph> +<paragraph id="par_idm1341470544" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1341469312" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341468064" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDivision2</paragraph> +<paragraph id="par_idm1341466832" role="bascode" localize="false" xml-lang="en-US">Dim iValue1 As Integer</paragraph> +<paragraph id="par_idm1341465600" role="bascode" localize="false" xml-lang="en-US">Dim iValue2 As Integer</paragraph> +<paragraph id="par_idm1341464368" role="bascode" localize="false" xml-lang="en-US"> iValue1 = 5</paragraph> +<paragraph id="par_idm1341463136" role="bascode" localize="false" xml-lang="en-US"> iValue2 = 10</paragraph> +<paragraph id="par_idm1341461904" role="bascode" localize="false" xml-lang="en-US"> Print iValue1 / iValue2</paragraph> +<paragraph id="par_idm1341460656" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03070500.xhp b/helpcontent2/source/text/sbasic/shared/03070500.xhp new file mode 100644 index 000000000..e69cee190 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070500.xhp @@ -0,0 +1,60 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03070500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">"^" Operator</title> + <filename>/text/sbasic/shared/03070500.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="power"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145315"> + <bookmark_value>"^" operator (mathematical)</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3145315" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03070500.xhp">"^" Operator</link></paragraph> +<paragraph id="par_id3149670" role="paragraph" xml-lang="en-US">Raises a number to a power.</paragraph> +</section> + +<paragraph id="hd_id3147264" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149656" role="bascode" xml-lang="en-US">Result = Expression ^ Exponent</paragraph> +</bascode> + +<paragraph id="hd_id3151211" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3153192" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numerical expression that contains the result of the number raised to a power.</paragraph> +<paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Numerical value that you want to raise to a power.</paragraph> +<paragraph id="par_id3156422" role="paragraph" xml-lang="en-US"> <emph>Exponent:</emph> The value of the power that you want to raise the expression to.</paragraph> + +<paragraph id="hd_id3147287" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340559440" role="bascode" localize="false" xml-lang="en-US">Sub Example</paragraph> +<paragraph id="par_idm1340558208" role="bascode" localize="false" xml-lang="en-US"> Print ( 12.345 ^ 23 )</paragraph> +<paragraph id="par_id3146984" role="bascode" xml-lang="en-US"> Print Exp ( 23 * Log( 12.345 ) ) ' Raises by forming a logarithm</paragraph> +<paragraph id="par_idm1340555200" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03070600.xhp b/helpcontent2/source/text/sbasic/shared/03070600.xhp new file mode 100644 index 000000000..ed510a94c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070600.xhp @@ -0,0 +1,83 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03070600xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Mod Operator</title> + <filename>/text/sbasic/shared/03070600.xhp</filename> + </topic> +</meta> + +<body> + +<section id="mod"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150669"> + <bookmark_value>MOD operator (mathematical)</bookmark_value> +</bookmark> + +<h1 id="hd_id3150669"><variable id="MOD_h1"><link href="text/sbasic/shared/03070600.xhp" name="Mod Operator">Mod Operator</link></variable></h1> +<paragraph id="par_id3148686" role="paragraph" xml-lang="en-US">The <literal>MOD</literal> operator takes in two numeric expressions and returns the remainder of the division.</paragraph> +</section> +<paragraph id="par_id3148004" role="paragraph" xml-lang="en-US">For example, the result of <literal>21 MOD 6</literal> is <literal>3</literal> because after dividing 21 by 6, the remainder of the division is 3.</paragraph> +<paragraph role="paragraph" id="par_id111617300964049">If the <literal>MOD</literal> operation involves non-integer values, both operands are rounded to the nearest integer values. Hence, the value returned by a <literal>MOD</literal> operation will always be an integer number.</paragraph> +<paragraph role="paragraph" id="par_id561617302820104">For example, the expression <literal>16.4 MOD 5.9</literal> is evaluated as follows:</paragraph> +<list type="ordered"> + <listitem> + <paragraph id="par_id151617302878527" role="listitem">The value 16.4 is rounded to 16.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id351617303087259" role="listitem">The value 5.9 is rounded to 6.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id91617303114774" role="listitem">The operation <literal>16 MOD 6</literal> returns 4, which is the remainder after dividing 16 by 6.</paragraph> + </listitem> +</list> +<note id="par_id921617302349290">Beware that Basic's <literal>MOD</literal> operator and Calc's <link href="text/scalc/01/04060106.xhp#bm_id3158247" name="MOD Function">MOD Function</link> behave differently. In Calc, both operands can be decimal values and they're not rounded before division, thus the resulting remainder may be a decimal value.</note> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3147560" role="bascode" xml-lang="en-US">Result = Expression1 MOD Expression2</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3153380" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145172" role="paragraph" xml-lang="en-US"> <emph>Result:</emph> Any numeric variable that contains the result of the <literal>MOD</literal> operation.</paragraph> +<paragraph id="par_id3151042" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2:</emph> Any numeric expressions for which you want to calculate the remainder after the division of <literal>Expression1</literal> by <literal>Expression2</literal>.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340853360" role="bascode" localize="false">Sub ExampleMod</paragraph> +<paragraph id="par_id3161832" role="bascode" localize="false"> Dim a As Double, b as Double</paragraph> +<paragraph id="par_id3150011" role="bascode" localize="false"> a = 10 : b = 4</paragraph> +<paragraph id="par_id3149483" role="bascode"> Print a Mod b 'Returns 2</paragraph> +<paragraph id="par_id3151114" role="bascode" localize="false"> a = 18 : b = 3.2</paragraph> +<paragraph id="par_id31494778" role="bascode"> Print a Mod b 'Returns 0</paragraph> +<paragraph id="par_id3146922" role="bascode" localize="false"> a = 16.4 : b = 5.9</paragraph> +<paragraph id="par_id3145273" role="bascode"> Print a Mod b 'Returns 4</paragraph> +<paragraph id="par_idm1340841712" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id771617305550403"><link href="text/scalc/01/04060106.xhp#bm_id3158247" name="Calc MOD Function">MOD Function</link></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03070700.xhp b/helpcontent2/source/text/sbasic/shared/03070700.xhp new file mode 100644 index 000000000..69a83b03c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03070700.xhp @@ -0,0 +1,53 @@ +<?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="textsbasicshared03070700xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">"\" Operator</title> + <filename>/text/sbasic/shared/03070700.xhp</filename> + </topic> +</meta> + +<body> + +<section id="IntegerDivision"> +<h1 id="hd_id3150669"><link href="text/sbasic/shared/03070700.xhp">"\" Operator</link></h1> +<paragraph id="par_id3149670" role="paragraph" xml-lang="en-US">Performs the integer division on two numbers and returns the result.</paragraph> +</section> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150669"> + <bookmark_value>Operators;Integer division (\\)</bookmark_value> + <bookmark_value>"\\" operator (mathematical)</bookmark_value> +</bookmark> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph id="par_id3153360" role="bascode" xml-lang="en-US">result = expression1 \ expression2 </paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3154141" role="paragraph" xml-lang="en-US"> <emph>result</emph>: A numerical value that contains the result of the integer division.</paragraph> +<paragraph id="par_id3150448" role="paragraph"> <emph>expression1, expression2</emph>: Dividend and diviser operands of the integer division.</paragraph> +<paragraph role="paragraph" id="par_id951642689912087">Before division both operands are rounded to whole numbers. The fractional part of the result is dropped.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341473008" role="bascode" localize="false">Sub IntegerDivision</paragraph> +<paragraph id="par_idm1341471776" role="bascode" xml-lang="en-US"> Print 5 \ 4 , 5 / 4 ' 1 , 1.25</paragraph> +<paragraph id="par_idm1341471777" role="bascode" xml-lang="en-US"> Print 7 \ 4 , 7 / 4 ' 1 , 1.75</paragraph> +<paragraph id="par_idm1341470544" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03070600.xhp#MOD_h1"/> + <embed href="text/sbasic/shared/03070000.xhp#MathOper_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080000.xhp b/helpcontent2/source/text/sbasic/shared/03080000.xhp new file mode 100644 index 000000000..dcadb6f25 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080000.xhp @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Numeric Functions</title> +<filename>/text/sbasic/shared/03080000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="numeric"> + <paragraph id="hd_id3153127" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080000.xhp" name="Numeric Functions">Numeric Functions</link></paragraph> + <paragraph role="paragraph" id="par_id3148550" xml-lang="en-US">The following numeric functions perform calculations. Mathematical and Boolean operators are described in a separate section. Functions differ from operators in that functions pass arguments and return a result, instead of operators that return a result by combining two numeric expressions.</paragraph> + </section> + <embed href="text/sbasic/shared/03080100.xhp#trigo"/> + <embed href="text/sbasic/shared/03080200.xhp#loga"/> + <embed href="text/sbasic/shared/03080300.xhp#random"/> + <embed href="text/sbasic/shared/03080400.xhp#square"/> + <embed href="text/sbasic/shared/03080500.xhp#integer"/> + <embed href="text/sbasic/shared/03080600.xhp#absolute"/> + <embed href="text/sbasic/shared/03080700.xhp#sign"/> + <embed href="text/sbasic/shared/03080800.xhp#converting"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080100.xhp b/helpcontent2/source/text/sbasic/shared/03080100.xhp new file mode 100644 index 000000000..9e50eae34 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080100.xhp @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080100xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Trigonometric Functions</title> +<filename>/text/sbasic/shared/03080100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="trigo"> + <paragraph id="hd_id3159201" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080100.xhp" name="Trigonometric Functions">Trigonometric Functions</link></paragraph> + <paragraph role="paragraph" id="par_id3149180" xml-lang="en-US">The following are the trigonometric functions that are supported in $[officename] Basic.</paragraph> + </section> + <embed href="text/sbasic/shared/03080101.xhp#atn"/> + <embed href="text/sbasic/shared/03080102.xhp#cos"/> + <embed href="text/sbasic/shared/03080103.xhp#sin"/> + <embed href="text/sbasic/shared/03080104.xhp#tan"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080101.xhp b/helpcontent2/source/text/sbasic/shared/03080101.xhp new file mode 100644 index 000000000..4188f8cca --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080101.xhp @@ -0,0 +1,76 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + <meta> + <topic id="textsbasicshared03080101xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Atn Function</title> + <filename>/text/sbasic/shared/03080101.xhp</filename> + </topic> + </meta> + + <body> + <section id="atn"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150616"> +<bookmark_value>Atn function</bookmark_value> + </bookmark> + <h1 id="hd_id3150616"><variable id="Atn_h1"><link href="text/sbasic/shared/03080101.xhp" name="Atn Function">Atn Function</link></variable></h1> + <paragraph id="par_id3149346" role="paragraph">Trigonometric function that returns the arctangent of a numeric expression. The return value is in the range -Pi/2 to +Pi/2.</paragraph> + </section> + <paragraph id="par_id3143271" role="paragraph" xml-lang="en-US">The arctangent is the inverse of the tangent function. The <literal>Atn</literal> Function returns the angle "Alpha", expressed in radians, using the tangent of this angle. The function can also return the angle "Alpha" by comparing the ratio of the length of the side that is opposite of the angle to the length of the side that is adjacent to the angle in a right-angled triangle.</paragraph> + <paragraph id="par_id3145315" role="paragraph" xml-lang="en-US"><literal>Atn</literal>(side opposite the angle/side adjacent to angle)= Alpha</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph id="par_id3148947" role="bascode" xml-lang="en-US">Atn (Number As Double) As Double</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3150359" localize="false" role="paragraph">Double</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id3156212" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numerical expression that represents the ratio of two sides of a right triangle. The <literal>Atn</literal> function returns the corresponding angle in radians (arctangent).</paragraph> + <paragraph id="par_id3153192" role="paragraph" xml-lang="en-US">To convert radians to degrees, multiply radians by 180/pi.</paragraph> + <paragraph id="par_id3147230" role="paragraph" xml-lang="en-US">degree=(radian*180)/pi</paragraph> + <paragraph id="par_id3125864" role="paragraph" xml-lang="en-US">radian=(degree*pi)/180</paragraph> + <paragraph id="par_id3159252" role="paragraph" xml-lang="en-US"><literal>Pi</literal> is here the fixed circle constant with the rounded value 3.14159. <literal>Pi</literal> is a <link href="text/sbasic/shared/03040000.xhp#mathconstants" name="pi">Basic mathematical constant</link>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_id3146985" role="bascode" xml-lang="en-US">' The following example calculates for a right-angled triangle</paragraph> + <paragraph id="par_id3145750" role="bascode" xml-lang="en-US">' the angle Alpha from the tangent of the angle Alpha:</paragraph> + <paragraph id="par_idm1340870576" role="bascode" localize="false">Sub ExampleAtn</paragraph> + <paragraph id="par_id3151112" role="bascode" xml-lang="en-US">' rounded Pi = 3.14159 Is a predefined constant</paragraph> + <paragraph id="par_idm1340867552" role="bascode" localize="false">Dim d1 As Double</paragraph> + <paragraph id="par_idm1340866320" role="bascode" localize="false">Dim d2 As Double</paragraph> + <paragraph id="par_id3149262" role="bascode" xml-lang="en-US"> d1 = InputBox("Enter the length of the side adjacent to the angle: ","Adjacent")</paragraph> + <paragraph id="par_id3149482" role="bascode" xml-lang="en-US"> d2 = InputBox("Enter the length of the side opposite the angle: ","Opposite")</paragraph> + <paragraph id="par_id3155415" role="bascode" xml-lang="en-US"> Print "The Alpha angle is"; (atn (d2/d1) * 180 / Pi); " degrees"</paragraph> + <paragraph id="par_idm1340859728" role="bascode" localize="false">End Sub</paragraph> + </bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03080102.xhp#Cos_h1"/> + <embed href="text/sbasic/shared/03080103.xhp#Sin_h1"/> + <embed href="text/sbasic/shared/03080104.xhp#Tan_h1"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080102.xhp b/helpcontent2/source/text/sbasic/shared/03080102.xhp new file mode 100644 index 000000000..9f2e227ea --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080102.xhp @@ -0,0 +1,79 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080102xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Cos Function</title> + <filename>/text/sbasic/shared/03080102.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="cos"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154923"> + <bookmark_value>Cos function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3154923"><variable id="Cos_h1"><link href="text/sbasic/shared/03080102.xhp" name="Cos Function">Cos Function</link></variable></h1> +<paragraph id="par_id3159413" role="paragraph">Calculates the cosine of an angle. The angle is specified in radians. The result lies between -1 and 1.</paragraph> +</section> +<paragraph id="par_id3150358" role="paragraph" xml-lang="en-US">Using the angle Alpha, the <literal>Cos</literal> function calculates the ratio of the length of the side that is adjacent to the angle, divided by the length of the hypotenuse in a right-angled triangle.</paragraph> +<paragraph id="par_id3154141" role="paragraph" xml-lang="en-US"><literal>Cos</literal>(Alpha) = Adjacent/Hypotenuse</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/><bascode> +<paragraph id="par_id3145172" role="bascode" xml-lang="en-US">Cos (Number As Double) As Double</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150449" localize="false" role="paragraph">Double</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153770" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Numeric expression that specifies an angle in radians that you want to calculate the cosine for.</paragraph> +<paragraph id="par_id3145749" role="paragraph" xml-lang="en-US">To convert degrees to radians, multiply degrees by pi/180. To convert radians to degrees, multiply radians by 180/pi.</paragraph> +<paragraph id="par_id3149664" role="paragraph" xml-lang="en-US">degree=(radian*180)/pi</paragraph> +<paragraph id="par_id3146985" role="paragraph" xml-lang="en-US">radian=(degree*pi)/180</paragraph> +<paragraph id="par_id3152885" role="paragraph" xml-lang="en-US"><literal>Pi</literal> is here the fixed circle constant with the rounded value 3.14159...</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id3155855" role="bascode" xml-lang="en-US">' The following example allows for a right-angled triangle the input of</paragraph> +<paragraph id="par_id3149484" role="bascode" xml-lang="en-US">' secant and angle (in degrees) and calculates the length of the hypotenuse:</paragraph> +<paragraph id="par_idm1341562416" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCosinus</paragraph> +<paragraph id="par_id3150010" role="bascode" xml-lang="en-US">' rounded Pi = 3.14159</paragraph> +<paragraph id="par_idm1341559424" role="bascode" localize="false" xml-lang="en-US">Dim d1 As Double, dAngle As Double</paragraph> +<paragraph id="par_id3144764" role="bascode" xml-lang="en-US"> d1 = InputBox("Enter the length of the adjacent side: ","Adjacent")</paragraph> +<paragraph id="par_id3154491" role="bascode" xml-lang="en-US"> dAngle = InputBox("Enter the angle Alpha (in degrees): ","Alpha")</paragraph> +<paragraph id="par_id3151074" role="bascode" xml-lang="en-US"> Print "The length of the hypothenuse is"; (d1 / cos (dAngle * Pi / 180))</paragraph> +<paragraph id="par_idm1341552832" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03080101.xhp#Atn_h1"/> + <embed href="text/sbasic/shared/03080103.xhp#Sin_h1"/> + <embed href="text/sbasic/shared/03080104.xhp#Tan_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080103.xhp b/helpcontent2/source/text/sbasic/shared/03080103.xhp new file mode 100644 index 000000000..7f9f25a15 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080103.xhp @@ -0,0 +1,81 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080103xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Sin Function</title> + <filename>/text/sbasic/shared/03080103.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="sin"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153896"> + <bookmark_value>Sin function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3153896"><variable id="Sin_h1"><link href="text/sbasic/shared/03080103.xhp" name="Sin Function">Sin Function</link></variable></h1> +<paragraph id="par_id3149456" role="paragraph">Returns the sine of an angle. The angle is specified in radians. The result lies between -1 and 1.</paragraph> +</section> +<paragraph id="par_id3153379" role="paragraph" xml-lang="en-US">Using the angle Alpha, the <literal>Sin</literal> function returns the ratio of the length of the opposite side of an angle to the length of the hypotenuse in a right-angled triangle.</paragraph> +<paragraph id="par_id3148798" role="paragraph" xml-lang="en-US"><literal>Sin</literal>(Alpha) = side opposite the angle/hypotenuse</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3154909" role="bascode" xml-lang="en-US">Sin (Number As Double) As Double</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150870" localize="false" role="paragraph">Double</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145786" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Numeric expression that defines the angle in radians that you want to calculate the sine for.</paragraph> +<paragraph id="par_id3155413" role="paragraph" xml-lang="en-US">To convert degrees to radians, multiply degrees by <literal>Pi</literal>/180, and to convert radians to degrees, multiply radians by 180/<literal>Pi</literal>.</paragraph> +<paragraph id="par_id3149664" role="paragraph" xml-lang="en-US">degrees=(radians*180)/<literal>Pi</literal></paragraph> +<paragraph id="par_id3153143" role="paragraph" xml-lang="en-US">radians=(degrees*<literal>Pi</literal>)/180</paragraph> +<paragraph id="par_id3151112" role="paragraph" xml-lang="en-US"><literal>Pi</literal> is approximately 3.141593.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id3149482" role="bascode" xml-lang="en-US">' In this example, the following entry is possible for a right-angled triangle:</paragraph> +<paragraph id="par_id3148577" role="bascode" xml-lang="en-US">' The side opposite the angle and the angle (in degrees) to calculate the length of the hypotenuse:</paragraph> +<paragraph id="par_idm1341562464" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSine</paragraph> +<paragraph id="par_id3150011" role="bascode" xml-lang="en-US">' Pi = 3.1415926 is a predefined variable</paragraph> +<paragraph id="par_idm1341559440" role="bascode" localize="false" xml-lang="en-US">Dim d1 As Double</paragraph> +<paragraph id="par_idm1341558208" role="bascode" localize="false" xml-lang="en-US">Dim dAlpha As Double</paragraph> +<paragraph id="par_id3145251" role="bascode" xml-lang="en-US"> d1 = InputBox("Enter the length of the opposite side: ","Opposite Side")</paragraph> +<paragraph id="par_id3148456" role="bascode" xml-lang="en-US"> dAlpha = InputBox("Enter the angle Alpha (in degrees): ","Alpha")</paragraph> +<paragraph id="par_id3153877" role="bascode" xml-lang="en-US"> Print "The length of the hypotenuse is"; (d1 / sin (dAlpha * Pi / 180))</paragraph> +<paragraph id="par_idm1341551616" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03080101.xhp#Atn_h1"/> + <embed href="text/sbasic/shared/03080102.xhp#Cos_h1"/> + <embed href="text/sbasic/shared/03080104.xhp#Tan_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080104.xhp b/helpcontent2/source/text/sbasic/shared/03080104.xhp new file mode 100644 index 000000000..aa1978567 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080104.xhp @@ -0,0 +1,81 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080104xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Tan Function</title> + <filename>/text/sbasic/shared/03080104.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="tan"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148550"> + <bookmark_value>Tan function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3148550"><variable id="Tan_h1"><link href="text/sbasic/shared/03080104.xhp" name="Tan Function">Tan Function</link></variable></h1> +<paragraph id="par_id3148663" role="paragraph" xml-lang="en-US">Determines the tangent of an angle. The angle is specified in radians.<comment>i71396</comment></paragraph> +</section> +<paragraph id="par_id3153379" role="paragraph" xml-lang="en-US">Using the angle Alpha, the <literal>Tan</literal> function calculates the ratio of the length of the side opposite the angle to the length of the side adjacent to the angle in a right-angled triangle.</paragraph> +<paragraph id="par_id3154366" role="paragraph" xml-lang="en-US"><literal>Tan</literal>(Alpha) = side opposite the angle/side adjacent to angle</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3151042" role="bascode" xml-lang="en-US">Tan (Number As Double) As Double</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3156281" localize="false" role="paragraph">Double</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145786" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that you want to calculate the tangent for (in radians).</paragraph> +<paragraph id="par_id3153728" role="paragraph" xml-lang="en-US">To convert degrees to radians, multiply by <literal>Pi</literal>/180. To convert radians to degrees, multiply by 180/<literal>Pi</literal>.</paragraph> +<paragraph id="par_id3155414" role="paragraph" xml-lang="en-US">degrees=(radians*180)/<literal>Pi</literal></paragraph> +<paragraph id="par_id3146975" role="paragraph" xml-lang="en-US">radians=(degrees*<literal>Pi</literal>)/180</paragraph> +<paragraph id="par_id3147434" role="paragraph" xml-lang="en-US"><literal>Pi</literal> is approximately 3.141593.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id3148646" role="bascode" xml-lang="en-US">' In this example, the following entry is possible for a right-angled triangle:</paragraph> +<paragraph id="par_id3150012" role="bascode" xml-lang="en-US">' The side opposite the angle and the angle (in degrees) to calculate the length of the side adjacent to the angle:</paragraph> +<paragraph id="par_idm1340786736" role="bascode" localize="false" xml-lang="en-US">Sub ExampleTangens</paragraph> +<paragraph id="par_id3153158" role="bascode" xml-lang="en-US">' Pi = 3.1415926 is a pre-defined variable</paragraph> +<paragraph id="par_idm1340783712" role="bascode" localize="false" xml-lang="en-US">Dim d1 As Double</paragraph> +<paragraph id="par_idm1340782480" role="bascode" localize="false" xml-lang="en-US">Dim dAlpha As Double</paragraph> +<paragraph id="par_id3145252" role="bascode" xml-lang="en-US"> d1 = InputBox("Enter the length of the side opposite the angle: ","opposite")</paragraph> +<paragraph id="par_id3149582" role="bascode" xml-lang="en-US"> dAlpha = InputBox("Enter the Alpha angle (in degrees): ","Alpha")</paragraph> +<paragraph id="par_id3154016" role="bascode" xml-lang="en-US"> Print "the length of the side adjacent the angle is"; (d1 / tan (dAlpha * Pi / 180))</paragraph> +<paragraph id="par_idm1340775872" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03080101.xhp#Atn_h1"/> + <embed href="text/sbasic/shared/03080102.xhp#Cos_h1"/> + <embed href="text/sbasic/shared/03080103.xhp#Sin_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080200.xhp b/helpcontent2/source/text/sbasic/shared/03080200.xhp new file mode 100644 index 000000000..66b019353 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080200.xhp @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080200xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Exponential and Logarithmic Functions</title> +<filename>/text/sbasic/shared/03080200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="loga"> + <paragraph id="hd_id3154758" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080200.xhp" name="Exponential and Logarithmic Functions">Exponential and Logarithmic Functions</link></paragraph> + <paragraph role="paragraph" id="par_id3148550" xml-lang="en-US">$[officename] Basic supports the following exponential and logarithmic functions.</paragraph> + </section> + <embed href="text/sbasic/shared/03080201.xhp#exp"/> + <embed href="text/sbasic/shared/03080202.xhp#log"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080201.xhp b/helpcontent2/source/text/sbasic/shared/03080201.xhp new file mode 100644 index 000000000..bf450847e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080201.xhp @@ -0,0 +1,64 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080201xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Exp Function</title> + <filename>/text/sbasic/shared/03080201.xhp</filename> + </topic> +</meta> + +<body> + +<section id="exp"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150616"> + <bookmark_value>Exp function</bookmark_value> +</bookmark> + +<paragraph id="hd_id3150616" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080201.xhp" name="Exp Function">Exp Function</link></paragraph> +<paragraph id="par_id3155555" role="paragraph" xml-lang="en-US">Returns the base of the natural logarithm (e = 2.718282) raised to a power.</paragraph> +</section> + +<paragraph id="hd_id3150984" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3145315" role="bascode" xml-lang="en-US">Exp (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3154347" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3149670" localize="false" role="paragraph">Double</paragraph> + +<paragraph id="hd_id3154760" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3150793" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that specifies the power that you want to raise "e" to (the base of natural logarithms). The power must be for both single-precision numbers less than or equal to 88.02969 and double-precision numbers less than or equal to 709.782712893, since $[officename] Basic returns an Overflow error for numbers exceeding these values.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3156280" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1206717456" role="bascode" localize="false" xml-lang="en-US">Sub ExampleLogExp</paragraph> +<paragraph id="par_idm1206716352" role="bascode" localize="false" xml-lang="en-US">Dim dValue As Double</paragraph> +<paragraph id="par_idm1206715248" role="bascode" localize="false" xml-lang="en-US"> Const b1=12.345e12</paragraph> +<paragraph id="par_id3159254" role="bascode" localize="false" xml-lang="en-US">Const b2=1.345e34</paragraph> +<paragraph id="par_idm1206712560" role="bascode" localize="false" xml-lang="en-US"> dValue=Exp( Log(b1)+Log(b2) )</paragraph> +<paragraph id="par_id3161832" role="bascode" xml-lang="en-US"> MsgBox "" & dValue & chr(13) & (b1*b2) ,0,"Multiplication by logarithm"</paragraph> +<paragraph id="par_idm1206709680" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080202.xhp b/helpcontent2/source/text/sbasic/shared/03080202.xhp new file mode 100644 index 000000000..b1a312563 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080202.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080202xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Log Function</title> + <filename>/text/sbasic/shared/03080202.xhp</filename> + </topic> +</meta> + +<body> + +<section id="log"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149416"> + <bookmark_value>Log function</bookmark_value> +</bookmark> + +<h1 id="hd_id3149416"><link href="text/sbasic/shared/03080202.xhp" name="Log Function">Log Function (BASIC)</link></h1> +<paragraph id="par_id3145066" role="paragraph" xml-lang="en-US">Returns the natural logarithm of a number.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3154760" role="bascode" xml-lang="en-US">Log (Number)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150791" localize="false" role="paragraph">Double</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3151041" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that you want to calculate the natural logarithm for.</paragraph> +<paragraph id="par_id3150869" role="paragraph" xml-lang="en-US">The natural logarithm is the logarithm to the base e. Base e is a constant with an approximate value of 2.718282...</paragraph> +<paragraph id="par_id3153968" role="paragraph" xml-lang="en-US">You can calculate logarithms to any base (n) for any number (x) by dividing the natural logarithm of x by the natural logarithm of n, as follows:</paragraph> +<paragraph id="par_id3145420" role="paragraph" xml-lang="en-US">Log<sub>n</sub>(x) = Log(x) / Log(n)</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341571344" role="bascode" localize="false" xml-lang="en-US">Sub ExampleLogExp</paragraph> +<paragraph id="par_idm1341570112" role="bascode" localize="false" xml-lang="en-US">Dim a As Double</paragraph> +<paragraph id="par_idm1341568880" role="bascode" localize="false" xml-lang="en-US">Dim Const b1=12.345e12</paragraph> +<paragraph id="par_idm1341567648" role="bascode" localize="false" xml-lang="en-US">Dim Const b2=1.345e34</paragraph> +<paragraph id="par_idm1341566416" role="bascode" localize="false" xml-lang="en-US"> a=Exp( Log(b1)+Log(b2) )</paragraph> +<paragraph id="par_id3149262" role="bascode" xml-lang="en-US"> MsgBox "" & a & chr(13) & (b1*b2) ,0,"Multiplication by logarithm function"</paragraph> +<paragraph id="par_idm1341563312" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080300.xhp b/helpcontent2/source/text/sbasic/shared/03080300.xhp new file mode 100644 index 000000000..e0cad76a8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080300.xhp @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080300xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Generating Random Numbers</title> +<filename>/text/sbasic/shared/03080300.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="random"> + <paragraph id="hd_id3143270" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080300.xhp" name="Generating Random Numbers">Generating Random Numbers</link></paragraph> + <paragraph role="paragraph" id="par_id3154347" xml-lang="en-US">The following statements and functions generate random numbers.</paragraph> + </section> + <embed href="text/sbasic/shared/03080301.xhp#randomize"/> + <embed href="text/sbasic/shared/03080302.xhp#rnd"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080301.xhp b/helpcontent2/source/text/sbasic/shared/03080301.xhp new file mode 100644 index 000000000..c846b1501 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080301.xhp @@ -0,0 +1,74 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080301xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Randomize Statement</title> + <filename>/text/sbasic/shared/03080301.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="randomize"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150616"> + <bookmark_value>Randomize statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150616" role="heading" level="1" xml-lang="en-US"><variable id="heading_randomize"><link href="text/sbasic/shared/03080301.xhp" name="Randomize Statement">Randomize Statement</link></variable></paragraph> +<paragraph id="par_id3145090" role="paragraph" xml-lang="en-US">Initializes the random-number generator used by the <emph>Rnd</emph> function.</paragraph> +</section> + +<paragraph id="hd_id3147573" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3145315" role="bascode" xml-lang="en-US">Randomize [Number]</paragraph> +</bascode> +<paragraph id="hd_id3152456" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3149670" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any integer value. Used as seed to initialize the random-number generator. Equal seeds result in equal random-number sequences by the <emph>Rnd</emph> function. If the parameter is omitted, the <emph>Randomize</emph> statement will be ignored.</paragraph> +<paragraph id="par_id110520161656428611" role="note" xml-lang="en-US">Unless a predictable sequence of numbers is desired, there is no need to use the <emph>Randomize</emph> statement, as the random-number generator will be initialized automatically at first use – it will be seeded using a system-provided random-number generator that produces uniformly-distributed, non-deterministic random numbers. If no such generator is available on the system, the system time will be used as seed.</paragraph> +<paragraph id="par_id12052016194258344" role="paragraph" xml-lang="en-US">The <emph>Randomize</emph> statement affects BASIC's <emph>Rnd</emph> function only. Other random-number generators (for example the Calc's RAND() function, etc.) are not affected by it.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3149655" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340800064" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRandomize</paragraph> +<paragraph id="par_idm1340798832" role="bascode" localize="false" xml-lang="en-US">Dim iCount As Integer, iVar As Integer, sText As String</paragraph> +<paragraph id="par_idm1340797584" role="bascode" localize="false" xml-lang="en-US">Dim iSpectral(10) As Integer</paragraph> +<paragraph id="par_idm1340796336" role="bascode" localize="false" xml-lang="en-US"> Randomize 2^14-1</paragraph> +<paragraph id="par_idm1340795104" role="bascode" localize="false" xml-lang="en-US"> For iCount = 1 To 1000</paragraph> +<paragraph id="par_id3147288" role="bascode" xml-lang="en-US"> iVar = Int(10 * Rnd) ' Range from 0 to 9</paragraph> +<paragraph id="par_idm1340792112" role="bascode" localize="false" xml-lang="en-US"> iSpectral(iVar) = iSpectral(iVar) +1</paragraph> +<paragraph id="par_idm1340790848" role="bascode" localize="false" xml-lang="en-US"> Next iCount</paragraph> +<paragraph id="par_idm1341621328" role="bascode" localize="false" xml-lang="en-US"> sText = " | "</paragraph> +<paragraph id="par_idm1341620096" role="bascode" localize="false" xml-lang="en-US"> For iCount = 0 To 9</paragraph> +<paragraph id="par_idm1341618864" role="bascode" localize="false" xml-lang="en-US"> sText = sText & iSpectral(iCount) & " | "</paragraph> +<paragraph id="par_idm1341617536" role="bascode" localize="false" xml-lang="en-US"> Next iCount</paragraph> +<paragraph id="par_id3148617" role="bascode" xml-lang="en-US"> MsgBox sText,0,"Spectral Distribution"</paragraph> +<paragraph id="par_idm1341614560" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> +<paragraph id="par_id110520162207025898" role="paragraph" localize="false" xml-lang="en-US"><embedvar href="text/sbasic/shared/03080302.xhp#heading_rnd"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080302.xhp b/helpcontent2/source/text/sbasic/shared/03080302.xhp new file mode 100644 index 000000000..109723caf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080302.xhp @@ -0,0 +1,76 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080302xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Rnd Function</title> + <filename>/text/sbasic/shared/03080302.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="rnd"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148685"> + <bookmark_value>Rnd function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3148685" role="heading" level="1" xml-lang="en-US"><variable id="heading_rnd"><link href="text/sbasic/shared/03080302.xhp" name="Rnd Function">Rnd Function</link></variable></paragraph> +<paragraph id="par_id3149669" role="paragraph" xml-lang="en-US">Returns a random number between 0 and 1.</paragraph> +</section> + +<paragraph id="hd_id3153897" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150543" role="bascode" xml-lang="en-US">Rnd [(Expression)]</paragraph> +</bascode> +<paragraph id="hd_id3149655" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154365" localize="false" role="paragraph">Double</paragraph> + +<paragraph id="hd_id3154909" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3125864" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Has no effect, is ignored if provided.</paragraph> +<paragraph id="par_id3147318" role="paragraph" xml-lang="en-US">The <emph>Rnd</emph> function returns decimal fractions ranging from 0 (included) to 1 (excluded) according to a uniform distribution. It uses the Mersenne Twister 19937 random-number generator. To generate random integers in a given range, use a formula like in the example below. A <emph>Randomize</emph> statement with a defined seed value can be used beforehand, if a predictable sequence of numbers is desired.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3151118" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341382704" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRandomSelect</paragraph> +<paragraph id="par_idm1341381472" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Integer</paragraph> +<paragraph id="par_idm1341380240" role="bascode" localize="false" xml-lang="en-US"> iVar = Int((15 * Rnd) -2)</paragraph> +<paragraph id="par_idm1341378992" role="bascode" localize="false" xml-lang="en-US"> Select Case iVar</paragraph> +<paragraph id="par_idm1341377760" role="bascode" localize="false" xml-lang="en-US"> Case 1 To 5</paragraph> +<paragraph id="par_id3147124" role="bascode" xml-lang="en-US"> Print "Number from 1 to 5"</paragraph> +<paragraph id="par_idm1341374800" role="bascode" localize="false" xml-lang="en-US"> Case 6, 7, 8</paragraph> +<paragraph id="par_id3154943" role="bascode" xml-lang="en-US"> Print "Number from 6 to 8"</paragraph> +<paragraph id="par_idm1341371792" role="bascode" localize="false" xml-lang="en-US"> Case Is > 8 And iVar < 11</paragraph> +<paragraph id="par_id3151074" role="bascode" xml-lang="en-US"> Print "Greater than 8"</paragraph> +<paragraph id="par_idm1341368768" role="bascode" localize="false" xml-lang="en-US"> Case Else</paragraph> +<paragraph id="par_id3155602" role="bascode" xml-lang="en-US"> Print "Outside range 1 to 10"</paragraph> +<paragraph id="par_idm1341365792" role="bascode" localize="false" xml-lang="en-US"> End Select</paragraph> +<paragraph id="par_idm1341364560" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> +<paragraph id="par_id110520162210036951" role="paragraph" localize="false" xml-lang="en-US"><embedvar href="text/sbasic/shared/03080301.xhp#heading_randomize"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080400.xhp b/helpcontent2/source/text/sbasic/shared/03080400.xhp new file mode 100644 index 000000000..b1c3eb18a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080400.xhp @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080400xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Square Root Calculation</title> +<filename>/text/sbasic/shared/03080400.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="square"> + <paragraph id="hd_id3148946" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080400.xhp" name="Square Root Calculation">Square Root Calculation</link></paragraph> + <paragraph role="paragraph" id="par_id3159414" xml-lang="en-US">Use this function to calculate square roots.</paragraph> + </section> + <embed href="text/sbasic/shared/03080401.xhp#sqr"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080401.xhp b/helpcontent2/source/text/sbasic/shared/03080401.xhp new file mode 100644 index 000000000..35a3c55e4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080401.xhp @@ -0,0 +1,65 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080401xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Sqr Function</title> + <filename>/text/sbasic/shared/03080401.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="sqr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"> + <bookmark_value>Sqr function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156027" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080401.xhp" name="Sqr Function">Sqr Function</link></paragraph> +<paragraph id="par_id3147226" role="paragraph" xml-lang="en-US">Calculates the square root of a numeric expression.</paragraph> +</section> + +<paragraph id="hd_id3143267" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3149415" role="bascode" xml-lang="en-US">Sqr (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3156023" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156343" localize="false" role="paragraph">Double</paragraph> + +<paragraph id="hd_id3147265" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that you want to calculate the square root for.</paragraph> +<paragraph id="par_id3154365" role="paragraph" xml-lang="en-US">A square root is the number that you multiply by itself to produce another number, for example, the square root of 36 is 6.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3153192" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341602560" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSqr</paragraph> +<paragraph id="par_idm1341601328" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Single</paragraph> +<paragraph id="par_idm1341600096" role="bascode" localize="false" xml-lang="en-US"> iVar = 36</paragraph> +<paragraph id="par_idm1341598864" role="bascode" localize="false" xml-lang="en-US"> MsgBox Sqr(iVar)</paragraph> +<paragraph id="par_idm1341597632" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080500.xhp b/helpcontent2/source/text/sbasic/shared/03080500.xhp new file mode 100644 index 000000000..2a8754efa --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080500.xhp @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080500xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Integers</title> +<filename>/text/sbasic/shared/03080500.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="integer"> + <paragraph id="hd_id3153345" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080500.xhp" name="Integers">Integers and Fractional</link></paragraph> + <paragraph role="paragraph" id="par_id3156152" xml-lang="en-US">Functions to round values to integers, and to take the fractional part of a value.</paragraph> + </section> + <embed href="text/sbasic/shared/03080501.xhp#fix"/> + <embed href="text/sbasic/shared/03080502.xhp#int"/> + <embed href="text/sbasic/shared/03080503.xhp#frac"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080501.xhp b/helpcontent2/source/text/sbasic/shared/03080501.xhp new file mode 100644 index 000000000..0cc5f18e0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080501.xhp @@ -0,0 +1,64 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080501xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Fix Function</title> + <filename>/text/sbasic/shared/03080501.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="fix"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3159201"> + <bookmark_value>Fix function</bookmark_value> +</bookmark> +<paragraph id="hd_id3159201" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080501.xhp" name="Fix Function">Fix Function</link></paragraph> +<paragraph id="par_id3149346" role="paragraph" xml-lang="en-US">Returns the integer value of a numeric expression by removing the fractional part of the number.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3156152" role="code" xml-lang="en-US">Fix (Expression)</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3148947" localize="false" role="paragraph">Double</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Numeric expression that you want to return the integer value for.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341085216" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFix</paragraph> +<paragraph id="par_id3156214" role="bascode" xml-lang="en-US"> Print Fix(3.14159) ' returns 3.</paragraph> +<paragraph id="par_id3154217" role="bascode" xml-lang="en-US"> Print Fix(0) ' returns 0.</paragraph> +<paragraph id="par_id3145786" role="bascode" xml-lang="en-US"> Print Fix(-3.14159) ' returns -3.</paragraph> +<paragraph id="par_idm1341078800" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id391546195157714"><link href="text/sbasic/shared/03080502.xhp" name="Int Function">Int Function</link></paragraph> + <paragraph role="paragraph" id="par_id51546195168056"><link href="text/sbasic/shared/03080503.xhp" name="Frac Function">Frac Function</link></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080502.xhp b/helpcontent2/source/text/sbasic/shared/03080502.xhp new file mode 100644 index 000000000..b695125ad --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080502.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080502xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Int Function</title> + <filename>/text/sbasic/shared/03080502.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="int"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153345"> + <bookmark_value>Int function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3153345" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080502.xhp" name="Int Function">Int Function</link></paragraph> +<paragraph id="par_id3155420" role="paragraph" xml-lang="en-US">Returns the integer portion of a number.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3146795" role="code" xml-lang="en-US">Int (Number)</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150400" localize="false" role="paragraph">Double</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3148797" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any valid numeric expression.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340837808" role="bascode" localize="false" xml-lang="en-US">Sub ExampleInt</paragraph> +<paragraph id="par_id3125864" role="bascode" xml-lang="en-US"> Print Int(3.99) ' returns the value 3</paragraph> +<paragraph id="par_id3145787" role="bascode" xml-lang="en-US"> Print Int(0) ' returns the value 0</paragraph> +<paragraph id="par_id3153143" role="bascode" xml-lang="en-US"> Print Int(-3.14159) ' returns the value -4</paragraph> +<paragraph id="par_idm1340831360" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id461546195246946"><link href="text/sbasic/shared/03080501.xhp" name="Fix Function">Fix Function</link></paragraph> + <paragraph role="paragraph" id="par_id51546195168056"><link href="text/sbasic/shared/03080503.xhp" name="Frac Function">Frac Function</link></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080503.xhp b/helpcontent2/source/text/sbasic/shared/03080503.xhp new file mode 100644 index 000000000..64e7fc9a0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080503.xhp @@ -0,0 +1,47 @@ +<?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="textsbasicshared03080503xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Frac Function</title> + <filename>/text/sbasic/shared/03080503.xhp</filename> + </topic> + </meta> + <body> + <section id="frac"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3153345"> + <bookmark_value>Frac function</bookmark_value> + </bookmark> + <h1 id="hd_id3153345"><link href="text/sbasic/shared/03080503.xhp" name="Frac Function">Frac Function</link></h1> + <paragraph id="par_id3155420" role="paragraph">Returns the fractional portion of a number.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph id="par_id3146795" role="code">Frac (Number)</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3150400" role="paragraph">Double</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id3148797" role="paragraph"> <emph>Number:</emph> Any valid numeric expression.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_idm1340837808" role="bascode" localize="false">Sub ExampleFrac</paragraph> + <paragraph id="par_id3125864" role="bascode"> Print Frac(3.99) ' returns the value 0.99</paragraph> + <paragraph id="par_id3145787" role="bascode"> Print Frac(0) ' returns the value 0</paragraph> + <paragraph id="par_id3153143" role="bascode"> Print Frac(-3.14159) ' returns the value -0.14159</paragraph> + <paragraph id="par_idm1340831360" role="bascode" localize="false">End Sub</paragraph> + </bascode> + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id461546195246946"><link href="text/sbasic/shared/03080501.xhp" name="Fix Function">Fix Function</link></paragraph> + <paragraph role="paragraph" id="par_id391546195157714"><link href="text/sbasic/shared/03080502.xhp" name="Int Function">Int Function</link></paragraph> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080600.xhp b/helpcontent2/source/text/sbasic/shared/03080600.xhp new file mode 100644 index 000000000..ec743146f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080600.xhp @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080600xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Absolute Values</title> +<filename>/text/sbasic/shared/03080600.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="absolute"> + <paragraph id="hd_id3146958" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080600.xhp" name="Absolute Values">Absolute Values</link></paragraph> + <paragraph role="paragraph" id="par_id3150771" xml-lang="en-US">This function returns absolute values.</paragraph> + </section> + <embed href="text/sbasic/shared/03080601.xhp#abs"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080601.xhp b/helpcontent2/source/text/sbasic/shared/03080601.xhp new file mode 100644 index 000000000..777db56b0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080601.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080601xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Abs Function</title> + <filename>/text/sbasic/shared/03080601.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="abs"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3159201"> + <bookmark_value>Abs function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3159201" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080601.xhp" name="Abs Function">Abs Function</link></paragraph> +<paragraph id="par_id3153394" role="paragraph" xml-lang="en-US">Returns the absolute value of a numeric expression.</paragraph> +</section> + +<paragraph id="hd_id3149233" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147573" role="bascode" xml-lang="en-US">Abs (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3156152" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3149670" localize="false" role="paragraph">Double</paragraph> + +<paragraph id="hd_id3154924" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154347" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that you want to return the absolute value for. Positive numbers, including 0, are returned unchanged, whereas negative numbers are converted to positive numbers.</paragraph> +<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US">The following example uses the Abs function to calculate the difference between two values. It does not matter which value you enter first.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3148451" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341574768" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDifference</paragraph> +<paragraph id="par_idm1341573536" role="bascode" localize="false" xml-lang="en-US">Dim siW1 As Single</paragraph> +<paragraph id="par_idm1341572304" role="bascode" localize="false" xml-lang="en-US">Dim siW2 As Single</paragraph> +<paragraph id="par_id3145786" role="bascode" xml-lang="en-US"> siW1 = Int(InputBox("Please enter the first amount","Value Input"))</paragraph> +<paragraph id="par_id3149561" role="bascode" xml-lang="en-US"> siW2 = Int(InputBox("Please enter the second amount","Value Input"))</paragraph> +<paragraph id="par_id3145750" role="bascode" xml-lang="en-US"> Print "The difference is "; Abs(siW1 - siW2)</paragraph> +<paragraph id="par_idm1341565744" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080700.xhp b/helpcontent2/source/text/sbasic/shared/03080700.xhp new file mode 100644 index 000000000..d578e1cdf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080700.xhp @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080700xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Expression Signs</title> +<filename>/text/sbasic/shared/03080700.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="sign"> + <paragraph id="hd_id3150702" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080700.xhp" name="Expression Signs">Expression Signs</link></paragraph> + <paragraph role="paragraph" id="par_id3148668" xml-lang="en-US">This function returns the algebraic sign of a numeric expression.</paragraph> + </section> + <embed href="text/sbasic/shared/03080701.xhp#sgn"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080701.xhp b/helpcontent2/source/text/sbasic/shared/03080701.xhp new file mode 100644 index 000000000..e90641510 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080701.xhp @@ -0,0 +1,100 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080701xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Sgn Function</title> + <filename>/text/sbasic/shared/03080701.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="sgn"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148474"> + <bookmark_value>Sgn function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3148474" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080701.xhp" name="Sgn Function">Sgn Function</link></paragraph> +<paragraph id="par_id3148686" role="paragraph" xml-lang="en-US">Returns an integer number between -1 and 1 that indicates if the number that is passed to the function is positive, negative, or zero.</paragraph> +</section> + +<paragraph id="hd_id3156023" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153897" role="bascode" xml-lang="en-US">Sgn (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3145069" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3150359" localize="false" role="paragraph">Integer</paragraph> + +<paragraph id="hd_id3150543" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154365" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Numeric expression that determines the value that is returned by the function.</paragraph> + +<table id="tbl_id3156281"> + <tablerow> + <tablecell> + <paragraph id="par_id3150767" role="paragraph" xml-lang="en-US">Number</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3150441" role="paragraph" xml-lang="en-US">Return value</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3161833" role="paragraph" xml-lang="en-US">negative</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155306" role="paragraph" xml-lang="en-US">Sgn returns -1.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3145271" role="paragraph" localize="false" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3146119" role="paragraph" xml-lang="en-US">Sgn returns 0.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3153139" role="paragraph" xml-lang="en-US">positive</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154319" role="paragraph" xml-lang="en-US">Sgn returns 1.</paragraph> + </tablecell> + </tablerow> +</table> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3152576" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340806400" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSgn</paragraph> +<paragraph id="par_id3155416" role="bascode" xml-lang="en-US"> Print sgn(-10) ' returns -1</paragraph> +<paragraph id="par_id3154096" role="bascode" xml-lang="en-US"> Print sgn(0) ' returns 0</paragraph> +<paragraph id="par_id3148457" role="bascode" xml-lang="en-US"> Print sgn(10) ' returns 1</paragraph> +<paragraph id="par_idm1340799936" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080800.xhp b/helpcontent2/source/text/sbasic/shared/03080800.xhp new file mode 100644 index 000000000..f340a1310 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080800.xhp @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03080800xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Converting Numbers</title> +<filename>/text/sbasic/shared/03080800.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="converting"> + <paragraph id="hd_id3145315" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080800.xhp" name="Converting Numbers">Converting Numbers</link></paragraph> + <paragraph role="paragraph" id="par_id3154760" xml-lang="en-US">The following functions convert numbers from one number format to another.</paragraph> + </section> + <embed href="text/sbasic/shared/03080801.xhp#hex"/> + <embed href="text/sbasic/shared/03080802.xhp#oct"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03080801.xhp b/helpcontent2/source/text/sbasic/shared/03080801.xhp new file mode 100644 index 000000000..82d5bb968 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080801.xhp @@ -0,0 +1,78 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080801xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Hex Function</title> + <filename>/text/sbasic/shared/03080801.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="hex"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150616"> + <bookmark_value>Hex function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150616" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080801.xhp" name="Hex Function">Hex Function</link></paragraph> +<paragraph id="par_id3145136" role="paragraph" xml-lang="en-US">Returns a string that represents the hexadecimal value of a number.</paragraph> +</section> + +<paragraph id="hd_id3147573" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150771" role="bascode" xml-lang="en-US">Hex (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3147530" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3156344" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3148947" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that you want to convert to a hexadecimal number.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3154365" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340898144" role="bascode" localize="false" xml-lang="en-US">Sub ExampleHex</paragraph> +<paragraph id="par_id3156214" role="bascode" xml-lang="en-US">' uses BasicFormulas in %PRODUCTNAME Calc</paragraph> +<paragraph id="par_idm1340895168" role="bascode" localize="false" xml-lang="en-US">Dim a2, b2, c2 As String</paragraph> +<paragraph id="par_idm1340893920" role="bascode" localize="false" xml-lang="en-US"> a2 = "&H3E8"</paragraph> +<paragraph id="par_idm1340892688" role="bascode" localize="false" xml-lang="en-US"> b2 = Hex2Lng(a2)</paragraph> +<paragraph id="par_idm1340891456" role="bascode" localize="false" xml-lang="en-US"> MsgBox b2</paragraph> +<paragraph id="par_idm1340890224" role="bascode" localize="false" xml-lang="en-US"> c2 = Lng2Hex(b2)</paragraph> +<paragraph id="par_idm1340888992" role="bascode" localize="false" xml-lang="en-US"> MsgBox c2</paragraph> +<paragraph id="par_idm1340887760" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1340886528" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1340885280" role="bascode" localize="false" xml-lang="en-US">Function Hex2Lng(sHex As String) As Long</paragraph> +<paragraph id="par_id3149262" role="bascode" xml-lang="en-US">' Returns a 32-bit signed integer number from an 8-digit hexadecimal value.</paragraph> +<paragraph id="par_idm1340882272" role="bascode" localize="false" xml-lang="en-US"> Hex2Lng = clng( sHex )</paragraph> +<paragraph id="par_idm1340881024" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +<paragraph id="par_idm1340879792" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1340878592" role="bascode" localize="false" xml-lang="en-US">Function Lng2Hex(iLong As Long) As String</paragraph> +<paragraph id="par_id3147215" role="bascode" xml-lang="en-US">' Calculates the 8-digit hexadecimal value out of a 32-bit signed integer number.</paragraph> +<paragraph id="par_idm1340875584" role="bascode" localize="false" xml-lang="en-US"> Lng2Hex = "&H" & Hex( iLong )</paragraph> +<paragraph id="par_idm1340874336" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03080802.xhp b/helpcontent2/source/text/sbasic/shared/03080802.xhp new file mode 100644 index 000000000..14910c900 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03080802.xhp @@ -0,0 +1,62 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03080802xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Oct Function</title> + <filename>/text/sbasic/shared/03080802.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="oct"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155420"> + <bookmark_value>Oct function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3155420" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03080802.xhp" name="Oct Function">Oct Function</link></paragraph> +<paragraph id="par_id3154924" role="paragraph" xml-lang="en-US">Returns the octal value of a number.</paragraph> +</section> + +<paragraph id="hd_id3148947" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150543" role="bascode" xml-lang="en-US">Oct (Number)</paragraph> +</bascode> + +<paragraph id="hd_id3153360" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154138" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3156422" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3150768" role="paragraph" xml-lang="en-US"> <emph>Number:</emph> Any numeric expression that you want to convert to an octal value.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3148672" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340708272" role="bascode" localize="false" xml-lang="en-US">Sub ExampleOct</paragraph> +<paragraph id="par_idm1340707040" role="bascode" localize="false" xml-lang="en-US"> MsgBox Oct(255)</paragraph> +<paragraph id="par_idm1340705808" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090000.xhp b/helpcontent2/source/text/sbasic/shared/03090000.xhp new file mode 100644 index 000000000..d632a2a8e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090000.xhp @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Controlling Program Execution</title> +<filename>/text/sbasic/shared/03090000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="prog_execution"> + <paragraph id="hd_id3145136" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090000.xhp" name="Controlling Program Execution">Controlling Program Execution</link></paragraph> + <paragraph role="paragraph" id="par_id3143268" xml-lang="en-US">The following statements control the execution of a program.</paragraph> + </section> + <paragraph role="paragraph" id="par_id3156152" xml-lang="en-US">A program generally executes from the first line of code to the last line of code. You can also execute certain procedures within the program according to specific conditions, or repeat a section of the program within a sub-procedure or function. You can use loops to repeat parts of a program as many times as necessary, or until a certain condition is met. These type of control statements are classified as Condition, Loop, or Jump statements.</paragraph> + <embed href="text/sbasic/shared/03090100.xhp#conditions"/> + <embed href="text/sbasic/shared/03090200.xhp#loops"/> + <embed href="text/sbasic/shared/03090300.xhp#jumps"/> + <embed href="text/sbasic/shared/03090400.xhp#further_statements"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090100.xhp b/helpcontent2/source/text/sbasic/shared/03090100.xhp new file mode 100644 index 000000000..e34cf1f1f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090100.xhp @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090100xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Condition Statements</title> +<filename>/text/sbasic/shared/03090100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="conditions"> + <paragraph id="hd_id3154422" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090100.xhp" name="Condition Statements">Condition Statements</link></paragraph> + <paragraph role="paragraph" id="par_id3153750" xml-lang="en-US">The following statements are based on conditions.</paragraph> + </section> + <embed href="text/sbasic/shared/03090101.xhp#ifthenelse"/> + <embed href="text/sbasic/shared/03090102.xhp#selectcase"/> + <embed href="text/sbasic/shared/03090103.xhp#iif"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090101.xhp b/helpcontent2/source/text/sbasic/shared/03090101.xhp new file mode 100644 index 000000000..bd9875630 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090101.xhp @@ -0,0 +1,98 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090101xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">If...Then...Else Statement</title> + <filename>/text/sbasic/shared/03090101.xhp</filename> + </topic> +</meta> + +<body> + +<section id="ifthenelse"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154422"> + <bookmark_value>If statement</bookmark_value> + <bookmark_value>ElseIf; If statement</bookmark_value> + <bookmark_value>Else If;If statement</bookmark_value> + <bookmark_value>Else;If statement</bookmark_value> + <bookmark_value>Else;If statement</bookmark_value> + <bookmark_value>End If;If statement</bookmark_value> + <bookmark_value>EndIf;If statement</bookmark_value> +</bookmark> + +<h1 id="hd_id81592320644826"><link href="text/sbasic/shared/03090101.xhp" name="If...Then...Else Statement">If...Then...Else Statement</link></h1> +<paragraph id="par_id3155555" role="paragraph" xml-lang="en-US">Defines one or more statement blocks that you only want to execute if a given condition or expression is <literal>True</literal>.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="image" id="par_id311592320434736"><image src="media/helpimg/sbasic/If_statement.svg" id="img_id601592320434736"><alt id="alt_id551592320434736">If...EndIf statement</alt></image></paragraph> +<paragraph role="image" id="par_id591592320435808"><image src="media/helpimg/sbasic/ElseIf_fragment.svg" id="img_id691592320435808"><alt id="alt_id341592320435808">ElseIf fragment</alt></image></paragraph> +<paragraph role="image" id="par_id221592320436632"><image src="media/helpimg/sbasic/Else_fragment.svg" id="img_id81592320436632"><alt id="alt_id391592320436632">Else fragment</alt></image></paragraph> + +<bascode> + <paragraph id="par_id3153126" role="bascode" localize="false">If condition Then </paragraph> + <paragraph role="bascode" id="bas_id801592319803093" localize="false"> statements</paragraph> + <paragraph role="bascode" id="bas_id561592319637952" localize="false">[{ElseIf|Else If} expression Then</paragraph> + <paragraph role="bascode" id="bas_id31592419640235" localize="false"> statements]</paragraph> + <paragraph role="bascode" id="bas_id561692319637952" localize="false">[Else </paragraph> + <paragraph role="bascode" id="bas_id31592319640235" localize="false"> statements]</paragraph> + <paragraph role="bascode" id="bas_id861592319641899" localize="false">{EndIf|End If}</paragraph> +</bascode> + <paragraph id="par_id3123476" role="paragraph" xml-lang="en-US">Instead of <emph>Else If</emph> you can write <emph>ElseIf</emph>, instead of <emph>End If</emph> you can write <emph>EndIf</emph>.</paragraph> + <tip id="par_id631592322239043"><emph>If</emph> statements can be shortened to one line when using single statement blocks.</tip> +<bascode> + <paragraph role="bascode" id="bas_id771592321093694" localize="false">If condition Then statement [Else statement]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id3153062" role="paragraph" xml-lang="en-US">The <emph>If...Then</emph> statement executes program blocks depending on given conditions. When %PRODUCTNAME Basic encounters an <emph>If</emph> statement, the condition is tested. If the condition is <literal>True</literal>, all subsequent statements up to the next <emph>Else</emph> or <emph>ElseIf</emph> statement are executed. If the condition is <literal>False</literal>, and an <emph>ElseIf</emph> statement follows, %PRODUCTNAME Basic tests the next expression and executes the following statements if the condition is <literal>True</literal>. If <literal>False</literal>, the program continues either with the next <emph>ElseIf</emph> or <emph>Else</emph> statement. Statements following <emph>Else</emph> are executed only if none of the previously tested conditions were <literal>True</literal>. After all conditions are evaluated, and the corresponding statements executed, the program continues with the statement following <emph>EndIf</emph>.</paragraph> +<paragraph id="par_id3153192" role="paragraph" xml-lang="en-US">You can nest multiple <emph>If...Then</emph> statements.</paragraph> +<paragraph id="par_id3154684" role="paragraph" xml-lang="en-US"> <emph>Else</emph> and <emph>ElseIf</emph> statements are optional.</paragraph> +<paragraph id="par_id3152939" role="warning" xml-lang="en-US">You can use <emph>GoTo</emph> and <emph>GoSub</emph> to jump out of an <emph>If...Then</emph> block, but not to jump into an <emph>If...Then</emph> structure.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<paragraph id="par_id3153951" role="paragraph" xml-lang="en-US">The following example enables you to enter the expiration date of a product, and determines if the expiration date has passed.</paragraph> +<bascode> +<paragraph id="par_idm1341422592" role="bascode" localize="false">Sub ExampleIfThenDate</paragraph> +<paragraph id="par_idm1341421360" role="bascode" localize="false"> Dim sDate As String</paragraph> +<paragraph id="par_idm1341420128" role="bascode" localize="false"> Dim sToday As String</paragraph> +<paragraph id="par_id3154490" role="bascode" xml-lang="en-US"> sDate = InputBox("Enter the expiration date (MM.DD.YYYY)")</paragraph> +<paragraph id="par_idm1341417136" role="bascode" localize="false"> sDate = Right$(sDate, 4) + Mid$(sDate, 4, 2) + Left$(sDate, 2)</paragraph> +<paragraph id="par_idm1341415856" role="bascode" localize="false"> sToday = Date$</paragraph> +<paragraph id="par_idm1341414624" role="bascode" localize="false"> sToday = Right$(sToday, 4)+ Mid$(sToday, 4, 2) + Left$(sToday, 2)</paragraph> +<paragraph id="par_idm1341413344" role="bascode" localize="false"> If sDate < sToday Then</paragraph> +<paragraph id="par_id3155601" role="bascode" xml-lang="en-US"> MsgBox "The expiration date has passed"</paragraph> +<paragraph id="par_idm1341410352" role="bascode" localize="false"> ElseIf sDate > sToday Then</paragraph> +<paragraph id="par_id3146912" role="bascode" xml-lang="en-US"> MsgBox "The expiration date has not yet passed"</paragraph> +<paragraph id="par_idm1341407312" role="bascode" localize="false"> Else</paragraph> +<paragraph id="par_id3154754" role="bascode" xml-lang="en-US"> MsgBox "The expiration date is today"</paragraph> +<paragraph id="par_idm1341404336" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1341403104" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161588865796615"><link href="text/sbasic/shared/03090102.xhp" name="Select Case statement">Select Case</link> statement</paragraph> + <paragraph role="paragraph" id="par_id281588865818334"><link href="text/sbasic/shared/03090103.xhp" name="Iif function">Iif</link> or <link href="text/sbasic/shared/03090410.xhp" name="Switch function">Switch</link> functions</paragraph> +</section> + +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090102.xhp b/helpcontent2/source/text/sbasic/shared/03090102.xhp new file mode 100644 index 000000000..571abc33d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090102.xhp @@ -0,0 +1,85 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090102xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Select...Case Statement</title> + <filename>/text/sbasic/shared/03090102.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="selectcase"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149416"> + <bookmark_value>Select Case statement</bookmark_value> + <bookmark_value>Case keyword; in Select Case statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3149416" xml-lang="en-US"><variable id="Select_h1"><link href="text/sbasic/shared/03090102.xhp" name="Select...Case Statement">Select...Case Statement</link></variable></h1> +<paragraph id="par_id3153896" role="paragraph" xml-lang="en-US">Defines one or more statement blocks depending on the value of an expression.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="image" id="par_id841588605629842"><image src="media/helpimg/sbasic/Select-Case_statement.svg" id="img_id931588605629842"><alt id="alt_id931588605629842">Select Case syntax</alt></image></paragraph> +<bascode> + <paragraph role="bascode" id="bas_id251592381900645">Select Case expression</paragraph> + <paragraph role="bascode" id="bas_id321592381903509"> Case values</paragraph> + <paragraph role="bascode" id="bas_id231592381903973"> Statement Block</paragraph> + <paragraph role="bascode" id="bas_id361592381904372">[ Case values2</paragraph> + <paragraph role="bascode" id="bas_id421592382002520"> Statement Block]</paragraph> + <paragraph role="bascode" id="bas_id161592382004496">[ Case Else</paragraph> + <paragraph role="bascode" id="bas_id681592382005351"> Statement Block]</paragraph> + <paragraph role="bascode" id="bas_id831592381905293">End Select</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id3156281" role="paragraph" xml-lang="en-US"> <emph>expression:</emph> Any expression that controls if the statement block that follows the respective <literal>Case</literal> clause is executed.</paragraph> + <paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>values:</emph> Any value list that is compatible with the expression. The statement block that follows the <literal>Case</literal> clause is executed if <emph>expression</emph> matches <emph>values</emph>.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341173760" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRandomSelect</paragraph> +<paragraph id="par_idm1341172528" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Integer</paragraph> +<paragraph id="par_idm1341171296" role="bascode" localize="false" xml-lang="en-US"> iVar = Int((15 * Rnd) -2)</paragraph> +<paragraph id="par_idm1341170048" role="bascode" localize="false" xml-lang="en-US"> Select Case iVar</paragraph> +<paragraph id="par_idm1341168816" role="bascode" localize="false" xml-lang="en-US"> Case 1 To 5</paragraph> +<paragraph id="par_id3152597" role="bascode" xml-lang="en-US"> Print "Number from 1 to 5"</paragraph> +<paragraph id="par_idm1341165856" role="bascode" localize="false" xml-lang="en-US"> Case 6, 7, 8</paragraph> +<paragraph id="par_id3147349" role="bascode" xml-lang="en-US"> Print "Number from 6 to 8"</paragraph> +<paragraph id="par_idm1341162896" role="bascode" localize="false" xml-lang="en-US"> Case 8 To 10</paragraph> +<paragraph id="par_id3152886" role="bascode" xml-lang="en-US"> Print "Greater than 8"</paragraph> +<paragraph id="par_idm1340795200" role="bascode" localize="false" xml-lang="en-US"> Case Else</paragraph> +<paragraph id="par_id3146975" role="bascode" xml-lang="en-US"> Print "Out of range 1 to 10"</paragraph> +<paragraph id="par_idm1340792224" role="bascode" localize="false" xml-lang="en-US"> End Select</paragraph> +<paragraph id="par_idm1340790992" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03090402.xhp#Choose_h1"/> + <embed href="text/sbasic/shared/03090410.xhp#Switch_h1"/> + <paragraph role="paragraph" id="par_id161588865796615"><link href="text/sbasic/shared/03090101.xhp" name="If...Then...Else statement">If</link> statement</paragraph> + <paragraph role="paragraph" id="par_id281588865818334"><link href="text/sbasic/shared/03090103.xhp" name="Iif function">Iif</link> or <link href="text/sbasic/shared/03090410.xhp" name="Switch function">Switch</link> functions</paragraph> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090103.xhp b/helpcontent2/source/text/sbasic/shared/03090103.xhp new file mode 100644 index 000000000..07b6e453d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090103.xhp @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090103xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">IIf Function</title> +<filename>/text/sbasic/shared/03090103.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="iif"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155420"><bookmark_value>IIf function</bookmark_value> +</bookmark> +<h1 id="hd_id3155420"><link href="text/sbasic/shared/03090103.xhp" name="IIf Function">IIf Function</link></h1> +<paragraph role="paragraph" id="par_id3145610" xml-lang="en-US">Returns one of two possible function results, depending on the logical value of the evaluated expression.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_id3147560" xml-lang="en-US">IIf (Expression, ExpressionTrue, ExpressionFalse)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3153381" xml-lang="en-US"> +<emph>Expression:</emph> Any expression that you want to evaluate. If the expression evaluates to <emph>True</emph>, the function returns the result of ExpressionTrue, otherwise it returns the result of ExpressionFalse.</paragraph> +<paragraph role="paragraph" id="par_id3150870" xml-lang="en-US"> +<emph>ExpressionTrue, ExpressionFalse:</emph> Any expression, one of which will be returned as the function result, depending on the logical evaluation.</paragraph> +<note id="par_id541598638231139">IIf evaluates both <literal>ExpressionTrue</literal> and <literal>ExpressionFalse</literal> even if it returns only one of them. If one of the expressions results in error, the function returns the error. For example, do not use IIF to bypass a possible division by zero result.</note> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="par_id1001598638460925" xml-lang="en-US">REM Returns the maximum of 3 values</paragraph> +<paragraph role="bascode" id="par_id11598638500752" xml-lang="en-US" localize="false">Function Max (A As Double, B As Double, C, As Double) As Double</paragraph> +<paragraph role="bascode" id="par_id271598638528057" xml-lang="en-US" localize="false"> Max = IIf( A >= B, A, B)</paragraph> +<paragraph role="bascode" id="par_id281598638539101" xml-lang="en-US" localize="false"> Max = IIf( C >= Max, C, Max)</paragraph> +<paragraph role="bascode" id="par_id521598638553550" xml-lang="en-US" localize="false">End Function</paragraph> +<paragraph role="bascode" id="par_id161598638840133" xml-lang="en-US">REM Bad usage of function IIf</paragraph> +<paragraph role="bascode" id="par_id571598638863628" xml-lang="en-US" localize="false">Function Inverse(A As Double) As Double</paragraph> +<paragraph role="bascode" id="par_id171598638875498" xml-lang="en-US" localize="false"> Inverse = IIf( A = 0, 0, 1/A )</paragraph> +<paragraph role="bascode" id="par_id451598638883642" xml-lang="en-US" localize="false">End Function</paragraph> +</bascode> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161588865796615"><link href="text/sbasic/shared/03090101.xhp" name="If...Then...Else statement">If</link> or <link href="text/sbasic/shared/03090102.xhp" name="Select Case statement">Select Case</link> statements</paragraph> + <paragraph role="paragraph" id="par_id281588865818334"><link href="text/sbasic/shared/03090410.xhp" name="Switch function">Switch</link> function</paragraph> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090200.xhp b/helpcontent2/source/text/sbasic/shared/03090200.xhp new file mode 100644 index 000000000..41c8aaedf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090200.xhp @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090200xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Loops</title> +<filename>/text/sbasic/shared/03090200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="loops"> + <paragraph id="hd_id3153990" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090200.xhp" name="Loops">Loops</link></paragraph> + <paragraph role="paragraph" id="par_id3147226" xml-lang="en-US">The following statements execute loops.</paragraph> + </section> + <embed href="text/sbasic/shared/03090201.xhp#doloop"/> + <embed href="text/sbasic/shared/03090202.xhp#fornext"/> + <embed href="text/sbasic/shared/03090203.xhp#whilewend"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090201.xhp b/helpcontent2/source/text/sbasic/shared/03090201.xhp new file mode 100644 index 000000000..696ffeecd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090201.xhp @@ -0,0 +1,102 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090201xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Do...Loop Statement</title> + <filename>/text/sbasic/shared/03090201.xhp</filename> + </topic> +</meta> + +<body> + +<section id="doloop"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156116"> + <bookmark_value>Do...Loop statement</bookmark_value> + <bookmark_value>While; Do loop</bookmark_value> + <bookmark_value>Until</bookmark_value> + <bookmark_value>loops</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156116" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090201.xhp" name="Do...Loop Statement">Do...Loop Statement</link></paragraph> + <paragraph id="par_id3109850" role="paragraph" xml-lang="en-US">Repeats the statements between the <emph>Do</emph> and the <emph>Loop</emph> statement while the condition is <literal>True</literal> or until the condition becomes <literal>True</literal>.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="image" id="par_id311592320434736"><image src="media/helpimg/sbasic/Do_statement.svg" id="img_id601592320434736"><alt id="alt_id551592320434736">Do statement</alt></image></paragraph> +<bascode> + <paragraph role="bascode" id="bas_id431592385468901" localize="false">Do {While | Until} condition = True</paragraph> + <paragraph role="bascode" id="bas_id171592386317704" xml-lang="en-US">' Do While: The statement block is repeated as long as the condition is true</paragraph> + <paragraph role="bascode" id="bas_id11592386319239" xml-lang="en-US">' Do Until: The statement block is repeated as long as the condition is false</paragraph> + <paragraph role="bascode" id="bas_id131592385470352" localize="false"> statements</paragraph> + <paragraph role="bascode" id="bas_id581592385470803" localize="false"> [Exit Do]</paragraph> + <paragraph role="bascode" id="bas_id461592385471261" localize="false"> statements</paragraph> + <paragraph role="bascode" id="bas_id831592385471675" localize="false">Loop</paragraph> +</bascode> + +<paragraph role="image" id="par_id591592320435808"><image src="media/helpimg/sbasic/Do-Loop_statement.svg" id="img_id691592320435808"><alt id="alt_id341592320435808">Do...Loop statement</alt></image></paragraph> +<bascode> + <paragraph role="bascode" id="bas_id441592385468901" localize="false">Do</paragraph> + <paragraph role="bascode" id="bas_id141592385470352" localize="false"> statements</paragraph> + <paragraph role="bascode" id="bas_id541592385470803" localize="false"> [Exit Do]</paragraph> + <paragraph role="bascode" id="bas_id441592385471261" localize="false"> statements</paragraph> + <paragraph role="bascode" id="bas_id911592386676044" xml-lang="en-US">' Loop While: The statement block repeats as long as the condition is true</paragraph> + <paragraph role="bascode" id="bas_id971592386677004" xml-lang="en-US">' Loop Until: The statement block repeats until the condition is true</paragraph> + <paragraph role="bascode" id="bas_id841592385471675" localize="false">Loop {While | Until} condition = True</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150791" role="paragraph" xml-lang="en-US">The <emph>Do...Loop</emph> statement executes a loop as long as, or until, a certain condition is <literal>True</literal>. The condition for exiting the loop must be entered following either the <emph>Do</emph> or the <emph>Loop</emph> statement. The above examples are valid combinations.</paragraph> +<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US"> <emph>condition:</emph> A comparison, numeric or Basic expression, that evaluates to either <literal>True</literal> or <literal>False</literal>.</paragraph> +<paragraph id="par_id3149669" role="paragraph" xml-lang="en-US"> <emph>statements:</emph> Statements that you want to repeat while or until a condition is <literal>True</literal>.</paragraph> + +<paragraph id="par_id3149484" role="paragraph" xml-lang="en-US">Use the <emph>Exit Do</emph> statement to unconditionally end the loop. You can add this statement anywhere in a <emph>Do</emph>...<emph>Loop</emph> statement. You can also define an exit condition using the <emph>If...Then</emph> structure as follows:</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id831592387131224" localize="false">Do...</paragraph> + <paragraph role="bascode" id="bas_id621592387131776" localize="false"> statements</paragraph> + <paragraph role="bascode" id="bas_id721592387132161" localize="false"> If condition = True Then Exit Do</paragraph> + <paragraph role="bascode" id="bas_id141592387132344" localize="false"> statements</paragraph> + <paragraph role="bascode" id="bas_id91592387132592" localize="false">Loop...</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341080208" role="bascode" localize="false">Sub ExampleDoLoop</paragraph> +<paragraph id="par_idm1341078976" role="bascode" localize="false"> Dim sFile As String</paragraph> +<paragraph id="par_idm1341077744" role="bascode" localize="false"> Dim sPath As String</paragraph> +<paragraph id="par_idm1341076512" role="bascode" localize="false"> sPath = "c:\"</paragraph> +<paragraph id="par_idm1341075280" role="bascode" localize="false"> sFile = Dir$( sPath ,22)</paragraph> +<paragraph id="par_idm1341074032" role="bascode" localize="false"> If sFile <> "" Then</paragraph> +<paragraph id="par_idm1341072656" role="bascode" localize="false"> Do</paragraph> +<paragraph id="par_idm1341071456" role="bascode" localize="false"> MsgBox sFile</paragraph> +<paragraph id="par_idm1341070208" role="bascode" localize="false"> sFile = Dir$</paragraph> +<paragraph id="par_idm1341068960" role="bascode" localize="false"> Loop Until sFile = ""</paragraph> +<paragraph id="par_idm1341067712" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1341066480" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161588865796615"><link href="text/sbasic/shared/03090202.xhp" name="For statement">For</link>, <link href="text/sbasic/shared/03090102.xhp" name="Select Case statement">Select Case</link> or <link href="text/sbasic/shared/03090203.xhp" name="While statement">While</link> statements</paragraph> + <paragraph role="paragraph" id="par_id281588865818334"><link href="text/sbasic/shared/03090103.xhp" name="Iif function">Iif</link> or <link href="text/sbasic/shared/03090410.xhp" name="Switch function">Switch</link> functions</paragraph> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090202.xhp b/helpcontent2/source/text/sbasic/shared/03090202.xhp new file mode 100644 index 000000000..eee101283 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090202.xhp @@ -0,0 +1,123 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090202xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">For...Next Statement</title> + <filename>/text/sbasic/shared/03090202.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="fornext"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149205"> +<bookmark_value>For statement</bookmark_value> +<bookmark_value>For Each statement</bookmark_value> +<bookmark_value>In keyword</bookmark_value> +<bookmark_value>Next keyword</bookmark_value> +<bookmark_value>Step keyword</bookmark_value> +<bookmark_value>To keyword</bookmark_value> +</bookmark> + + +<h1 id="hd_id3149205" xml-lang="en-US"><link href="text/sbasic/shared/03090202.xhp" name="For...Next Statement">For...Next Statement</link></h1> + <paragraph id="par_id3143267" role="paragraph" xml-lang="en-US">Repeats the statements between the <literal>For...Next</literal> block a specified number of times.</paragraph> +</section> + +<h2 id="hd_id3156153" xml-lang="en-US">Syntax:</h2> +<paragraph role="paragraph" id="par_id491585753339474"> + <image src="media/helpimg/sbasic/For-Next_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">For Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3148473" role="bascode" localize="false">For counter=start To end [Step step]</paragraph> +<paragraph id="par_id3156024" role="bascode" xml-lang="en-US"> statement-block</paragraph> +<paragraph id="par_id3146796" role="bascode" localize="false"> [Exit For]</paragraph> +<paragraph id="par_id3159414" role="bascode" xml-lang="en-US"> statement-block</paragraph> +<paragraph id="par_id3153897" role="bascode" localize="false">Next [counter]</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id491585653339474"> + <image src="media/helpimg/sbasic/For-Each_statement.svg" id="img_id4156297484514"><alt xml-lang="en-US" id="alt_id15152797484514">For Each Statement diagram</alt></image> +</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id331586521232310" localize="false">For Each item In list</paragraph> + <paragraph role="bascode" id="bas_id821586521234861" xml-lang="en-US"> statement-block</paragraph> + <paragraph role="bascode" id="bas_id991586521235339" localize="false">[Exit For]</paragraph> + <paragraph role="bascode" id="bas_id501586521235517" xml-lang="en-US"> statement-block</paragraph> + <paragraph role="bascode" id="bas_id941586521235718" localize="false">Next [item]</paragraph> +</bascode> + +<h2 id="hd_id3150400" xml-lang="en-US">Variables:</h2> +<paragraph id="par_id3150358" role="paragraph" xml-lang="en-US"> <emph>counter:</emph> Loop <literal>counter</literal> initially assigned the value to the right of the equal sign (<literal>start</literal>). Only numeric variables are valid. The loop counter increases or decreases according to the variable <literal>step</literal> until <literal>end</literal> is passed.</paragraph> +<paragraph id="par_id3152455" role="paragraph" xml-lang="en-US"> <emph>start:</emph> Numeric variable that defines the initial value at the beginning of the loop.</paragraph> +<paragraph id="par_id3151043" role="paragraph" xml-lang="en-US"> <emph>end:</emph> Numeric variable that defines the final value at the end of the loop.</paragraph> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US"> <emph>step:</emph> Sets the value by which to increase or decrease the loop counter. If <literal>step</literal> is not specified, the loop counter is incremented by 1. In this case, <literal>end</literal> must be greater than <literal>start</literal>. If you want to decrease <literal>counter</literal>, <literal>end</literal> must be less than <literal>start</literal>, and <literal>step</literal> must be assigned a negative value.</paragraph> +<paragraph id="par_id3154684" role="paragraph" xml-lang="en-US">The <emph>For...Next</emph> loop repeats all of the statements in the loop for the number of times that is specified by the parameters.</paragraph> +<paragraph id="par_id3147287" role="paragraph" xml-lang="en-US">As the <literal>counter</literal> variable is decreased, %PRODUCTNAME Basic checks if the <literal>end</literal> value has been reached. As soon as the <literal>counter</literal> passes the <literal>end</literal> value, the loop automatically terminates.</paragraph> +<paragraph id="par_id3159154" role="paragraph" xml-lang="en-US">It is possible to nest <emph>For...Next</emph> statements. If you do not specify a variable following the <emph>Next</emph> statement, <emph>Next</emph> automatically refers to the most recent <emph>For</emph> statement.</paragraph> +<paragraph id="par_id3155306" role="paragraph" xml-lang="en-US">If you specify an increment of 0, the statements between <emph>For</emph> and <emph>Next</emph> are repeated continuously.</paragraph> +<paragraph id="par_id3155854" role="paragraph" xml-lang="en-US">When counting down the counter variable, %PRODUCTNAME Basic checks for overflow or underflow. The loop ends when <literal>counter</literal> exceeds <literal>end</literal> (positive Step value) or is less than <literal>end</literal> (negative Step value).</paragraph> +<paragraph id="par_id3145273" role="paragraph" xml-lang="en-US">Use the <emph>Exit For</emph> statement to exit the loop unconditionally. This statement must be within a <emph>For...Next</emph> loop. Use the <emph>If...Then</emph> statement to test the exit condition as follows:</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id631586522581351" localize="false">For...</paragraph> + <paragraph role="bascode" id="bas_id621586522583437" xml-lang="en-US"> statement-block</paragraph> + <paragraph role="bascode" id="bas_id571586522583814" localize="false"> If condition = True Then Exit For</paragraph> + <paragraph role="bascode" id="bas_id711586522584013" xml-lang="en-US"> statement-block</paragraph> + <paragraph role="bascode" id="bas_id831586522584527" localize="false">Next</paragraph> +</bascode> + +<note id="par_id3156286" xml-lang="en-US">In nested <emph>For...Next</emph> loops, if you exit a loop unconditionally with <emph>Exit For</emph>, only one loop is exited.</note> + +<h2 id="hd_id3148457" xml-lang="en-US">Examples</h2> +<paragraph id="par_id3151074" role="paragraph" xml-lang="en-US">The following example uses two nested loops to sort a string array with 10 elements ( sEntry() ), that is filled with various contents:</paragraph> +<bascode> +<paragraph id="par_idm1341539088" role="bascode" localize="false">Sub ExampleSort</paragraph> +<paragraph id="par_idm1340517312" role="bascode" localize="false">Dim sEntry(9) As String</paragraph> +<paragraph id="par_idm1340516080" role="bascode" localize="false">Dim iCount As Integer, iCount2 As Integer</paragraph> +<paragraph id="par_idm1340513616" role="bascode" localize="false">Dim sTemp As String</paragraph> +<paragraph id="par_id31557349267" role="bascode" localize="false"> sEntry = Array("Jerry","Patty","Kurt","Thomas","Michael",_</paragraph> +<paragraph id="par_id49231539711" role="bascode" localize="false"> "David","Cathy","Susie","Edward","Christine")</paragraph> +<paragraph id="par_idm1340495152" role="bascode" localize="false"> For iCount = 0 To 9</paragraph> +<paragraph id="par_idm1340493920" role="bascode" localize="false"> For iCount2 = iCount + 1 To 9</paragraph> +<paragraph id="par_idm1340492672" role="bascode" localize="false"> If sEntry(iCount) > sEntry(iCount2) Then</paragraph> +<paragraph id="par_idm1340491296" role="bascode" localize="false"> sTemp = sEntry(iCount)</paragraph> +<paragraph id="par_idm1340490096" role="bascode" localize="false"> sEntry(iCount) = sEntry(iCount2)</paragraph> +<paragraph id="par_idm1340488832" role="bascode" localize="false"> sEntry(iCount2) = sTemp</paragraph> +<paragraph id="par_idm1340487584" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1340486352" role="bascode" localize="false"> Next iCount2</paragraph> +<paragraph id="par_idm1340485120" role="bascode" localize="false"> Next iCount</paragraph> +<paragraph id="par_idm1340483888" role="bascode" localize="false"> For iCount = 0 To 9</paragraph> +<paragraph id="par_idm1340482656" role="bascode" localize="false"> Print sEntry(iCount)</paragraph> +<paragraph id="par_idm1340481408" role="bascode" localize="false"> Next iCount</paragraph> +<paragraph id="par_idm1340480176" role="bascode" localize="false">End Sub</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id561586524231943">This explores the content of an array to display each item it contains.</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id511586523090639">Sub list_iteration</paragraph> + <paragraph role="bascode" id="bas_id391586523091799"> cutlery = Array("fork", "knife", "spoon")</paragraph> + <paragraph role="bascode" id="bas_id811586523092655"> For Each item in cutlery</paragraph> + <paragraph role="bascode" id="bas_id271586523092911"> Print item</paragraph> + <paragraph role="bascode" id="bas_id941586523093415"> Next ' item</paragraph> + <paragraph role="bascode" id="bas_id301586523093607">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090203.xhp b/helpcontent2/source/text/sbasic/shared/03090203.xhp new file mode 100644 index 000000000..dad29dca3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090203.xhp @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090203xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">While...Wend Statement</title> +<filename>/text/sbasic/shared/03090203.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + <section id="whilewend"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150400"> + <bookmark_value>While;While...Wend loop</bookmark_value> + <bookmark_value>While;While Wend loop</bookmark_value> + </bookmark> + <paragraph id="hd_id3150400" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090203.xhp" name="While...Wend Statement">While...Wend Statement</link></paragraph> + <paragraph xml-lang="en-US" role="paragraph" id="par_id3151211">When a program encounters a <literal>While</literal> statement, it tests the condition. If the condition is <literal>False</literal>, the program continues directly following the <literal>Wend</literal> statement. If the condition is <literal>True</literal>, the loop is executed until the program finds <literal>Wend</literal> and then jumps back to the <emph>While</emph> statement. If the condition is still <literal>True</literal>, the loop is executed again.</paragraph> + </section> + <paragraph xml-lang="en-US" id="par_id3151041" role="paragraph">Unlike the <link href="text/sbasic/shared/03090201.xhp" name="Do...Loop">Do...Loop</link> statement, you cannot cancel a <emph>While...Wend</emph> loop with <link href="text/sbasic/shared/03090412.xhp" name="Exit">Exit</link>. Never exit a <literal>While...Wend</literal> loop with <link href="text/sbasic/shared/03090302.xhp" name="GoTo">GoTo</link>, since this can cause a run-time error.</paragraph> + <paragraph role="paragraph" id="par_id3145172" xml-lang="en-US">A <literal>Do...Loop</literal> is more flexible than a <literal>While...Wend.</literal></paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="image" id="par_id831588865616326"> + <image src="media/helpimg/sbasic/While_statement.svg" id="img_id651588865616326"><alt id="alt_id281588865616326">While syntax</alt></image> + </paragraph> +<bascode> + <paragraph role="bascode" id="par_id3147288" localize="false">While Condition [statements] Wend</paragraph> +</bascode> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" id="par_id3159153" localize="false">Sub ExampleWhileWend</paragraph> + <paragraph role="bascode" id="par_id3151114" localize="false"> Dim stext As String</paragraph> + <paragraph role="bascode" id="par_id3153143" localize="false"> Dim iRun As Integer</paragraph> + <paragraph role="bascode" id="par_id3155306" xml-lang="en-US"> sText ="This is a short text"</paragraph> + <paragraph role="bascode" id="par_id3154011" localize="false"> iRun = 1</paragraph> + <paragraph role="bascode" id="par_id3147215" localize="false"> While iRun < Len(sText)</paragraph> + <paragraph role="bascode" id="par_id3147427" localize="false"> If Mid(sText,iRun,1 )<> " " Then Mid( sText ,iRun, 1) = Chr( 1 + Asc( Mid(sText,iRun,1 )) )</paragraph> + <paragraph role="bascode" id="par_id3149665" localize="false"> iRun = iRun + 1</paragraph> + <paragraph role="bascode" id="par_id3152939" localize="false"> Wend</paragraph> + <paragraph role="bascode" id="par_id3153189" xml-lang="en-US"> MsgBox sText,0,"Text encoded"</paragraph> + <paragraph role="bascode" localize="false" id="par_id3145251">End Sub</paragraph> +</bascode> + + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161588865796615"><link href="text/sbasic/shared/03090201.xhp" name="Do...Loop statement">Do...Until</link> or <link href="text/sbasic/shared/03090201.xhp" name="Do...While statement">Do...While</link> statement</paragraph> + <paragraph role="paragraph" id="par_id281588865818334"><link href="text/sbasic/shared/03090412.xhp" name="Exit statement">Exit</link> statement</paragraph> + </section> + + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090300.xhp b/helpcontent2/source/text/sbasic/shared/03090300.xhp new file mode 100644 index 000000000..c4e2a5e62 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090300.xhp @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090300xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Jumps</title> +<filename>/text/sbasic/shared/03090300.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="jumps"> + <paragraph id="hd_id3151262" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090300.xhp" name="Jumps">Jumps</link></paragraph> + <paragraph role="paragraph" id="par_id3148983" xml-lang="en-US">The following statements execute jumps.</paragraph> + </section> + <embed href="text/sbasic/shared/03090301.xhp#gosubreturn"/> + <embed href="text/sbasic/shared/03090302.xhp#goto"/> + <embed href="text/sbasic/shared/03090303.xhp#ongosub"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090301.xhp b/helpcontent2/source/text/sbasic/shared/03090301.xhp new file mode 100644 index 000000000..b2331842b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090301.xhp @@ -0,0 +1,91 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090301xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">GoSub...Return Statement</title> + <filename>/text/sbasic/shared/03090301.xhp</filename> + </topic> +</meta> + +<body> + +<section id="gosubreturn"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147242"> + <bookmark_value>GoSub...Return statement</bookmark_value> + <bookmark_value>label; in GoSub...Return statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3147242" xml-lang="en-US"><variable id="GoSubh1"><link href="text/sbasic/shared/03090301.xhp" name="GoSub...Return Statement">GoSub...Return Statement</link></variable></h1> + <paragraph id="par_id3145316" role="paragraph" xml-lang="en-US">Calls a subroutine that is indicated by a label inside a <literal>Sub</literal> or a <literal>Function</literal>. The statements following the label are executed until the next <literal>Return</literal> statement. Afterwards, the program continues with the statement that follows the <literal>GoSub</literal> statement.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3145069" role="bascode" xml-lang="en-US">GoSub label[:]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id471588670859073"><emph>label: </emph>A line identifier indicating where to continue execution. The scope of a label in that of the routine it belongs to.</paragraph> +<paragraph id="par_id3147318" role="paragraph" xml-lang="en-US">The <literal>GoSub</literal> statement calls a local subroutine indicated by a label from within a subroutine or a function. The name of the label must end with a colon (":").</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id171588670446922" localize="false">Sub/Function foo</paragraph> + <paragraph role="bascode" id="bas_id411588670455217" xml-lang="en-US"> ' statements</paragraph> + <paragraph role="bascode" id="bas_id315886704565218" localize="false"> GoSub label</paragraph> + <paragraph role="bascode" id="bas_id421588670457589" xml-lang="en-US"> ' statements </paragraph> + <paragraph role="bascode" id="bas_id551588670457866" localize="false"> Exit Sub/Function</paragraph> + <paragraph role="bascode" id="bas_id721588670458055" localize="false">label:</paragraph> + <paragraph role="bascode" id="bas_id171588670458263" xml-lang="en-US"> ' statements </paragraph> + <paragraph role="bascode" id="bas_id881588670473041" localize="false"> Return</paragraph> + <paragraph role="bascode" id="bas_id661588670476240" localize="false">End Sub/Function</paragraph> +</bascode> + +<paragraph id="par_id3153190" role="warning" xml-lang="en-US">If the program encounters a Return statement not preceded by <emph>GoSub</emph>, $[officename] Basic returns an error message. Use <emph>Exit Sub</emph> or <emph>Exit Function</emph> to ensure that the program leaves a Sub or Function before reaching the next Return statement.</paragraph> +<paragraph id="par_id3145799" role="paragraph" xml-lang="en-US">The following example demonstrates the use of <emph>GoSub</emph> and <emph>Return</emph>. By executing a program section twice, the program calculates the square root of two numbers that are entered by the user.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341591488" role="bascode" localize="false" xml-lang="en-US">Sub ExampleGoSub</paragraph> +<paragraph id="par_idm1341590256" role="bascode" localize="false" xml-lang="en-US">Dim iInputa As Single</paragraph> +<paragraph id="par_idm1341589024" role="bascode" localize="false" xml-lang="en-US">Dim iInputb As Single</paragraph> +<paragraph id="par_idm1341587792" role="bascode" localize="false" xml-lang="en-US">Dim iInputc As Single</paragraph> +<paragraph id="par_id3146970" role="bascode" xml-lang="en-US"> iInputa = Int(InputBox("Enter the first number: ","NumberInput"))</paragraph> +<paragraph id="par_id3150329" role="bascode" xml-lang="en-US"> iInputb = Int(InputBox("Enter the second number: ","NumberInput"))</paragraph> +<paragraph id="par_idm1341583040" role="bascode" localize="false" xml-lang="en-US"> iInputc=iInputa</paragraph> +<paragraph id="par_idm1341581808" role="bascode" localize="false" xml-lang="en-US"> GoSub SquareRoot</paragraph> +<paragraph id="par_id3154756" role="bascode" xml-lang="en-US"> Print "The square root of";iInputa;" is";iInputc</paragraph> +<paragraph id="par_idm1341578832" role="bascode" localize="false" xml-lang="en-US"> iInputc=iInputb</paragraph> +<paragraph id="par_idm1341577600" role="bascode" localize="false" xml-lang="en-US"> GoSub SquareRoot</paragraph> +<paragraph id="par_id3147340" role="bascode" xml-lang="en-US"> Print "The square root of";iInputb;" is";iInputc</paragraph> +<paragraph id="par_idm1341574624" role="bascode" localize="false" xml-lang="en-US"> Exit Sub</paragraph> +<paragraph id="par_idm1341573392" role="bascode" localize="false" xml-lang="en-US">SquareRoot:</paragraph> +<paragraph id="par_idm1341572160" role="bascode" localize="false" xml-lang="en-US"> iInputc=sqr(iInputc)</paragraph> +<paragraph id="par_idm1341570912" role="bascode" localize="false" xml-lang="en-US"> Return</paragraph> +<paragraph id="par_idm1341569680" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03090302.xhp#GoToh1"/> + <embed href="text/sbasic/shared/03090303.xhp#OnGoSubGoToh1"/> +</section> + +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090302.xhp b/helpcontent2/source/text/sbasic/shared/03090302.xhp new file mode 100644 index 000000000..4f9cd57f5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090302.xhp @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> + +<meta> + <topic id="textsbasicshared03090302xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">GoTo Statement</title> + <filename>/text/sbasic/shared/03090302.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> +</meta> + +<body> +<section id="goto"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3159413"> + <bookmark_value>GoTo statement</bookmark_value> + <bookmark_value>label; in GoTo statement</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3159413" xml-lang="en-US" level="1"><variable id="GoToh1"><link href="text/sbasic/shared/03090302.xhp" name="GoTo Statement">GoTo Statement</link></variable></paragraph> + <paragraph role="paragraph" id="par_id3153379" xml-lang="en-US">Continues program execution within a <literal>Sub</literal> or <literal>Function</literal> at the procedure line indicated by a label.</paragraph> +</section> +<paragraph role="heading" id="hd_id3149656" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="bas_id211588675705501" localize="false">GoTo label[:]</paragraph> +</bascode> + +<paragraph role="heading" id="hd_id3150870" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id471588670859073"><emph>label: </emph>A line identifier indicating where to continue execution. The scope of a label is that of the routine it belongs to.</paragraph> + <paragraph role="paragraph" id="par_id3152596" xml-lang="en-US">Use the <literal>GoTo</literal> statement to instruct $[officename] Basic to continue program execution at another place within the procedure. The position must be indicated by a label. To set a label, assign a name, and end it with a colon (":").</paragraph> + <paragraph role="warning" id="par_id3155416" xml-lang="en-US">You cannot use the <literal>GoTo</literal> statement to jump out of a <literal>Sub</literal> or <literal>Function</literal>.</paragraph> +<paragraph role="heading" id="hd_id3154731" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> + <paragraph role="bascode" id="par_id3156214" localize="false">Sub/Function</paragraph> + <paragraph role="bascode" id="par_id3156424" xml-lang="en-US"> ' statement block</paragraph> + <paragraph role="bascode" id="par_id3154685" localize="false"> GoTo Label1</paragraph> + <paragraph role="bascode" id="par_id3145786" localize="false">Label2:</paragraph> + <paragraph role="bascode" id="par_id3161832" xml-lang="en-US"> ' statement block</paragraph> + <paragraph role="bascode" id="par_id3146120" localize="false"> Exit Sub/Function</paragraph> + <paragraph role="bascode" id="par_id3150010" localize="false">Label1:</paragraph> + <paragraph role="bascode" id="par_id3152462" xml-lang="en-US"> ' statement block</paragraph> + <paragraph role="bascode" id="par_id3149664" localize="false"> GoTo Label2</paragraph> + <paragraph role="bascode" localize="false" id="par_id3152886" xml-lang="en-US">End Sub/Function</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03090301.xhp#GoSubh1"/> + <embed href="text/sbasic/shared/03090303.xhp#OnGoSubGoToh1"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090303.xhp b/helpcontent2/source/text/sbasic/shared/03090303.xhp new file mode 100644 index 000000000..cad7a574f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090303.xhp @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> +<helpdocument version="1.0"> + +<meta> + <topic id="textsbasicshared03090303xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">On...GoSub Statement; On...GoTo Statement</title> + <filename>/text/sbasic/shared/03090303.xhp</filename> + </topic> +</meta> + +<body> + +<section id="ongosub"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153897"> + <bookmark_value>On...GoSub statement</bookmark_value> + <bookmark_value>On...GoTo statement</bookmark_value> + <bookmark_value>label; in On...GoSub statement</bookmark_value> + <bookmark_value>label; in On...GoTo statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3153897" xml-lang="en-US"><variable id="OnGoSubGoToh1"><link href="text/sbasic/shared/03090303.xhp" name="On...GoSub Statement; On...GoTo Statement">On...GoSub Statement; On...GoTo Statement</link></variable></h1> +<paragraph id="par_id3150359" role="paragraph" xml-lang="en-US">Branches to one of several specified lines in the program code, depending on the value of a numeric expression.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="image" id="par_id841588605629842"><image src="media/helpimg/sbasic/On-GoSub-GoTo_statement.svg" id="img_id931588605629842"><alt id="alt_id931588605629842">On GoSub/GoTo syntax</alt></image></paragraph> +<bascode> +<paragraph id="par_id3154366" role="bascode" xml-lang="en-US">On expression GoSub Label1[, Label2[, Label3[,...]]]</paragraph> +<paragraph id="par_id3150769" role="bascode" xml-lang="en-US">On expression GoTo Label1[, Label2[, Label3[,...]]]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3148673" role="paragraph" xml-lang="en-US"> <emph>expression:</emph> Any numeric expression between 0 and 255 that determines which of the lines the program branches to. If <emph>expression</emph> is 0, the statement is not executed. If <emph>expression</emph> is greater than 0, the program jumps to the label that has a position number that corresponds to the expression (1 = First label; 2 = Second label)</paragraph> +<paragraph id="par_id3153194" role="paragraph" xml-lang="en-US"> <emph>label:</emph> Target line according to<emph> GoTo </emph>or <emph>GoSub</emph> structure.</paragraph> +<paragraph id="par_id3156442" role="note" xml-lang="en-US">The <emph>GoTo</emph> or <emph>GoSub </emph>conventions are valid.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341610144" role="bascode" localize="false" xml-lang="en-US">Sub ExampleOnGosub</paragraph> +<paragraph id="par_idm1341608912" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Integer</paragraph> +<paragraph id="par_idm1341607680" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1341606448" role="bascode" localize="false" xml-lang="en-US"> iVar = 2</paragraph> +<paragraph id="par_idm1341605216" role="bascode" localize="false" xml-lang="en-US"> sVar =""</paragraph> +<paragraph id="par_idm1341603984" role="bascode" localize="false" xml-lang="en-US"> On iVar GoSub Sub1, Sub2</paragraph> +<paragraph id="par_idm1341602736" role="bascode" localize="false" xml-lang="en-US"> On iVar GoTo Line1, Line2</paragraph> +<paragraph id="par_idm1341601488" role="bascode" localize="false" xml-lang="en-US"> Exit Sub</paragraph> +<paragraph id="par_idm1341600256" role="bascode" localize="false" xml-lang="en-US">Sub1:</paragraph> +<paragraph id="par_id3153948" role="bascode" xml-lang="en-US"> sVar =sVar & " From Sub 1 to" : Return</paragraph> +<paragraph id="par_idm1341597216" role="bascode" localize="false" xml-lang="en-US">Sub2:</paragraph> +<paragraph id="par_id3153708" role="bascode" xml-lang="en-US"> sVar =sVar & " From Sub 2 to" : Return</paragraph> +<paragraph id="par_idm1341594128" role="bascode" localize="false" xml-lang="en-US">Line1:</paragraph> +<paragraph id="par_id3150321" role="bascode" xml-lang="en-US"> sVar =sVar & " Label 1" : GoTo Ende</paragraph> +<paragraph id="par_idm1341591088" role="bascode" localize="false" xml-lang="en-US">Line2:</paragraph> +<paragraph id="par_id3155764" role="bascode" xml-lang="en-US"> sVar =sVar & " Label 2"</paragraph> +<paragraph id="par_idm1341588128" role="bascode" localize="false" xml-lang="en-US">Ende:</paragraph> +<paragraph id="par_idm1341586896" role="bascode" localize="false" xml-lang="en-US"> MsgBox sVar,0,"On...GoSub"</paragraph> +<paragraph id="par_idm1341585648" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03090301.xhp#GoSubh1"/> + <embed href="text/sbasic/shared/03090302.xhp#GoToh1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090400.xhp b/helpcontent2/source/text/sbasic/shared/03090400.xhp new file mode 100644 index 000000000..91ea068ef --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090400.xhp @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090400xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Further Statements</title> +<filename>/text/sbasic/shared/03090400.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + <section id="further_statements"> + <paragraph id="hd_id3145316" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090400.xhp" name="Further Statements">Further Statements</link></paragraph> + <paragraph role="paragraph" id="par_id3154923" xml-lang="en-US">Statements that do not belong to any of the other categories are described here.</paragraph> + </section> + <embed href="text/sbasic/shared/03090401.xhp#call"/> + <embed href="text/sbasic/shared/03090402.xhp#choose"/> + <embed href="text/sbasic/shared/03090403.xhp#declare"/> + <embed href="text/sbasic/shared/03090404.xhp#end"/> + <embed href="text/sbasic/shared/03090412.xhp#exit"/> + <embed href="text/sbasic/shared/03090405.xhp#freelibrary"/> + <embed href="text/sbasic/shared/03090406.xhp#function"/> + <embed href="text/sbasic/shared/03090407.xhp#rem"/> + <embed href="text/sbasic/shared/03090408.xhp#stop"/> + <embed href="text/sbasic/shared/03090409.xhp#sub"/> + <embed href="text/sbasic/shared/03090410.xhp#switch"/> + <embed href="text/sbasic/shared/03090411.xhp#with"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090401.xhp b/helpcontent2/source/text/sbasic/shared/03090401.xhp new file mode 100644 index 000000000..2737a682c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090401.xhp @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090401xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Call Statement</title> +<filename>/text/sbasic/shared/03090401.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="call"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154422"><bookmark_value>Call statement</bookmark_value> +</bookmark> +<h1 id="hd_id3154422"><variable id="Call_h1"><link href="text/sbasic/shared/03090401.xhp" name="Call Statement">Call Statement</link></variable></h1> +<paragraph role="paragraph" id="par_id3153394" xml-lang="en-US">Transfers the control of the program to a subroutine, a function, or a procedure of a <link href="text/sbasic/shared/03090403.xhp" name="Dynamic Link Library">Dynamic Link Library (DLL)</link>. The keyword, type and number of parameters is dependent on the routine that is being called.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id491585753339474"> + <image src="media/helpimg/sbasic/Call_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Call Statement diagram</alt></image></paragraph> +<bascode> +<paragraph role="bascode" id="par_id3150984" xml-lang="en-US">[Call] name [(] [param :=] value, ... [)] </paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3148473" xml-lang="en-US"> +<emph>name:</emph> Name of the subroutine, the function, or the <link href="text/sbasic/shared/03090403.xhp" name="Dynamic Link Library">DLL</link> that you want to call</paragraph> +<paragraph role="paragraph" id="par_id3148946" xml-lang="en-US"> +<emph>param:</emph> Keyword parameter name to pass to the routine, followed by its <emph>value</emph>. The name must match the routine declaration. Keywords are optional and can be used in any order. </paragraph> +<paragraph role="paragraph" id="par_id871586190690812"><emph>value:</emph> Positional parameter value. The type is dependent on the routine that is being called</paragraph> +<note id="par_id421586006407428" xml-lang="en-US">When mixing positional and keyword parameters, make sure positional parameters are following the routine declaration order.</note> +<tip id="par_id3154216" xml-lang="en-US">When a function is used as an expression, enclosing parameters with brackets becomes necessary. Using a <link href="text/sbasic/shared/03090403.xhp" name="Declare Statement">Declare statement</link> is compulsory prior to call a DLL.</tip> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="par_id3159254" xml-lang="en-US" localize="false">Sub ExampleCall</paragraph> +<paragraph role="bascode" id="par_id3161832" xml-lang="en-US" localize="false"> Dim value As String</paragraph> +<paragraph role="bascode" id="par_id3147317" xml-lang="en-US" localize="false"> value = "LibreOffice"</paragraph> +<paragraph role="bascode" id="par_id3145273" xml-lang="en-US" localize="false"> Call aRoutine value</paragraph> +<paragraph role="bascode" id="bas_id181585749262948" xml-lang="en-US" localize="false"> aRoutine text := value</paragraph> +<paragraph role="bascode" id="par_id3147435" xml-lang="en-US" localize="false">End Sub</paragraph> +<paragraph role="bascode" id="par_id3147436" xml-lang="en-US" localize="false"></paragraph> +<paragraph role="bascode" id="par_id3155414" xml-lang="en-US" localize="false">Sub aRoutine (text as String)</paragraph> +<paragraph role="bascode" id="par_id3151112" xml-lang="en-US" localize="false"> Msgbox text</paragraph> +<paragraph role="bascode" id="par_id3148646" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/CallByName.xhp#CallByName_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090402.xhp b/helpcontent2/source/text/sbasic/shared/03090402.xhp new file mode 100644 index 000000000..18d47e98c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090402.xhp @@ -0,0 +1,81 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090402xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Choose Function</title> + <filename>/text/sbasic/shared/03090402.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="choose"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143271"> + <bookmark_value>Choose function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3143271" xml-lang="en-US"><variable id="Choose_h1"><link href="text/sbasic/shared/03090402.xhp" name="Choose Function">Choose Function</link></variable></h1> +<paragraph id="par_id3149234" role="paragraph" xml-lang="en-US">Returns a selected value from a list of arguments.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph id="par_id3147560" role="bascode" localize="false">Choose (Index As Integer, Expression1[, Expression2, ... [, Expression_n]]) As Variant</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" id="par_id131649410695924">Variant. A value inferred from the <literal>Index</literal> parameter.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3148664" role="paragraph" xml-lang="en-US"> <emph>Index</emph>: Any numeric expression rounded to a whole number. <literal>Index</literal> accepts integer values starting at 1 that specify which of the possible choices to return.</paragraph> +<paragraph id="par_id3150791" role="paragraph" xml-lang="en-US"> <emph>Expression1, Expression2, …, Expression_n</emph>: Expressions representing each of the possible choices.</paragraph> +<paragraph id="par_id3151043" role="paragraph" xml-lang="en-US">The <emph>Choose</emph> function returns a value from the list of expressions based on the index value. If <emph>Index = 1</emph>, the function returns the first expression in the list, if <emph>Index = 2</emph>, it returns the second expression, and so on.</paragraph> +<paragraph id="par_id3153192" role="paragraph" xml-lang="en-US">If the index value is less than 1 or greater than the number of expressions listed, the function returns a <literal>Null</literal> value.</paragraph> +<paragraph role="paragraph" id="par_id911649410528836">Error #5 occurs when parameters are omitted. Error #13 occurs if <literal>Index</literal> equals <literal>Null</literal>. +<comment> If expressions are omitted - e.g. Choose(5) - or Index=Null, Basic runtime raises error #13. If the chosen expression is not defined -e.g. Choose(2,"a",,45) - "Error 448" is returned !!.</comment></paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err13"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">The following example uses the or <literal>Choose</literal> function to select a string from several strings that form a menu:</paragraph> + +<bascode> +<paragraph id="par_idm871799424" role="bascode" localize="false">Sub ExampleChoose</paragraph> +<paragraph id="par_idm871795712" role="bascode" xml-lang="en-US"> Print ChooseMenu(2) ' "Save Format"</paragraph> +<paragraph role="bascode" id="bas_id101649409956174" localize="false"> MsgBox Choose(index := -5, 9, "Basic", PI) ' Null</paragraph> +<paragraph role="bascode" id="bas_id291649409956630" localize="false"> MsgBox Choose(index := 3.14, 9, "Basic", PI) ' PI</paragraph> +<paragraph id="par_idm871794480" role="bascode" localize="false">End Sub</paragraph> +<paragraph id="par_idm871793248" role="bascode" localize="false"> </paragraph> +<paragraph id="par_idm871792000" role="bascode" localize="false">Function ChooseMenu(Index As Integer)</paragraph> +<paragraph id="par_id3156443" role="bascode" xml-lang="en-US"> ChooseMenu = Choose(Index, "Quick Format", "Save Format", "System Format")</paragraph> +<paragraph id="par_idm871788976" role="bascode" localize="false">End Function</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03090102.xhp#Select_h1"/> + <embed href="text/sbasic/shared/03090410.xhp#Switch_h1"/> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090403.xhp b/helpcontent2/source/text/sbasic/shared/03090403.xhp new file mode 100644 index 000000000..2a4b3d519 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090403.xhp @@ -0,0 +1,71 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090403xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Declare Statement</title> + <filename>/text/sbasic/shared/03090403.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="declare"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148473"> + <bookmark_value>Declare statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3148473" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090403.xhp" name="Declare Statement">Declare Statement</link></paragraph> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145316"> + <bookmark_value>DLL (Dynamic Link Library)</bookmark_value> +</bookmark> + +<paragraph id="par_id3145316" role="paragraph" xml-lang="en-US">Declares and defines a subroutine in a DLL file that you want to execute from $[officename] Basic.</paragraph> +</section> +<paragraph id="par_id3146795" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03090405.xhp" name="FreeLibrary">FreeLibrary</link></paragraph> + +<paragraph id="hd_id3156344" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3148664" role="bascode" xml-lang="en-US">Declare {Sub | Function} Name Lib "Libname" [Alias "Aliasname"] [Parameter] [As Type]</paragraph> +</bascode> + +<paragraph id="hd_id3153360" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154140" role="paragraph" xml-lang="en-US"> <emph>Name:</emph> A different name than defined in the DLL, to call the subroutine from $[officename] Basic.</paragraph> +<paragraph id="par_id3150870" role="paragraph" xml-lang="en-US"> <emph>Aliasname</emph>: Name of the subroutine as defined in the DLL.</paragraph> +<paragraph id="par_id3154684" role="paragraph" xml-lang="en-US"> <emph>Libname:</emph> File or system name of the DLL. This library is automatically loaded the first time the function is used.</paragraph> +<paragraph id="par_id3148452" role="paragraph" xml-lang="en-US"> <emph>Argumentlist:</emph> List of parameters representing arguments that are passed to the procedure when it is called. The type and number of parameters is dependent on the executed procedure.</paragraph> +<paragraph id="par_id3147289" role="paragraph" xml-lang="en-US"> <emph>Type:</emph> Defines the data type of the value that is returned by a function procedure. You can exclude this parameter if a type-declaration character is entered after the name.</paragraph> +<paragraph id="par_id3146922" role="warning" xml-lang="en-US">To pass a parameter to a subroutine as a value instead of as a reference, the parameter must be indicated by the keyword <emph>ByVal</emph>.</paragraph> + +<paragraph id="hd_id3153951" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340861616" role="bascode" localize="false" xml-lang="en-US">Declare Sub MyMessageBeep Lib "user32.dll" Alias "MessageBeep" ( Long )</paragraph> +<paragraph id="par_idm1340860336" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDeclare</paragraph> +<paragraph id="par_idm1340859104" role="bascode" localize="false" xml-lang="en-US">Dim lValue As Long</paragraph> +<paragraph id="par_idm1340857872" role="bascode" localize="false" xml-lang="en-US"> lValue = 5000</paragraph> +<paragraph id="par_idm1340856640" role="bascode" localize="false" xml-lang="en-US"> MyMessageBeep( lValue )</paragraph> +<paragraph id="par_idm1340855392" role="bascode" localize="false" xml-lang="en-US"> FreeLibrary("user32.dll" )</paragraph> +<paragraph id="par_idm1340854144" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090404.xhp b/helpcontent2/source/text/sbasic/shared/03090404.xhp new file mode 100644 index 000000000..ada8a37a8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090404.xhp @@ -0,0 +1,77 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090404xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">End Statement</title> + <filename>/text/sbasic/shared/03090404.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="end"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150771"> + <bookmark_value>End statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150771" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090404.xhp" name="End Statement">End Statement</link></paragraph> +<paragraph id="par_id3153126" role="paragraph" xml-lang="en-US">Ends a procedure or block.</paragraph> +</section> + +<paragraph id="hd_id3147264" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3148552" role="bascode" localize="false" xml-lang="en-US">End, End Enum, End Function, End If, End Property, End Select, End Sub, End With</paragraph> +</bascode> + +<paragraph id="hd_id3149456" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3150398" role="paragraph" xml-lang="en-US">Use the End statement as follows:</paragraph> + +<paragraph id="hd_id3154366" role="heading" level="2" xml-lang="en-US">Statement</paragraph> +<paragraph id="par_id3151043" role="paragraph" xml-lang="en-US">End: Is not required, but can be entered anywhere within a procedure to end the program execution.</paragraph> +<paragraph role="paragraph" id="par_id371543799561260">End Enum: Ends an Enum VBA statement</paragraph> +<paragraph id="par_id3145171" role="paragraph" xml-lang="en-US">End Function: Ends a <emph>Function</emph> statement.</paragraph> +<paragraph id="par_id3153192" role="paragraph" xml-lang="en-US">End If: Marks the end of a <emph>If...Then...Else</emph> block.</paragraph> +<paragraph role="paragraph" id="par_id51581259731973" xml-lang="en-US">End Property: Marks the end of a <emph>Property</emph> statement.</paragraph> +<paragraph id="par_id3148451" role="paragraph" xml-lang="en-US">End Select: Marks the end of a <emph>Select Case</emph> block.</paragraph> +<paragraph id="par_id3155131" role="paragraph" xml-lang="en-US">End Sub: Ends a <emph>Sub</emph> statement.</paragraph> +<paragraph role="paragraph" id="par_id811543799601628">End With: Ends a With statement</paragraph> + +<paragraph id="hd_id3146120" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340746288" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRandomSelect</paragraph> +<paragraph id="par_idm1340745056" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Integer</paragraph> +<paragraph id="par_idm1340743824" role="bascode" localize="false" xml-lang="en-US"> iVar = Int((15 * Rnd) -2)</paragraph> +<paragraph id="par_idm1340742576" role="bascode" localize="false" xml-lang="en-US"> Select Case iVar</paragraph> +<paragraph id="par_idm1340741344" role="bascode" localize="false" xml-lang="en-US"> Case 1 To 5</paragraph> +<paragraph id="par_id3152887" role="bascode" xml-lang="en-US"> Print "Number from 1 to 5"</paragraph> +<paragraph id="par_idm1340738336" role="bascode" localize="false" xml-lang="en-US"> Case 6, 7, 8</paragraph> +<paragraph id="par_id3148618" role="bascode" xml-lang="en-US"> Print "Number from 6 to 8"</paragraph> +<paragraph id="par_idm1340735376" role="bascode" localize="false" xml-lang="en-US"> Case Is > 8 And iVar < 11</paragraph> +<paragraph id="par_id3147436" role="bascode" xml-lang="en-US"> Print "Greater than 8"</paragraph> +<paragraph id="par_idm1340732352" role="bascode" localize="false" xml-lang="en-US"> Case Else</paragraph> +<paragraph id="par_id3150418" role="bascode" xml-lang="en-US"> Print "Outside range 1 to 10"</paragraph> +<paragraph id="par_idm1340729376" role="bascode" localize="false" xml-lang="en-US"> End Select</paragraph> +<paragraph id="par_idm1340728144" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090405.xhp b/helpcontent2/source/text/sbasic/shared/03090405.xhp new file mode 100644 index 000000000..7297dd934 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090405.xhp @@ -0,0 +1,64 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090405xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FreeLibrary Function</title> + <filename>/text/sbasic/shared/03090405.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="freelibrary"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143270"> + <bookmark_value>FreeLibrary function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3143270" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03090405.xhp" name="FreeLibrary Function">FreeLibrary Function</link></paragraph> +<paragraph id="par_id3147559" role="paragraph" xml-lang="en-US">Releases DLLs that were loaded by a Declare statement. A released DLL is automatically reloaded if one of its functions is called. See also: <link href="text/sbasic/shared/03090403.xhp" name="Declare">Declare</link></paragraph> +</section> + +<paragraph id="hd_id3148550" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153361" role="bascode" xml-lang="en-US">FreeLibrary (LibName As String)</paragraph> +</bascode> + +<paragraph id="hd_id3153380" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154138" role="paragraph" xml-lang="en-US"> <emph>LibName:</emph> String expression that specifies the name of the DLL.</paragraph> +<paragraph id="par_id3146923" role="note" xml-lang="en-US">FreeLibrary can only release DLLs that are loaded during Basic runtime.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3153363" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340895648" role="bascode" localize="false" xml-lang="en-US">Declare Sub MyMessageBeep Lib "user32.dll" Alias "MessageBeep" ( Long )</paragraph> +<paragraph id="par_idm1340894368" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDeclare</paragraph> +<paragraph id="par_idm1340893136" role="bascode" localize="false" xml-lang="en-US">Dim lValue As Long</paragraph> +<paragraph id="par_idm1340891904" role="bascode" localize="false" xml-lang="en-US"> lValue = 5000</paragraph> +<paragraph id="par_idm1340890672" role="bascode" localize="false" xml-lang="en-US"> MyMessageBeep( lValue )</paragraph> +<paragraph id="par_idm1340889424" role="bascode" localize="false" xml-lang="en-US"> FreeLibrary("user32.dll" )</paragraph> +<paragraph id="par_idm1340888176" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090406.xhp b/helpcontent2/source/text/sbasic/shared/03090406.xhp new file mode 100644 index 000000000..7ecfbe73c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090406.xhp @@ -0,0 +1,93 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> +<meta> + <topic id="textsbasicshared03090406xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Function Statement</title> + <filename>/text/sbasic/shared/03090406.xhp</filename> + </topic> +</meta> +<body> +<section id="function"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153346"> + <bookmark_value>Function statement</bookmark_value> +</bookmark> +<h1 id="hd_id3153346" xml-lang="en-US"><variable id="Function_h1"><link href="text/sbasic/shared/03090406.xhp" name="Function Statement">Function Statement</link></variable></h1> +<paragraph id="par_id3159158" role="paragraph" xml-lang="en-US">A function is a block of code which runs when it is called. A function is usually called in an expression.</paragraph> +<paragraph role="paragraph" id="par_id451647246564161" xml-lang="en-US">You can pass data, known as parameters or arguments, into a function. You may pass a parameter by value or by reference. When by reference, modifications applied to the parameter in the function will be sent back to the calling code.</paragraph> +<paragraph role="paragraph" id="par_id101647247154065" xml-lang="en-US">A function usually returns data as a result.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971588473588701"> + <image src="media/helpimg/sbasic/Function_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Function Statement diagram</alt></image></paragraph> +<bascode> + <paragraph role="bascode" id="bas_id151588427099190" localize="false">[Private | Public] Function Name[char] (argument1 [As Type][, argument2[char][,...]]) [As typename]</paragraph> + <paragraph role="bascode" id="bas_id541588427401158" xml-lang="en-US"> statements</paragraph> + <paragraph role="bascode" id="bas_id981588427406211" localize="false"> [Exit Function]</paragraph> + <paragraph role="bascode" id="bas_id631588427410583" xml-lang="en-US"> statements</paragraph> + <paragraph role="bascode" id="bas_id581588427417085" localize="false">End Function</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<section id="RoutineScope"> + <paragraph role="paragraph" id="par_id81588429476557"> <emph>scope:</emph> Function default scope is <literal>Public</literal>. A <literal>Private</literal> scope denotes a module internal routine, not intended to be used from other modules.</paragraph> +</section> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>name:</emph> Name of the subroutine to contain the value returned by the function.</paragraph> +<paragraph id="par_id3147229" role="paragraph" xml-lang="en-US"> <emph>arguments:</emph> Parameters to be passed to the subroutine.</paragraph> +<embed href="text/sbasic/shared/fragments.xhp#argument"/> +<embed href="text/sbasic/shared/fragments.xhp#typename"/> +<embed href="text/sbasic/shared/fragments.xhp#char"/> +<section id="BasicExamples"> +<h2 id="hd_id3163710" xml-lang="en-US">Examples:</h2> +<bascode> +<paragraph id="par_idm1340981728" role="bascode" localize="false">Sub ExampleExit</paragraph> +<paragraph id="par_idm1340980496" role="bascode" localize="false">Dim sReturn As String</paragraph> +<paragraph id="par_idm1340979264" role="bascode" localize="false">Dim sListArray(10) As String</paragraph> +<paragraph id="par_idm1340978016" role="bascode" localize="false">Dim siStep As Single</paragraph> +<paragraph id="par_id3152939" role="bascode" xml-lang="en-US"> For siStep = 0 To 10 ' Fill array with test data</paragraph> +<paragraph id="par_idm1340975040" role="bascode" localize="false"> sListArray(siStep) = chr$(siStep + 65)</paragraph> +<paragraph id="par_idm1340973776" role="bascode" localize="false"> MsgBox sListArray(siStep)</paragraph> +<paragraph id="par_idm1340972528" role="bascode" localize="false"> Next siStep</paragraph> +<paragraph id="par_idm1340971296" role="bascode" localize="false"> sReturn = LinSearch(sListArray(), "B")</paragraph> +<paragraph id="par_idm1340970032" role="bascode" localize="false"> Print sReturn</paragraph> +<paragraph id="par_idm1340968800" role="bascode" localize="false">End Sub</paragraph> +<paragraph id="par_idm1340967568" role="bascode" localize="false"> </paragraph> +<paragraph id="par_idm1340966320" role="bascode" localize="false">Function LinSearch( sList(), sItem As String ) As Integer</paragraph> +<paragraph id="par_idm1340965040" role="bascode" localize="false" xml-lang="en-US">Dim iCount As Integer</paragraph> +<paragraph id="par_id3154943" role="bascode" xml-lang="en-US">' Linsearch searches a TextArray:sList() for a TextEntry:</paragraph> +<paragraph id="par_id3155601" role="bascode" xml-lang="en-US">' Return value Is the index of the entry Or 0 (Null)</paragraph> +<paragraph id="par_idm1340960304" role="bascode" localize="false"> For iCount=1 To Ubound( sList() )</paragraph> +<paragraph id="par_idm1340959056" role="bascode" localize="false"> If sList( iCount ) = sItem Then</paragraph> +<paragraph id="par_id3153707" role="bascode" xml-lang="en-US"> Exit For ' sItem found</paragraph> +<paragraph id="par_idm1340956080" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1340954848" role="bascode" localize="false"> Next iCount</paragraph> +<paragraph id="par_idm1340953616" role="bascode" localize="false"> If iCount = Ubound( sList() ) Then iCount = 0</paragraph> +<paragraph id="par_idm1340952352" role="bascode" localize="false"> LinSearch = iCount</paragraph> +<paragraph id="par_idm1340951120" role="bascode" localize="false">End Function</paragraph> +</bascode> +</section> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id181647247913872"><link href="text/sbasic/shared/01010210.xhp" name="Subroutine basics">Subroutines basics</link></paragraph> + <embed href="text/sbasic/shared/01020300.xhp#UsingSubs_h1"/> + <embed href="text/sbasic/shared/03090409.xhp#Sub_h1"/> + <embed href="text/sbasic/shared/property.xhp#Property_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090407.xhp b/helpcontent2/source/text/sbasic/shared/03090407.xhp new file mode 100644 index 000000000..7e4239841 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090407.xhp @@ -0,0 +1,61 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090407xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Rem Statement</title> + <filename>/text/sbasic/shared/03090407.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="rem"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154347"> + <bookmark_value>Rem statement</bookmark_value> + <bookmark_value>comments;Rem statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3154347"><variable id="remstatement"><link href="text/sbasic/shared/03090407.xhp" name="Rem Statement">Rem Statement</link></variable></h1> +<paragraph id="par_id3153525" role="paragraph" xml-lang="en-US">Specifies that a program line is a comment.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3154141" localize="false" role="code">Rem Text</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150869" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any text that serves as a comment.</paragraph> +<paragraph id="par_id3147318" role="tip" xml-lang="en-US">You can use the single quotation mark instead of the Rem keyword to indicate that the text on a line is comments. This symbol can be inserted directly to the right of the program code, followed by a comment.</paragraph> +<paragraph id="par_id6187017" role="note" xml-lang="en-US">You can use a space followed by the underline character _ as the last two characters of a line to continue the logical line on the next line. To continue comment lines, you must enter "Option Compatible" in the same Basic module.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340926544" role="bascode" localize="false" xml-lang="en-US">Sub ExampleMid</paragraph> +<paragraph id="par_idm1340925312" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1340924080" role="bascode" localize="false" xml-lang="en-US"> sVar = "Las Vegas"</paragraph> +<paragraph id="par_idm1340922848" role="bascode" localize="false" xml-lang="en-US"> Print Mid(sVar,3,5) ' Returns "s Veg"</paragraph> +<paragraph id="par_id3153140" role="bascode" xml-lang="en-US"> ' Nothing occurs here</paragraph> +<paragraph id="par_idm1340919856" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090408.xhp b/helpcontent2/source/text/sbasic/shared/03090408.xhp new file mode 100644 index 000000000..8aefe030f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090408.xhp @@ -0,0 +1,58 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090408xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Stop Statement</title> + <filename>/text/sbasic/shared/03090408.xhp</filename> + </topic> +</meta> + +<body> + +<section id="stop"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153311"> + <bookmark_value>Stop statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3153311" xml-lang="en-US"><link href="text/sbasic/shared/03090408.xhp" name="Stop Statement">Stop Statement</link></h1> +<paragraph id="par_id3154142" role="paragraph" xml-lang="en-US">Stops the execution of the Basic program.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Stop_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Stop Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3156023" role="bascode" localize="false" xml-lang="en-US">Stop</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341620128" role="bascode" localize="false">Sub ExampleStop</paragraph> +<paragraph id="par_idm1341618896" role="bascode" localize="false">Dim iVar As Single</paragraph> +<paragraph id="par_idm1341617664" role="bascode" localize="false"> iVar = 36</paragraph> +<paragraph id="par_idm1341616432" role="bascode" localize="false"> Stop</paragraph> +<paragraph id="par_idm1341615200" role="bascode" localize="false"> MsgBox Sqr(iVar)</paragraph> +<paragraph id="par_idm1341613968" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03090409.xhp b/helpcontent2/source/text/sbasic/shared/03090409.xhp new file mode 100644 index 000000000..f10753bde --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090409.xhp @@ -0,0 +1,68 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090409xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Sub Statement</title> + <filename>/text/sbasic/shared/03090409.xhp</filename> + </topic> +</meta> + +<body> + +<section id="sub"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147226"> + <bookmark_value>Sub statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3147226"><variable id="Sub_h1"><link href="text/sbasic/shared/03090409.xhp" name="Sub Statement">Sub Statement</link></variable></h1> +<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US">Defines a subroutine.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Sub_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Sub Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_idm1341163696" role="bascode" localize="false" xml-lang="en-US">[Private | Public] Sub name[(argument1 [As typename][, argument2[char][,...]])]</paragraph> +<paragraph id="par_id3147530" role="bascode" xml-lang="en-US"> ' statements</paragraph> + <paragraph id="par_id3247530" role="bascode" localize="false"> [Exit Sub]</paragraph> + <paragraph id="par_id3148530" role="bascode" xml-lang="en-US"> ' statements</paragraph> +<paragraph id="par_idm1341160656" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150792" role="paragraph" xml-lang="en-US"> <emph>name:</emph> Name of the subroutine.</paragraph> +<paragraph id="par_id3154138" role="paragraph" xml-lang="en-US"> <emph>arguments:</emph> Optional parameters that you want to pass to the subroutine.</paragraph> + +<embed href="text/sbasic/shared/fragments.xhp#argument"/> +<embed href="text/sbasic/shared/fragments.xhp#typename"/> +<embed href="text/sbasic/shared/fragments.xhp#char"/> + +<embed href="text/sbasic/shared/03090406.xhp#BasicExamples"/> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id181647247913872"><link href="text/sbasic/shared/01010210.xhp" name="Subroutine basics">Subroutines basics</link></paragraph> + <embed href="text/sbasic/shared/01020300.xhp#UsingSubs_h1"/> + <embed href="text/sbasic/shared/03090406.xhp#Function_h1"/> + <embed href="text/sbasic/shared/property.xhp#Property_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090410.xhp b/helpcontent2/source/text/sbasic/shared/03090410.xhp new file mode 100644 index 000000000..acade098e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090410.xhp @@ -0,0 +1,72 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090410xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Switch Function</title> + <filename>/text/sbasic/shared/03090410.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="switch"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148554"> + <bookmark_value>Switch function</bookmark_value> +</bookmark> + +<h1 id="hd_id3148554" xml-lang="en-US"><variable id="Switch_h1"><link href="text/sbasic/shared/03090410.xhp" name="Switch Function">Switch Function</link></variable></h1> +<paragraph id="par_id3148522" role="paragraph" xml-lang="en-US">Evaluates a list of arguments, consisting of an expression followed by a value. The Switch function returns a value that is associated with the expression that is passed by this function.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3155934" role="bascode" xml-lang="en-US">Switch (Expression1, Value1[, Expression2, Value2[..., Expression_n, Value_n]]) As Variant</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153894" role="paragraph" xml-lang="en-US">The <emph>Switch</emph> function evaluates the expressions from left to right, and then returns the value that is assigned to the function expression. If expression and value are not given as a pair, a runtime error occurs.</paragraph> +<paragraph id="par_id3153990" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> The expression that you want to evaluate.</paragraph> +<paragraph id="par_id3153394" role="paragraph" xml-lang="en-US"> <emph>Value:</emph> The value that you want to return if the expression is True.</paragraph> +<paragraph id="par_id3153346" role="paragraph" xml-lang="en-US">In the following example, the <emph>Switch</emph> function assigns the appropriate gender to the name that is passed to the function:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341052032" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSwitch</paragraph> +<paragraph id="par_idm1341050800" role="bascode" localize="false" xml-lang="en-US">Dim sGender As String</paragraph> +<paragraph id="par_id31495790124" role="bascode" localize="false" xml-lang="en-US"> sGender = GetGenderIndex( "John" )</paragraph> +<paragraph id="par_idm1341047840" role="bascode" localize="false" xml-lang="en-US"> MsgBox sGender</paragraph> +<paragraph id="par_idm1341046608" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1341045376" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341044128" role="bascode" localize="false" xml-lang="en-US">Function GetGenderIndex (sName As String) As String</paragraph> +<paragraph id="par_id3153361" role="bascode" xml-lang="en-US"> GetGenderIndex = Switch(sName = "Jane", "female", sName = "John", "male")</paragraph> +<paragraph id="par_idm1341041088" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03090402.xhp#Choose_h1"/> + <embed href="text/sbasic/shared/03090102.xhp#Select_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090411.xhp b/helpcontent2/source/text/sbasic/shared/03090411.xhp new file mode 100644 index 000000000..aa1740ba6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090411.xhp @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03090411xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">With Statement</title> +<filename>/text/sbasic/shared/03090411.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + +<section id="with"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153311"><bookmark_value>With statement</bookmark_value> +</bookmark> +<h1 id="hd_id3153311" xml-lang="en-US"><link href="text/sbasic/shared/03090411.xhp" name="With Statement">With Statement</link></h1> + <paragraph role="paragraph" id="par_id3159158" xml-lang="en-US">Sets an object as the default object. Unless another object name is declared, all properties and methods refer to the default object until the <literal>End With</literal> statement is reached.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id491585753339474"><image src="media/helpimg/sbasic/With_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">With statement diagram</alt></image></paragraph> +<bascode> + <paragraph role="bascode" id="par_id3145609" localize="false">With object</paragraph> + <paragraph role="bascode" id="par_id951512205849777" localize="false"> [statements]</paragraph> + <paragraph role="bascode" id="par_id841512205903256" localize="false">End With</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3147560" xml-lang="en-US">Use <literal>With</literal> and <literal>End With</literal> if you have several properties or methods for a single object or an extended data type definition.</paragraph> +<tip id="par_id311606839557245">Nesting <literal>With</literal> statements helps writing and reading Basic routines.</tip> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id921606840180540"><link href="text/sbasic/shared/03090413.xhp" name="Type Statement">Type Statement</link></paragraph> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090412.xhp b/helpcontent2/source/text/sbasic/shared/03090412.xhp new file mode 100644 index 000000000..adad55212 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090412.xhp @@ -0,0 +1,87 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03090412xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Exit Statement</title> + <filename>/text/sbasic/shared/03090412.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="exit"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3152924"> + <bookmark_value>Exit statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3152924"><link href="text/sbasic/shared/03090412.xhp" name="Exit Statement">Exit Statement</link></h1> +<paragraph id="par_id3153394" role="paragraph" xml-lang="en-US">Exits a <emph>Do...Loop</emph>, <emph>For...Next</emph>, a function, a property, or a subroutine.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3159157" role="bascode" xml-lang="en-US">Exit Do, Exit For, Exit Function, Exit Property, Exit Sub</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3154760" role="paragraph" xml-lang="en-US" localize="false"> <emph>Exit Do</emph> </paragraph> +<paragraph id="par_id3147559" role="paragraph" xml-lang="en-US">Only valid within a <emph>Do...Loop</emph> statement to exit the loop. Program execution continues with the statement that follows the Loop statement. If <emph>Do...Loop</emph> statements are nested, the control is transferred to the loop in the next higher level.</paragraph> +<paragraph id="par_id3150398" role="paragraph" xml-lang="en-US" localize="false"> <emph>Exit For</emph> </paragraph> +<paragraph id="par_id3148797" role="paragraph" xml-lang="en-US">Only valid within a <emph>For...Next</emph> loop to exit the loop. Program execution continues with the first statement that follows the <emph>Next</emph> statement. In nested statements, the control is transferred to the loop in the next higher level.</paragraph> +<paragraph id="par_id3147229" role="paragraph" xml-lang="en-US" localize="false"> <emph>Exit Function</emph> </paragraph> +<paragraph id="par_id3154685" role="paragraph" xml-lang="en-US">Exits the <emph>Function</emph> procedure immediately. Program execution continues with the statement that follows the <emph>Function</emph> call.</paragraph> +<paragraph id="par_id31581260355116" role="paragraph" xml-lang="en-US" localize="false"> <emph>Exit Property</emph> </paragraph> +<paragraph id="par_id1001581260355700" role="paragraph" xml-lang="en-US">Exits the <emph>Property</emph> procedure immediately. Program execution continues with the statement that follows the <emph>Property</emph> call.</paragraph> +<paragraph id="par_id3155132" role="paragraph" xml-lang="en-US" localize="false"> <emph>Exit Sub</emph> </paragraph> +<paragraph id="par_id3149561" role="paragraph" xml-lang="en-US">Exits the subroutine immediately. Program execution continues with the statement that follows the <emph>Sub</emph> call.</paragraph> +<paragraph id="par_id3153143" role="note" xml-lang="en-US">The Exit statement does not define the end of a structure, and must not be confused with the End statement.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341018896" role="bascode" localize="false" xml-lang="en-US">Sub ExampleExit</paragraph> +<paragraph id="par_idm1341017664" role="bascode" localize="false" xml-lang="en-US">Dim sReturn As String</paragraph> +<paragraph id="par_idm1341016432" role="bascode" localize="false" xml-lang="en-US">Dim sListArray(10) As String</paragraph> +<paragraph id="par_idm1341015184" role="bascode" localize="false" xml-lang="en-US">Dim siStep As Single</paragraph> +<paragraph id="par_id3153158" role="bascode" xml-lang="en-US"> For siStep = 0 To 10 ' Fill array with test data</paragraph> +<paragraph id="par_idm1341012208" role="bascode" localize="false" xml-lang="en-US"> sListArray(siStep) = chr(siStep + 65)</paragraph> +<paragraph id="par_idm1341010944" role="bascode" localize="false" xml-lang="en-US"> MsgBox sListArray(siStep)</paragraph> +<paragraph id="par_idm1341009696" role="bascode" localize="false" xml-lang="en-US"> Next siStep</paragraph> +<paragraph id="par_idm1341008464" role="bascode" localize="false" xml-lang="en-US"> sReturn = LinSearch(sListArray(), "B")</paragraph> +<paragraph id="par_idm1341007200" role="bascode" localize="false" xml-lang="en-US"> Print sReturn</paragraph> +<paragraph id="par_idm1341005968" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1341004736" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341003488" role="bascode" localize="false" xml-lang="en-US">Function LinSearch( sList(), sItem As String ) As Integer</paragraph> +<paragraph id="par_idm1341002208" role="bascode" localize="false" xml-lang="en-US">Dim iCount As Integer</paragraph> +<paragraph id="par_id3153764" role="bascode" xml-lang="en-US">' LinSearch searches a TextArray:sList() for a TextEntry:</paragraph> +<paragraph id="par_id3148995" role="bascode" xml-lang="en-US">' Returns the index of the entry or 0 (Null)</paragraph> +<paragraph id="par_idm1340997424" role="bascode" localize="false" xml-lang="en-US"> For iCount=1 To Ubound( sList() )</paragraph> +<paragraph id="par_idm1340996176" role="bascode" localize="false" xml-lang="en-US"> If sList( iCount ) = sItem Then</paragraph> +<paragraph id="par_id3149567" role="bascode" xml-lang="en-US"> Exit For ' sItem found</paragraph> +<paragraph id="par_idm1340993200" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1340991968" role="bascode" localize="false" xml-lang="en-US"> Next iCount</paragraph> +<paragraph id="par_idm1340990736" role="bascode" localize="false" xml-lang="en-US"> If iCount = Ubound( sList() ) Then iCount = 0</paragraph> +<paragraph id="par_idm1340989472" role="bascode" localize="false" xml-lang="en-US"> LinSearch = iCount</paragraph> +<paragraph id="par_idm1340988240" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +</bascode> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03090413.xhp b/helpcontent2/source/text/sbasic/shared/03090413.xhp new file mode 100644 index 000000000..38c6709ae --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03090413.xhp @@ -0,0 +1,69 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="textsbasicshared03090413xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Type Statement</title> + <filename>/text/sbasic/shared/03090413.xhp</filename> + </topic> +</meta> + +<body> + <section id="type"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3153311"> + <bookmark_value>Type statement</bookmark_value> + </bookmark> + <h1 id="hd_id3153311"><variable id="Type_h1"><link href="text/sbasic/shared/03090413.xhp" name="Type Statement">Type Statement</link></variable></h1> + <paragraph role="paragraph" id="par_id3159158" xml-lang="en-US">Define non-UNO data structures.</paragraph> + </section> + <paragraph role="paragraph" id="par_id311512206747401" xml-lang="en-US">A Type structure is an ordered collection of data fields, that can be manipulated as a single item.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id491585753339474"><image src="media/helpimg/sbasic/Type_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Type statement diagram</alt></image></paragraph> + <bascode> + <paragraph role="bascode" id="par_id3145609" xml-lang="en-US" localize="false">Type struct_name</paragraph> + <paragraph role="bascode" id="par_id951512205849777" xml-lang="en-US" localize="false"> DataField1 As TypeName1</paragraph> + <paragraph role="bascode" id="par_id951512205849778" xml-lang="en-US" localize="false"> DataField2 As TypeName2</paragraph> + <paragraph role="bascode" id="par_id951512205849779" xml-lang="en-US" localize="false"> (...)</paragraph> + <paragraph role="bascode" id="par_id841512205903256" xml-lang="en-US" localize="false">End Type ' struct_name</paragraph> + </bascode> + <embed href="text/sbasic/shared/fragments.xhp#array"/> + <embed href="text/sbasic/shared/fragments.xhp#typename"/> + <note id="par_id701574739564765">Extended types such as <literal>Type</literal> statement structures, UNO objects or <link href="text/sbasic/shared/classmodule.xhp" name="ClassModule">ClassModule</link> objects are valid typenames.</note> + <embed href="text/sbasic/shared/fragments.xhp#char"/> + <note id="par_id351573639548645">A Type structure scope is that of the module it belongs to.</note> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id981512211072701" xml-lang="en-US" localize="false">Type Customer</paragraph> + <paragraph role="bascode" id="par_id171512211067797" xml-lang="en-US" localize="false"> Name1 As String</paragraph> + <paragraph role="bascode" id="par_id541512211063461" xml-lang="en-US" localize="false"> City As String</paragraph> + <paragraph role="bascode" id="par_id481512211058930" xml-lang="en-US" localize="false">End Type ' Customer structure</paragraph> + <paragraph role="bascode" id="par_id841512211054689" xml-lang="en-US" localize="false">Sub setCustomer</paragraph> + <paragraph role="bascode" id="par_id471512211049777" xml-lang="en-US" localize="false"> Dim oCustomer as New Customer</paragraph> + <paragraph role="bascode" id="par_id881512211042456" xml-lang="en-US" localize="false"> oCustomer.Name1 = "The Document Foundation"</paragraph> + <paragraph role="bascode" id="par_id461512211038180" xml-lang="en-US" localize="false"> oCustomer.City = "Berlin"</paragraph> + <paragraph role="bascode" id="par_id21512211032617" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> + <tip id="par_id701573639564765"><link href="text/sbasic/shared/enum.xhp" name ="enumerations">Enumerations</link> can be created using Type statement definitions. <link href="text/sbasic/guide/basic_2_python.xhp" name ="Calling Python Scripts from Basic">Calling Python Scripts from Basic</link> illustrates that mechanism.</tip> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> + <paragraph role="paragraph" id="par_id211512215755793" xml-lang="en-US"><link href="text/sbasic/shared/03132400.xhp" name="CreateObject function">CreateObject function</link></paragraph> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03100000.xhp b/helpcontent2/source/text/sbasic/shared/03100000.xhp new file mode 100644 index 000000000..1c06b40e8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100000.xhp @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03100000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Variables</title> +<filename>/text/sbasic/shared/03100000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="variables"> +<paragraph role="heading" id="hd_id3149669" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03100000.xhp" name="Variables">Variables</link></paragraph> +<paragraph role="paragraph" id="par_id3147265" xml-lang="en-US">The following statements and functions are for working with variables. You can use these functions to declare or define variables, convert variables from one type to another, or determine the variable type.</paragraph> +</section> +<embed href="text/sbasic/shared/03100050.xhp#ccur"/> +<embed href="text/sbasic/shared/03100100.xhp#cbool"/> +<embed href="text/sbasic/shared/03100300.xhp#cdate"/> +<embed href="text/sbasic/shared/03100060.xhp#cdec"/> +<embed href="text/sbasic/shared/03100400.xhp#cdbl"/> +<embed href="text/sbasic/shared/03100500.xhp#cint"/> +<embed href="text/sbasic/shared/03100600.xhp#clng"/> +<embed href="text/sbasic/shared/03100700.xhp#const"/> +<embed href="text/sbasic/shared/03100900.xhp#csng"/> +<embed href="text/sbasic/shared/03101000.xhp#cstr"/> +<embed href="text/sbasic/shared/03100070.xhp#cvar"/> +<embed href="text/sbasic/shared/03100080.xhp#cverr"/> +<embed href="text/sbasic/shared/03101100.xhp#defbool"/> +<embed href="text/sbasic/shared/03101110.xhp#defcur"/> +<embed href="text/sbasic/shared/03101300.xhp#defdate"/> +<embed href="text/sbasic/shared/03101400.xhp#defdbl"/> +<embed href="text/sbasic/shared/03101120.xhp#deferr"/> +<embed href="text/sbasic/shared/03101500.xhp#defint"/> +<embed href="text/sbasic/shared/03101600.xhp#deflng"/> +<embed href="text/sbasic/shared/03101700.xhp#defobj"/> +<embed href="text/sbasic/shared/03101130.xhp#defsng"/> +<embed href="text/sbasic/shared/03101140.xhp#defstr"/> +<embed href="text/sbasic/shared/03102000.xhp#defvar"/> +<embed href="text/sbasic/shared/03102100.xhp#dimtext"/> +<embed href="text/sbasic/shared/03102101.xhp#redim"/> +<embed href="text/sbasic/shared/03090413.xhp#type"/> +<embed href="text/sbasic/shared/03102200.xhp#isarray"/> +<embed href="text/sbasic/shared/03102300.xhp#isdate"/> +<embed href="text/sbasic/shared/03102400.xhp#isempty"/> +<embed href="text/sbasic/shared/03102450.xhp#iserror"/> +<embed href="text/sbasic/shared/03102600.xhp#isnull"/> +<embed href="text/sbasic/shared/03102700.xhp#isnumeric"/> +<embed href="text/sbasic/shared/03102800.xhp#isobject"/> +<embed href="text/sbasic/shared/03102900.xhp#lbound"/> +<embed href="text/sbasic/shared/03103000.xhp#ubound"/> +<embed href="text/sbasic/shared/03103100.xhp#let"/> +<embed href="text/sbasic/shared/03104200.xhp#array"/> +<embed href="text/sbasic/shared/03104300.xhp#dimarray"/> +<embed href="text/sbasic/shared/03104700.xhp#erase"/> +<embed href="text/sbasic/shared/03103200.xhp#optionbase"/> +<embed href="text/sbasic/shared/03103300.xhp#optionexplicit"/> +<embed href="text/sbasic/shared/03103400.xhp#public"/> +<embed href="text/sbasic/shared/03103450.xhp#global"/> +<embed href="text/sbasic/shared/03103500.xhp#static"/> +<embed href="text/sbasic/shared/03103600.xhp#typename"/> +<embed href="text/sbasic/shared/03103700.xhp#set"/> +<embed href="text/sbasic/shared/03103800.xhp#findobject"/> +<embed href="text/sbasic/shared/03103900.xhp#findpropertyobject"/> +<embed href="text/sbasic/shared/03104100.xhp#optional"/> +<embed href="text/sbasic/shared/03104000.xhp#ismissing"/> +<embed href="text/sbasic/shared/03104400.xhp#hasunointerfaces"/> +<embed href="text/sbasic/shared/03104600.xhp#equalunoobjects"/> +<embed href="text/sbasic/shared/03104500.xhp#isunostruct"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03100050.xhp b/helpcontent2/source/text/sbasic/shared/03100050.xhp new file mode 100644 index 000000000..37bb4d404 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100050.xhp @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03100050xhp" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">CCur Function</title> +<filename>/text/sbasic/shared/03100050.xhp</filename> +</topic> +<history> +<created date="2005-04-25T10:26:18">CCur</created> +</history> +</meta> +<body> +<section id="ccur"> +<bookmark xml-lang="en-US" branch="index" id="bm_id8926053"><bookmark_value>CCur function</bookmark_value> +</bookmark> +<h1 id="par_idN10541"><variable id="CCur_h1"><link href="text/sbasic/shared/03100050.xhp">CCur Function</link></variable></h1> +<paragraph role="paragraph" id="par_idN10545" xml-lang="en-US">Converts a string expression or numeric expression to a currency expression. The locale settings are used for decimal separators and currency symbols.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_idN105E8" xml-lang="en-US">CCur(Expression As Variant) As Currency</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" id="par_idN105EF" xml-lang="en-US">Currency</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3145068" xml-lang="en-US"> +<emph>Expression</emph>: Any string or a numeric expression that you want to convert to a number. <br/><literal>CCur(EMPTY)</literal> returns 0.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err6"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" id="bas_id1001637763908509" localize="false">Sub CCur_example</paragraph> + <paragraph role="bascode" id="bas_id691637753542614" localize="false"> Print CCur( expression := 145.279 * "654" )</paragraph> + <paragraph role="bascode" id="bas_id371637753545973" localize="false"> Print CCur( -258.0421E+02 )</paragraph> + <paragraph role="bascode" id="bas_id771637763936773" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03100100.xhp#CBool_h1"/> + <embed href="text/sbasic/shared/03120105.xhp#CByte_h1"/> +<!-- WiP + <embed href="text/sbasic/shared/03100050.xhp#CCur_h1"/> + <embed href="text/sbasic/shared/03100300.xhp#CDate_h1"/> + <embed href="text/sbasic/shared/03100400.xhp#CDbl_h1"/> + <embed href="text/sbasic/shared/03100060.xhp#CDec_h1"/> + <embed href="text/sbasic/shared/03100500.xhp#CInt_h1"/> + <embed href="text/sbasic/shared/03100600.xhp#CLng_h1"/> + <embed href="text/sbasic/shared/03100900.xhp#CSng_h1"/> + <embed href="text/sbasic/shared/03101000.xhp#CStr_h1"/> +--> +</section> + +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03100060.xhp b/helpcontent2/source/text/sbasic/shared/03100060.xhp new file mode 100644 index 000000000..f25a39b2a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100060.xhp @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03100060xhp" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">CDec Function</title> +<filename>/text/sbasic/shared/03100060.xhp</filename> +</topic> +<history> +<created date="2005-04-25T10:42:57">CDec</created> +</history> +</meta> +<body> +<section id="cdec"> +<bookmark xml-lang="en-US" branch="index" id="bm_id863979"><bookmark_value>CDec function</bookmark_value> +</bookmark> +<paragraph role="heading" id="par_idN10548" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03100060.xhp">CDec Function</link></paragraph> +<paragraph role="paragraph" id="par_idN10558" xml-lang="en-US">Converts a string expression or numeric expression to a decimal expression.</paragraph> +</section> +<paragraph role="heading" id="par_idN1055B" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_idN105EA" xml-lang="en-US">CDec(Expression)</paragraph> +</bascode> +<paragraph role="heading" id="par_idN105ED" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_idN105F1" xml-lang="en-US">Decimal number.</paragraph> +<paragraph role="heading" id="par_idN105F4" xml-lang="en-US" level="2">Parameter:</paragraph> +<paragraph role="paragraph" id="par_idN105F8" xml-lang="en-US">Expression: Any string or numeric expression that you want to convert.</paragraph> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03100070.xhp b/helpcontent2/source/text/sbasic/shared/03100070.xhp new file mode 100644 index 000000000..840a6eb66 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100070.xhp @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03100070xhp" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">CVar Function</title> +<filename>/text/sbasic/shared/03100070.xhp</filename> +</topic> +<history> +<created date="2005-04-25T11:31:39">CVar</created> +</history> +</meta> +<body> +<section id="cvar"> +<bookmark xml-lang="en-US" branch="index" id="bm_id2338633"><bookmark_value>CVar function</bookmark_value> +</bookmark> +<paragraph role="heading" id="par_idN1054B" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03100070.xhp">CVar Function</link></paragraph> +<paragraph role="paragraph" id="par_idN1055B" xml-lang="en-US">Converts a string expression or numeric expression to a variant expression.</paragraph> +</section> +<paragraph role="heading" id="par_idN1055E" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_idN10562" xml-lang="en-US">CVar(Expression)</paragraph> +</bascode> +<paragraph role="heading" id="par_idN10565" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" id="par_idN10569" xml-lang="en-US">Variant.</paragraph> +<paragraph role="heading" id="par_idN1056C" xml-lang="en-US" level="2">Parameter:</paragraph> +<paragraph role="paragraph" id="par_idN10570" xml-lang="en-US">Expression: Any string or numeric expression that you want to convert.</paragraph> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03100080.xhp b/helpcontent2/source/text/sbasic/shared/03100080.xhp new file mode 100644 index 000000000..3107ba049 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100080.xhp @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> + <meta> + <topic id="textsbasicshared03100080xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CVErr Function</title> + <filename>/text/sbasic/shared/03100080.xhp</filename> + </topic> + <history> + <created date="2005-04-25T11:37:22">CVErr</created> + </history> + </meta> + <body> + <section id="cverr"> + <bookmark xml-lang="en-US" branch="index" id="bm_id531022"><bookmark_value>CVErr function</bookmark_value> + </bookmark> + <h1 id="par_idN1054B"><variable id="CvErrh1"><link href="text/sbasic/shared/03100080.xhp">CVErr Function</link></variable></h1> + <paragraph role="paragraph" id="par_idN1055B">Converts a string expression or numeric expression to a variant expression of the sub type "Error".</paragraph> + </section> + <h2 id="par_idN1055E">Syntax:</h2> + <bascode> + <paragraph role="bascode" id="par_idN10562">CVErr(Expression)</paragraph> + </bascode> + <h2 id="par_idN10565">Return value:</h2> + <paragraph role="paragraph" id="par_idN10569">Variant.</paragraph> + <h2 id="par_idN1056C">Parameter:</h2> + <paragraph role="paragraph" id="par_idN10570">Expression: Any string or numeric expression that you want to convert.</paragraph> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03050000.xhp#ErrHandlingh1"/> + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03100100.xhp b/helpcontent2/source/text/sbasic/shared/03100100.xhp new file mode 100644 index 000000000..66dd198cf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100100.xhp @@ -0,0 +1,88 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03100100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CBool Function</title> + <filename>/text/sbasic/shared/03100100.xhp</filename> + </topic> +</meta> + +<body> + +<section id="cbool"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150616"> + <bookmark_value>CBool function</bookmark_value> +</bookmark> + +<h1 id="hd_id3150616" ><variable id="CBool_h1"><link href="text/sbasic/shared/03100100.xhp" name="CBool Function">CBool Function</link></variable></h1> +<paragraph id="par_id3145136" role="paragraph">Converts an expression or a set of expressions into a boolean. An expression is composed of strings, numbers and operators. Comparison, logical or mathematical operators are allowed inside expressions.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph id="par_id3194514" role="bascode" localize="false">CBool (expression As Variant) As Boolean</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id681638266349216"><literal>expression</literal> can be a number or a set of combined expressions.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3155419" role="paragraph" xml-lang="en-US">Boolean</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id791636986444058"><emph>expression</emph>: A logical expression, a mathematical formula, a numeric expression or a set of expressions combined with operators. During expression evaluation <link href="text/sbasic/shared/03060000.xhp" name="logical operators">logical operators</link> take preceedence over <link href="text/sbasic/shared/03110100.xhp" name="comparison operators">comparison operators</link>, which in turn take preceedence over <link href="text/sbasic/shared/03070000.xhp" name="mathematical operators">mathematical operators</link>.</paragraph> +<paragraph role="paragraph" id="par_id1001638264728895">The <literal>expression</literal> can be a number or mathematical formula. When equals to 0, <literal>False</literal> is returned, otherwise <literal>True</literal> is returned.</paragraph> +<paragraph id="par_id3149655" role="paragraph">Multiple expressions such as <input>expr1 [[{operator] expr2]..]</input> can be combined. <input>expr1</input> and <input>expr2</input> can be any string or numeric expressions that you want to evaluate. <literal>CBool</literal> combines the expressions and returns either <literal>True</literal> or <literal>False</literal>. <input>operator</input> can be a <link href="text/sbasic/shared/03070000.xhp" name="mathematical operator">mathematical operator</link>, <link href="text/sbasic/shared/03060000.xhp" name="logical operator">logical operator</link> or <link href="text/sbasic/shared/03110100.xhp" name="comparison operator">comparison operator</link>.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<paragraph id="par_id3145171" role="paragraph" xml-lang="en-US">In the following examples, the <literal>CBool</literal> function evaluates a logical expression, a mathematical formula and the value that is returned by the <literal>Instr</literal> function. The function checks if the character "a" is found in the sentence that was entered by the user.</paragraph> +<bascode> +<paragraph id="par_idm1340987280" role="bascode" localize="false">Sub ExampleCBool</paragraph> +<paragraph role="bascode" id="bas_id961636989038747" xml-lang="en-US"> Print CBool( 1>2 Xor 44 ) ' computes to True</paragraph> +<paragraph role="bascode" id="bas_id991636996682074" xml-lang="en-US"> Print CBool( expression := 15 /2 -7.5 ) ' displays False as expression equals 0</paragraph> +<paragraph id="par_id3155132" role="bascode" xml-lang="en-US"> txt = InputBox("Please enter a short sentence:")</paragraph> +<paragraph id="par_id3155855" role="bascode" xml-lang="en-US"> ' Proof if the character "a" appears in the sentence.</paragraph> +<paragraph id="par_id3146984" role="bascode" xml-lang="en-US"> ' Instead of the command line</paragraph> +<paragraph id="par_id3148576" localize="false" role="bascode" xml-lang="en-US"> ' If Instr(Input, "a")<>0 Then...</paragraph> +<paragraph id="par_id3154014" role="bascode" xml-lang="en-US"> ' the CBool function is applied as follows:</paragraph> +<paragraph id="par_id3155413" localize="false" role="bascode" xml-lang="en-US"> If CBool(Instr(txt, "a")) Then</paragraph> +<paragraph id="par_id3152940" role="bascode" xml-lang="en-US"> MsgBox "The character »a« appears in the sentence you entered!"</paragraph> +<paragraph id="par_idm1340972320" role="bascode" localize="false"> EndIf</paragraph> +<paragraph id="par_idm1340971088" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03120105.xhp#CByte_h1"/> + <embed href="text/sbasic/shared/03100050.xhp#CCur_h1"/> +<!-- WiP + <embed href="text/sbasic/shared/03100300.xhp#CDate_h1"/> + <embed href="text/sbasic/shared/03100400.xhp#CDbl_h1"/> + <embed href="text/sbasic/shared/03100060.xhp#CDec_h1"/> + <embed href="text/sbasic/shared/03100500.xhp#CInt_h1"/> + <embed href="text/sbasic/shared/03100600.xhp#CLng_h1"/> + <embed href="text/sbasic/shared/03100900.xhp#CSng_h1"/> + <embed href="text/sbasic/shared/03101000.xhp#CStr_h1"/> +--> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03100300.xhp b/helpcontent2/source/text/sbasic/shared/03100300.xhp new file mode 100644 index 000000000..adabbdc0b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100300.xhp @@ -0,0 +1,62 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03100300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDate Function</title> + <filename>/text/sbasic/shared/03100300.xhp</filename> + </topic> +</meta> + +<body> + +<section id="cdate"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150772"> + <bookmark_value>CDate function</bookmark_value> +</bookmark> +<paragraph id="hd_id3150772" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03100300.xhp" name="CDate Function">CDate Function</link></paragraph> +<paragraph id="par_id3150986" role="paragraph" xml-lang="en-US">Converts any string or numeric expression to a date value.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3148947" role="bascode" xml-lang="en-US">CDate (Expression)</paragraph> +</bascode> + +<paragraph id="hd_id3148552" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3159414" localize="false" role="paragraph">Date</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150359" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Any string or numeric expression that you want to convert.</paragraph> +<section id="CDate_str_date"> + <paragraph id="par_id3125864" role="paragraph" xml-lang="en-US">When you convert a string expression, the date and time must be entered either in one of the date acceptance patterns defined for your locale setting (see <switchinline select="sys"><caseinline select="MAC"><menuitem>%PRODUCTNAME - Preferences</menuitem></caseinline><defaultinline><menuitem>Tools - Options</menuitem></defaultinline></switchinline><menuitem> - Language Settings - Languages</menuitem>) or in ISO date format (momentarily, only the ISO format with hyphens, e.g. "2012-12-31" is accepted). In numeric expressions, values to the left of the decimal represent the date, beginning from December 31, 1899. Values to the right of the decimal represent the time.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph id="par_idm1341009312" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCDate</paragraph> + <paragraph id="par_idm1341008080" role="bascode" localize="false" xml-lang="en-US"> MsgBox cDate(1000.25) ' 09.26.1902 06:00:00</paragraph> + <paragraph id="par_idm1341006816" role="bascode" localize="false" xml-lang="en-US"> MsgBox cDate(1001.26) ' 09.27.1902 06:14:24</paragraph> + <paragraph id="par_idm1341005552" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03100400.xhp b/helpcontent2/source/text/sbasic/shared/03100400.xhp new file mode 100644 index 000000000..9546166c6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100400.xhp @@ -0,0 +1,56 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03100400xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CDbl Function</title> + <filename>/text/sbasic/shared/03100400.xhp</filename> + </topic> +</meta> + +<body> + +<section id="cdbl"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153750"> + <bookmark_value>CDbl function</bookmark_value> +</bookmark> + +<h1 id="hd_id3153750" xml-lang="en-US"><link href="text/sbasic/shared/03100400.xhp" name="CDbl Function">CDbl Function</link></h1> +<paragraph id="par_id3149233" role="paragraph" xml-lang="en-US">Converts any numerical expression or string expression to a double type.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3156152" role="bascode" xml-lang="en-US">CDbl (Expression As Variant) As Double</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3145068" localize="false" role="paragraph">Double</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<embed href="text/sbasic/shared/03100900.xhp#ExpressionArgument"/> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03100900.xhp#ExampleCountryConvert"/> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03100500.xhp b/helpcontent2/source/text/sbasic/shared/03100500.xhp new file mode 100644 index 000000000..9dda18512 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100500.xhp @@ -0,0 +1,71 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03100500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CInt Function</title> + <filename>/text/sbasic/shared/03100500.xhp</filename> + </topic> +</meta> + +<body> + +<section id="cint"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149346"> + <bookmark_value>CInt function</bookmark_value> +</bookmark> + +<h1 id="hd_id3149346"><link href="text/sbasic/shared/03100500.xhp" name="CInt Function">CInt Function</link></h1> +<paragraph id="par_id3155419" role="paragraph" xml-lang="en-US">Converts any string or numeric expression to an integer.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3154142" role="bascode" xml-lang="en-US">CInt (Expression As Variant) As Integer</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3147560" localize="false" role="paragraph">Integer</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<embed href="text/sbasic/shared/03100900.xhp#ExpressionArgument"/> +<paragraph id="par_id3159416" role="paragraph" xml-lang="en-US">If the argument is string, the function trims the leading white space; then it tries to recognize a number in following characters. The syntax below are recognized:</paragraph> +<list type="unordered"> + <listitem> + <paragraph id="par_id811638383475418" role="listitem">Decimal numbers (with optional leading sign) using decimal and group separators of locale configured in $[officename] (group separators are accepted in any position), with optional exponential notation like "-12e+1" (where an optionally signed whole decimal number after e or E or d or D defines power of 10);</paragraph> + </listitem> + <listitem> + <paragraph id="par_id361638383494362" role="listitem">Octal numbers like "&Onnn...", where "nnn..." after "&O" or "&o" is sequence no longer than 11 digits, from 0 to 7, up to the next non-alphanumeric character;</paragraph> + </listitem> + <listitem> + <paragraph id="par_id91638383518862" role="listitem">Hexadecimal numbers like "&Hnnn...", where "nnn..." after "&H" or "&h" is sequence of characters up to the next non-alphanumeric character, and must be no longer than 8 digits, from 0 to 9, A to F, or a to f. </paragraph> + </listitem> +</list> +<paragraph role="paragraph" id="par_id61638383582794">The rest of the string is ignored. If the string is not recognized, e.g. when after trimming leading whitespace it doesn't start with plus, minus, a decimal digit, or "&", or when the sequence after "&O" is longer than 11 characters or contains an alphabetic character, the numeric value of expression is 0.</paragraph> +<paragraph id="par_id3159417" role="paragraph" xml-lang="en-US">If the argument is an error, the error number is used as numeric value of the expression.</paragraph> +<paragraph id="par_id3159418" role="paragraph" xml-lang="en-US">If the argument is a date, number of days since 1899-12-30 (serial date) is used as numeric value of the expression. Time is represented as fraction of a day.</paragraph> +<paragraph id="par_id3150358" role="paragraph" xml-lang="en-US">After calculating the numeric value of the expression, it is rounded to the nearest integer (if needed), and if the result is not between -32768 and 32767, $[officename] Basic reports an overflow error. Otherwise, the result is returned.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03100900.xhp#ExampleCountryConvert"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03100600.xhp b/helpcontent2/source/text/sbasic/shared/03100600.xhp new file mode 100644 index 000000000..a8743a0b8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100600.xhp @@ -0,0 +1,58 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03100600xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CLng Function</title> + <filename>/text/sbasic/shared/03100600.xhp</filename> + </topic> +</meta> + +<body> + +<section id="clng"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153311"> + <bookmark_value>CLng function</bookmark_value> +</bookmark> + +<h1 id="hd_id3153311" xml-lang="en-US"><link href="text/sbasic/shared/03100600.xhp" name="CLng Function">CLng Function</link></h1> +<paragraph id="par_id3148686" role="paragraph" xml-lang="en-US">Converts any string or numeric expression to a long integer.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3147573" role="bascode" xml-lang="en-US">CLng (Expression As Variant) As Long</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3153897" localize="false" role="paragraph">Long</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<embed href="text/sbasic/shared/03100900.xhp#ExpressionArgument"/> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US">If <literal>Expression</literal> lies outside the valid long integer range between -2.147.483.648 and 2.147.483.647, $[officename] Basic returns an overflow error.</paragraph> +<paragraph id="par_id3150358" role="paragraph" xml-lang="en-US">This function always rounds the fractional part of a number to the nearest integer.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03100900.xhp#ExampleCountryConvert"/> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03100700.xhp b/helpcontent2/source/text/sbasic/shared/03100700.xhp new file mode 100644 index 000000000..14d00c83b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100700.xhp @@ -0,0 +1,75 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03100700xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Const Statement</title> + <filename>/text/sbasic/shared/03100700.xhp</filename> + </topic> +</meta> + +<body> + +<section id="const"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3146958"> + <bookmark_value>Const statement</bookmark_value> +</bookmark> + +<paragraph id="hd_id3146958" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03100700.xhp" name="Const Statement">Const Statement</link></paragraph> +<paragraph id="par_id3154143" role="paragraph" xml-lang="en-US">Defines one or more identifiers as constants.</paragraph> +</section> +<paragraph id="par_id3147264" role="paragraph" xml-lang="en-US">A constant is a variable that helps to improve the readability of a program. Constants are not defined as a specific type of variable, but rather are used as placeholders in the code. You can only define a constant once and it cannot be modified.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="image" id="par_id831588865616326"> + <image src="media/helpimg/sbasic/Const_statement.svg" id="img_id651588865616326"><alt id="alt_id281588865616326">Const syntax</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3150984" role="bascode" xml-lang="en-US">[Global|Private|Public] Const name = expression[, ...]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id3153897" role="paragraph"> <emph>name:</emph> Any identifier that follows the standard variable naming conventions.</paragraph> +<paragraph role="paragraph" id="par_id791593689338208"><emph>expression:</emph> Any literal expression. </paragraph> +<paragraph id="par_id3150400" role="paragraph" xml-lang="en-US">The data type must be omitted. When a library gets loaded in memory, %PRODUCTNAME Basic converts the program code internally so that each time a constant is used, the defined expression replaces it.</paragraph> +<h3 id="hd_id51593690561479">Scope</h3> +<paragraph role="paragraph" id="par_id431593690612961">By default constants are defined as private in modules and routines. Constants can be made public or global in order to be used from all modules, from all Basic libraries.</paragraph> +<paragraph role="paragraph" id="par_id241593693307830"><literal>Global</literal>, <literal>Private</literal> and <literal>Public</literal> specifiers can only be used for module constants.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" id="bas_id911593692598060" xml-lang="en-US">Const EARTH = "♁" ' module scope</paragraph> + <paragraph role="bascode" id="bas_id441593692601125" xml-lang="en-US">Private Const MOON = "☾" ' module scope</paragraph> + <paragraph role="bascode" id="bas_id161593692601597" xml-lang="en-US">Public Const VENUS="♀", MARS="♂" ' general scope</paragraph> + <paragraph role="bascode" id="bas_id581593692602046" xml-lang="en-US">Global Const SUN = "☉", STAR = "☆" ' general scope</paragraph> + <paragraph role="bascode" id="bas_id711593692602477" localize="false"></paragraph> + <paragraph id="par_idm1341161984" role="bascode" localize="false">Sub ExampleConst</paragraph> + <paragraph id="par_idm1341160752" role="bascode" xml-lang="en-US"> Const SUN = 3 * 1.456 / 56 ' SUN is local</paragraph> + <paragraph id="par_idm1341159520" role="bascode" xml-lang="en-US"> MsgBox SUN,, MOON ' SUN global constant is unchanged</paragraph> + <paragraph id="par_id3153969" role="bascode" localize="false"> Const Pgm = "Program", Var = 1.00</paragraph> + <paragraph id="par_idm1341156544" role="bascode" localize="false"> MsgBox Pgm & " " & Var, , VENUS &" and "& MARS</paragraph> + <paragraph id="par_idm1341155296" role="bascode" localize="false">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id111593694878677"><link href="text/sbasic/shared/enum.xhp" name="Enum">Enum</link> statement</paragraph> + <paragraph role="paragraph" id="par_id111953694878677"><link href="text/sbasic/shared/03090413.xhp" name="Enum">Type</link> statement</paragraph> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03100900.xhp b/helpcontent2/source/text/sbasic/shared/03100900.xhp new file mode 100644 index 000000000..649768f0e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03100900.xhp @@ -0,0 +1,73 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03100900xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CSng Function</title> + <filename>/text/sbasic/shared/03100900.xhp</filename> + </topic> +</meta> + +<body> + +<section id="csng"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153753"> + <bookmark_value>CSng function</bookmark_value> +</bookmark> + +<h1 id="hd_id3153753" xml-lang="en-US"><link href="text/sbasic/shared/03100900.xhp" name="CSng Function">CSng Function</link></h1> +<paragraph id="par_id3149748" role="paragraph" xml-lang="en-US">Converts any string or numeric expression to data type Single.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3148983" role="bascode" xml-lang="en-US">CSng (Expression As Variant) As Single</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3153750" localize="false" role="paragraph">Single</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<section id="ExpressionArgument"> +<paragraph id="par_id3153897" role="paragraph" xml-lang="en-US"> <emph>Expression</emph>: Any string or numeric expression that you want to convert. To convert a string expression, the number must be entered using a dot "." as the decimal point and a comma "," as the thousands separator (for instance 123,456.78), which may differ from your %PRODUCTNAME <link href="text/shared/optionen/01140000.xhp" name="language settings">language settings</link>.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<section id="ExampleCountryConvert"> +<paragraph role="paragraph" id="par_id761652451117906">Numeric expressions are displayed according %PRODUCTNAME <link href="text/shared/optionen/01140000.xhp" name="language settings">language settings</link>:</paragraph> +<bascode> +<paragraph id="par_idm1341609456" role="bascode" localize="false">Sub ExampleCountryConvert</paragraph> +<paragraph id="par_idm1341608224" role="bascode" xml-lang="en-US"> MsgBox CDbl(1234.5678) ' 1234.5678</paragraph> +<paragraph id="par_idm1341606976" role="bascode" localize="false"> MsgBox CInt(1234.5678) ' 1235</paragraph> +<paragraph id="par_idm1341605728" role="bascode" localize="false"> MsgBox CLng(1234+5678) ' 6912</paragraph> +<paragraph id="par_idm1341604480" role="bascode" xml-lang="en-US"> MsgBox CSng(1234.5678) ' 1234.567749023</paragraph> +<paragraph id="par_idm1341603223" role="bascode" localize="false"></paragraph> +<paragraph id="par_idm1341608242" role="bascode" xml-lang="en-US"> MsgBox CDbl(expression := 5678.1234) ' 5678.1234</paragraph> +<paragraph id="par_idm1341606967" role="bascode" localize="false"> MsgBox CInt(expression := 5678.1234) ' 5678</paragraph> +<paragraph id="par_idm1341605782" role="bascode" localize="false"> MsgBox CLng(expression := 5678+1234) ' 6912</paragraph> +<paragraph id="par_idm1341604408" role="bascode" xml-lang="en-US"> MsgBox CSng(expression := 5678.1234) ' 5678.123535156</paragraph> +<paragraph id="par_idm1314603223" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03101000.xhp b/helpcontent2/source/text/sbasic/shared/03101000.xhp new file mode 100644 index 000000000..f9745a463 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101000.xhp @@ -0,0 +1,115 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CStr Function</title> + <filename>/text/sbasic/shared/03101000.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="cstr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3146958"> + <bookmark_value>CStr function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3146958" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101000.xhp" name="CStr Function">CStr Function</link></paragraph> +<paragraph id="par_id3147574" role="paragraph" xml-lang="en-US">Converts any numeric expression to a string expression.</paragraph> +</section> + +<paragraph id="hd_id3148473" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3145315" role="bascode" xml-lang="en-US">CStr (Expression)</paragraph> +</bascode> + +<paragraph id="hd_id3153062" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3153897" localize="false" role="paragraph">String</paragraph> + +<paragraph id="hd_id3154760" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Any valid string or numeric expression that you want to convert.</paragraph> + +<paragraph id="hd_id3150358" role="heading" level="2" xml-lang="en-US">Expression Types and Conversion Returns</paragraph> + +<table id="tbl_id3148797"> + <tablerow> + <tablecell> + <paragraph id="par_id3153192" role="paragraph" xml-lang="en-US" localize="false">Boolean :</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3156422" role="paragraph" xml-lang="en-US">String that evaluates to either <emph>True</emph> or <emph>False</emph>.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3147287" role="paragraph" xml-lang="en-US" localize="false">Date :</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155411" role="paragraph" xml-lang="en-US">String that contains the date and time.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3147428" role="paragraph" xml-lang="en-US" localize="false">Null :</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3150486" role="paragraph" xml-lang="en-US">Run-time error.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3153953" role="paragraph" xml-lang="en-US" localize="false">Empty :</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155306" role="paragraph" xml-lang="en-US">String without any characters.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3149260" role="paragraph" xml-lang="en-US" localize="false">Any :</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3152938" role="paragraph" xml-lang="en-US">Corresponding number as string.</paragraph> + </tablecell> + </tablerow> +</table> + +<paragraph id="par_id3155738" role="paragraph" xml-lang="en-US">Zeros at the end of a floating-point number are not included in the returned string.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3154729" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1206743296" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCSTR</paragraph> +<paragraph id="par_idm1206742192" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1206741088" role="bascode" localize="false" xml-lang="en-US"> MsgBox CDbl(1234.5678)</paragraph> +<paragraph id="par_idm1206739936" role="bascode" localize="false" xml-lang="en-US"> MsgBox CInt(1234.5678)</paragraph> +<paragraph id="par_idm1206738784" role="bascode" localize="false" xml-lang="en-US"> MsgBox CLng(1234.5678)</paragraph> +<paragraph id="par_idm1206737632" role="bascode" localize="false" xml-lang="en-US"> MsgBox CSng(1234.5678)</paragraph> +<paragraph id="par_idm1206736480" role="bascode" localize="false" xml-lang="en-US"> sVar = CStr(1234.5678)</paragraph> +<paragraph id="par_idm1206735328" role="bascode" localize="false" xml-lang="en-US"> MsgBox sVar</paragraph> +<paragraph id="par_idm1206734224" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03101100.xhp b/helpcontent2/source/text/sbasic/shared/03101100.xhp new file mode 100644 index 000000000..811494ccb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101100.xhp @@ -0,0 +1,79 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefBool Statement</title> + <filename>/text/sbasic/shared/03101100.xhp</filename> + </topic> +</meta> + +<body> + +<section id="defbool"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145759"> + <bookmark_value>DefBool statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3145759"><link href="text/sbasic/shared/03101100.xhp" name="DefBool Statement">DefBool Statement</link></h1> +<paragraph id="par_id3153089" role="paragraph">If no type-declaration character or keyword is specified, the DefBool statement sets the default data type for variables, according to a letter range.</paragraph> +</section> + +<section id="PrefixDefCommon"> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Defxxx_statements.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">DefType statements diagram</alt></image> + </paragraph> + <bascode> + <paragraph id="par_id3150682" role="bascode" localize="false">{DefBool|DefCur|DefDate|DefDbl|DefErr|DefInt|DefLng|DefObj|DefStr|DefSng|DefVar} {char|char-char}[,...]</paragraph> + </bascode> + + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + + <paragraph id="par_id3147336" role="paragraph"> <emph>char:</emph> Letter prefix that specifies default data type for variables.</paragraph> + <paragraph id="par_id3147226" role="paragraph"> <emph>char-char:</emph> Letter range prefixes that specify default data type for variables.</paragraph> +</section> + +<section id="ExamplePrefixDefCommon"> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_id3156152" role="bascode" xml-lang="en-US">' Prefix definitions for variable types:</paragraph> + <paragraph id="par_idm1341573120" role="bascode" localize="false">DefBool b</paragraph> + <paragraph id="par_idm1341571778" role="bascode" localize="false">DefCur c,l-m</paragraph> + <paragraph id="par_idm1341571888" role="bascode" localize="false">DefDate t</paragraph> + <paragraph id="par_idm1341570656" role="bascode" localize="false">DefDbl f</paragraph> + <paragraph id="par_idm1341570656" role="bascode" localize="false">DefErr e</paragraph> + <paragraph id="par_idm1341569424" role="bascode" localize="false">DefInt i-k,N</paragraph> + <paragraph id="par_idm1341568192" role="bascode" localize="false">DefLng x-z, D</paragraph> + <paragraph id="par_idm1341566960" role="bascode" localize="false">DefObj U, o-R</paragraph> + <paragraph id="par_idm1352566960" role="bascode" localize="false">DefSng w,a</paragraph> + <paragraph id="par_idm1341676960" role="bascode" localize="false">DefStr s</paragraph> + <paragraph id="par_idm1341565728" role="bascode" localize="false">DefVar V,g</paragraph> +</bascode> +</section> +<bascode> + <paragraph id="par_idm1341564496" role="bascode" localize="false">Sub ExampleDefBool</paragraph> + <paragraph id="par_id3152481" role="bascode" xml-lang="en-US"> Print TypeName(Boole), VarType(Babbage), bitcoin ' Displays: Boolean 11 False</paragraph> + <paragraph id="par_id3151381" role="bascode" xml-lang="en-US"> bOK=True ' bOK is an implicit boolean variable</paragraph> + <paragraph id="par_idm1341561520" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101110.xhp b/helpcontent2/source/text/sbasic/shared/03101110.xhp new file mode 100644 index 000000000..f9774f48c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101110.xhp @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03101110xhp" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">DefCur Statement</title> +<filename>/text/sbasic/shared/03101110.xhp</filename> +</topic> +<history> +<created date="2005-04-25T15:14:37">DefCur</created> +</history> +</meta> +<body> +<section id="defcur"> +<bookmark xml-lang="en-US" branch="index" id="bm_id9555345"><bookmark_value>DefCur statement</bookmark_value> +</bookmark> +<paragraph role="heading" id="par_idN1057D" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03101110.xhp">DefCur Statement</link></paragraph> +<paragraph role="paragraph" id="par_idN1058D" xml-lang="en-US">If no type-declaration character or keyword is specified, the DefCur statement sets the default variable type, according to a letter range.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> + <paragraph role="bascode" id="par_idN105D6" localize="false">Sub ExampleDefCur</paragraph> + <paragraph role="bascode" id="par_idN105D8" xml-lang="en-US"> Print liquid, Typename(coinbit), VarType(money) ' Result is: 0.0000 Currency 6</paragraph> + <paragraph role="bascode" id="par_idN105D9" xml-lang="en-US"> cCur=Currency ' cCur is an implicit currency variable.</paragraph> + <paragraph role="bascode" id="par_idN105DC" localize="false">End Sub</paragraph> +</bascode> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101120.xhp b/helpcontent2/source/text/sbasic/shared/03101120.xhp new file mode 100644 index 000000000..35c1cbba7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101120.xhp @@ -0,0 +1,50 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101120xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefErr Statement</title> + <filename>/text/sbasic/shared/03101120.xhp</filename> + </topic> +</meta> + +<body> + +<section id="deferr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id8177739"> + <bookmark_value>DefErr statement</bookmark_value> +</bookmark> + +<h1 id="par_idN1057D"><link href="text/sbasic/shared/03101120.xhp">DefErr Statement</link></h1> +<paragraph id="par_idN1058D" role="paragraph" xml-lang="en-US">If no type-declaration character or keyword is specified, the DefErr statement sets the default variable type, according to a letter range.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> +<paragraph id="par_idm1340915568" role="bascode" localize="false" xml-lang="en-US">DefErr e</paragraph> +<paragraph id="par_idm1340914336" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDefErr</paragraph> +<paragraph id="par_idN105D9" role="bascode" xml-lang="en-US"> eErr=Error ' eErr is an implicit error variable</paragraph> +<paragraph id="par_idm1340911840" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101130.xhp b/helpcontent2/source/text/sbasic/shared/03101130.xhp new file mode 100644 index 000000000..7fbd6cc98 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101130.xhp @@ -0,0 +1,50 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101130xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefSng Statement</title> + <filename>/text/sbasic/shared/03101130.xhp</filename> + </topic> +</meta> + +<body> + +<section id="defsng"> +<bookmark xml-lang="en-US" branch="index" id="bm_id2445142"> + <bookmark_value>DefSng statement</bookmark_value> +</bookmark> + +<h1 id="par_idN10577"><link href="text/sbasic/shared/03101130.xhp">DefSng Statement</link></h1> +<paragraph id="par_idN10587" role="paragraph" xml-lang="en-US">If no type-declaration character or keyword is specified, the DefSng statement sets the default variable type, according to a letter range.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> + <paragraph id="par_idm1341232592" role="bascode" localize="false">Sub ExampleDefSng</paragraph> + <paragraph id="par_idN105D3" role="bascode" xml-lang="en-US"> wSng=Single ' wSng is an implicit single variable</paragraph> + <paragraph id="par_idN105D4" role="bascode" xml-lang="en-US"> Print afloat, Typename(Word), VarType(anyNum) ' Result is : 0 single 4</paragraph> + <paragraph id="par_idm1341230096" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101140.xhp b/helpcontent2/source/text/sbasic/shared/03101140.xhp new file mode 100644 index 000000000..22be17bbe --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101140.xhp @@ -0,0 +1,51 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101140xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefStr Statement</title> + <filename>/text/sbasic/shared/03101140.xhp</filename> + </topic> +</meta> + +<body> + +<section id="defstr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id6161381"> + <bookmark_value>DefStr statement</bookmark_value> +</bookmark> + +<h1 id="par_idN10577"><link href="text/sbasic/shared/03101140.xhp">DefStr Statement</link></h1> +<paragraph id="par_idN10587" role="paragraph" xml-lang="en-US">If no type-declaration character or keyword is specified, the DefStr statement sets the default variable type, according to a letter range.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> + +<bascode> + <paragraph id="par_idm1340826688" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDefStr</paragraph> + <paragraph id="par_idN105D3" role="bascode" xml-lang="en-US"> sStr=String ' sStr is an implicit string variable</paragraph> + <paragraph id="par_idN105D4" role="bascode" xml-lang="en-US"> Print VarType(slice), strng, TypeName(sheet) ' Result is: 8 "" String</paragraph> + <paragraph id="par_idm1341620336" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101300.xhp b/helpcontent2/source/text/sbasic/shared/03101300.xhp new file mode 100644 index 000000000..6c84e6563 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101300.xhp @@ -0,0 +1,50 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefDate Statement</title> + <filename>/text/sbasic/shared/03101300.xhp</filename> + </topic> +</meta> + +<body> + +<section id="defdate"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150504"> + <bookmark_value>DefDate statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3150504"><link href="text/sbasic/shared/03101300.xhp" name="DefDate Statement">DefDate Statement</link></h1> +<paragraph id="par_id3145069" role="paragraph" xml-lang="en-US">If no type-declaration character or keyword is specified, the DefDate statement sets the default variable type, according to a letter range.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> + <paragraph id="par_idm1341297408" role="bascode" localize="false">Sub ExampleDefDate</paragraph> + <paragraph id="par_id3152462" role="bascode" xml-lang="en-US"> tDate=Date ' tDate is an implicit date variable</paragraph> + <paragraph id="par_id3153562" role="bascode" xml-lang="en-US"> Print VarType(tea), train, TypeName(timedate), IsDate(tick) ' Displays: 7 00:00:00 Date True</paragraph> + <paragraph id="par_idm1341619984" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101400.xhp b/helpcontent2/source/text/sbasic/shared/03101400.xhp new file mode 100644 index 000000000..ee96efa7a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101400.xhp @@ -0,0 +1,50 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101400xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefDbl Statement</title> + <filename>/text/sbasic/shared/03101400.xhp</filename> + </topic> +</meta> + +<body> + +<section id="defdbl"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147242"> + <bookmark_value>DefDbl statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3147242"><link href="text/sbasic/shared/03101400.xhp" name="DefDbl Statement">DefDbl Statement</link></h1> +<paragraph id="par_id3153126" role="paragraph" xml-lang="en-US">Sets the default variable type, according to a letter range, if no type-declaration character or keyword is specified.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> + <paragraph id="par_idm1341565856" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDefDBL</paragraph> + <paragraph id="par_id3154244" role="bascode" xml-lang="en-US"> fValue=1.23e43 ' fValue is an implicit double variable type</paragraph> + <paragraph id="par_id3153144" role="bascode" xml-lang="en-US"> Print Typename(float), VarType(fire), factory ' Result is: Double 5 0</paragraph> + <paragraph id="par_idm1341562864" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101500.xhp b/helpcontent2/source/text/sbasic/shared/03101500.xhp new file mode 100644 index 000000000..2a371295b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101500.xhp @@ -0,0 +1,50 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefInt Statement</title> + <filename>/text/sbasic/shared/03101500.xhp</filename> + </topic> +</meta> + +<body> + +<section id="defint"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149811"> + <bookmark_value>DefInt statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3149811"><link href="text/sbasic/shared/03101500.xhp" name="DefInt Statement">DefInt Statement</link></h1> +<paragraph id="par_id3149762" role="paragraph" xml-lang="en-US">Sets the default variable type, according to a letter range, if no type-declaration character or keyword is specified.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> + <paragraph id="par_idm1341564528" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDefInt</paragraph> + <paragraph id="par_id3164728" role="bascode" xml-lang="en-US"> iCount=200 ' iCount is an implicit integer variable</paragraph> + <paragraph id="par_id3153728" role="bascode" xml-lang="en-US"> Print kilos, Typename(number), VarType(Java) ' Result is: 0 Integer 2</paragraph> + <paragraph id="par_idm1341561552" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101600.xhp b/helpcontent2/source/text/sbasic/shared/03101600.xhp new file mode 100644 index 000000000..f872bcdf0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101600.xhp @@ -0,0 +1,50 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03101600xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefLng Statement</title> + <filename>/text/sbasic/shared/03101600.xhp</filename> + </topic> +</meta> + +<body> + +<section id="deflng"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148538"> + <bookmark_value>DefLng statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3148538" ><link href="text/sbasic/shared/03101600.xhp" name="DefLng Statement">DefLng Statement</link></h1> +<paragraph id="par_id3149514" role="paragraph">Sets the default variable type, according to a letter range, if no type-declaration character or keyword is specified.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> + <paragraph id="par_idm871792224" role="bascode" localize="false">Sub ExampleDefLng</paragraph> + <paragraph id="par_id3145273" role="bascode" xml-lang="en-US"> xCount=123456789 ' xCount is an implicit long integer variable</paragraph> + <paragraph id="par_id3255273" role="bascode" xml-lang="en-US"> Print VarType(Yes), zinc, Typename(Max) ' Result is: 3 0 Long</paragraph> + <paragraph id="par_idm871789232" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03101700.xhp b/helpcontent2/source/text/sbasic/shared/03101700.xhp new file mode 100644 index 000000000..db099499c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03101700.xhp @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03101700xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">DefObj Statement</title> +<filename>/text/sbasic/shared/03101700.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="defobj"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149811"><bookmark_value>DefObj statement</bookmark_value> +</bookmark> +<h1 id="hd_id3149811"><link href="text/sbasic/shared/03101700.xhp" name="DefObj Statement">DefObj Statement</link></h1> +<paragraph role="paragraph" id="par_id3147573" xml-lang="en-US">Sets the default variable type, according to a letter range, if no type-declaration character or keyword is specified.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> + <paragraph id="par_idm871792224" role="bascode" localize="false">Sub DefObj_example</paragraph> + <paragraph id="par_id3255273" role="bascode" xml-lang="en-US"> Print Typename(properties), VarType(ordinal), IsNull(unique), IsObject(org)' Result is: Object 9 True False</paragraph> + <paragraph id="par_idm871789232" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03102000.xhp b/helpcontent2/source/text/sbasic/shared/03102000.xhp new file mode 100644 index 000000000..2e7a31252 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102000.xhp @@ -0,0 +1,51 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DefVar Statement</title> + <filename>/text/sbasic/shared/03102000.xhp</filename> + </topic> +</meta> + +<body> + +<section id="defvar"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143267"> + <bookmark_value>DefVar statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3143267"><link href="text/sbasic/shared/03102000.xhp" name="DefVar Statement">DefVar Statement</link></h1> +<paragraph id="par_id3153825" role="paragraph" xml-lang="en-US">Sets the default variable type, according to a letter range, if no type-declaration character or keyword is specified.</paragraph> +</section> + +<embed href="text/sbasic/shared/03101100.xhp#PrefixDefCommon"/> + +<embed href="text/sbasic/shared/03101100.xhp#ExamplePrefixDefCommon"/> +<bascode> + <paragraph id="par_idm1341090720" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDefVar</paragraph> + <paragraph id="par_id3154012" role="bascode" xml-lang="en-US"> vDiv=99 ' vDiv is an implicit variant</paragraph> + <paragraph id="par_id3146121" role="bascode" xml-lang="en-US"> values="Hello world"</paragraph> + <paragraph id="par_id3147221" role="bascode" xml-lang="en-US"> Print Typename(glob), VarType(values), IsEmpty(vOffer) ' Displays: Empty 8 True</paragraph> + <paragraph id="par_idm1341086032" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03102100.xhp b/helpcontent2/source/text/sbasic/shared/03102100.xhp new file mode 100644 index 000000000..b66acc580 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102100.xhp @@ -0,0 +1,163 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Dim Statement</title> + <filename>/text/sbasic/shared/03102100.xhp</filename> + </topic> +</meta> + +<body> + +<section id="dimtext"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149812"> + <bookmark_value>Dim statement</bookmark_value> + <bookmark_value>arrays; dimensioning</bookmark_value> + <bookmark_value>dimensioning arrays</bookmark_value> +</bookmark> + +<h1 id="hd_id3149812" xml-lang="en-US"><variable id="Dimh1"><link href="text/sbasic/shared/03102100.xhp" name="Dim Statement">Dim Statement</link></variable></h1> +<paragraph id="par_id3143271" role="paragraph">Declares variables or arrays.</paragraph> +</section> + +<paragraph id="par_id3154686" role="paragraph" xml-lang="en-US">If the variables are separated by commas - for example <literal>Dim v1, v2, v3 As String</literal> - first ones get defined as Variant variables. A new line, or colon sign (<emph>:</emph>), help separate variable definitions.</paragraph> +<bascode> + <paragraph id="par_idm871116272" role="bascode" localize="false">Dim text As String</paragraph> + <paragraph id="par_idm871115040" role="bascode" localize="false">Dim pv As com.sun.star.beans.PropertyValue, d As Date</paragraph> + <paragraph role="bascode" id="bas_id591587474364949" localize="false">Dim Units as Integer : Dim EULER As Double</paragraph> +</bascode> +<paragraph id="par_id3152576" role="paragraph" xml-lang="en-US"><literal>Dim</literal> declares local variables within subroutines. Global variables are declared with the <literal>Global</literal>, <literal>Public</literal> or the <literal>Private</literal> statement.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Dim_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Dim Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3149412" role="bascode" xml-lang="en-US">Dim variable [(start To end)] [As typename][, variable2[char] [(start To end)] [,...]]</paragraph> +</bascode> +<section id="optionalNew"> +<tip id="par_id221651071987432"><literal>New</literal> operator is optional when setting <link href="text/sbasic/shared/compatible.xhp" name="Option Compatible">Option Compatible</link> option.</tip> +</section> + +<section id="DimCommons"> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3154730" role="paragraph" xml-lang="en-US"> <emph>variable:</emph> Any variable or array name.</paragraph> + +<paragraph id="par_id3154510" role="paragraph" xml-lang="en-US"> <emph>typename:</emph> Keyword that declares the data type of a variable.</paragraph> +<paragraph role="paragraph" id="par_id971587473508701"> + <image src="media/helpimg/sbasic/typename_fragment.svg" id="img_id4156296484515"><alt xml-lang="en-US" id="alt_id15152796484515">primitive data types fragment</alt></image> +</paragraph> +<paragraph role="paragraph" id="par_id21587557790810"> <emph>Byte:</emph> Byte variable (0-255)</paragraph> +<paragraph id="par_id3153949" role="paragraph" xml-lang="en-US"> <emph>Boolean:</emph> Boolean variable (True, False)</paragraph> +<paragraph id="par_id3156275" role="paragraph" xml-lang="en-US"> <emph>Currency:</emph> Currency variable (Currency with 4 Decimal places)</paragraph> +<paragraph id="par_id3156057" role="paragraph" xml-lang="en-US"> <emph>Date:</emph> Date variable</paragraph> +<paragraph id="par_id3148405" role="paragraph" xml-lang="en-US"> <emph>Double:</emph> Double-precision floating-point variable (1,79769313486232 x 10E308 - 4,94065645841247 x 10E-324)</paragraph> +<paragraph id="par_id3148916" role="paragraph" xml-lang="en-US"> <emph>Integer:</emph> Integer variable (-32768 - 32767)</paragraph> +<paragraph id="par_id3150045" role="paragraph" xml-lang="en-US"> <emph>Long:</emph> Long integer variable (-2.147.483.648 - 2.147.483.647)</paragraph> +<paragraph id="par_id3149255" role="paragraph" xml-lang="en-US"> <emph>Object:</emph> Object variable (Note: this variable can only subsequently be defined with <literal>Set</literal>!)</paragraph> +<paragraph id="par_id3155937" role="paragraph" xml-lang="en-US"> <emph>Single:</emph> Single-precision floating-point variable (3,402823 x 10E38 - 1,401298 x 10E-45).</paragraph> +<paragraph id="par_id3151251" role="paragraph" xml-lang="en-US"> <emph>String:</emph> String variable consisting of a maximum of 64,000 ASCII characters.</paragraph> +<paragraph id="par_id3154704" role="paragraph" xml-lang="en-US"> <emph>Variant:</emph> Variant variable type (contains all types, specified by definition). If a type name is not specified, variables are automatically defined as Variant Type, unless a statement from <literal>DefBool</literal> to <literal>DefVar</literal> is used.</paragraph> +<paragraph role="paragraph" id="par_id21587667790810"> <emph>object:</emph> Universal Network object (UNO) object or <link href="text/sbasic/shared/classmodule" name="Class module">ClassModule</link> object instance.</paragraph> +<paragraph id="par_id3153510" role="paragraph" xml-lang="en-US"><emph>char:</emph> Special character that declares the data type of a variable.</paragraph><paragraph role="paragraph" id="par_id971587473518701"> + <image src="media/helpimg/sbasic/char_fragment.svg" id="img_id4156296484516"><alt xml-lang="en-US" id="alt_id15152796484516">Type declaration characters fragment</alt></image> +</paragraph> +<paragraph id="par_id3146316" role="paragraph" xml-lang="en-US">In %PRODUCTNAME Basic, you do not need to declare variables explicitly. However, you need to declare arrays before you can use them. You can declare a variable with the <literal>Dim</literal> statement, using commas (<emph>,</emph>) to separate multiple declarations. To declare a variable type, enter a type-declaration character following the name or use a corresponding type keyword name.</paragraph> +<table id="tab_id821587558178871"> + <tablerow> + <tablecell><paragraph id="par_id411587558178871" localize="false" role="tablehead">Declaration character</paragraph></tablecell> + <tablecell><paragraph id="par_id851587558178871" localize="false" role="tablehead">Variable type name</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id211587558178871" localize="false" role="tablecontent">%</paragraph></tablecell> + <tablecell><paragraph id="par_id42587558178871" localize="false" role="tablecontent">Integer</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id221587558178871" localize="false" role="tablecontent">&</paragraph></tablecell> + <tablecell><paragraph id="par_id43587558178871" localize="false" role="tablecontent">Long</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id231587558178871" localize="false" role="tablecontent">!</paragraph></tablecell> + <tablecell><paragraph id="par_id44587558178871" localize="false" role="tablecontent">Single</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id241587558178871" localize="false" role="tablecontent">#</paragraph></tablecell> + <tablecell><paragraph id="par_id45587558178871" localize="false" role="tablecontent">Double</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id251587558178871" localize="false" role="tablecontent">$</paragraph></tablecell> + <tablecell><paragraph id="par_id46587558178871" localize="false" role="tablecontent">String</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id251687558178871" localize="false" role="tablecontent">@</paragraph></tablecell> + <tablecell><paragraph id="par_id56587558178871" localize="false" role="tablecontent">Currency</paragraph></tablecell> + </tablerow> +</table> + +<paragraph role="paragraph" id="par_id441587477911298"> <emph>array:</emph> Array declaration.</paragraph> +<paragraph role="paragraph" id="par_id971587473519701"> + <image src="media/helpimg/sbasic/array_fragment.svg" id="img_id4156296485516"><alt xml-lang="en-US" id="alt_id15152796485516">array fragment</alt></image> +</paragraph> +<paragraph id="par_id3147125" role="paragraph" xml-lang="en-US"> <emph>start, end:</emph> Numerical values or constants that define the number of elements (NumberElements=(end-start)+1) and the index range.<comment>see #i36558</comment></paragraph> +<paragraph id="par_id3153877" role="paragraph" xml-lang="en-US"> <emph>start</emph> and <emph>end</emph> can be numerical expressions if <literal>ReDim</literal> is applied at the procedure level.</paragraph> +<paragraph id="par_id3149924" role="paragraph" xml-lang="en-US">$[officename] Basic supports single or multi-dimensional arrays that are defined by a specified variable type. Arrays are suitable if the program contains lists or tables that you want to edit. The advantage of arrays is that it is possible to address individual elements according to indexes, which can be formulated as numeric expressions or variables.</paragraph> + <paragraph id="par_id3148488" role="paragraph" xml-lang="en-US">Arrays are declared with the <literal>Dim</literal> statement. There are multiple ways to define the index range:</paragraph> +<bascode> + <paragraph role="bascode" id="bas_id381587475057846" xml-lang="en-US">Dim text(20) As String ' 21 elements numbered from 0 to 20</paragraph> + <paragraph role="bascode" id="bas_id1001587475058292" xml-lang="en-US">Dim value(5 to 25) As Integer ' 21 values numbered from 5 to 25</paragraph> + <paragraph role="bascode" id="bas_id481587475059423" xml-lang="en-US">Dim amount(-15 to 5) As Currency ' 21 amounts (including 0), numbered from -15 to 5</paragraph> + <paragraph role="bascode" id="bas_id621587475059824" xml-lang="en-US">REM Two-dimensional data field</paragraph> + <paragraph role="bascode" id="bas_id11587475060830" xml-lang="en-US">Dim table$(20,2) ' 63 items; from 0 to 20 level 1, from 0 to 20 level 2 and from 0 to 20 level 3.</paragraph> +</bascode> + +<paragraph id="par_id3159239" role="paragraph" xml-lang="en-US">You can declare an array types as dynamic if a <literal>ReDim</literal> statement defines the number of dimensions in the subroutine or the function that contains the array. Generally, you can only define an array dimension once, and you cannot modify it. Within a subroutine, you can declare an array with <literal>ReDim</literal>. You can only define dimensions with numeric expressions. This ensures that the fields are only as large as necessary.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm871051008" role="bascode" localize="false">Sub ExampleDim1</paragraph> +<paragraph id="par_idm871049776" role="bascode" localize="false">Dim sVar As String</paragraph> +<paragraph id="par_idm871048544" role="bascode" localize="false">Dim iVar As Integer</paragraph> +<paragraph id="par_id3154657" role="bascode" localize="false"> sVar = "Office"</paragraph> +<paragraph id="par_idm871045600" role="bascode" localize="false">End Sub</paragraph> +<paragraph id="par_idm871044368" role="bascode" localize="false"> </paragraph> +<paragraph id="par_idm871043120" role="bascode" localize="false">Sub ExampleDim2</paragraph> +<paragraph id="par_id3149036" role="bascode" xml-lang="en-US"> ' Two-dimensional data field</paragraph> +<paragraph id="par_idm871040112" role="bascode" localize="false"> Dim stext(20,2) As String</paragraph> +<paragraph id="par_id3153782" role="bascode" xml-lang="en-US"> Const sDim As String = " Dimension:"</paragraph> +<paragraph id="par_idm871037136" role="bascode" localize="false"> For i = 0 To 20</paragraph> +<paragraph id="par_idm871035904" role="bascode" localize="false"> For ii = 0 To 2</paragraph> +<paragraph id="par_idm871034672" role="bascode" localize="false"> stext(i,ii) = str(i) & sDim & str(ii)</paragraph> +<paragraph id="par_idm871033392" role="bascode" localize="false"> Next ii</paragraph> +<paragraph id="par_idm871032160" role="bascode" localize="false"> Next i</paragraph> +<paragraph id="par_idm871030928" role="bascode" localize="false"> For i = 0 To 20</paragraph> +<paragraph id="par_idm871029696" role="bascode" localize="false"> For ii = 0 To 2</paragraph> +<paragraph id="par_idm871028464" role="bascode" localize="false"> MsgBox stext(i,ii)</paragraph> +<paragraph id="par_idm871027216" role="bascode" localize="false"> Next ii</paragraph> +<paragraph id="par_idm871025984" role="bascode" localize="false"> Next i</paragraph> +<paragraph id="par_idm871024752" role="bascode" localize="false">End Sub</paragraph> +</bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/new_keyword.xhp#NewOperator_h1"/> + </section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03102101.xhp b/helpcontent2/source/text/sbasic/shared/03102101.xhp new file mode 100644 index 000000000..8c71168a4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102101.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102101xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ReDim Statement</title> + <filename>/text/sbasic/shared/03102101.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="redim"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150398"> + <bookmark_value>ReDim statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3150398" xml-lang="en-US"><link href="text/sbasic/shared/03102101.xhp" name="ReDim Statement">ReDim Statement</link></h1> +<paragraph id="par_id3154685" role="paragraph" xml-lang="en-US">Declares or redefines variables or arrays.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/ReDim_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">ReDim Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3156214" role="bascode">ReDim [Preserve] variable [(start To end)] [As type-name][, variable2 [(start To end)] [As type-name][,...]]</paragraph> +</bascode> +<paragraph id="par_id711996" role="paragraph">Optionally, add the <literal>Preserve</literal> keyword to preserve the contents of the array that is redimensioned. <literal>ReDim</literal> can only be used in subroutines.</paragraph> + +<embed href="text/sbasic/shared/03102100.xhp#DimCommons"/> + +<paragraph id="hd_id3148405" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341054016" role="bascode" localize="false">Sub ExampleRedim</paragraph> +<paragraph id="par_idm1341052784" role="bascode" localize="false"> Dim iVar() As Integer, iCount As Byte</paragraph> +<paragraph id="par_idm1341051520" role="bascode" localize="false"> ReDim iVar(5) As Integer</paragraph> +<paragraph id="par_idm1341050272" role="bascode" localize="false"> For iCount = 1 To 5</paragraph> +<paragraph id="par_idm1341049040" role="bascode" localize="false"> iVar(iCount) = iCount</paragraph> +<paragraph id="par_idm1341047792" role="bascode" localize="false"> Next iCount</paragraph> +<paragraph id="par_idm1341046560" role="bascode" localize="false"> ReDim iVar(10) As Integer</paragraph> +<paragraph id="par_idm1341045312" role="bascode" localize="false"> For iCount = 1 To 10</paragraph> +<paragraph id="par_idm1341044080" role="bascode" localize="false"> iVar(iCount) = iCount</paragraph> +<paragraph id="par_idm1341042832" role="bascode" localize="false"> Next iCount</paragraph> +<paragraph id="par_idm1341041600" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03102200.xhp b/helpcontent2/source/text/sbasic/shared/03102200.xhp new file mode 100644 index 000000000..431fee1c8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102200.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102200xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IsArray Function</title> + <filename>/text/sbasic/shared/03102200.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="isarray"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154346"> + <bookmark_value>IsArray function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3154346" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03102200.xhp" name="IsArray Function">IsArray Function</link></paragraph> +<paragraph id="par_id3159413" role="paragraph" xml-lang="en-US">Determines if a variable is a data field in an array.</paragraph> +</section> + +<paragraph id="hd_id3150792" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153379" role="bascode" xml-lang="en-US">IsArray (Var)</paragraph> +</bascode> + +<paragraph id="hd_id3154365" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154685" localize="false" role="paragraph">Boolean</paragraph> + +<paragraph id="hd_id3153969" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145172" role="paragraph" xml-lang="en-US"> <emph>Var:</emph> Any variable that you want to test if it is declared as an array. If the variable is an array, then the function returns <emph>True</emph>, otherwise <emph>False </emph>is returned.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3155131" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341575744" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIsArray</paragraph> +<paragraph id="par_idm1341574512" role="bascode" localize="false" xml-lang="en-US">Dim sDatf(10) As String</paragraph> +<paragraph id="par_idm1341573280" role="bascode" localize="false" xml-lang="en-US"> Print isarray(sdatf())</paragraph> +<paragraph id="par_idm1341572032" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03102300.xhp b/helpcontent2/source/text/sbasic/shared/03102300.xhp new file mode 100644 index 000000000..41976a79f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102300.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IsDate Function</title> + <filename>/text/sbasic/shared/03102300.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="isdate"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145090"> + <bookmark_value>IsDate function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3145090" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03102300.xhp" name="IsDate Function">IsDate Function</link></paragraph> +<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US">Tests if a numeric or string expression can be converted to a <emph>Date</emph> variable.</paragraph> +</section> + +<paragraph id="hd_id3153824" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147573" role="bascode" xml-lang="en-US">IsDate (Expression)</paragraph> +</bascode> + +<paragraph id="hd_id3143270" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3147560" localize="false" role="paragraph">Boolean</paragraph> + +<paragraph id="hd_id3148947" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3145069" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Any numeric or string expression that you want to test. If the expression can be converted to a date, the function returns <emph>True</emph>, otherwise the function returns <emph>False</emph>.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3150447" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340791552" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIsDate</paragraph> +<paragraph id="par_idm1340790320" role="bascode" localize="false" xml-lang="en-US">Dim sDateVar As String</paragraph> +<paragraph id="par_idm1340789088" role="bascode" localize="false" xml-lang="en-US"> sDateVar = "12.12.1997"</paragraph> +<paragraph id="par_id31508692102" role="bascode" localize="false" xml-lang="en-US"> Print IsDate(sDateVar) ' True</paragraph> +<paragraph id="par_idm1340786096" role="bascode" localize="false" xml-lang="en-US"> sDateVar = "12121997"</paragraph> +<paragraph id="par_id31472883695" role="bascode" localize="false" xml-lang="en-US"> Print IsDate(sDateVar) ' False</paragraph> +<paragraph id="par_idm1340783056" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03102400.xhp b/helpcontent2/source/text/sbasic/shared/03102400.xhp new file mode 100644 index 000000000..7343efb89 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102400.xhp @@ -0,0 +1,64 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102400xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IsEmpty Function</title> + <filename>/text/sbasic/shared/03102400.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="isempty"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153394"> + <bookmark_value>IsEmpty function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3153394" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03102400.xhp" name="IsEmpty Function">IsEmpty Function</link></paragraph> +<paragraph id="par_id3163045" role="paragraph" xml-lang="en-US">Tests if a Variant variable contains the Empty value. The Empty value indicates that the variable is not initialized.</paragraph> +</section> + +<paragraph id="hd_id3159158" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153126" role="bascode" xml-lang="en-US">IsEmpty (Var)</paragraph> +</bascode> + +<paragraph id="hd_id3148685" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156344" localize="false" role="paragraph">Boolean</paragraph> + +<paragraph id="hd_id3148947" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154347" role="paragraph" xml-lang="en-US"> <emph>Var:</emph> Any variable that you want to test. If the Variant contains the Empty value, the function returns True, otherwise the function returns False.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3154138" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341577824" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIsEmpty</paragraph> +<paragraph id="par_idm1341576592" role="bascode" localize="false" xml-lang="en-US">Dim sVar As Variant</paragraph> +<paragraph id="par_idm1341575360" role="bascode" localize="false" xml-lang="en-US"> sVar = Empty</paragraph> +<paragraph id="par_id31548633021" role="bascode" localize="false" xml-lang="en-US"> Print IsEmpty(sVar) ' True</paragraph> +<paragraph id="par_idm1341572400" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03102450.xhp b/helpcontent2/source/text/sbasic/shared/03102450.xhp new file mode 100644 index 000000000..c08464407 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102450.xhp @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> + <meta> + <topic id="textsbasicshared03102450xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IsError Function</title> + <filename>/text/sbasic/shared/03102450.xhp</filename> + </topic> + <history> + <created date="2005-04-25T12:20:38">IsError</created> + </history> + </meta> + <body> + <section id="iserror"> + <bookmark xml-lang="en-US" branch="index" id="bm_id4954680"><bookmark_value>IsError function</bookmark_value> + </bookmark> + <h1 id="par_idN1054E"><variable id="IsErrorh1"><link href="text/sbasic/shared/03102450.xhp">IsError Function</link></variable></h1> + <paragraph role="paragraph" id="par_idN1055E">Tests if a variable contains an error value.</paragraph> + </section> + <h2 id="par_idN10561">Syntax:</h2> + <bascode> + <paragraph role="bascode" localize="false" id="par_idN10565" xml-lang="en-US">IsError (Var)</paragraph> + </bascode> + <h2 id="par_idN10568">Return value:</h2> + <paragraph role="paragraph" id="par_idN1056C" xml-lang="en-US">Bool</paragraph> + <h2 id="par_idN1056F">Parameters:</h2> + <paragraph role="paragraph" id="par_idN10573" xml-lang="en-US"><emph>Var:</emph> Any variable that you want to test. If the variable contains an error value, the function returns True, otherwise the function returns False.</paragraph> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03050000.xhp#ErrHandlingh1"/> + </section> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03102600.xhp b/helpcontent2/source/text/sbasic/shared/03102600.xhp new file mode 100644 index 000000000..cbad0b2b3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102600.xhp @@ -0,0 +1,65 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102600xml" indexer="include"> + <title id="tit" xml-lang="en-US">IsNull Function</title> + <filename>/text/sbasic/shared/03102600.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="isnull"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155555"> + <bookmark_value>IsNull function</bookmark_value> + <bookmark_value>Null value</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3155555" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03102600.xhp" name="IsNull Function">IsNull Function</link></paragraph> +<paragraph id="par_id3146957" role="paragraph" xml-lang="en-US">Tests if a Variant contains the special Null value, indicating that the variable does not contain data.</paragraph> +</section> + +<paragraph id="hd_id3150670" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150984" role="bascode" xml-lang="en-US">IsNull (Var)</paragraph> +</bascode> + +<paragraph id="hd_id3149514" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3145609" localize="false" role="paragraph">Boolean</paragraph> + +<paragraph id="hd_id3149669" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US"> <emph>Var:</emph> Any variable that you want to test. This function returns True if the Variant contains the Null value, or False if the Variant does not contain the Null value.</paragraph> +<paragraph id="par_idN1062A" role="paragraph" xml-lang="en-US"> <emph>Null</emph> - This value is used for a variant data sub type without valid contents.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3153381" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340980640" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIsNull</paragraph> +<paragraph id="par_idm1340979408" role="bascode" localize="false" xml-lang="en-US">Dim vVar As Variant</paragraph> +<paragraph id="par_idm1340978176" role="bascode" localize="false" xml-lang="en-US"> MsgBox IsNull(vVar)</paragraph> +<paragraph id="par_idm1340976944" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03102700.xhp b/helpcontent2/source/text/sbasic/shared/03102700.xhp new file mode 100644 index 000000000..5a868f0fc --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102700.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102700xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IsNumeric Function</title> + <filename>/text/sbasic/shared/03102700.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="isnumeric"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145136"> + <bookmark_value>IsNumeric function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3145136" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03102700.xhp" name="IsNumeric Function">IsNumeric Function</link></paragraph> +<paragraph id="par_id3149177" role="paragraph" xml-lang="en-US">Tests if an expression is a number. If the expression is a <link href="text/sbasic/shared/00000002.xhp#dezimal" name="number">number</link>, the function returns True, otherwise the function returns False.</paragraph> +</section> + +<paragraph id="hd_id3149415" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150771" role="bascode" xml-lang="en-US">IsNumeric (Var)</paragraph> +</bascode> + +<paragraph id="hd_id3148685" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3148944" localize="false" role="paragraph">Boolean</paragraph> + +<paragraph id="hd_id3148947" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3154760" role="paragraph" xml-lang="en-US"> <emph>Var:</emph> Any expression that you want to test.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3149656" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341575664" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIsNumeric</paragraph> +<paragraph id="par_idm1341574432" role="bascode" localize="false" xml-lang="en-US">Dim vVar As Variant</paragraph> +<paragraph id="par_idm1341573200" role="bascode" localize="false" xml-lang="en-US"> vVar = "ABC"</paragraph> +<paragraph id="par_id31472308744" role="bascode" localize="false" xml-lang="en-US"> Print IsNumeric(vVar) ' False</paragraph> +<paragraph id="par_idm1341570224" role="bascode" localize="false" xml-lang="en-US"> vVar = "123"</paragraph> +<paragraph id="par_id31549103258" role="bascode" localize="false" xml-lang="en-US"> Print IsNumeric(vVar) ' True</paragraph> +<paragraph id="par_idm1341567200" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03102800.xhp b/helpcontent2/source/text/sbasic/shared/03102800.xhp new file mode 100644 index 000000000..4655ee47f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102800.xhp @@ -0,0 +1,72 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="textsbasicshared03102800xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IsObject Function</title> + <filename>/text/sbasic/shared/03102800.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> +</meta> +<body> + <section id="isobject"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3149346"> + <bookmark_value>IsObject function</bookmark_value> + </bookmark> + <h1 id="hd_id51633474369322"><variable id="IsObject_h1"><link href="text/sbasic/shared/03102800.xhp" name="IsObject Function">IsObject Function</link></variable></h1> + <paragraph role="paragraph" id="par_id3148538" xml-lang="en-US">Tests if a variable is an object, as opposed to primitive data types such as dates, numbers, texts. The function returns <literal>True</literal> if the variable is an object, otherwise it returns <literal>False</literal>.</paragraph> + </section> + <paragraph role="paragraph" id="par_id891575896963115">This function returns <literal>True</literal> for the following object types:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id471575892220352" role="listitem"><switchinline select="sys"><caseinline select="WIN">OLE objects or </caseinline></switchinline>UNO objects</paragraph></listitem> + <listitem><paragraph id="par_id451575892264518" role="listitem"><link href="text/sbasic/shared/classmodule.xhp" name="Class module">Class module</link> object instances</paragraph></listitem> + <listitem><paragraph id="par_id851575882379006" role="listitem"><link href="text/sbasic/shared/03090413.xhp" name="Extended types">Extended types</link> or <link href="text/sbasic/shared/enum.xhp" name="enumerations">enumerations</link></paragraph> </listitem> + <listitem><paragraph id="par_id131575882378422" role="listitem">Routines or variables when defined as Object.</paragraph></listitem> + <listitem><paragraph id="par_id511575889156356" role="listitem">%PRODUCTNAME Basic modules</paragraph></listitem> + </list> + <warning id="par_id441575886284392">Data structures return <literal>True</literal> even when empty. Object defined variables return <literal>True</literal> even if uninitialized.</warning> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id331633474506248"> + <input>IsObject(var)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id3156024" xml-lang="en-US">Boolean</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id3148552" xml-lang="en-US"> + <emph>var:</emph> The variable to be tested.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03104600.xhp#EqualUnoObjects_h1"/> + <paragraph role="paragraph" id="par_id191575887649871"><link href="text/sbasic/shared/enum.xhp" name="Enum statement">Enum statement</link></paragraph> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> + <!-- Function statement--> + <!-- Object type--> + <!-- CreateObject--> + <!-- UNO objects--> + <!-- Property statement--> + <paragraph role="paragraph" id="par_id51575897210153"><link href="text/sbasic/shared/03090413.xhp" name="Type statement">Type statement</link></paragraph> + <paragraph role="paragraph" id="par_id811575887627196"><link href="text/sbasic/shared/01020100.xhp" name="Using variables">Using variables</link></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03102900.xhp b/helpcontent2/source/text/sbasic/shared/03102900.xhp new file mode 100644 index 000000000..cd12c7460 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03102900.xhp @@ -0,0 +1,70 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03102900xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">LBound Function</title> + <filename>/text/sbasic/shared/03102900.xhp</filename> + </topic> +</meta> + +<body> + +<section id="lbound"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"> + <bookmark_value>LBound function</bookmark_value> +</bookmark> + +<h1 id="hd_id3156027"><link href="text/sbasic/shared/03102900.xhp" name="LBound Function">LBound Function</link></h1> +<paragraph id="par_id3147226" role="paragraph" xml-lang="en-US">Returns the lower boundary of an array.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3150503" role="code" xml-lang="en-US">LBound (ArrayName [, Dimension])</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3153126" localize="false" role="paragraph">Long</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145069" role="paragraph" xml-lang="en-US"> <emph>ArrayName:</emph> Name of the array for which you want to return the upper (<emph>Ubound</emph>) or the lower (<emph>LBound</emph>) boundary of the array dimension.</paragraph> +<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US"> <emph>[Dimension]:</emph> Integer that specifies which dimension to return the upper (<emph>Ubound</emph>) or the lower (<emph>LBound</emph>) boundary for. If a value is not specified, the first dimension is assumed.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err9"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1206770608" role="bascode" localize="false" xml-lang="en-US">Sub VectorBounds</paragraph> +<paragraph id="par_idm1206769504" role="bascode" localize="false" xml-lang="en-US"> Dim v(10 To 20) As String</paragraph> +<paragraph id="par_idm1206768352" role="bascode" xml-lang="en-US"> Print LBound(v()) ' returns 10</paragraph> +<paragraph id="par_idm1206767200" role="bascode" localize="false" xml-lang="en-US"> Print UBound(v) ' returns 20</paragraph> +<paragraph id="par_idm1206766048" role="bascode" localize="false" xml-lang="en-US">End Sub ' VectorBounds</paragraph> +<paragraph id="par_idm1206764944" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1206763792" role="bascode" localize="false" xml-lang="en-US">Sub TableBounds</paragraph> +<paragraph id="par_idm1206762640" role="bascode" localize="false" xml-lang="en-US"> Dim t(10 To 20,-5 To 70) As Currency</paragraph> +<paragraph id="par_id3145365" role="bascode" localize="false" xml-lang="en-US"> Print LBound(t), UBound(t()) ' returns 10 20</paragraph> +<paragraph id="par_id3149665" role="bascode" localize="false" xml-lang="en-US"> Print LBound(t(),2) ' returns - 5</paragraph> +<paragraph id="par_id3159154" role="bascode" localize="false" xml-lang="en-US"> Print UBound(t,2) ' returns 70</paragraph> +<paragraph id="par_idm1206754912" role="bascode" localize="false" xml-lang="en-US">End Sub ' TableBounds</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03103000.xhp b/helpcontent2/source/text/sbasic/shared/03103000.xhp new file mode 100644 index 000000000..f87474f46 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103000.xhp @@ -0,0 +1,73 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">UBound Function</title> + <filename>/text/sbasic/shared/03103000.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ubound"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3148538"> + <bookmark_value>UBound function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3148538"><link href="text/sbasic/shared/03103000.xhp" name="UBound Function">UBound Function</link></h1> +<paragraph id="par_id3147573" role="paragraph" xml-lang="en-US">Returns the upper boundary of an array.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3149415" role="code" xml-lang="en-US">UBound (ArrayName [, Dimension])</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3149670" localize="false" role="paragraph">Long</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US"> <emph>ArrayName:</emph> Name of the array for which you want to determine the upper (<emph>Ubound</emph>) or the lower (<emph>LBound</emph>) boundary.</paragraph> +<paragraph id="par_id3148797" role="paragraph" xml-lang="en-US"> <emph>[Dimension]:</emph> Integer that specifies which dimension to return the upper(<emph>Ubound</emph>) or lower (<emph>LBound</emph>) boundary for. If no value is specified, the boundary of the first dimension is returned.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err9"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1206770608" role="bascode" localize="false" xml-lang="en-US">Sub VectorBounds</paragraph> +<paragraph id="par_idm1206769504" role="bascode" localize="false" xml-lang="en-US"> Dim v(10 To 20) As String</paragraph> +<paragraph id="par_idm1206768352" role="bascode" localize="false" xml-lang="en-US"> Print LBound(v()) ' 10</paragraph> +<paragraph id="par_idm1206767200" role="bascode" localize="false" xml-lang="en-US"> Print UBound(v) ' 20</paragraph> +<paragraph id="par_idm1206766048" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1206764944" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1206763792" role="bascode" localize="false" xml-lang="en-US">Sub TableBounds</paragraph> +<paragraph id="par_idm1206762640" role="bascode" localize="false" xml-lang="en-US"> Dim t(10 To 20,-5 To 70) As Currency</paragraph> +<paragraph id="par_id31453652587" role="bascode" localize="false" xml-lang="en-US"> Print LBound(t), UBound(t()) ' 10 20</paragraph> +<paragraph id="par_id31496653658" role="bascode" localize="false" xml-lang="en-US"> Print LBound(t(),2) ' -5</paragraph> +<paragraph id="par_id31591549632" role="bascode" localize="false" xml-lang="en-US"> Print UBound(t,2) ' 70</paragraph> +<paragraph id="par_idm1206754912" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03103100.xhp b/helpcontent2/source/text/sbasic/shared/03103100.xhp new file mode 100644 index 000000000..a03f8e04d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103100.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Let Statement</title> + <filename>/text/sbasic/shared/03103100.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="let"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147242"> + <bookmark_value>Let statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3147242" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03103100.xhp" name="Let Statement">Let Statement</link></paragraph> +<paragraph id="par_id3149233" role="paragraph" xml-lang="en-US">Assigns a value to a variable.</paragraph> +</section> + +<paragraph id="hd_id3153127" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<paragraph role="paragraph" id="par_id41586012988213"> + <image src="media/helpimg/sbasic/LetSet_statement.svg" id="img_id4156306484514"><alt xml-lang="en-US" id="alt_id15152796484514">Let Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3154285" role="bascode" localize="false">[Let] variable = expression</paragraph> +</bascode> + +<paragraph id="hd_id3148944" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3147560" role="paragraph" xml-lang="en-US"> <emph>variable:</emph> Variable that you want to assign a value to. Value and variable type must be compatible.</paragraph> +<paragraph id="par_id3148451" role="note" xml-lang="en-US">As in most BASIC dialects, the keyword <emph>Let</emph> is optional.</paragraph> + +<paragraph id="hd_id3145785" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340853056" role="bascode" localize="false">Sub ExampleLet</paragraph> +<paragraph id="par_idm1340851824" role="bascode" localize="false">Dim sText As String</paragraph> +<paragraph id="par_idm1340850592" role="bascode" localize="false"> Let sText = "Las Vegas"</paragraph> +<paragraph id="par_id3152939" role="bascode" xml-lang="en-US"> MsgBox Len(sText) ' returns 9</paragraph> +<paragraph id="par_idm1340847616" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03103200.xhp b/helpcontent2/source/text/sbasic/shared/03103200.xhp new file mode 100644 index 000000000..d7418435a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103200.xhp @@ -0,0 +1,54 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103200xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Option Base Statement</title> + <filename>/text/sbasic/shared/03103200.xhp</filename> + </topic> +</meta> + +<body> + +<section id="optionbase"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155805"> + <bookmark_value>Option Base statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3155805"><variable id="optionbasestatement"><link href="text/sbasic/shared/03103200.xhp" name="Option Base Statement">Option Base Statement</link></variable></h1> +<paragraph id="par_id3147242" role="paragraph" xml-lang="en-US">Defines the default lower boundary for arrays as 0 or 1.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3147573" role="code" localize="false" xml-lang="en-US">Option Base { 0 | 1}</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3147229" role="warning" xml-lang="en-US">This statement must be added before the executable program code in a module.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341310544" role="bascode" localize="false" xml-lang="en-US">Option Base 1</paragraph> +<paragraph id="par_idm1341309312" role="bascode" localize="false" xml-lang="en-US">Sub ExampleOptionBase</paragraph> +<paragraph id="par_idm1341308080" role="bascode" localize="false" xml-lang="en-US"> Dim sVar(20) As String</paragraph> +<paragraph id="par_idm1341306832" role="bascode" localize="false" xml-lang="en-US"> MsgBox LBound(sVar())</paragraph> +<paragraph id="par_idm1341305584" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03103300.xhp b/helpcontent2/source/text/sbasic/shared/03103300.xhp new file mode 100644 index 000000000..96c490d39 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103300.xhp @@ -0,0 +1,57 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Option Explicit Statement</title> + <filename>/text/sbasic/shared/03103300.xhp</filename> + </topic> +</meta> + +<body> + +<section id="optionexplicit"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145090"> + <bookmark_value>Option Explicit statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3145090"><variable id="explicitstatement"><link href="text/sbasic/shared/03103300.xhp" name="Option Explicit Statement">Option Explicit Statement</link></variable></h1> +<paragraph id="par_id3148538" role="paragraph" xml-lang="en-US">Specifies that every variable in the program code must be explicitly declared with the Dim statement.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3149514" role="code" localize="false" xml-lang="en-US">Option Explicit</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<embed href="text/sbasic/shared/00000003.xhp#beforeexecutable"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340938880" role="bascode" localize="false" xml-lang="en-US">Option Explicit</paragraph> +<paragraph id="par_idm1340937648" role="bascode" localize="false" xml-lang="en-US">Sub ExampleExplicit</paragraph> +<paragraph id="par_idm1340936416" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1340935056" role="bascode" localize="false" xml-lang="en-US"> sVar = "Las Vegas"</paragraph> +<paragraph id="par_id3145787" role="bascode" xml-lang="en-US"> For i% = 1 To 10 ' This results in a run-time error</paragraph> +<paragraph id="par_idm1340932080" role="bascode" localize="false" xml-lang="en-US"> Rem</paragraph> +<paragraph id="par_idm1340930848" role="bascode" localize="false" xml-lang="en-US"> Next i%</paragraph> +<paragraph id="par_idm1340929616" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03103350.xhp b/helpcontent2/source/text/sbasic/shared/03103350.xhp new file mode 100644 index 000000000..1a0b9c522 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103350.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Option VBASupport Statement</title> + <filename>/text/sbasic/shared/03103350.xhp</filename> + </topic> +</meta> + +<body> +<section id="optionVBASupport"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145090"> + <bookmark_value>Microsoft Excel macros support;Enable</bookmark_value> + <bookmark_value>Microsoft Excel macros support;Option VBASupport statement</bookmark_value> + <bookmark_value>VBA Support;Option VBASupport statement</bookmark_value> + <bookmark_value>Option VBASupport statement</bookmark_value> +</bookmark> +<h1 id="hd_id3145090"><variable id="vbasupportstatement"><link href="text/sbasic/shared/03103350.xhp" name="Option VBASupport Statement">Option VBASupport Statement</link></variable></h1> +<paragraph id="par_id3148538" role="paragraph" xml-lang="en-US">Specifies that %PRODUCTNAME Basic will support some VBA statements, functions and objects.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#beforeexecutable"/> +<note id="par_id051720171055367194">The support for VBA is not complete, but covers a large portion of the common usage patterns.</note> +<warning id="par_id941552915528262">When VBA support is enabled, %PRODUCTNAME Basic function arguments and return values are the same as their VBA functions counterparts. When the support is disabled, %PRODUCTNAME Basic functions may accept arguments and return values different of their VBA counterparts.</warning> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3149514" role="code" localize="false" xml-lang="en-US">Option VBASupport {1|0}</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + +<paragraph id="par_id051720171055361727" role="paragraph" xml-lang="en-US">1: Enable VBA support in %PRODUCTNAME</paragraph> +<paragraph id="par_id051720171055369857" role="paragraph" xml-lang="en-US">0: Disable VBA support</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340938880" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_idm1340937648" role="bascode" localize="false" xml-lang="en-US">Sub ExampleVBA</paragraph> +<paragraph id="par_id051720171055368852" role="bascode" localize="false" xml-lang="en-US"> Dim sVar As Single</paragraph> +<paragraph id="par_id051720171055369387" role="bascode" localize="false" xml-lang="en-US"> sVar = Worksheets("Sheet1").Range("A1")</paragraph> +<paragraph id="par_id051720171055365423" role="bascode" localize="false" xml-lang="en-US"> Print sVar</paragraph> +<paragraph id="par_idm1340929616" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id051720171119254111" role="paragraph" xml-lang="en-US"><link href="text/shared/optionen/01130100.xhp">VBA Properties</link></paragraph> +<paragraph id="par_id051720170424259343" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/vbasupport.xhp">VBA support in %PRODUCTNAME</link></paragraph> +<embed href="text/sbasic/shared/compatibilitymode.xhp#compatibilitymodeh1"/> +<embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03103400.xhp b/helpcontent2/source/text/sbasic/shared/03103400.xhp new file mode 100644 index 000000000..b56fe0d94 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103400.xhp @@ -0,0 +1,56 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103400xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Public Statement</title> + <filename>/text/sbasic/shared/03103400.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="public"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153311"> + <bookmark_value>Public statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3153311" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03103400.xhp" name="Public Statement">Public Statement</link></paragraph> +<paragraph id="par_id3150669" role="paragraph" xml-lang="en-US">Dimensions a variable or an array at the module level (that is, not within a subroutine or function), so that the variable and the array are valid in all libraries and modules.</paragraph> +</section> + +<paragraph id="hd_id3150772" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3155341" role="bascode" xml-lang="en-US">Public VarName[(start To end)] [As VarType][, VarName2[(start To end)] [As VarType][,...]]</paragraph> +</bascode> + +<paragraph id="hd_id3145315" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341596288" role="bascode" localize="false" xml-lang="en-US">Public iPublicVar As Integer</paragraph> +<paragraph id="par_idm1341595040" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePublic</paragraph> +<paragraph id="par_idm1341593808" role="bascode" localize="false" xml-lang="en-US"> iPublicVar = iPublicVar + 1</paragraph> +<paragraph id="par_idm1341592560" role="bascode" localize="false" xml-lang="en-US"> MsgBox iPublicVar</paragraph> +<paragraph id="par_idm1341591328" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03103450.xhp b/helpcontent2/source/text/sbasic/shared/03103450.xhp new file mode 100644 index 000000000..b2c0e5144 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103450.xhp @@ -0,0 +1,56 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103450xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Global Statement</title> + <filename>/text/sbasic/shared/03103450.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="global"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3159201"> + <bookmark_value>Global keyword</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3159201" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03103450.xhp" name="Global keyword">Global keyword</link></paragraph> +<paragraph id="par_id3149177" role="paragraph" xml-lang="en-US">Dimensions a variable or an array at the global level (that is, not within a subroutine or function), so that the variable and the array are valid in all libraries and modules for the current session.</paragraph> +</section> + +<paragraph id="hd_id3143270" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150771" role="bascode" xml-lang="en-US">Global VarName[(start To end)] [As VarType][, VarName2[(start To end)] [As VarType][,...]]</paragraph> +</bascode> + +<paragraph id="hd_id3156152" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341092512" role="bascode" localize="false" xml-lang="en-US">Global iGlobalVar As Integer</paragraph> +<paragraph id="par_idm1341091264" role="bascode" localize="false" xml-lang="en-US">Sub ExampleGlobal</paragraph> +<paragraph id="par_idm1341090032" role="bascode" localize="false" xml-lang="en-US"> iGlobalVar = iGlobalVar + 1</paragraph> +<paragraph id="par_idm1341088784" role="bascode" localize="false" xml-lang="en-US"> MsgBox iGlobalVar</paragraph> +<paragraph id="par_idm1341087552" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03103500.xhp b/helpcontent2/source/text/sbasic/shared/03103500.xhp new file mode 100644 index 000000000..52a0261bb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103500.xhp @@ -0,0 +1,71 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Static Statement</title> + <filename>/text/sbasic/shared/03103500.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="static"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149798"> + <bookmark_value>Static statement</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3149798" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03103500.xhp" name="Static Statement">Static Statement</link></paragraph> +<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US">Declares a variable or an array at the procedure level within a subroutine or a function, so that the values of the variable or the array are retained after exiting the subroutine or function. Dim statement conventions are also valid.</paragraph> +</section> +<paragraph id="par_id3147264" role="warning" xml-lang="en-US">The <emph>Static statement</emph> cannot be used to define variable arrays. Arrays must be specified according to a fixed size.</paragraph> + +<paragraph id="hd_id3149657" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150400" role="bascode" xml-lang="en-US">Static VarName[(start To end)] [As VarType], VarName2[(start To end)] [As VarType], ...</paragraph> +</bascode> + +<paragraph id="hd_id3148452" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340791536" role="bascode" localize="false" xml-lang="en-US">Sub ExampleStatic</paragraph> +<paragraph id="par_idm1340790304" role="bascode" localize="false" xml-lang="en-US">Dim iCount As Integer, iResult As Integer</paragraph> +<paragraph id="par_idm1340789040" role="bascode" localize="false" xml-lang="en-US"> For iCount = 0 To 2</paragraph> +<paragraph id="par_idm1340787808" role="bascode" localize="false" xml-lang="en-US"> iResult = InitVar()</paragraph> +<paragraph id="par_idm1340786560" role="bascode" localize="false" xml-lang="en-US"> Next iCount</paragraph> +<paragraph id="par_id3150870" role="bascode" xml-lang="en-US"> MsgBox iResult,0,"The answer is"</paragraph> +<paragraph id="par_idm1340783600" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1340782368" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_id3151115" role="bascode" xml-lang="en-US">' Function for initialization of the static variable</paragraph> +<paragraph id="par_idm1340779328" role="bascode" localize="false" xml-lang="en-US">Function InitVar() As Integer</paragraph> +<paragraph id="par_idm1340778080" role="bascode" localize="false" xml-lang="en-US"> Static iInit As Integer</paragraph> +<paragraph id="par_id1057161" role="bascode" xml-lang="en-US"> Const iMinimum As Integer = 40 ' minimum return value of this function</paragraph> +<paragraph id="par_id580462" role="bascode" xml-lang="en-US"> If iInit = 0 Then ' check if initialized</paragraph> +<paragraph id="par_idm1340950464" role="bascode" localize="false" xml-lang="en-US"> iInit = iMinimum</paragraph> +<paragraph id="par_idm1340949216" role="bascode" localize="false" xml-lang="en-US"> Else</paragraph> +<paragraph id="par_idm1340947984" role="bascode" localize="false" xml-lang="en-US"> iInit = iInit + 1</paragraph> +<paragraph id="par_idm1340946736" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph> +<paragraph id="par_idm1340945504" role="bascode" localize="false" xml-lang="en-US"> InitVar = iInit</paragraph> +<paragraph id="par_idm1340944272" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03103600.xhp b/helpcontent2/source/text/sbasic/shared/03103600.xhp new file mode 100644 index 000000000..6f4d3e345 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103600.xhp @@ -0,0 +1,275 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103600xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">TypeName Function; VarType Function</title> + <filename>/text/sbasic/shared/03103600.xhp</filename> + </topic> +</meta> + +<body> +<section id="typename"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143267"> +<bookmark_value>TypeName function</bookmark_value> +<bookmark_value>VarType function</bookmark_value> +<bookmark_value>Basic Variable Type constants</bookmark_value> +</bookmark> +<h1 id="hd_id3143267"><link href="text/sbasic/shared/03103600.xhp" name="TypeName Function; VarType Function">TypeName Function; VarType Function</link></h1> +<paragraph id="par_id3159157" role="paragraph" xml-lang="en-US">Returns a string (TypeName) or a numeric value (VarType) that contains information for a variable.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3155341" role="bascode" xml-lang="en-US">TypeName (Variable) / VarType (Variable)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3148947" localize="false" role="paragraph">String; Integer</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3148664" role="paragraph" xml-lang="en-US"> <emph>Variable:</emph> The variable that you want to determine the type of. You can use the following values:</paragraph> + +<section id="VarType_constants"> +<table id="tbl_id3153362"> + <tablerow> + <tablecell> + <paragraph id="par_id3145171" role="tablehead" xml-lang="en-US">Keyword</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608269696" role="tablehead" xml-lang="en-US">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3156212" role="tablehead" xml-lang="en-US" localize="false">VarType</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154684" role="tablehead" xml-lang="en-US">Variable type</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3151041" role="paragraph" localize="false" xml-lang="en-US">Boolean</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170609229026" role="paragraph" localize="false" xml-lang="en-US"> </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153367" role="paragraph" localize="false" xml-lang="en-US">11</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3148645" role="paragraph" xml-lang="en-US">Boolean variable</paragraph> + </tablecell> + </tablerow> <tablerow> + <tablecell> + <paragraph id="par_id3151042" role="paragraph" localize="false" xml-lang="en-US">Byte</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id061620170609229026" role="paragraph" localize="false" xml-lang="en-US"> </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3253367" role="paragraph" localize="false" xml-lang="en-US">17</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3158645" role="paragraph" xml-lang="en-US">Byte variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3153138" role="paragraph" localize="false" xml-lang="en-US">Date</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608329367" role="paragraph" localize="false" xml-lang="en-US">V_DATE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153363" role="paragraph" localize="false" xml-lang="en-US">7</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155411" role="paragraph" xml-lang="en-US">Date variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id051620170608331783" role="paragraph" localize="false" xml-lang="en-US">Currency</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608333476" role="paragraph" localize="false" xml-lang="en-US">V_CURRENCY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608333808" role="paragraph" localize="false" xml-lang="en-US">6</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608331416" role="paragraph" xml-lang="en-US">Currency variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3146975" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608337319" role="paragraph" localize="false" xml-lang="en-US">V_DOUBLE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3150486" role="paragraph" localize="false" xml-lang="en-US">5</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3148616" role="paragraph" xml-lang="en-US">Double floating point variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3148457" role="paragraph" localize="false" xml-lang="en-US">Integer</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id05162017060833922" role="paragraph" localize="false" xml-lang="en-US">V_INTEGER</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145647" role="paragraph" localize="false" xml-lang="en-US">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154490" role="paragraph" xml-lang="en-US">Integer variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3149960" role="paragraph" localize="false" xml-lang="en-US">Long</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608332124" role="paragraph" localize="false" xml-lang="en-US">V_LONG</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154513" role="paragraph" localize="false" xml-lang="en-US">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3151318" role="paragraph" xml-lang="en-US">Long integer variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3146972" role="paragraph" localize="false" xml-lang="en-US">Object</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170609224777" role="paragraph" localize="false" xml-lang="en-US"> </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154482" role="paragraph" localize="false" xml-lang="en-US">9</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3150323" role="paragraph" xml-lang="en-US">Object variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3148405" role="paragraph" localize="false" xml-lang="en-US">Single</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608337392" role="paragraph" localize="false" xml-lang="en-US">V_SINGLE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3149020" role="paragraph" localize="false" xml-lang="en-US">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3147341" role="paragraph" xml-lang="en-US">Single floating-point variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3155901" role="paragraph" localize="false" xml-lang="en-US">String</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id05162017060833587" role="paragraph" localize="false" xml-lang="en-US">V_STRING</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155960" role="paragraph" localize="false" xml-lang="en-US">8</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3146313" role="paragraph" xml-lang="en-US">String variable</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3145149" role="paragraph" localize="false" xml-lang="en-US">Variant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170609222468" role="paragraph" localize="false" xml-lang="en-US"> </paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3154021" role="paragraph" localize="false" xml-lang="en-US">12</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145789" role="paragraph" xml-lang="en-US">Variant variable (can contain all types specified by the definition)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3148630" role="paragraph" localize="false" xml-lang="en-US">Empty</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id051620170608331395" role="paragraph" localize="false" xml-lang="en-US">V_EMPTY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3152584" role="paragraph" localize="false" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3151278" role="paragraph" xml-lang="en-US">Variable is not initialized</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3154576" role="paragraph" localize="false" xml-lang="en-US">Null</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id05162017060833692" role="paragraph" localize="false" xml-lang="en-US">V_NULL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3166424" role="paragraph" localize="false" xml-lang="en-US">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3145131" role="paragraph" xml-lang="en-US">No valid data</paragraph> + </tablecell> + </tablerow> +</table> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340870000" role="bascode" localize="false" xml-lang="en-US">Sub ExampleType</paragraph> +<paragraph id="par_idm1340868768" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Integer</paragraph> +<paragraph id="par_idm1340867536" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1340866304" role="bascode" localize="false" xml-lang="en-US">Dim siVar As Single</paragraph> +<paragraph id="par_idm1340865072" role="bascode" localize="false" xml-lang="en-US">Dim dVar As Double</paragraph> +<paragraph id="par_idm1340863840" role="bascode" localize="false" xml-lang="en-US">Dim bVar As Boolean</paragraph> +<paragraph id="par_idm1340862608" role="bascode" localize="false" xml-lang="en-US">Dim lVar As Long</paragraph> +<paragraph id="par_id051620170608333887" role="bascode" localize="false" xml-lang="en-US">Dim cVar as Currency</paragraph> +<paragraph id="par_id051620170608333925" role="bascode" localize="false" xml-lang="en-US">Dim tVar as Date</paragraph> +<paragraph id="par_idm1340861376" role="bascode" localize="false" xml-lang="en-US"> MsgBox TypeName(iVar) & " " & VarType(iVar) & Chr(13) &_</paragraph> +<paragraph id="par_idm1340860032" role="bascode" localize="false" xml-lang="en-US"> TypeName(sVar) & " " & VarType(sVar) & Chr(13) &_</paragraph> +<paragraph id="par_idm1340858736" role="bascode" localize="false" xml-lang="en-US"> TypeName(siVar) & " " & VarType(siVar) & Chr(13) &_</paragraph> +<paragraph id="par_idm1340857424" role="bascode" localize="false" xml-lang="en-US"> TypeName(dVar) & " " & VarType(dVar) & Chr(13) &_</paragraph> +<paragraph id="par_idm1340856128" role="bascode" localize="false" xml-lang="en-US"> TypeName(bVar) & " " & VarType(bVar) & Chr(13) &_</paragraph> +<paragraph id="par_id051620170608339345" role="bascode" localize="false" xml-lang="en-US"> TypeName(cVar) & " " & VarType(cVar) & Chr(13) &_</paragraph> +<paragraph id="par_id051620170608347372" role="bascode" localize="false" xml-lang="en-US"> TypeName(tVar) & " " & VarType(tVar) & Chr(13) &_</paragraph> +<paragraph id="par_id3148817" role="bascode" xml-lang="en-US"> TypeName(lVar) & " " & VarType(lVar),0,"Some types In $[officename] Basic"</paragraph> +<paragraph id="par_idm1340852896" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03103700.xhp b/helpcontent2/source/text/sbasic/shared/03103700.xhp new file mode 100644 index 000000000..45f6ce0e0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103700.xhp @@ -0,0 +1,75 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03103700xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Set Statement</title> + <filename>/text/sbasic/shared/03103700.xhp</filename> + </topic> +</meta> + +<body> + +<section id="set"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154422"> + <bookmark_value>Set statement</bookmark_value> + <bookmark_value>Nothing object</bookmark_value> +</bookmark> + + +<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> + +<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> +</bascode> + +<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> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<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> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/new_keyword.xhp#NewOperator_h1"/> + </section> +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03103800.xhp b/helpcontent2/source/text/sbasic/shared/03103800.xhp new file mode 100644 index 000000000..f77b77da8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103800.xhp @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03103800xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">FindObject Function</title> +<filename>/text/sbasic/shared/03103800.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="findobject"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3145136"><bookmark_value>FindObject function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3145136" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03103800.xhp" name="FindObject Function">FindObject Function</link></paragraph> +<paragraph role="paragraph" id="par_id3155341" xml-lang="en-US">Enables an object to be addressed at run-time as a string parameter through the object name.</paragraph> +</section> +<section id="examplefindobject"> +<paragraph role="paragraph" id="par_id3150669" xml-lang="en-US">For example, the following command:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3148473" localize="false" xml-lang="en-US">MyObj.Prop1.Command = 5</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3156023" xml-lang="en-US">corresponds to the command block:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3153896" localize="false" xml-lang="en-US">Dim ObjVar as Object</paragraph> +<paragraph role="bascode" id="par_id3154760" localize="false" xml-lang="en-US">Dim ObjProp as Object</paragraph> +<paragraph role="bascode" id="par_id3145069" localize="false" xml-lang="en-US">ObjName As String = "MyObj"</paragraph> +<paragraph role="bascode" id="par_id3154939" localize="false" xml-lang="en-US">ObjVar = FindObject( ObjName As String )</paragraph> +<paragraph role="bascode" id="par_id3150793" localize="false" xml-lang="en-US">PropName As String = "Prop1"</paragraph> +<paragraph role="bascode" id="par_id3154141" localize="false" xml-lang="en-US">ObjProp = FindPropertyObject( ObjVar, PropName As String )</paragraph> +<paragraph role="bascode" id="par_id3156424" localize="false" xml-lang="en-US">ObjProp.Command = 5</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3145420" xml-lang="en-US">This allows names to be dynamically created at run-time. For example:</paragraph> +<paragraph role="paragraph" id="par_id3153104" xml-lang="en-US">"TextEdit1" to "TextEdit5" in a loop to create five control names.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3150767" xml-lang="en-US">See also: <link href="text/sbasic/shared/03103900.xhp" name="FindPropertyObject">FindPropertyObject</link></paragraph> +<paragraph role="heading" id="hd_id3150868" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3151042" localize="false" xml-lang="en-US">FindObject( ObjName As String )</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3159254" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3150439" xml-lang="en-US"> +<emph>ObjName: </emph>String that specifies the name of the object that you want to address at run-time.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err12"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03103900.xhp b/helpcontent2/source/text/sbasic/shared/03103900.xhp new file mode 100644 index 000000000..75486f5bf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03103900.xhp @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03103900xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">FindPropertyObject Function</title> +<filename>/text/sbasic/shared/03103900.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="findpropertyobject"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3146958"><bookmark_value>FindPropertyObject function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3146958" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03103900.xhp" name="FindPropertyObject Function">FindPropertyObject Function</link></paragraph> +<paragraph role="paragraph" id="par_id3154285" xml-lang="en-US">Enables objects to be addressed at run-time as a string parameter using the object name.</paragraph> +</section> +<embed href="text/sbasic/shared/03103800.xhp#examplefindobject"/> +<paragraph role="paragraph" id="par_id3150868" xml-lang="en-US">See also: <link href="text/sbasic/shared/03103800.xhp" name="FindObject">FindObject</link></paragraph> +<paragraph role="heading" id="hd_id3147287" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3149560" localize="false" xml-lang="en-US">FindPropertyObject( ObjVar, PropName As String )</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3150012" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3109839" xml-lang="en-US"> +<emph>ObjVar:</emph> Object variable that you want to dynamically define at run-time.</paragraph> +<paragraph role="paragraph" id="par_id3153363" xml-lang="en-US"> +<emph>PropName:</emph> String that specifies the name of the property that you want to address at run-time.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err12"/> +<embed href="text/sbasic/shared/00000003.xhp#err14"/> +<embed href="text/sbasic/shared/00000003.xhp#err52"/> +<embed href="text/sbasic/shared/00000003.xhp#err57"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03104000.xhp b/helpcontent2/source/text/sbasic/shared/03104000.xhp new file mode 100644 index 000000000..f12213c9f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104000.xhp @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03104000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">IsMissing function</title> +<filename>/text/sbasic/shared/03104000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="ismissing"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153527"><bookmark_value>IsMissing function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3153527" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03104000.xhp" name="IsMissing Function">IsMissing Function</link></paragraph> +<paragraph role="paragraph" id="par_id3153825" xml-lang="en-US">Tests if a function is called with an optional parameter.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3150669" xml-lang="en-US">See also: <link href="text/sbasic/shared/03104100.xhp" name="Optional">Optional</link></paragraph> +<paragraph role="heading" id="hd_id3145611" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3154924" xml-lang="en-US">IsMissing( ArgumentName )</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3145069" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3149457" xml-lang="en-US"> +<emph>ArgumentName:</emph> the name of an optional argument.</paragraph> +<paragraph role="paragraph" id="par_id3150398" xml-lang="en-US">If the IsMissing function is called by the ArgumentName, then True is returned.</paragraph> +<paragraph role="paragraph" id="par_id3148798" xml-lang="en-US">See also <link href="text/sbasic/guide/sample_code.xhp" name="Examples">Examples</link>.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03104100.xhp b/helpcontent2/source/text/sbasic/shared/03104100.xhp new file mode 100644 index 000000000..26e9b2201 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104100.xhp @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03104100xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Optional (in Function Statement)</title> +<filename>/text/sbasic/shared/03104100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="optional"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149205"><bookmark_value>Optional function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3149205" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03104100.xhp" name="Optional (in Function Statement)">Optional (in Function Statement)</link></paragraph> +<paragraph role="paragraph" id="par_id3143267" xml-lang="en-US">Allows you to define parameters that are passed to a function as optional.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US">See also: <link href="text/sbasic/shared/03104000.xhp" name="IsMissing">IsMissing</link></paragraph> +<paragraph role="heading" id="hd_id3153824" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3159157" xml-lang="en-US">Function MyFunction(Text1 As String, Optional Arg2, Optional Arg3)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3145610" xml-lang="en-US" level="2">Examples:</paragraph> +<bascode> + <paragraph role="bascode" id="par_id3154347" xml-lang="en-US">Result = MyFunction("Here", 1, "There") ' all arguments are passed.</paragraph> + <paragraph role="bascode" id="par_id3146795" xml-lang="en-US">Result = MyFunction("Test", ,1) ' second argument is missing.</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3153897" xml-lang="en-US">See also <link href="text/sbasic/guide/sample_code.xhp" name="Examples">Examples</link>.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03104200.xhp b/helpcontent2/source/text/sbasic/shared/03104200.xhp new file mode 100644 index 000000000..1ee1a8fff --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104200.xhp @@ -0,0 +1,58 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="textsbasicshared03104200xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Array Function</title> + <filename>/text/sbasic/shared/03104200.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> +</meta> +<body> + <section id="array"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>Array function</bookmark_value> + </bookmark> + <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> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph role="bascode" id="par_id3153126" xml-lang="en-US">Array (ArgumentList)</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> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id3145609" xml-lang="en-US"> + <emph>ArgumentList:</emph> A list of any number of arguments that are separated by commas.</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" localize="false" id="par_id3153525" xml-lang="en-US">A = Array("Fred","Tom","Bill")</paragraph> + <paragraph role="bascode" localize="false" id="par_id3150792" xml-lang="en-US">Msgbox A(2)</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/collection.xhp#Collection_h1"/> + <embed href="text/sbasic/shared/03/sf_array.xhp#ArrayService"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03104300.xhp b/helpcontent2/source/text/sbasic/shared/03104300.xhp new file mode 100644 index 000000000..177c75d38 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104300.xhp @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03104300xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">DimArray Function</title> +<filename>/text/sbasic/shared/03104300.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="dimarray"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150616"><bookmark_value>DimArray function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3150616" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03104300.xhp" name="DimArray Function">DimArray Function</link></paragraph> +<paragraph role="paragraph" id="par_id3153527" xml-lang="en-US">Returns a Variant array.</paragraph> +</section> +<paragraph role="heading" id="hd_id3149762" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3148473" xml-lang="en-US">DimArray (ArgumentList)</paragraph> +</bascode> +<paragraph role="paragraph" id="par_id3154142" xml-lang="en-US">See also <link href="text/sbasic/shared/03104200.xhp" name="Array">Array</link></paragraph> +<paragraph role="paragraph" id="par_id3156023" xml-lang="en-US">If no parameters are passed, an empty array is created (like Dim A() that is the same as a sequence of length 0 in Uno). If parameters are specified, a dimension is created for each parameter.</paragraph> +<paragraph role="heading" id="hd_id3154760" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3159414" xml-lang="en-US"> +<emph>ArgumentList:</emph> A list of any number of arguments that are separated by commas.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err9"/> +<paragraph role="heading" id="hd_id3150358" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> + <paragraph role="bascode" id="par_id3154939" xml-lang="en-US">a = DimArray( 2, 2, 4 ) ' is the same as DIM a( 2, 2, 4 )</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03104400.xhp b/helpcontent2/source/text/sbasic/shared/03104400.xhp new file mode 100644 index 000000000..541ce535b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104400.xhp @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03104400xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">HasUnoInterfaces Function</title> +<filename>/text/sbasic/shared/03104400.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="hasunointerfaces"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149987"><bookmark_value>HasUnoInterfaces function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3149987" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03104400.xhp" name="HasUnoInterfaces Function">HasUnoInterfaces Function</link></paragraph> +<paragraph role="paragraph" id="par_id3151262" xml-lang="en-US">Tests if a Basic Uno object supports certain Uno interfaces.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3154232" xml-lang="en-US">Returns True, if <emph>all</emph> stated Uno interfaces are supported, otherwise False is returned.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="code" id="par_id3155555" xml-lang="en-US">HasUnoInterfaces( oTest, Uno-Interface-Name 1 [, Uno-Interface-Name 2, ...])</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" localize="false" id="par_id3148538">Bool</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US"> +<emph>oTest:</emph> the Basic Uno object that you want to test.</paragraph> +<paragraph role="paragraph" id="par_id3149236" xml-lang="en-US"> +<emph>Uno-Interface-Name:</emph> list of Uno interface names.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" localize="false" id="par_id3149580" xml-lang="en-US">bHas = HasUnoInterfaces( oTest, "com.sun.star.beans.XIntrospection" )</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03104500.xhp b/helpcontent2/source/text/sbasic/shared/03104500.xhp new file mode 100644 index 000000000..49cd4588a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104500.xhp @@ -0,0 +1,63 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03104500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IsUnoStruct Function</title> + <filename>/text/sbasic/shared/03104500.xhp</filename> + </topic> +</meta> +<body> +<section id="isunostruct"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3146117"> + <bookmark_value>IsUnoStruct function</bookmark_value> +</bookmark> +<paragraph id="hd_id3146117" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03104500.xhp" name="IsUnoStruct Function">IsUnoStruct Function</link></paragraph> +<paragraph id="par_id3146957" role="paragraph" xml-lang="en-US">Returns True if the given object is a Uno struct.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3155341" role="code" xml-lang="en-US">IsUnoStruct( Uno type )</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3145315" localize="false" role="paragraph">Boolean</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3148947" role="paragraph" xml-lang="en-US">Uno type : A UnoObject</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341578272" role="bascode" localize="false" xml-lang="en-US">Sub Main</paragraph> +<paragraph id="par_idm1341577040" role="bascode" localize="false" xml-lang="en-US">Dim bIsStruct</paragraph> +<paragraph id="par_idN10638" role="bascode" xml-lang="en-US">' Instantiate a service</paragraph> +<paragraph id="par_idm1341574576" role="bascode" localize="false" xml-lang="en-US">Dim oSimpleFileAccess</paragraph> +<paragraph id="par_idm1341573344" role="bascode" localize="false" xml-lang="en-US">oSimpleFileAccess = CreateUnoService( "com.sun.star.ucb.SimpleFileAccess" )</paragraph> +<paragraph id="par_idm1341572048" role="bascode" localize="false" xml-lang="en-US">bIsStruct = IsUnoStruct( oSimpleFileAccess )</paragraph> +<paragraph id="par_idN10644" role="bascode" xml-lang="en-US">MsgBox bIsStruct ' Displays False because oSimpleFileAccess Is NO struct</paragraph> +<paragraph id="par_idN10649" role="bascode" xml-lang="en-US">' Instantiate a Property struct</paragraph> +<paragraph id="par_idm1341568240" role="bascode" localize="false" xml-lang="en-US">Dim aProperty As New com.sun.star.beans.Property</paragraph> +<paragraph id="par_idm1341566976" role="bascode" localize="false" xml-lang="en-US">bIsStruct = IsUnoStruct( aProperty )</paragraph> +<paragraph id="par_idN10653" role="bascode" xml-lang="en-US">MsgBox bIsStruct ' Displays True because aProperty is a struct</paragraph> +<paragraph id="par_idm1341564448" role="bascode" localize="false" xml-lang="en-US">bIsStruct = IsUnoStruct( 42 )</paragraph> +<paragraph id="par_idN1065B" role="bascode" xml-lang="en-US">MsgBox bIsStruct ' Displays False because 42 is NO struct</paragraph> +<paragraph id="par_idm1341561920" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03104600.xhp b/helpcontent2/source/text/sbasic/shared/03104600.xhp new file mode 100644 index 000000000..891421b50 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104600.xhp @@ -0,0 +1,70 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="textsbasicshared03104600xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">EqualUnoObjects Function</title> + <filename>/text/sbasic/shared/03104600.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> +</meta> + +<body> + <section id="equalunoobjects"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3149205"> + <bookmark_value>EqualUnoObjects function</bookmark_value> + </bookmark> + <h1 id="hd_id791633472607429"><variable id="EqualUnoObjects_h1"><link href="text/sbasic/shared/03104600.xhp" name="EqualUnoObjects Function">EqualUnoObjects Function</link></variable></h1> + <paragraph role="paragraph" id="par_id3145090">Returns <emph>True</emph> if the two specified Basic variables represent the same Uno object instance.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711633530276845"> + <input>EqualUnoObjects(oObj1, oObj2)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id61633530293311"><emph>oObj1, oObj2:</emph> the variables to be tested.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id3154285">Bool</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id771633473462939">The example below returns <emph>True</emph> because both <literal>oDoc</literal> and <literal>ThisComponent</literal> are references to the same object:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id981633473836933">Dim oDoc as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941633473837598">oDoc = ThisComponent</paragraph> + <paragraph role="bascode" localize="false" id="par_id3150541">MsgBox EqualUnoObjects(oDoc, ThisComponent) ' True</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id181633473874216">The example below returns <emph>False</emph> because the assignment creates a copy of the original object. Hence <literal>Struct1</literal> and <literal>Struct2</literal> refer to different object instances.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id441633474052121">Dim Struct1 as new com.sun.star.beans.PropertyValue</paragraph> + <paragraph role="bascode" localize="false" id="bas_id191633474052633">Dim Struct2 as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201633474052866">Struct1.Name = "John"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id761633474053090">Struct2 = Struct1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251633474053313">MsgBox EqualUnoObjects(Struct1, Struct2) ' False</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441633474053530">Struct2.Name = "Judy"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id611633474053754">MsgBox Struct1.Name ' John</paragraph> + <paragraph role="bascode" localize="false" id="bas_id251633474053977">MsgBox Struct2.Name ' Judy</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03102800.xhp#IsObject_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03104700.xhp b/helpcontent2/source/text/sbasic/shared/03104700.xhp new file mode 100644 index 000000000..968cac313 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03104700.xhp @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> + <topic id="textsbasicshared03104700xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Erase Statement</title> + <filename>/text/sbasic/shared/03104700.xhp</filename> + </topic> + <history><created date="2005-04-25T14:43:31">Erase</created></history> +</meta> + +<body> + +<section id="erase"> +<bookmark xml-lang="en-US" branch="index" id="bm_id624713"><bookmark_value>Erase statement</bookmark_value> +</bookmark> +<paragraph role="heading" id="par_idN10548" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03104700.xhp">Erase Statement</link></paragraph> +<paragraph role="paragraph" id="par_idN10558" xml-lang="en-US">Erases the contents of array elements of fixed size arrays, and releases the memory used by arrays of variable size.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="image" id="par_id831588865616326"><image src="media/helpimg/sbasic/Erase_statement.svg" id="img_id651588865616326"><alt id="alt_id281588865616326">Erase syntax</alt></image></paragraph> +<bascode> + <paragraph role="bascode" id="par_idN105E6" xml-lang="en-US">Erase array1 [, array2 [,...]]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_idN105ED" xml-lang="en-US"><emph>array list</emph> - A comma delimited list of arrays to be erased.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" id="bas_id551588866531991" localize="false">Sub Erase_Example</paragraph> + <paragraph role="bascode" id="bas_id941588866552486" localize="false"> a = Array(1,2,3) : b= Array("z","y","x") : c=Array(a,b)</paragraph> + <paragraph role="bascode" id="bas_id821588866562452" xml-lang="en-US"> Erase a, c(Ubound(c)) ' b and c(0) are unchanged</paragraph> + <paragraph role="bascode" id="bas_id701588866563382" xml-lang="en-US"> Erase b, c(0) ' everything gets cleared</paragraph> + <paragraph role="bascode" id="bas_id691588866563757" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161588865796615"><link href="text/sbasic/shared/03102100.xhp" name="Dim statement">Dim</link> or <link href="text/sbasic/shared/03102101.xhp" name="ReDim statement">ReDim</link> statements</paragraph> + <paragraph role="paragraph" id="par_id281588865818334"><link href="text/sbasic/shared/03104200.xhp" name="Array function">Array</link> or <link href="text/sbasic/shared/03104300.xhp" name="DimArray function">DimArray</link> functions</paragraph> + <paragraph role="paragraph" id="par_id761588867124078"><link href="text/sbasic/shared/03102900.xhp" name="lower bound function">Lbound</link> and <link href="text/sbasic/shared/03103000.xhp" name="upper bound function">Ubound</link> functions</paragraph> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03110100.xhp b/helpcontent2/source/text/sbasic/shared/03110100.xhp new file mode 100644 index 000000000..801ba423a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03110100.xhp @@ -0,0 +1,85 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03110100xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Comparison Operators</title> + <filename>/text/sbasic/shared/03110100.xhp</filename> + </topic> +</meta> + +<body> + +<section id="operators"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150682"> + <bookmark_value>comparison operators;%PRODUCTNAME Basic</bookmark_value> + <bookmark_value>Operators;comparison</bookmark_value> + <bookmark_value>Operators;equal sign (=)</bookmark_value> + <bookmark_value>Operators;greater than (>)</bookmark_value> + <bookmark_value>Operators;greater than or equal to (>=)</bookmark_value> + <bookmark_value>Operators;less than (<)</bookmark_value> + <bookmark_value>Operators;less than or equal to (<=)</bookmark_value> + <bookmark_value>Operators;not equal to (<>)</bookmark_value> +</bookmark> + +<h1 id="hd_id3150682"><variable id="CompOper_h1"><link href="text/sbasic/shared/03110100.xhp" name="Comparison Operators">Comparison Operators</link></variable></h1> +<paragraph id="par_id3156042" role="paragraph" xml-lang="en-US">Comparison operators compare two expressions. The result is returned as a boolean expression that determines if the comparison is <literal>True</literal> (-1) or <literal>False</literal> (0).</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph id="par_id3149177" role="bascode" localize="false">result = expression1 { = | < | > | <= | >= } expression2</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3147573" role="paragraph" xml-lang="en-US"> <emph>result</emph>: Boolean that specifies the result of the comparison (<literal>True</literal>, or <literal>False</literal>)</paragraph> +<paragraph id="par_id3148686" role="paragraph" xml-lang="en-US"> <emph>expression1, expression2</emph>: Any numeric values or strings that you want to compare.</paragraph> + +<paragraph id="hd_id3147531" role="heading" level="2" xml-lang="en-US">Comparison operators</paragraph> +<paragraph id="par_id3147265" role="paragraph" xml-lang="en-US">= : Equal to</paragraph> +<paragraph id="par_id3154924" role="paragraph" xml-lang="en-US">< : Less than</paragraph> +<paragraph id="par_id3146795" role="paragraph" xml-lang="en-US">> : Greater than</paragraph> +<paragraph id="par_id3150541" role="paragraph" xml-lang="en-US"><= : Less than or equal to</paragraph> +<paragraph id="par_id3150400" role="paragraph" xml-lang="en-US">>= : Greater than or equal to</paragraph> +<paragraph id="par_id3148797" role="paragraph" xml-lang="en-US"><> : Not equal to</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341075248" role="bascode" localize="false">Sub ExampleUnequal</paragraph> +<paragraph id="par_idm1341074016" role="bascode" localize="false">Dim sFile As String</paragraph> +<paragraph id="par_id3154909" role="bascode" xml-lang="en-US">Dim sRoot As String ' Root directory for file in and output</paragraph> +<paragraph id="par_idm1341071024" role="bascode" localize="false"> sRoot = "c:\"</paragraph> +<paragraph id="par_idm1341069792" role="bascode" localize="false"> sFile = Dir$( sRoot ,22)</paragraph> +<paragraph id="par_idm1341068544" role="bascode" localize="false"> If sFile <> "" Then</paragraph> +<paragraph id="par_idm1341067296" role="bascode" localize="false"> Do</paragraph> +<paragraph id="par_idm1341066064" role="bascode" localize="false"> MsgBox sFile</paragraph> +<paragraph id="par_idm1341064816" role="bascode" localize="false"> sFile = Dir$</paragraph> +<paragraph id="par_idm1341063568" role="bascode" localize="false"> Loop Until sFile = ""</paragraph> +<paragraph id="par_idm1341062320" role="bascode" localize="false"> End If</paragraph> +<paragraph id="par_idm1341061088" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03070000.xhp#MathOper_h1"/> + <embed href="text/sbasic/shared/03060000.xhp#BoolOper_h1"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120000.xhp b/helpcontent2/source/text/sbasic/shared/03120000.xhp new file mode 100644 index 000000000..8709a9a24 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120000.xhp @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120000xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Strings</title> +<filename>/text/sbasic/shared/03120000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="strings"> + <paragraph id="hd_id3156153" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120000.xhp" name="Strings">Strings</link></paragraph> + <paragraph role="paragraph" id="par_id3159176" xml-lang="en-US">The following functions and statements validate and return strings.</paragraph> + </section> + <paragraph role="paragraph" id="par_id3154285" xml-lang="en-US">You can use strings to edit text within $[officename] Basic programs.</paragraph> + <embed href="text/sbasic/shared/03120100.xhp#ascii"/> + <embed href="text/sbasic/shared/03120200.xhp#repeating_contents"/> + <embed href="text/sbasic/shared/03120300.xhp#manipu"/> + <embed href="text/sbasic/shared/03120400.xhp#determine"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120100.xhp b/helpcontent2/source/text/sbasic/shared/03120100.xhp new file mode 100644 index 000000000..dccf9aeb6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120100.xhp @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120100xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">ASCII/ANSI Conversion in Strings</title> +<filename>/text/sbasic/shared/03120100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="ascii"> + <paragraph id="hd_id3147443" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120100.xhp" name="ASCII/ANSI Conversion in Strings">ASCII/ANSI Conversion in Strings</link></paragraph> + <paragraph role="paragraph" id="par_id3159201" xml-lang="en-US">The following functions convert strings to and from ASCII or ANSI code.</paragraph> + </section> + <embed href="text/sbasic/shared/03120101.xhp#asc"/> + <embed href="text/sbasic/shared/03120102.xhp#chr"/> + <embed href="text/sbasic/shared/03120103.xhp#str"/> + <embed href="text/sbasic/shared/03120104.xhp#val"/> + <embed href="text/sbasic/shared/03120105.xhp#cbyte"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120101.xhp b/helpcontent2/source/text/sbasic/shared/03120101.xhp new file mode 100644 index 000000000..deb1b1baf --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120101.xhp @@ -0,0 +1,69 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120101xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Asc Function</title> + <filename>/text/sbasic/shared/03120101.xhp</filename> + </topic> +</meta> + +<body> + +<section id="asc"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>Asc function</bookmark_value> +</bookmark> + +<h1 id="hd_id3150499"><variable id="Asc_h1"><link href="text/sbasic/shared/03120101.xhp" name="Asc Function">Asc Function (BASIC)</link></variable></h1> +<paragraph id="par_id3151384" role="paragraph">Returns the ASCII (American Standard Code for Information Interchange) value of the first character in a string expression.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" xml-lang="en-US">Asc(string) As Long</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Long</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3149415" role="paragraph" xml-lang="en-US"><emph>string</emph>: Any valid string expression. Only the first character in the string is relevant.</paragraph> +<paragraph id="par_id3145609" role="paragraph" xml-lang="en-US">Use the Asc function to replace keys with values. If the Asc function encounters a blank string, $[officename] Basic reports a run-time error. In addition to 7 bit ASCII characters (Codes 0-127), the ASCII function can also detect non-printable key codes in ASCII code. This function can also handle 16 bit unicode characters.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341586960" role="bascode" localize="false" xml-lang="en-US">Sub ExampleASC</paragraph> +<paragraph id="par_id3150792" role="bascode" xml-lang="en-US"> Print ASC("A") ' returns 65</paragraph> +<paragraph id="par_id3148797" role="bascode" xml-lang="en-US"> Print ASC(string:="Z") ' returns 90</paragraph> +<paragraph id="par_id3163800" role="bascode" xml-lang="en-US"> Print ASC("Las Vegas") ' returns 76, since only the first character is taken into account</paragraph> +<paragraph id="par_idm1341580480" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03120111.xhp#AscW_h1"/> + <embed href="text/sbasic/shared/03120102.xhp#Chr_h1"/> + <embed href="text/sbasic/shared/03120112.xhp#ChrW_h1"/> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120102.xhp b/helpcontent2/source/text/sbasic/shared/03120102.xhp new file mode 100644 index 000000000..e0329d570 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120102.xhp @@ -0,0 +1,74 @@ +<?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/. +* +* This file incorporates work covered by the following license notice: +* +* Licensed to the Apache Software Foundation (ASF) under one or more +* contributor license agreements. See the NOTICE file distributed +* with this work for additional information regarding copyright +* ownership. The ASF licenses this file to you under the Apache +* License, Version 2.0 (the "License"); you may not use this file +* except in compliance with the License. You may obtain a copy of +* the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120102xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Chr Function</title> + <filename>/text/sbasic/shared/03120102.xhp</filename> + </topic> +</meta> + +<body> + <section id="chr"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3149205"> + <bookmark_value>Chr function</bookmark_value> + </bookmark> + <h1 id="hd_id3149205"><variable id="Chr_h1"><link href="text/sbasic/shared/03120102.xhp" name="Chr Function">Chr Function</link></variable></h1> + <paragraph id="par_id3153311" role="paragraph">Returns the character that corresponds to the specified character code.</paragraph> + </section> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph role="bascode" id="bas_id91642668171601">Chr[$](charcode As Integer) As String</paragraph> + </bascode> + + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3153824" role="paragraph" localize="false" xml-lang="en-US">String</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id3149295" role="paragraph" xml-lang="en-US"><emph>charcode</emph>: a numeric expression that represents a valid 8-bit ASCII value (0-255) or a 16-bit Unicode value. (To support expressions with a nominally negative argument like <emph>Chr(&H8000)</emph> in a backwards-compatible way, values in the range −32768 to −1 are internally mapped to the range 32768 to 65535.)</paragraph> + + <warning id="par_id991552913928635">When VBA compatibility mode is enabled (<link href="text/sbasic/shared/03103350.xhp" name="vbasupport"><literal>Option VBASupport 1</literal></link>), <literal>charcode</literal> is a numeric expression that represents a valid 8-bit ASCII value (0-255) only.</warning> + + <paragraph id="par_id3159414" role="paragraph" xml-lang="en-US">Use the <emph>Chr$</emph> function to send special control sequences to a printer or to another output source. You can also use it to insert quotation marks in a string expression.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#err6"/> + <note id="par_id81634652871848">An overflow error will occur when VBA compatibility mode is enabled and the expression value is greater than 255.</note> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_idm1341138080" role="bascode" localize="false">Sub ExampleChr</paragraph> + <paragraph id="par_id3154909" role="bascode" xml-lang="en-US"> ' This example inserts quotation marks (ASCII value 34) in a string.</paragraph> + <paragraph id="par_id3151380" role="bascode" xml-lang="en-US"> MsgBox "A " + Chr$(34) + "short" + Chr(34) + " trip."</paragraph> + <paragraph id="par_id3145174" role="bascode" xml-lang="en-US"> ' The printout appears in the dialog as: A "short" trip.</paragraph> + <paragraph role="bascode" id="bas_id481642668824226" xml-lang="en-US"> MsgBox Chr(charcode := 64) ' "@" sign</paragraph> + <paragraph id="par_idm1341131568" role="bascode" localize="false">End Sub</paragraph> + <paragraph role="bascode" id="bas_id661642668825250"></paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03120101.xhp#Asc_h1"/> + <embed href="text/sbasic/shared/03120111.xhp#AscW_h1"/> + <embed href="text/sbasic/shared/03120112.xhp#ChrW_h1"/> + </section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120103.xhp b/helpcontent2/source/text/sbasic/shared/03120103.xhp new file mode 100644 index 000000000..976c53e7e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120103.xhp @@ -0,0 +1,85 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120103xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Str Function</title> + <filename>/text/sbasic/shared/03120103.xhp</filename> + </topic> +</meta> + +<body> + <section id="str"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3143272"> + <bookmark_value>Str function</bookmark_value> + </bookmark> + <h1 id="hd_id3143272"><variable id="Str_h1"><link href="text/sbasic/shared/03120103.xhp" name="Str Function">Str Function</link></variable></h1> + <paragraph id="par_id3155100" role="paragraph">The <literal>Str</literal> function converts the contents of variables into a string. It handles numeric values, dates, strings and currency values.</paragraph> + <paragraph id="par_id3146958" role="paragraph">Positive numbers are preceded by a blank space. Negative numbers are preceded by a minus sign.</paragraph> + <note id="par_id331641237252390">For numeric values the string returned by the <literal>Str</literal> function is locale-independent. Hence the dot is used as the decimal separator when needed.</note> + <paragraph role="paragraph" id="par_id601641237849695">If a string is passed as argument, it is returned without any changes.</paragraph> + <paragraph role="paragraph" id="par_id231641251937406">Dates are converted into locale-dependent strings.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph id="par_id3149497" role="bascode">Str (Value As Variant)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3146117" localize="false" role="paragraph">String</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id3149178" role="paragraph"> <emph>Value:</emph> Any value to be converted into a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id401641251970766">Below are some numeric examples using the <literal>Str</literal> function.</paragraph> + <bascode> + <paragraph id="par_idm1341439760" role="bascode" localize="false">Sub ExampleStr_1</paragraph> + <paragraph role="bascode" id="bas_id831641238784987"> ' Note the blank space at the beginning of the returned strings</paragraph> + <paragraph id="par_idm1341438528" role="bascode" localize="false"> MsgBox Str(10) ' " 10"</paragraph> + <paragraph id="par_idm1341437296" role="bascode" localize="false"> MsgBox Str(10.5) ' " 10.5"</paragraph> + <paragraph id="par_idm1341436064" role="bascode" localize="false"> MsgBox Str(-12345 + 1.3) ' " -12346.3"</paragraph> + <paragraph id="par_idm1341434832" role="bascode" localize="false"> MsgBox Str(10000 / 3) ' " 3333.33333333333"</paragraph> + <paragraph role="bascode" id="bas_id991641238830710"> ' Strings passed as arguments are left unchanged</paragraph> + <paragraph id="par_idm1341433584" role="bascode" localize="false"> MsgBox Str("A123") ' "A123"</paragraph> + <paragraph id="par_idm1341432272" role="bascode" localize="false">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id601641238259787">Use the <literal>LTrim</literal> function to remove the blank space at the beginning of the returned string.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id521641238327633">Sub ExampleStr_2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211641238327951"> MsgBox Str(10.5) ' " 10.5"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id481641238328191"> MsgBox LTrim(Str(10.5)) ' "10.5"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id51641238328726">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id881641252036753">The <literal>Str</literal> function can also handle <literal>Date</literal> variables.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id781641252076979">Sub ExampleStr_3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id271641252077387"> Dim aDate as Date, aTime as Date</paragraph> + <paragraph role="bascode" localize="false" id="bas_id816412520776129"> aDate = DateSerial(2021, 12, 20)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id631641252077803"> aTime = TimeSerial(10, 20, 45)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id311641252078019"> Print Str(aDate) ' "12/20/2021"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id481641252230128"> Print Str(aTime) ' "10:20:45"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id481641252078235">End sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03120104.xhp#Val_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120104.xhp b/helpcontent2/source/text/sbasic/shared/03120104.xhp new file mode 100644 index 000000000..b83dc5625 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120104.xhp @@ -0,0 +1,65 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120104xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Val Function</title> + <filename>/text/sbasic/shared/03120104.xhp</filename> + </topic> +</meta> + +<body> + <section id="val"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3149205"> + <bookmark_value>Val function</bookmark_value> + </bookmark> + <h1 id="hd_id3149205"><variable id="Val_h1"><link href="text/sbasic/shared/03120104.xhp" name="Val Function">Val Function</link></variable></h1> + <paragraph id="par_id3153345" role="paragraph">Use the <literal>Val</literal> function to convert a string that represents a number into numeric data type.</paragraph> + <note id="par_id281641235880765">The string passed to the <literal>Val</literal> function is locale-independent. This means that commas are interpreted as thousands separators and a dot is used as the decimal separator.</note> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph id="par_id3149514" role="bascode">Val (Text As String)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3143228" role="paragraph">Double</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id3154348" role="paragraph"><emph>Text:</emph> String that represents a number.</paragraph> + <paragraph id="par_id3149670" role="paragraph">If only part of the string contains numbers, only the first appropriate characters of the string are converted. If the string does not contain any numbers then <literal>Val</literal> returns 0.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_idm1341084240" role="bascode" localize="false">Sub ExampleVal</paragraph> + <paragraph id="par_idm1341083008" role="bascode" localize="false"> MsgBox Val("123.1") + 1 ' 124.1</paragraph> + <paragraph role="bascode" id="bas_id131641236938068"> ' Below 123,1 is interpreted as 1231 since "," is the thousands separator</paragraph> + <paragraph id="par_idm1341083014" role="bascode" localize="false"> MsgBox Val("123,1") + 1 ' 1232</paragraph> + <paragraph role="bascode" id="bas_id681641252873197"> ' All numbers are considered until a non-numeric character is reached</paragraph> + <paragraph role="bascode" id="bas_id821641252904470" localize="false"> MsgBox Val("123.4A") ' 123.4</paragraph> + <paragraph role="bascode" id="bas_id911641237027667"> ' The example below returns 0 (zero) since the string provided does not start with a number</paragraph> + <paragraph id="par_idm1341081760" role="bascode" localize="false"> MsgBox Val("A123.123") ' 0</paragraph> + <paragraph id="par_idm1341080512" role="bascode" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03120103.xhp#Str_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120105.xhp b/helpcontent2/source/text/sbasic/shared/03120105.xhp new file mode 100644 index 000000000..e3f925c69 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120105.xhp @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120105xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">CByte Function</title> +<filename>/text/sbasic/shared/03120105.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="cbyte"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"><bookmark_value>CByte function</bookmark_value> +</bookmark> +<h1 id="hd_id3156027"><variable id="CByte_h1"><link href="text/sbasic/shared/03120105.xhp" name="CByte Function">CByte Function</link></variable></h1> +<paragraph role="paragraph" id="par_id3143267" xml-lang="en-US">Converts a string or a numeric expression to the <literal>Byte</literal> type.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_id3147573" xml-lang="en-US">Cbyte( expression As Variant) As Byte</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" localize="false" id="par_id3148473">Byte</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3145068" xml-lang="en-US"> +<emph>Expression</emph>: Any string or a numeric expression that can be evaluated to a number. Decimal values are rounded to the nearest tenth. Valid values range from 0 to 256.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err6"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> + +<bascode> + <paragraph role="bascode" id="bas_id481637749236603" localize="false">Sub CByte_example</paragraph> + <paragraph role="bascode" id="bas_id301637749237580" localize="false"> Print CByte( expression := "17"/2 + 7.44), CByte(EMPTY), CByte(PI)</paragraph> + <paragraph role="bascode" id="bas_id941637751110886" xml-lang="en-US"> ' Above expressions are computed as 16, 0 and 3</paragraph> + <paragraph role="bascode" id="bas_id771637749238365" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03100100.xhp#CBool_h1"/> + <embed href="text/sbasic/shared/03100050.xhp#CCur_h1"/> +<!-- WiP + <embed href="text/sbasic/shared/03100300.xhp#CDate_h1"/> + <embed href="text/sbasic/shared/03100400.xhp#CDbl_h1"/> + <embed href="text/sbasic/shared/03100060.xhp#CDec_h1"/> + <embed href="text/sbasic/shared/03100500.xhp#CInt_h1"/> + <embed href="text/sbasic/shared/03100600.xhp#CLng_h1"/> + <embed href="text/sbasic/shared/03100900.xhp#CSng_h1"/> + <embed href="text/sbasic/shared/03101000.xhp#CStr_h1"/> +--> +</section> + + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120111.xhp b/helpcontent2/source/text/sbasic/shared/03120111.xhp new file mode 100644 index 000000000..fe6d22493 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120111.xhp @@ -0,0 +1,68 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120101xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">AscW Function</title> + <filename>/text/sbasic/shared/03120111.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ascw"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>AscW function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3150499"><variable id="AscW_h1"><link href="text/sbasic/shared/03120111.xhp" name="AscW Function [VBA]">AscW Function [VBA]</link></variable></h1> +<paragraph id="par_id3151384" role="paragraph">Returns the Unicode value of the first character in a string expression.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">AscW (string) As Long</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Long</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3149415" role="paragraph" xml-lang="en-US"> <emph>string</emph>: Any valid string expression. Only the first character in the string is relevant.</paragraph> +<paragraph id="par_id3145609" role="paragraph" xml-lang="en-US">Use the AscW function to replace keys with Unicode values. If the AscW function encounters a blank string, %PRODUCTNAME Basic reports a run-time error. Returned values are between 0 and 65535.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341586960" role="bascode" localize="false" xml-lang="en-US">Sub ExampleAscW</paragraph> +<paragraph id="par_id3150792" role="bascode" xml-lang="en-US"> Print AscW("A") ' returns 65</paragraph> +<paragraph id="par_id3148797" role="bascode" xml-lang="en-US"> Print AscW(string:="Ω") ' returns 937</paragraph> +<paragraph id="par_id3163800" role="bascode" xml-lang="en-US"> Print AscW("Αθήνα") ' returns 913, since only the first character (Alpha) is taken into account</paragraph> +<paragraph id="par_idm1341580480" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03120101.xhp#Asc_h1"/> + <embed href="text/sbasic/shared/03120102.xhp#Chr_h1"/> + <embed href="text/sbasic/shared/03120112.xhp#ChrW_h1"/> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120112.xhp b/helpcontent2/source/text/sbasic/shared/03120112.xhp new file mode 100644 index 000000000..e1eba0429 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120112.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120102xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ChrW Function [VBA]</title> + <filename>/text/sbasic/shared/03120112.xhp</filename> + </topic> +</meta> + +<body> + +<section id="chrw"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149205"> + <bookmark_value>ChrW function</bookmark_value> +</bookmark> + +<h1 id="hd_id3149205"><variable id="ChrW_h1"><link href="text/sbasic/shared/03120112.xhp" name="ChrW Function">ChrW Function [VBA]</link></variable></h1> +<paragraph id="par_id3153311" role="paragraph">Returns the Unicode character that corresponds to the specified character code.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3150669" role="bascode" localize="false">ChrW(charcode As Integer) As String</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3153824" role="paragraph" xml-lang="en-US">String</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3149295" role="paragraph" xml-lang="en-US"> <emph>charcode</emph>: Numeric expression that represent a valid 16 bit Unicode value (0-65535). (To support expressions with a nominally negative argument like <emph>ChrW(&H8000)</emph> in a backwards-compatible way, values in the range −32768 to −1 are internally mapped to the range 32768 to 65535.) An empty value returns error code 5. A value out of the range [0 to 65535] returns error code 6.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err6"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341138080" role="bascode" localize="false">Sub ExampleChrW</paragraph> +<paragraph id="par_id3154909" role="bascode" xml-lang="en-US"> ' This example inserts the Greek letters alpha and omega in a string.</paragraph> +<paragraph id="par_id3151380" role="bascode" xml-lang="en-US"> MsgBox "From " + ChrW(913) + " to " + ChrW(937)</paragraph> +<paragraph id="par_id3145174" role="bascode" xml-lang="en-US"> ' The printout appears in the dialog as: From Α to Ω</paragraph> +<paragraph role="bascode" id="bas_id181642669411658" xml-lang="en-US"> MsgBox ChrW(charcode := 116) ' "t" lowercase T letter</paragraph> +<paragraph id="par_idm1341131568" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03120101.xhp#Asc_h1"/> + <embed href="text/sbasic/shared/03120111.xhp#AscW_h1"/> + <embed href="text/sbasic/shared/03120102.xhp#Chr_h1"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120200.xhp b/helpcontent2/source/text/sbasic/shared/03120200.xhp new file mode 100644 index 000000000..2a432da70 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120200.xhp @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120200xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Repeating Contents</title> +<filename>/text/sbasic/shared/03120200.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="repeating_contents"> + <paragraph id="hd_id3152363" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120200.xhp" name="Repeating Contents">Repeating Contents</link></paragraph> + <paragraph role="paragraph" id="par_id3150178" xml-lang="en-US">The following functions repeat the contents of strings.</paragraph> + </section> + <embed href="text/sbasic/shared/03120201.xhp#space"/> + <embed href="text/sbasic/shared/03120202.xhp#string"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120201.xhp b/helpcontent2/source/text/sbasic/shared/03120201.xhp new file mode 100644 index 000000000..9b60756d9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120201.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120201xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Space and Spc Function</title> + <filename>/text/sbasic/shared/03120201.xhp</filename> + </topic> +</meta> + +<body> + +<section id="space"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>Space function</bookmark_value> + <bookmark_value>Spc function</bookmark_value> +</bookmark> + +<h1 id="hd_id3150499"><link href="text/sbasic/shared/03120201.xhp" name="Space Function">Space and Spc Functions</link></h1> +<paragraph id="par_id3154927" role="paragraph" xml-lang="en-US">Returns a string that consists of a specified amount of spaces.</paragraph> +</section> +<note id="par_id681546202842979">The Spc function works the same as the Space function.</note> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + +<paragraph id="par_id3143267" role="code" localize="false">Space (n As Long)<br/></paragraph> +<paragraph role="code" id="par_id631546202894380" localize="false">Spc (n As Long)</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3149233" role="paragraph" xml-lang="en-US">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3143228" role="paragraph" xml-lang="en-US"> <emph>n:</emph> Numeric expression that defines the number of spaces in the string. The maximum allowed value of <emph>n</emph> is 2,147,483,648.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341576672" role="bascode" localize="false">Sub ExampleSpace</paragraph> +<paragraph id="par_idm1341575440" role="bascode" localize="false">Dim sText As String, sOut As String</paragraph> +<paragraph id="par_idm1341574192" role="bascode" localize="false">Dim iLen As Integer</paragraph> +<paragraph id="par_idm1341572960" role="bascode" localize="false"> iLen = 10</paragraph> +<paragraph id="par_idm1341571728" role="bascode" localize="false"> sText = "Las Vegas"</paragraph> +<paragraph id="par_idm1341570496" role="bascode" localize="false"> sOut = sText & Space(iLen) & sText & Chr(13) &_</paragraph> +<paragraph id="par_idm1341569184" role="bascode" localize="false"> sText & Space(iLen*2) & sText & Chr(13) &_</paragraph> +<paragraph id="par_idm1341567888" role="bascode" localize="false"> sText & Space(iLen*4) & sText & Chr(13)</paragraph> +<paragraph id="par_id3154216" role="bascode"> MsgBox sOut,0,"Info:"</paragraph> +<paragraph id="par_idm1341564864" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120202.xhp b/helpcontent2/source/text/sbasic/shared/03120202.xhp new file mode 100644 index 000000000..9a09d81a3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120202.xhp @@ -0,0 +1,68 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120202xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">String Function</title> + <filename>/text/sbasic/shared/03120202.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="string"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147291"> + <bookmark_value>String function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3147291"><variable id="String_h1"><link href="text/sbasic/shared/03120202.xhp" name="String Function">String Function</link></variable></h1> +<paragraph id="par_id3147242" role="paragraph" xml-lang="en-US">Creates a string according to the specified character, or the first character of a string expression that is passed to the function.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3149233" role="bascode" xml-lang="en-US">String (n As Long, {expression As Integer | character As String})</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3147530" role="paragraph" xml-lang="en-US">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3154347" role="paragraph" xml-lang="en-US"> <emph>n:</emph> Numeric expression that indicates the number of characters to return in the string. The maximum allowed value of n is 2,147,483,648.</paragraph> +<paragraph id="par_id3148664" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Numeric expression that defines the ASCII code for the character.</paragraph> +<paragraph id="par_id3150359" role="paragraph" xml-lang="en-US"> <emph>Character:</emph> Any single character used to build the return string, or any string of which only the first character will be used.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340924160" role="bascode" localize="false" xml-lang="en-US">Sub ExampleString</paragraph> +<paragraph id="par_idm1340922928" role="bascode" localize="false" xml-lang="en-US">Dim sText As String</paragraph> +<paragraph id="par_idm1340921696" role="bascode" localize="false" xml-lang="en-US"> sText = String(10,"A")</paragraph> +<paragraph id="par_idm1340920448" role="bascode" localize="false" xml-lang="en-US"> MsgBox sText</paragraph> +<paragraph id="par_idm1340919216" role="bascode" localize="false" xml-lang="en-US"> sText = String(10,65)</paragraph> +<paragraph id="par_idm1340917968" role="bascode" localize="false" xml-lang="en-US"> MsgBox sText</paragraph> +<paragraph id="par_idm1340916736" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120300.xhp b/helpcontent2/source/text/sbasic/shared/03120300.xhp new file mode 100644 index 000000000..cc9697f29 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120300.xhp @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120300xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Editing String Contents</title> +<filename>/text/sbasic/shared/03120300.xhp</filename> +</topic> +</meta> +<body> +<section id="manipu"> +<paragraph role="heading" id="hd_id3153894" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03120300.xhp" name="Editing String Contents">Editing String Contents</link></paragraph> +<paragraph role="paragraph" id="par_id3149178" xml-lang="en-US">The following functions edit, format, and align the contents of strings. Use the <literal>&</literal> or <literal>+</literal> operators to concatenate strings.</paragraph> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150669"> + <bookmark_value>ampersand symbol; in string handling</bookmark_value> + <bookmark_value>Operators;concatenation (& or +)</bookmark_value> + <bookmark_value>"& or +" concatenation (strings)</bookmark_value> +</bookmark> +</section> +<embed href="text/sbasic/shared/03120301.xhp#format"/> +<embed href="text/sbasic/shared/03120302.xhp#lcase"/> +<embed href="text/sbasic/shared/03120303.xhp#left"/> +<embed href="text/sbasic/shared/03120304.xhp#lset"/> +<embed href="text/sbasic/shared/03120305.xhp#ltrim"/> +<embed href="text/sbasic/shared/03120306.xhp#mid"/> +<embed href="text/sbasic/shared/replace.xhp#replace"/> +<embed href="text/sbasic/shared/03120307.xhp#right"/> +<embed href="text/sbasic/shared/03120308.xhp#rset"/> +<embed href="text/sbasic/shared/03120309.xhp#rtrim"/> +<embed href="text/sbasic/shared/03120311.xhp#trim"/> +<embed href="text/sbasic/shared/03120310.xhp#ucase"/> +<embed href="text/sbasic/shared/03120314.xhp#split"/> +<embed href="text/sbasic/shared/03120315.xhp#join"/> +<embed href="text/sbasic/shared/03120312.xhp#converttourl"/> +<embed href="text/sbasic/shared/03120313.xhp#convertfromurl"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120301.xhp b/helpcontent2/source/text/sbasic/shared/03120301.xhp new file mode 100644 index 000000000..48f9e0b85 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120301.xhp @@ -0,0 +1,108 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120301xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Format Function</title> + <filename>/text/sbasic/shared/03120301.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="format"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153539"> + <bookmark_value>Format function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3153539"><link href="text/sbasic/shared/03120301.xhp" name="Format Function">Format Function</link></h1> +<paragraph id="par_id3156042" role="paragraph" xml-lang="en-US">Converts a numeric expression to a string, and then formats it according to the format that you specify.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3153527" role="bascode" xml-lang="en-US">Format(expression [, format As String]) As String</paragraph> +</bascode> + +<section id="ValueParms"> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3149415" role="paragraph" xml-lang="en-US"> <emph>expression</emph>: Numeric expression that you want to convert to a formatted string.</paragraph> +<paragraph id="par_id3147531" role="paragraph" xml-lang="en-US"> <emph>format</emph>: String that specifies the format code for the number. If <literal>format</literal> is omitted, the Format function works like the %PRODUCTNAME Basic <literal>Str()</literal> function.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3148474" role="paragraph" xml-lang="en-US">Text string.</paragraph> +</section> + +<h2 id="hd_id3147561">Formatting Codes</h2> +<section id="codes"> +<paragraph id="par_id3147265" role="paragraph" xml-lang="en-US">The following list describes the codes that you can use for formatting a numeric expression:</paragraph> +<paragraph id="par_id3153380" role="paragraph" xml-lang="en-US"> <emph>0:</emph> If <literal>expression</literal> has a digit at the position of the 0 in the <literal>format</literal> code, the digit is displayed, otherwise a zero is displayed.</paragraph> +<paragraph id="par_id3151210" role="paragraph" xml-lang="en-US">If <literal>expression</literal> has fewer digits than the number of zeros in the <literal>format</literal> code, (on either side of the decimal), leading or trailing zeros are displayed. If the <literal>expression</literal> has more digits to the left of the decimal separator than the amount of zeros in the <literal>format</literal> code, the additional digits are displayed without formatting.</paragraph> +<paragraph id="par_id3151176" role="paragraph" xml-lang="en-US">Decimal places in the <literal>expression</literal> are rounded according to the number of zeros that appear after the decimal separator in the <literal>format</literal> code.</paragraph> +<paragraph id="par_id3154123" role="paragraph" xml-lang="en-US"> <emph>#:</emph> If <literal>expression</literal> contains a digit at the position of the # placeholder in the <literal>format</literal> code, the digit is displayed, otherwise nothing is displayed at this position.</paragraph> +<paragraph id="par_id3148452" role="paragraph" xml-lang="en-US">This symbol works like the 0, except that leading or trailing zeroes are not displayed if there are more # characters in the <literal>format</literal> code than digits in the <literal>expression</literal>. Only the relevant digits of the <literal>expression</literal> are displayed.</paragraph> +<paragraph id="par_id3159150" role="paragraph" xml-lang="en-US"> <emph>.:</emph> The decimal placeholder determines the number of decimal places to the left and right of the decimal separator.</paragraph> +<paragraph id="par_id3159252" role="paragraph" xml-lang="en-US">If the <literal>format</literal> code contains only # placeholders to the left of this symbol, numbers less than 1 begin with a decimal separator. To always display a leading zero with fractional numbers, use 0 as a placeholder for the first digit to the left of the decimal separator.</paragraph> +<paragraph id="par_id3153368" role="paragraph" xml-lang="en-US"> <emph>%:</emph> Multiplies the <literal>expression</literal>by 100 and inserts the percent sign (%) where the <literal>expression</literal> appears in the <literal>format</literal> code.</paragraph> +<paragraph id="par_id3149481" role="paragraph" xml-lang="en-US"> <emph>E- E+ e- e+ :</emph> If the <literal>format</literal> code contains at least one digit placeholder (0 or #) to the right of the symbol E-, E+, e-, or e+, the <literal>expression</literal> is formatted in the scientific or exponential format. The letter E or e is inserted between the number and the exponent. The number of placeholders for digits to the right of the symbol determines the number of digits in the exponent.</paragraph> +<paragraph id="par_id3149262" role="paragraph" xml-lang="en-US">If the exponent is negative, a minus sign is displayed directly before an exponent with E-, E+, e-, e+. If the exponent is positive, a plus sign is only displayed before exponents with E+ or e+.</paragraph> +<paragraph id="par_id3148617" role="paragraph" xml-lang="en-US">The thousands delimiter is displayed if the <literal>format</literal> code contains the delimiter enclosed by digit placeholders (0 or #).</paragraph> +<paragraph id="par_id3163713" role="paragraph" xml-lang="en-US">The use of a period as a thousands and decimal separator is dependent on the regional setting. When you enter a number directly in Basic source code, always use a period as decimal delimiter. The actual character displayed as a decimal separator depends on the number format in your system settings.</paragraph> +<paragraph id="par_id3152887" role="paragraph" xml-lang="en-US"> <emph>- + $ ( ) space:</emph> A plus (+), minus (-), dollar ($), space, or brackets entered directly in the <literal>format</literal> code is displayed as a literal character.</paragraph> +<paragraph id="par_id3148576" role="paragraph" xml-lang="en-US">To display characters other than the ones listed here, you must precede it by a backslash (\), or enclose it in quotation marks (" ").</paragraph> +<paragraph id="par_id3153139" role="paragraph" xml-lang="en-US"> <emph>\ :</emph> The backslash displays the next character in the <literal>format</literal> code.</paragraph> +<paragraph id="par_id3153366" role="paragraph" xml-lang="en-US">Characters in the <literal>format</literal> code that have a special meaning can only be displayed as literal characters if they are preceded by a backslash. The backslash itself is not displayed, unless you enter a double backslash (\\) in the format code.</paragraph> +<paragraph id="par_id3155411" role="paragraph" xml-lang="en-US">Characters that must be preceded by a backslash in the format code in order to be displayed as literal characters are date- and time-formatting characters (a, c, d, h, m, n, p, q, s, t, w, y, /, :), numeric-formatting characters (#, 0, %, E, e, comma, period), and string-formatting characters (@, &, <, >, !).</paragraph> +<paragraph id="par_id3145749" role="paragraph" xml-lang="en-US">You can also use the following predefined number formats. Except for <literal>"General Number"</literal>, all of the predefined format codes return the number as a decimal number with two decimal places.</paragraph> +<paragraph id="par_id3150113" role="paragraph" xml-lang="en-US">If you use predefined formats, the name of the format must be enclosed in quotation marks.</paragraph> +</section> + +<h2 id="hd_id3149377">Predefined format</h2> +<section id="formats"> +<paragraph id="par_id3154730" role="paragraph" xml-lang="en-US"> <emph>General Number:</emph> Numbers are displayed as entered.</paragraph> +<paragraph id="par_id3153158" role="paragraph" xml-lang="en-US"> <emph>Currency:</emph> Inserts a dollar sign in front of the number and encloses negative numbers in brackets.</paragraph> +<paragraph id="par_id3154490" role="paragraph" xml-lang="en-US"> <emph>Fixed:</emph> Displays at least one digit in front of the decimal separator.</paragraph> +<paragraph id="par_id3153415" role="paragraph" xml-lang="en-US"> <emph>Standard:</emph> Displays numbers with a thousands separator.</paragraph> +<paragraph id="par_id3150715" role="paragraph" xml-lang="en-US"> <emph>Percent:</emph> Multiplies the number by 100 and appends a percent sign to the number.</paragraph> +<paragraph id="par_id3153836" role="paragraph" xml-lang="en-US"> <emph>Scientific:</emph> Displays numbers in scientific format (for example, 1.00E+03 for 1000).</paragraph> +<paragraph id="par_id3153707" role="paragraph" xml-lang="en-US">A <literal>format</literal> code can be divided into three sections that are separated by semicolons. The first part defines the format for positive values, the second part for negative values, and the third part for zero. If you only specify one <literal>format</literal> code, it applies to all numbers.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#languageformat"/> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341556320" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFormat</paragraph> +<paragraph id="par_idm1341555088" role="bascode" localize="false" xml-lang="en-US"> MsgBox Format(6328.2, "##,##0.00")</paragraph> +<paragraph id="par_idN107A2" role="bascode" xml-lang="en-US"> ' always use a period as decimal delimiter when you enter numbers in Basic source code.</paragraph> +<paragraph id="par_id3147339" role="bascode" xml-lang="en-US"> ' displays for example 6,328.20 in English locale, 6.328,20 in German locale.</paragraph> +<paragraph id="par_idm1341550752" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id381513082126889" xml-lang="en-US"><link href="text/shared/01/05020301.xhp" name="number format code">Number format codes</link></paragraph> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120302.xhp b/helpcontent2/source/text/sbasic/shared/03120302.xhp new file mode 100644 index 000000000..8664f24e6 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120302.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120302xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">LCase Function</title> + <filename>/text/sbasic/shared/03120302.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="lcase"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3152363"> + <bookmark_value>LCase function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3152363"><link href="text/sbasic/shared/03120302.xhp" name="LCase Function">LCase Function</link></h1> +<paragraph id="par_id3145609" role="paragraph" xml-lang="en-US">Converts all uppercase letters in a string to lowercase.</paragraph> +</section> +<paragraph id="par_id3154347" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03120310.xhp" name="UCase">UCase</link> Function</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3150791" role="code" xml-lang="en-US">LCase (Text As String)</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3144760" localize="false" role="paragraph">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that you want to convert.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341103568" role="bascode" localize="false" xml-lang="en-US">Sub ExampleLUCase</paragraph> +<paragraph id="par_idm1341102336" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1341101104" role="bascode" localize="false" xml-lang="en-US"> sVar = "Las Vegas"</paragraph> +<paragraph id="par_id31461212058" role="bascode" localize="false" xml-lang="en-US"> Print LCase(sVar) ' "las vegas"</paragraph> +<paragraph id="par_id31469863658" role="bascode" localize="false" xml-lang="en-US"> Print UCase(sVar) ' "LAS VEGAS"</paragraph> +<paragraph id="par_idm1341096336" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120303.xhp b/helpcontent2/source/text/sbasic/shared/03120303.xhp new file mode 100644 index 000000000..596b15faa --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120303.xhp @@ -0,0 +1,74 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120303xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Left Function</title> + <filename>/text/sbasic/shared/03120303.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="left"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149346"> + <bookmark_value>Left function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3149346"><link href="text/sbasic/shared/03120303.xhp" name="Left Function">Left Function</link></h1> +<paragraph id="par_id3147242" role="paragraph" xml-lang="en-US">Returns the number of leftmost characters that you specify of a string expression.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3150771" role="bascode" xml-lang="en-US">Left (Text As String, n As Long)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3147530" role="paragraph" xml-lang="en-US">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3148552" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that you want to return the leftmost characters from.</paragraph> +<paragraph id="par_id3149456" role="paragraph" xml-lang="en-US"> <emph>n:</emph> Numeric expression that specifies the number of characters that you want to return. If <emph>n</emph> = 0, a zero-length string is returned. The maximum allowed value is 2,147,483,648.</paragraph> +<paragraph id="par_id3150791" role="paragraph" xml-lang="en-US">The following example converts a date in YYYY.MM.DD format to MM/DD/YYYY format.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340818096" role="bascode" localize="false" xml-lang="en-US">Sub ExampleUSDate</paragraph> +<paragraph id="par_idm1340816864" role="bascode" localize="false" xml-lang="en-US">Dim sInput As String</paragraph> +<paragraph id="par_idm1340815632" role="bascode" localize="false" xml-lang="en-US">Dim sUS_date As String</paragraph> +<paragraph id="par_id3150448" role="bascode" xml-lang="en-US"> sInput = InputBox("Please input a date in the international format 'YYYY-MM-DD'")</paragraph> +<paragraph id="par_idm1340812576" role="bascode" localize="false" xml-lang="en-US"> sUS_date = Mid(sInput, 6, 2)</paragraph> +<paragraph id="par_idm1340811328" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & "/"</paragraph> +<paragraph id="par_idm1340810064" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & Right(sInput, 2)</paragraph> +<paragraph id="par_idm1340808800" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & "/"</paragraph> +<paragraph id="par_idm1340807536" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & Left(sInput, 4)</paragraph> +<paragraph id="par_idm1340806272" role="bascode" localize="false" xml-lang="en-US"> MsgBox sUS_date</paragraph> +<paragraph id="par_idm1340805040" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120304.xhp b/helpcontent2/source/text/sbasic/shared/03120304.xhp new file mode 100644 index 000000000..54567d6a0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120304.xhp @@ -0,0 +1,84 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120304xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">LSet Statement</title> + <filename>/text/sbasic/shared/03120304.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="lset"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143268"> + <bookmark_value>LSet statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3143268"><link href="text/sbasic/shared/03120304.xhp" name="LSet Statement">LSet Statement</link></h1> +<paragraph id="par_id3155419" role="paragraph" xml-lang="en-US">Aligns a string to the left of a string variable, or copies a variable of a user-defined type to another variable of a different user-defined type.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3150984" role="bascode" xml-lang="en-US">LSet Var As String = Text or LSet Var1 = Var2</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145610" role="paragraph" xml-lang="en-US"> <emph>Var:</emph> Any String variable that contains the string that you want align to the left.</paragraph> +<paragraph id="par_id3154346" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> String that you want to align to the left of the string variable.</paragraph> +<paragraph id="par_id3151054" role="paragraph" xml-lang="en-US"> <emph>Var1:</emph> Name of the user-defined type variable that you want to copy to.</paragraph> +<paragraph id="par_id3153361" role="paragraph" xml-lang="en-US"> <emph>Var2:</emph> Name of the user-defined type variable that you want to copy from.</paragraph> +<paragraph id="par_id3154686" role="paragraph" xml-lang="en-US">If the string is shorter than the string variable, <emph>LSet</emph> left-aligns the string within the string variable. Any remaining positions in the string variable are replaced by spaces. If the string is longer than the string variable, only the leftmost characters up to the length of the string variable are copied. With the <emph>LSet</emph> statement, you can also copy a user-defined type variable to another variable of the same type.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341571792" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRLSet</paragraph> +<paragraph id="par_idm1341570560" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1341569328" role="bascode" localize="false" xml-lang="en-US">Dim sExpr As String</paragraph> +<paragraph id="par_idm1341568096" role="bascode" localize="false" xml-lang="en-US"> sVar = String(40,"*")</paragraph> +<paragraph id="par_idm1341566848" role="bascode" localize="false" xml-lang="en-US"> sExpr = "SBX"</paragraph> +<paragraph id="par_id3152940" role="bascode" xml-lang="en-US"> ' Align "SBX" within the 40-character reference string</paragraph> +<paragraph id="par_id3148647" role="bascode" xml-lang="en-US"> ' Replace asterisks with spaces</paragraph> +<paragraph id="par_idm1341562080" role="bascode" localize="false" xml-lang="en-US"> RSet sVar = sExpr</paragraph> +<paragraph id="par_idm1341560848" role="bascode" localize="false" xml-lang="en-US"> Print ">"; sVar; "<"</paragraph> +<paragraph id="par_idm1341559600" role="bascode" localize="false" xml-lang="en-US"> sVar = String(5,"*")</paragraph> +<paragraph id="par_idm1341558352" role="bascode" localize="false" xml-lang="en-US"> sExpr = "123457896"</paragraph> +<paragraph id="par_idm1341557120" role="bascode" localize="false" xml-lang="en-US"> RSet sVar = sExpr</paragraph> +<paragraph id="par_idm1341555888" role="bascode" localize="false" xml-lang="en-US"> Print ">"; sVar; "<"</paragraph> +<paragraph id="par_idm1341554640" role="bascode" localize="false" xml-lang="en-US"> sVar = String(40,"*")</paragraph> +<paragraph id="par_idm1341553392" role="bascode" localize="false" xml-lang="en-US"> sExpr = "SBX"</paragraph> +<paragraph id="par_id3151075" role="bascode" xml-lang="en-US"> ' Left-align "SBX" within the 40-character reference string</paragraph> +<paragraph id="par_idm1341550400" role="bascode" localize="false" xml-lang="en-US"> LSet sVar = sExpr</paragraph> +<paragraph id="par_idm1341549168" role="bascode" localize="false" xml-lang="en-US"> Print ">"; sVar; "<"</paragraph> +<paragraph id="par_idm1341547920" role="bascode" localize="false" xml-lang="en-US"> sVar = String(5,"*")</paragraph> +<paragraph id="par_idm1341546672" role="bascode" localize="false" xml-lang="en-US"> sExpr = "123456789"</paragraph> +<paragraph id="par_idm1341545440" role="bascode" localize="false" xml-lang="en-US"> LSet sVar = sExpr</paragraph> +<paragraph id="par_idm1341544208" role="bascode" localize="false" xml-lang="en-US"> Print ">"; sVar; "<"</paragraph> +<paragraph id="par_idm1341542960" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120305.xhp b/helpcontent2/source/text/sbasic/shared/03120305.xhp new file mode 100644 index 000000000..730e3cbb7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120305.xhp @@ -0,0 +1,75 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120305xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">LTrim Function</title> + <filename>/text/sbasic/shared/03120305.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ltrim"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147574"> + <bookmark_value>LTrim function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3147574"><link href="text/sbasic/shared/03120305.xhp" name="LTrim Function">LTrim Function</link></h1> +<paragraph id="par_id3145316" role="paragraph" xml-lang="en-US">Removes all leading spaces at the start of a string expression.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3148552" role="bascode" xml-lang="en-US">LTrim (Text As String)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3151056" localize="false" role="paragraph">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150792" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression.</paragraph> +<paragraph id="par_id3125863" role="paragraph" xml-lang="en-US">Use this function to remove spaces at the beginning of a string expression.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340839888" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSpaces</paragraph> +<paragraph id="par_idm1340838656" role="bascode" localize="false" xml-lang="en-US">Dim sText2 As String,sText As String,sOut As String</paragraph> +<paragraph id="par_idm1340837392" role="bascode" localize="false" xml-lang="en-US"> sText2 = " <*Las Vegas*> "</paragraph> +<paragraph id="par_idm1340836144" role="bascode" localize="false" xml-lang="en-US"> sOut = "'"+sText2 +"'"+ Chr(13)</paragraph> +<paragraph id="par_idm1340834896" role="bascode" localize="false" xml-lang="en-US"> sText = Ltrim(sText2) ' sText = "<*Las Vegas*> "</paragraph> +<paragraph id="par_idm1340833600" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut + "'"+sText +"'" + Chr(13)</paragraph> +<paragraph id="par_idm1340832336" role="bascode" localize="false" xml-lang="en-US"> sText = Rtrim(sText2) ' sText = " <*Las Vegas*>"</paragraph> +<paragraph id="par_idm1340831040" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut +"'"+ sText +"'" + Chr(13)</paragraph> +<paragraph id="par_idm1340829776" role="bascode" localize="false" xml-lang="en-US"> sText = Trim(sText2) ' sText = "<*Las Vegas*>"</paragraph> +<paragraph id="par_idm1340828480" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut +"'"+ sText +"'"</paragraph> +<paragraph id="par_idm1340827232" role="bascode" localize="false" xml-lang="en-US"> MsgBox sOut</paragraph> +<paragraph id="par_idm1340826000" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120306.xhp b/helpcontent2/source/text/sbasic/shared/03120306.xhp new file mode 100644 index 000000000..d3f4efe7b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120306.xhp @@ -0,0 +1,78 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120306xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Mid Function, Mid Statement</title> + <filename>/text/sbasic/shared/03120306.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="mid"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143268"> + <bookmark_value>Mid function</bookmark_value> + <bookmark_value>Mid statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3143268"><link href="text/sbasic/shared/03120306.xhp" name="Mid Function, Mid Statement">Mid Function, Mid Statement</link></h1> +<paragraph id="par_id3148473" role="paragraph" xml-lang="en-US">Returns the specified portion of a string expression (<emph>Mid function</emph>), or replaces the portion of a string expression with another string (<emph>Mid statement</emph>).</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3147530" role="bascode" xml-lang="en-US">Mid (Text As String, Start As Long [, Length As Long]) or Mid (Text As String, Start As Long , Length As Long, Text As String)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3149295" role="paragraph" xml-lang="en-US">String (only by Function)</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3148664" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that you want to modify.</paragraph> +<paragraph id="par_id3150359" role="paragraph" xml-lang="en-US"> <emph>Start: </emph>Numeric expression that indicates the character position within the string where the string portion that you want to replace or to return begins. The minimum allowed value is 1. The maximum allowed value is 2,147,483,648.<comment>see i17928</comment></paragraph> +<paragraph id="par_id3148451" role="paragraph" xml-lang="en-US"> <emph>Length:</emph> Numeric expression that returns the number of characters that you want to replace or return. The maximum allowed value is 2,147,483,648.</paragraph> +<paragraph id="par_id3125864" role="paragraph" xml-lang="en-US">If the Length parameter in the <emph>Mid function</emph> is omitted, all characters in the string expression from the start position to the end of the string are returned.</paragraph> +<paragraph id="par_id3144762" role="paragraph" xml-lang="en-US">If the Length parameter in the <emph>Mid statement</emph> is less than the length of the text that you want to replace, the text is reduced to the specified length.</paragraph> +<paragraph id="par_id3150769" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> The string to replace the string expression (<emph>Mid statement</emph>).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341563264" role="bascode" localize="false" xml-lang="en-US">Sub ExampleUSDate</paragraph> +<paragraph id="par_idm1341562032" role="bascode" localize="false" xml-lang="en-US">Dim sInput As String</paragraph> +<paragraph id="par_idm1341560800" role="bascode" localize="false" xml-lang="en-US">Dim sUS_date As String</paragraph> +<paragraph id="par_id3153189" role="bascode" xml-lang="en-US"> sInput = InputBox("Please input a date in the international format 'YYYY-MM-DD'")</paragraph> +<paragraph id="par_idm1341557792" role="bascode" localize="false" xml-lang="en-US"> sUS_date = Mid(sInput, 6, 2)</paragraph> +<paragraph id="par_idm1341556544" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & "/"</paragraph> +<paragraph id="par_idm1341555280" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & Right(sInput, 2)</paragraph> +<paragraph id="par_idm1341554016" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & "/"</paragraph> +<paragraph id="par_idm1341552752" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & Left(sInput, 4)</paragraph> +<paragraph id="par_idm1341551488" role="bascode" localize="false" xml-lang="en-US"> MsgBox sUS_date</paragraph> +<paragraph id="par_idm1341550256" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120307.xhp b/helpcontent2/source/text/sbasic/shared/03120307.xhp new file mode 100644 index 000000000..e970b80a1 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120307.xhp @@ -0,0 +1,76 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120307xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Right Function</title> + <filename>/text/sbasic/shared/03120307.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="right"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153311"> + <bookmark_value>Right function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3153311"><link href="text/sbasic/shared/03120307.xhp" name="Right Function">Right Function</link></h1> +<paragraph id="par_id3150984" role="paragraph" xml-lang="en-US">Returns the rightmost "n" characters of a string expression.</paragraph> +</section> +<paragraph id="par_id3149763" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03120303.xhp" name="Left Function">Left Function</link>.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3153061" role="bascode" xml-lang="en-US">Right (Text As String, n As Long)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153526" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that you want to return the rightmost characters of.</paragraph> +<paragraph id="par_id3151211" role="paragraph" xml-lang="en-US"> <emph>n:</emph> Numeric expression that defines the number of characters that you want to return. If <emph>n</emph> = 0, a zero-length string is returned. The maximum allowed value is 2,147,483,648.</paragraph> +<paragraph id="par_id3158410" role="paragraph" xml-lang="en-US">The following example converts a date in YYYY-MM-DD format to the US date format (MM/DD/YYYY).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341027360" role="bascode" localize="false" xml-lang="en-US">Sub ExampleUSDate</paragraph> +<paragraph id="par_idm1341026128" role="bascode" localize="false" xml-lang="en-US">Dim sInput As String</paragraph> +<paragraph id="par_idm1341024896" role="bascode" localize="false" xml-lang="en-US">Dim sUS_date As String</paragraph> +<paragraph id="par_id3159252" role="bascode" xml-lang="en-US"> sInput = InputBox("Please input a date in the international format 'YYYY-MM-DD'")</paragraph> +<paragraph id="par_idm1341021888" role="bascode" localize="false" xml-lang="en-US"> sUS_date = Mid(sInput, 6, 2)</paragraph> +<paragraph id="par_idm1341020640" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & "/"</paragraph> +<paragraph id="par_idm1341019376" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & Right(sInput, 2)</paragraph> +<paragraph id="par_idm1341018112" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & "/"</paragraph> +<paragraph id="par_idm1341016848" role="bascode" localize="false" xml-lang="en-US"> sUS_date = sUS_date & Left(sInput, 4)</paragraph> +<paragraph id="par_idm1341015584" role="bascode" localize="false" xml-lang="en-US"> MsgBox sUS_date</paragraph> +<paragraph id="par_idm1341014352" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120308.xhp b/helpcontent2/source/text/sbasic/shared/03120308.xhp new file mode 100644 index 000000000..e527399c5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120308.xhp @@ -0,0 +1,86 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120308xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">RSet Statement</title> + <filename>/text/sbasic/shared/03120308.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="rset"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153345"> + <bookmark_value>RSet statement</bookmark_value> +</bookmark> + + +<h1 id="hd_id3153345"><link href="text/sbasic/shared/03120308.xhp" name="RSet Statement">RSet Statement</link></h1> +<paragraph id="par_id3150503" role="paragraph" xml-lang="en-US">Right-aligns a string within a string variable, or copies a user-defined variable type into another.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3150669" role="bascode" xml-lang="en-US">RSet Text As String = Text or RSet Variable1 = Variable2</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3148552" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string variable.</paragraph> +<paragraph id="par_id3154924" role="paragraph" xml-lang="en-US"> <emph>Text</emph>: String that you want to right-align in the string variable.</paragraph> +<paragraph id="par_id3149456" role="paragraph" xml-lang="en-US"> <emph>Variable1:</emph> User-defined variable that is the target for the copied variable.</paragraph> +<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US"> <emph>Variable2:</emph> User-defined variable that you want to copy to another variable.</paragraph> +<paragraph id="par_id3154140" role="paragraph" xml-lang="en-US">If the string is shorter than the string variable, <emph>RSet</emph> aligns the string to the right within the string variable. Any remaining characters in the string variable are replaced with spaces. If the string is longer than the string variable, characters exceeding the length of the variable are truncated, and only the remaining characters are right-aligned within the string variable.</paragraph> +<paragraph id="par_id3149202" role="paragraph" xml-lang="en-US">You can also use the <emph>RSet statement</emph> to assign variables of one user-defined type to another.</paragraph> +<paragraph id="par_id3151042" role="paragraph" xml-lang="en-US">The following example uses the <emph>RSet</emph> and <emph>LSet</emph> statements to modify the left and right alignment of a string.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341567472" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRLSet</paragraph> +<paragraph id="par_idm1341566240" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1341565008" role="bascode" localize="false" xml-lang="en-US">Dim sExpr As String</paragraph> +<paragraph id="par_idm1341563776" role="bascode" localize="false" xml-lang="en-US"> sVar = String(40,"*")</paragraph> +<paragraph id="par_idm1341562528" role="bascode" localize="false" xml-lang="en-US"> sExpr = "SBX"</paragraph> +<paragraph id="par_id3155856" role="bascode" xml-lang="en-US"> ' Right-align "SBX" in a 40-character string</paragraph> +<paragraph id="par_id3152577" role="bascode" xml-lang="en-US"> ' Replace asterisks with spaces</paragraph> +<paragraph id="par_idm1341557824" role="bascode" localize="false" xml-lang="en-US"> RSet sVar = sExpr</paragraph> +<paragraph id="par_idm1341556592" role="bascode" localize="false" xml-lang="en-US"> Print ">"; sVar; "<"</paragraph> +<paragraph id="par_idm1341555344" role="bascode" localize="false" xml-lang="en-US"> sVar = String(5,"*")</paragraph> +<paragraph id="par_idm1341554096" role="bascode" localize="false" xml-lang="en-US"> sExpr = "123457896"</paragraph> +<paragraph id="par_idm1341552864" role="bascode" localize="false" xml-lang="en-US"> RSet sVar = sExpr</paragraph> +<paragraph id="par_idm1341551632" role="bascode" localize="false" xml-lang="en-US"> Print ">"; sVar; "<"</paragraph> +<paragraph id="par_idm1341550384" role="bascode" localize="false" xml-lang="en-US"> sVar = String(40,"*")</paragraph> +<paragraph id="par_idm1341549136" role="bascode" localize="false" xml-lang="en-US"> sExpr = "SBX"</paragraph> +<paragraph id="par_id3145801" role="bascode" xml-lang="en-US"> ' Left-align "SBX" in a 40-character string</paragraph> +<paragraph id="par_idm1341546160" role="bascode" localize="false" xml-lang="en-US"> LSet sVar = sExpr</paragraph> +<paragraph id="par_idm1341544928" role="bascode" localize="false" xml-lang="en-US"> Print ">"; sVar; "<"</paragraph> +<paragraph id="par_idm1341543680" role="bascode" localize="false" xml-lang="en-US"> sVar = String(5,"*")</paragraph> +<paragraph id="par_idm1341542432" role="bascode" localize="false" xml-lang="en-US"> sExpr = "123456789"</paragraph> +<paragraph id="par_idm1341541200" role="bascode" localize="false" xml-lang="en-US"> LSet sVar = sExpr</paragraph> +<paragraph id="par_idm1341539968" role="bascode" localize="false" xml-lang="en-US"> Print ">"; sVar; "<"</paragraph> +<paragraph id="par_idm1341538720" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120309.xhp b/helpcontent2/source/text/sbasic/shared/03120309.xhp new file mode 100644 index 000000000..8e6d160f5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120309.xhp @@ -0,0 +1,75 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120309xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">RTrim Function</title> + <filename>/text/sbasic/shared/03120309.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="rtrim"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154286"> + <bookmark_value>RTrim function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3154286"><link href="text/sbasic/shared/03120309.xhp" name="RTrim Function">RTrim Function</link></h1> +<paragraph id="par_id3153127" role="paragraph" xml-lang="en-US">Deletes the spaces at the end of a string expression.</paragraph> +</section> +<paragraph id="par_id3153062" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03120305.xhp" name="LTrim Function">LTrim Function</link></paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3154347" role="bascode" xml-lang="en-US">RTrim (Text As String)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3153381" localize="false" role="paragraph">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3151380" role="paragraph" xml-lang="en-US"> <emph>Text: </emph>Any string expression.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341574144" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSpaces</paragraph> +<paragraph id="par_idm1341572912" role="bascode" localize="false" xml-lang="en-US">Dim sText2 As String,sText As String,sOut As String</paragraph> +<paragraph id="par_idm1341571648" role="bascode" localize="false" xml-lang="en-US"> sText2 = " <*Las Vegas*> "</paragraph> +<paragraph id="par_idm1341570400" role="bascode" localize="false" xml-lang="en-US"> sOut = "'"+sText2 +"'"+ Chr(13)</paragraph> +<paragraph id="par_idm1341569152" role="bascode" localize="false" xml-lang="en-US"> sText = Ltrim(sText2) ' sText = "<*Las Vegas*> "</paragraph> +<paragraph id="par_idm1341567856" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut + "'"+sText +"'" + Chr(13)</paragraph> +<paragraph id="par_idm1341566592" role="bascode" localize="false" xml-lang="en-US"> sText = Rtrim(sText2) ' sText = " <*Las Vegas*>"</paragraph> +<paragraph id="par_idm1341565296" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut +"'"+ sText +"'" + Chr(13)</paragraph> +<paragraph id="par_idm1341564032" role="bascode" localize="false" xml-lang="en-US"> sText = Trim(sText2) ' sText = "<*Las Vegas*>"</paragraph> +<paragraph id="par_idm1341562736" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut +"'"+ sText +"'"</paragraph> +<paragraph id="par_idm1341561488" role="bascode" localize="false" xml-lang="en-US"> MsgBox sOut</paragraph> +<paragraph id="par_idm1341560256" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120310.xhp b/helpcontent2/source/text/sbasic/shared/03120310.xhp new file mode 100644 index 000000000..87c0de547 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120310.xhp @@ -0,0 +1,65 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120310xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">UCase Function</title> + <filename>/text/sbasic/shared/03120310.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ucase"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153527"> + <bookmark_value>UCase function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3153527"><link href="text/sbasic/shared/03120310.xhp" name="UCase Function">UCase Function</link></h1> +<paragraph id="par_id3155420" role="paragraph" xml-lang="en-US">Converts lowercase characters in a string to uppercase.</paragraph> +</section> +<paragraph id="par_id3150771" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03120302.xhp" name="LCase Function">LCase Function</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3153061" role="code" xml-lang="en-US">UCase (Text As String)</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3146795" localize="false" role="paragraph">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150791" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that you want to convert.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1340878864" role="bascode" localize="false" xml-lang="en-US">Sub ExampleLUCase</paragraph> +<paragraph id="par_idm1340877632" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1340876400" role="bascode" localize="false" xml-lang="en-US"> sVar = "Las Vegas"</paragraph> +<paragraph id="par_id31492040025" role="bascode" localize="false" xml-lang="en-US"> Print LCase(sVar) ' "las vegas"</paragraph> +<paragraph id="par_id31562806521" role="bascode" localize="false" xml-lang="en-US"> Print UCase(sVar) ' "LAS VEGAS"</paragraph> +<paragraph id="par_idm1340871632" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120311.xhp b/helpcontent2/source/text/sbasic/shared/03120311.xhp new file mode 100644 index 000000000..5d12ed80a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120311.xhp @@ -0,0 +1,74 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120311xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Trim Function</title> + <filename>/text/sbasic/shared/03120311.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="trim"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150616"> + <bookmark_value>Trim function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3150616"><link href="text/sbasic/shared/03120311.xhp" name="Trim Function">Trim Function</link></h1> +<paragraph id="par_id3149177" role="paragraph" xml-lang="en-US">Removes all leading and trailing spaces from a string expression.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3155341" role="bascode" xml-lang="en-US">Trim( Text As String )</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3143228" localize="false" role="paragraph">String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341576784" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSpaces</paragraph> +<paragraph id="par_idm1341575552" role="bascode" localize="false" xml-lang="en-US">Dim sText2 As String,sText As String,sOut As String</paragraph> +<paragraph id="par_idm1341574288" role="bascode" localize="false" xml-lang="en-US"> sText2 = " <*Las Vegas*> "</paragraph> +<paragraph id="par_idm1341573040" role="bascode" localize="false" xml-lang="en-US"> sOut = "'"+sText2 +"'"+ Chr(13)</paragraph> +<paragraph id="par_idm1341571792" role="bascode" localize="false" xml-lang="en-US"> sText = Ltrim(sText2) ' sText = "<*Las Vegas*> "</paragraph> +<paragraph id="par_idm1341570496" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut + "'"+sText +"'" + Chr(13)</paragraph> +<paragraph id="par_idm1341569232" role="bascode" localize="false" xml-lang="en-US"> sText = Rtrim(sText2) ' sText = " <*Las Vegas*>"</paragraph> +<paragraph id="par_idm1341567936" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut +"'"+ sText +"'" + Chr(13)</paragraph> +<paragraph id="par_idm1341566672" role="bascode" localize="false" xml-lang="en-US"> sText = Trim(sText2) ' sText = "<*Las Vegas*>"</paragraph> +<paragraph id="par_idm1341565376" role="bascode" localize="false" xml-lang="en-US"> sOut = sOut +"'"+ sText +"'"</paragraph> +<paragraph id="par_idm1341564128" role="bascode" localize="false" xml-lang="en-US"> MsgBox sOut</paragraph> +<paragraph id="par_idm1341562896" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120312.xhp b/helpcontent2/source/text/sbasic/shared/03120312.xhp new file mode 100644 index 000000000..8c67769f5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120312.xhp @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120312xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">ConvertToURL Function</title> +<filename>/text/sbasic/shared/03120312.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="converttourl"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3152801"><bookmark_value>ConvertToURL function</bookmark_value> +</bookmark> +<h1 id="hd_id3152801"><link href="text/sbasic/shared/03120312.xhp" name="ConvertToURL Function">ConvertToURL Function</link></h1> +<paragraph role="paragraph" id="par_id3148538" xml-lang="en-US">Converts a system file name to a file URL.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_id3154285" xml-lang="en-US">ConvertToURL(filename)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" localize="false" id="par_id3147530">String</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3148947" xml-lang="en-US"><emph>filename:</emph> A file name as string.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<section id="exampleconverttofromurl"> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" localize="false" id="par_id3150792" xml-lang="en-US">systemFile$ = "c:\folder\mytext.txt"</paragraph> + <paragraph role="bascode" localize="false" id="par_id3154365" xml-lang="en-US">url$ = ConvertToURL( systemFile$ )</paragraph> + <paragraph role="bascode" localize="false" id="par_id3151042" xml-lang="en-US">print url$</paragraph> + <paragraph role="bascode" localize="false" id="par_id3154909" xml-lang="en-US">systemFileAgain$ = ConvertFromURL( url$ )</paragraph> + <paragraph role="bascode" localize="false" id="par_id3144762" xml-lang="en-US">print systemFileAgain$</paragraph> +</bascode> +</section> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120313.xhp b/helpcontent2/source/text/sbasic/shared/03120313.xhp new file mode 100644 index 000000000..0c4ab4ba8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120313.xhp @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120313xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">ConvertFromURL Function</title> +<filename>/text/sbasic/shared/03120313.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="convertfromurl"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153894"><bookmark_value>ConvertFromURL function</bookmark_value> +</bookmark> +<h1 id="hd_id3153894"><link href="text/sbasic/shared/03120313.xhp" name="ConvertFromURL Function">ConvertFromURL Function</link></h1> +<paragraph role="paragraph" id="par_id3147226" xml-lang="en-US">Converts a file URL to a system file name.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_id3154142" xml-lang="en-US">ConvertFromURL(filename)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" localize="false" id="par_id3150669">String</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3156023" xml-lang="en-US"><emph>filename:</emph> A file name as a string.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/03120312.xhp#exampleconverttofromurl"/> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120314.xhp b/helpcontent2/source/text/sbasic/shared/03120314.xhp new file mode 100644 index 000000000..059f5e95e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120314.xhp @@ -0,0 +1,104 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120314xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Split Function</title> + <filename>/text/sbasic/shared/03120314.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="split"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"> + <bookmark_value>Split function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3156027"><link href="text/sbasic/shared/03120314.xhp" name="Split Function">Split Function</link></h1> +<paragraph id="par_id3155805" role="paragraph" xml-lang="en-US">Returns an array of substrings from a string expression.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3153824" role="bascode" xml-lang="en-US">Split (Text As String, delimiter, number)</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3154285" role="paragraph" xml-lang="en-US">With Option VBASupport 1: String, with Option VBASupport 0: Variant/String</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3156023" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression.</paragraph> +<paragraph id="par_id3147560" role="paragraph" xml-lang="en-US"> <emph>delimiter (optional):</emph> A string of one or more characters length that is used to delimit the Text. The default is the space character.</paragraph> +<paragraph id="par_id3145069" role="paragraph" xml-lang="en-US"> <emph>number (optional):</emph> The number of substrings that you want to return.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> + +<section id="splitjoinex"> +<bascode> +<paragraph id="par_idm1341285008" role="bascode" localize="false" xml-lang="en-US">Dim a(3)</paragraph> +<paragraph id="par_idm1341283776" role="bascode" localize="false" xml-lang="en-US">Sub main()</paragraph> +<paragraph id="par_idm1341282544" role="bascode" localize="false" xml-lang="en-US"> a(0) = "ABCDE"</paragraph> +<paragraph id="par_idm1341281312" role="bascode" localize="false" xml-lang="en-US"> a(1) = 42</paragraph> +<paragraph id="par_idm1341280080" role="bascode" localize="false" xml-lang="en-US"> a(2) = "MN"</paragraph> +<paragraph id="par_idm1341278848" role="bascode" localize="false" xml-lang="en-US"> a(3) = "X Y Z"</paragraph> +<paragraph id="par_idm1341277616" role="bascode" localize="false" xml-lang="en-US"> JStr = Join1()</paragraph> +<paragraph id="par_idm1341276384" role="bascode" localize="false" xml-lang="en-US"> Call Show(JStr, Split1(JStr))</paragraph> +<paragraph id="par_idm1341275136" role="bascode" localize="false" xml-lang="en-US"> JStr = Join2()</paragraph> +<paragraph id="par_idm1341273904" role="bascode" localize="false" xml-lang="en-US"> Call Show(JStr, Split1(JStr))</paragraph> +<paragraph id="par_idm1341272656" role="bascode" localize="false" xml-lang="en-US"> JStr = Join3()</paragraph> +<paragraph id="par_idm1341271424" role="bascode" localize="false" xml-lang="en-US"> Call Show(JStr, Split1(JStr))</paragraph> +<paragraph id="par_idm1341270176" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1341268944" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341267696" role="bascode" localize="false" xml-lang="en-US">Function Join1()</paragraph> +<paragraph id="par_idm1341266464" role="bascode" localize="false" xml-lang="en-US"> Join1 = Join(a(), "abc")</paragraph> +<paragraph id="par_idm1341265216" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +<paragraph id="par_idm1341263984" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341262784" role="bascode" localize="false" xml-lang="en-US">Function Join2()</paragraph> +<paragraph id="par_idm1341261552" role="bascode" localize="false" xml-lang="en-US"> Join2 = Join(a(), ",")</paragraph> +<paragraph id="par_idm1341260304" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +<paragraph id="par_idm1341259072" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341257872" role="bascode" localize="false" xml-lang="en-US">Function Join3()</paragraph> +<paragraph id="par_idm1341256640" role="bascode" localize="false" xml-lang="en-US"> Join3 = Join(a())</paragraph> +<paragraph id="par_idm1341255408" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +<paragraph id="par_idm1341254176" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341252976" role="bascode" localize="false" xml-lang="en-US">Function Split1(aStr)</paragraph> +<paragraph id="par_idm1341251744" role="bascode" localize="false" xml-lang="en-US"> Split1 = Split(aStr, "D")</paragraph> +<paragraph id="par_idm1341250496" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +<paragraph id="par_idm1341249264" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1341248064" role="bascode" localize="false" xml-lang="en-US">Sub Show(JoinStr, TheArray)</paragraph> +<paragraph id="par_idm1341246816" role="bascode" localize="false" xml-lang="en-US"> l = LBound(TheArray)</paragraph> +<paragraph id="par_idm1341245568" role="bascode" localize="false" xml-lang="en-US"> u = UBound(TheArray)</paragraph> +<paragraph id="par_idm1341244320" role="bascode" localize="false" xml-lang="en-US"> total$ = "=============================" + Chr$(13) + JoinStr + Chr$(13) + Chr$(13)</paragraph> +<paragraph id="par_idm1341243024" role="bascode" localize="false" xml-lang="en-US"> For i = l To u</paragraph> +<paragraph id="par_idm1341241792" role="bascode" localize="false" xml-lang="en-US"> total$ = total$ + TheArray(i) + Str(Len(TheArray(i))) + Chr$(13)</paragraph> +<paragraph id="par_idm1341240496" role="bascode" localize="false" xml-lang="en-US"> Next i</paragraph> +<paragraph id="par_idm1341239264" role="bascode" localize="false" xml-lang="en-US"> MsgBox total$</paragraph> +<paragraph id="par_idm1341238032" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</section> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120315.xhp b/helpcontent2/source/text/sbasic/shared/03120315.xhp new file mode 100644 index 000000000..68e406f3b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120315.xhp @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120315xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Join Function</title> +<filename>/text/sbasic/shared/03120315.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="join"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3149416"><bookmark_value>Join function</bookmark_value> +</bookmark> +<h1 id="hd_id3149416"><link href="text/sbasic/shared/03120315.xhp" name="Join Function">Join Function</link></h1> +<paragraph role="paragraph" id="par_id3149670" xml-lang="en-US">Returns a string from a number of substrings in a string array.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph role="bascode" id="par_id3156344" xml-lang="en-US">Join (Text As String Array, delimiter)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" localize="false" id="par_id3150359">String</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3145171" xml-lang="en-US"><emph>Text:</emph> A string array.</paragraph> +<paragraph role="paragraph" id="par_id3154908" xml-lang="en-US"><emph>delimiter (optional):</emph> A string character that is used to separate the substrings in the resulting string. The default delimiter is the space character. If delimiter is a string of length zero "", the substrings are joined without separator.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<embed href="text/sbasic/shared/03120314.xhp#splitjoinex"/> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120400.xhp b/helpcontent2/source/text/sbasic/shared/03120400.xhp new file mode 100644 index 000000000..b3012ca68 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120400.xhp @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120400xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Editing String Length</title> +<filename>/text/sbasic/shared/03120400.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="determine"> + <paragraph id="hd_id3155150" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120400.xhp" name="Editing String Length">Editing String Length</link></paragraph> + <paragraph role="paragraph" id="par_id3159201" xml-lang="en-US">The following functions determine string lengths and compare strings.</paragraph> + </section> + <embed href="text/sbasic/shared/03120401.xhp#instr"/> + <embed href="text/sbasic/shared/03120402.xhp#len"/> + <embed href="text/sbasic/shared/03120403.xhp#strcomp"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120401.xhp b/helpcontent2/source/text/sbasic/shared/03120401.xhp new file mode 100644 index 000000000..ae53e0d99 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120401.xhp @@ -0,0 +1,71 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120401xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">InStr Function</title> + <filename>/text/sbasic/shared/03120401.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="instr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155934"> + <bookmark_value>InStr function</bookmark_value> +</bookmark> + + +<h1 id="hd_id3155934"><link href="text/sbasic/shared/03120401.xhp" name="InStr Function">InStr Function</link></h1> +<paragraph id="par_id3153990" role="paragraph" xml-lang="en-US">Returns the position of a string within another string.</paragraph> +</section> +<paragraph id="par_id3147303" role="paragraph" xml-lang="en-US">The Instr function returns the position at which the match was found. If the string was not found, the function returns 0.</paragraph> + +<h2 id="hd_id3145090">Syntax:</h2> +<bascode> +<paragraph id="par_id3146957" role="bascode" xml-lang="en-US">InStr ([Start As Long,] Text1 As String, Text2 As String[, Compare])</paragraph> +</bascode> + +<h2 id="hd_id3148538">Return value:</h2> +<paragraph id="par_id3149763" localize="false" role="paragraph">Integer</paragraph> + +<h2 id="hd_id3148473">Parameters:</h2> +<paragraph id="par_id3153126" role="paragraph" xml-lang="en-US"> <emph>Start: </emph>A numeric expression that marks the position in a string where the search for the specified substring starts. If you omit this parameter, the search starts at the first character of the string. The minimum allowed value is 1. The maximum allowed value is 2,147,483,648.<comment>see i17928</comment></paragraph> +<paragraph id="par_id3145609" role="paragraph" xml-lang="en-US"> <emph>Text1:</emph> The string expression that you want to search.</paragraph> +<paragraph id="par_id3147559" role="paragraph" xml-lang="en-US"> <emph>Text2:</emph> The string expression that you want to search for.</paragraph> +<paragraph id="par_id3154758" role="paragraph" xml-lang="en-US"> <emph>Compare:</emph> Optional numeric expression that defines the type of comparison. The value of this parameter can be 0 or 1. The default value of 1 specifies a text comparison that is not case-sensitive. The value of 0 specifies a binary comparison that is case-sensitive.<comment>fixes i17929</comment></paragraph> +<paragraph id="par_id3153361" role="paragraph" xml-lang="en-US">To avoid a run-time error, do not set the Compare parameter if the first optional parameter is omitted.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<h2 id="hd_id3154366">Example:</h2> +<bascode> +<paragraph id="par_idm1341612352" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePosition</paragraph> +<paragraph id="par_idm1341611120" role="bascode" localize="false" xml-lang="en-US">Dim sInput As String</paragraph> +<paragraph id="par_idm1341609888" role="bascode" localize="false" xml-lang="en-US">Dim iPos As Integer</paragraph> +<paragraph id="par_id31447603655" role="bascode" localize="false" xml-lang="en-US"> sInput = "Office"</paragraph> +<paragraph id="par_id31541252287" role="bascode" localize="false" xml-lang="en-US"> iPos = Instr(sInput,"c")</paragraph> +<paragraph id="par_idm1341605120" role="bascode" localize="false" xml-lang="en-US"> Print iPos</paragraph> +<paragraph id="par_idm1341603888" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120402.xhp b/helpcontent2/source/text/sbasic/shared/03120402.xhp new file mode 100644 index 000000000..e57cb67fd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120402.xhp @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03120402xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Len Function</title> +<filename>/text/sbasic/shared/03120402.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="len"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154136"><bookmark_value>Len function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3154136" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03120402.xhp" name="Len Function">Len Function</link></paragraph> +<paragraph role="paragraph" id="par_id3147576" xml-lang="en-US">Returns the number of characters in a string, or the number of bytes that are required to store a variable.</paragraph> +</section> +<paragraph role="heading" id="hd_id3159177" xml-lang="en-US" level="2">Syntax:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3150669" xml-lang="en-US">Len (Text As String)</paragraph> +</bascode> +<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="2">Return value:</paragraph> +<paragraph role="paragraph" localize="false" id="par_id3143270">Long</paragraph> +<paragraph role="heading" id="hd_id3147531" xml-lang="en-US" level="2">Parameters:</paragraph> +<paragraph role="paragraph" id="par_id3147265" xml-lang="en-US"> +<emph>Text:</emph> Any string expression or a variable of another type.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<paragraph role="heading" id="hd_id3153360" xml-lang="en-US" level="2">Example:</paragraph> +<bascode> +<paragraph role="bascode" id="par_id3150792" xml-lang="en-US" localize="false">Sub ExampleLen</paragraph> +<paragraph role="bascode" id="par_id3151211" xml-lang="en-US" localize="false">Dim sText as String</paragraph> +<paragraph role="bascode" id="par_id3154125" xml-lang="en-US" localize="false"> sText = "Las Vegas"</paragraph> +<paragraph role="bascode" id="par_id3156214" xml-lang="en-US" localize="false"> MsgBox Len(sText) ' 9</paragraph> +<paragraph role="bascode" id="par_id3125864" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03120403.xhp b/helpcontent2/source/text/sbasic/shared/03120403.xhp new file mode 100644 index 000000000..6551e263d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120403.xhp @@ -0,0 +1,81 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120403xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">StrComp Function</title> + <filename>/text/sbasic/shared/03120403.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="strcomp"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3156027"> + <bookmark_value>StrComp function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3156027" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120403.xhp" name="StrComp Function">StrComp Function</link></paragraph> +<paragraph id="par_id3155805" role="paragraph" xml-lang="en-US">Compares two strings and returns an integer value that represents the result of the comparison.</paragraph> +</section> + +<paragraph id="hd_id3153345" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3150503" role="bascode" xml-lang="en-US">StrComp (Text1 As String, Text2 As String[, Compare])</paragraph> +</bascode> + +<paragraph id="hd_id3147574" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3156152" localize="false" role="paragraph">Integer</paragraph> + +<paragraph id="hd_id3150984" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph> +<paragraph id="par_id3153061" role="paragraph" xml-lang="en-US"> <emph>Text1:</emph> Any string expression</paragraph> +<paragraph id="par_id3147560" role="paragraph" xml-lang="en-US"> <emph>Text2:</emph> Any string expression</paragraph> +<paragraph id="par_id3146796" role="paragraph" xml-lang="en-US"> <emph>Compare:</emph> This optional parameter sets the comparison method. If Compare = 1, the string comparison is case-sensitive. If Compare = 0, no distinction is made between uppercase and lowercase letters.</paragraph> + +<paragraph id="hd_id3154940" role="heading" level="3" xml-lang="en-US">Return value</paragraph> + +<list type="unordered"> + <listitem> + <paragraph id="par_id3150358" role="listitem" xml-lang="en-US">If Text1 < Text2 the function returns -1</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3151043" role="listitem" xml-lang="en-US">If Text1 = Text2 the function returns 0</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3158410" role="listitem" xml-lang="en-US">If Text1 > Text2 the function returns 1</paragraph> + </listitem></list> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3153968" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341100656" role="bascode" localize="false" xml-lang="en-US">Sub ExampleStrComp</paragraph> +<paragraph id="par_idm1341099424" role="bascode" localize="false" xml-lang="en-US">Dim iVar As Single</paragraph> +<paragraph id="par_idm1341098192" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph> +<paragraph id="par_idm1341096960" role="bascode" localize="false" xml-lang="en-US"> iVar = 123.123</paragraph> +<paragraph id="par_idm1341095728" role="bascode" localize="false" xml-lang="en-US"> sVar = Str$(iVar)</paragraph> +<paragraph id="par_idm1341094496" role="bascode" localize="false" xml-lang="en-US"> MsgBox strcomp(sVar , Str$(iVar),1)</paragraph> +<paragraph id="par_idm1341093248" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03120411.xhp b/helpcontent2/source/text/sbasic/shared/03120411.xhp new file mode 100644 index 000000000..5ba7cc315 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120411.xhp @@ -0,0 +1,76 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120401xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">InStrRev Function [VBA]</title> + <filename>/text/sbasic/shared/03120411.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="instrrev"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155934"> + <bookmark_value>InStrRev function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3155934" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120411.xhp" name="InStrRev Function">InStrRev Function [VBA]</link></paragraph> +<paragraph id="par_id3153990" role="paragraph" xml-lang="en-US">Returns the position of a string within another string, starting from the right side of the string. </paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<paragraph id="par_id3147303" role="paragraph" xml-lang="en-US">The InStrRev function returns the position at which the match was found, from the right. If the string was not found, the function returns 0.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3146957" role="bascode" xml-lang="en-US">InStrRev (Text1 As String, Text2 As String [,Start As Long] [, Compare As Integer])</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3149763" localize="false" role="paragraph">Long</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145609" role="paragraph" xml-lang="en-US"> <emph>Text1:</emph> The string expression that you want to search.</paragraph> +<paragraph id="par_id3147559" role="paragraph" xml-lang="en-US"> <emph>Text2:</emph> The string expression that you want to search for.</paragraph> +<paragraph id="par_id3153126" role="paragraph" xml-lang="en-US"> <emph>Start: </emph>Optional numeric expression that marks the position <emph>from the left </emph>in a string where the search for the specified substring starts. If you omit this parameter, the search starts at the last character of the string. The maximum allowed value is 65535.</paragraph> +<paragraph id="par_id3154758" role="paragraph" xml-lang="en-US"> <emph>Compare:</emph> Optional numeric expression that defines the type of comparison. The value of this parameter can be </paragraph> +<paragraph id="par_id051920170326028042" role="paragraph" xml-lang="en-US">1: The default value of 1 specifies a text comparison that is not case-sensitive.</paragraph> +<paragraph id="par_id051920170326027721" role="paragraph" xml-lang="en-US">0: The value of 0 specifies a binary comparison that is case-sensitive.</paragraph> +<paragraph id="par_id3153361" role="paragraph" xml-lang="en-US">To avoid a run-time error, do not set the Compare parameter if the first return parameter is omitted.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341612352" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePosition</paragraph> +<paragraph id="par_idm1341611120" role="bascode" localize="false" xml-lang="en-US">Dim sInput As String</paragraph> +<paragraph id="par_idm1341609888" role="bascode" localize="false" xml-lang="en-US">Dim iPos As Integer</paragraph> +<paragraph id="par_id31447606588" role="bascode" localize="false" xml-lang="en-US"> sInput = "The book is on the table"</paragraph> +<paragraph id="par_id31541255547" role="bascode" xml-lang="en-US"> iPos = InStrRev(sInput,"the",10,1) ' Returns 1, search is case-insensitive</paragraph> +<paragraph id="par_idm1341605120" role="bascode" localize="false" xml-lang="en-US"> Print iPos </paragraph> +<paragraph id="par_id05192017032" role="bascode" xml-lang="en-US"> iPos = InStrRev(sInput,"the",10,0) ' Returns 0, search is case-sensitive</paragraph> +<paragraph id="par_id05192017032" role="bascode" localize="false" xml-lang="en-US"> Print iPos</paragraph> +<paragraph id="par_idm1341603888" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id051920170316395065" localize="false" role="paragraph"><link href="text/sbasic/shared/03120401.xhp">InStr</link></paragraph> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03120412.xhp b/helpcontent2/source/text/sbasic/shared/03120412.xhp new file mode 100644 index 000000000..0c743326c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03120412.xhp @@ -0,0 +1,57 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03120401xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">StrReverse Function [VBA]</title> + <filename>/text/sbasic/shared/03120412.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="strreverse"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155934"> + <bookmark_value>StrReverse function</bookmark_value> +</bookmark> +<paragraph id="hd_id3155934" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03120412.xhp" name="StrReverse Function">StrReverse Function [VBA]</link></paragraph> +<paragraph id="par_id3153990" role="paragraph" xml-lang="en-US">Returns the string with the character order reversed.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3146957" role="bascode" xml-lang="en-US">StrReverse (Text1 As String)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3149763" localize="false" role="paragraph">String</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3145609" role="paragraph" xml-lang="en-US"> <emph>Text1:</emph> The string expression that you want to reverse the character order.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341612352" role="bascode" localize="false" xml-lang="en-US">Sub ExampleReverse</paragraph> +<paragraph id="par_idm1341605120" role="bascode" localize="false" xml-lang="en-US"> Print StrReverse("ABCdefGH") ' return "HGfedCBA"</paragraph> +<paragraph id="par_idm1341603888" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03130000.xhp b/helpcontent2/source/text/sbasic/shared/03130000.xhp new file mode 100644 index 000000000..c281ca33c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130000.xhp @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03130000xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Other Commands</title> +<filename>/text/sbasic/shared/03130000.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="other"> +<paragraph role="heading" id="hd_id3156027" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03130000.xhp" name="Other Commands">Other Commands</link></paragraph> +<paragraph role="paragraph" id="par_id3153312" xml-lang="en-US">This is a list of the functions and the statements that are not included in the other categories.</paragraph> +</section> +<embed href="text/sbasic/shared/03130100.xhp#beep"/> +<embed href="text/sbasic/shared/03130500.xhp#shell"/> +<embed href="text/sbasic/shared/03130600.xhp#wait"/> +<embed href="text/sbasic/shared/03130610.xhp#waituntil"/> +<embed href="text/sbasic/shared/03130700.xhp#getsystemticks"/> +<embed href="text/sbasic/shared/GetPathSeparator.xhp#getpathseparator"/> +<embed href="text/sbasic/shared/03130800.xhp#environ"/> +<embed href="text/sbasic/shared/03131000.xhp#getsolarversion"/> +<embed href="text/sbasic/shared/03132100.xhp#getguitype"/> +<embed href="text/sbasic/shared/03131300.xhp#twipsperpixelx"/> +<embed href="text/sbasic/shared/03131400.xhp#twipsperpixely"/> +<embed href="text/sbasic/shared/03131900.xhp#globalscope"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03130100.xhp b/helpcontent2/source/text/sbasic/shared/03130100.xhp new file mode 100644 index 000000000..f8e90b2dd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130100.xhp @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03130100xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Beep Statement</title> +<filename>/text/sbasic/shared/03130100.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="beep"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3143284"><bookmark_value>Beep statement</bookmark_value> +</bookmark> +<h1 id="hd_id3143284" xml-lang="en-US"><link href="text/sbasic/shared/03130100.xhp" name="Beep Statement">Beep Statement</link></h1> +<paragraph role="paragraph" id="par_id3159201" xml-lang="en-US">Plays a tone through the computer's speaker. The tone is system-dependent and you cannot modify its volume or pitch.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Beep_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Beep Statement diagram</alt></image> +</paragraph> +<bascode> +<paragraph role="bascode" localize="false" id="par_id3147291" xml-lang="en-US">Beep</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="par_id3149762" localize="false">Sub ExampleBeep</paragraph> +<paragraph role="bascode" id="par_id3154285" localize="false"> Beep</paragraph> +<paragraph role="bascode" id="par_id3143270" localize="false"> Beep</paragraph> +<paragraph role="bascode" id="par_id3154142" localize="false"> Beep</paragraph> +<paragraph role="bascode" id="par_id3148943" localize="false">End Sub</paragraph> +</bascode> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03130500.xhp b/helpcontent2/source/text/sbasic/shared/03130500.xhp new file mode 100644 index 000000000..c6c6fb321 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130500.xhp @@ -0,0 +1,137 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03130500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Shell Function</title> + <filename>/text/sbasic/shared/03130500.xhp</filename> + </topic> +</meta> + +<body> + +<section id="shell"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150040"> + <bookmark_value>Shell function</bookmark_value> +</bookmark> + +<h1 id="hd_id3150040"><link href="text/sbasic/shared/03130500.xhp" name="Shell Function">Shell Function</link></h1> +<paragraph id="par_id3153394" role="paragraph" xml-lang="en-US">Starts another application and defines the respective window style, if necessary.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3147576" role="code" xml-lang="en-US">Shell (Pathname As String[, Windowstyle As Integer][, Param As String][, bSync]) </paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + +<h3 id="hd_id3154306">Pathname</h3> +<paragraph id="par_id3155419" role="paragraph" xml-lang="en-US">Complete path and program name of the program that you want to start.</paragraph> + +<h3 id="hd_id3150771">Windowstyle</h3> +<paragraph id="par_id3145609" role="paragraph" xml-lang="en-US">Optional integer expression that specifies the style of the window that the program is executed in. The following values are possible:</paragraph> + +<table id="tbl_id3156343"> + <tablehead> + <tablerow> + <tablecell> + <paragraph id="par_id931651081957773" role="tablehead" localize="false" xml-lang="en-US" >Windowstyle</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221651081957774" role="tablehead" xml-lang="en-US" >Meaning</paragraph> + </tablecell> + </tablerow> + </tablehead> + <tablerow> + <tablecell> + <paragraph id="par_id3148663" role="paragraph" localize="false" xml-lang="en-US">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3153360" role="paragraph" xml-lang="en-US">The focus is on the hidden program window.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3154123" role="paragraph" localize="false" xml-lang="en-US">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3144760" role="paragraph" xml-lang="en-US">The focus is on the program window in standard size.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3156422" role="paragraph" localize="false" xml-lang="en-US">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3148451" role="paragraph" xml-lang="en-US">The focus is on the minimized program window.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3149561" role="paragraph" localize="false" xml-lang="en-US">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3146921" role="paragraph" xml-lang="en-US">focus is on the maximized program window.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3149481" role="paragraph" localize="false" xml-lang="en-US">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3155854" role="paragraph" xml-lang="en-US">Standard size program window, without focus.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3145271" role="paragraph" localize="false" xml-lang="en-US">6</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3152938" role="paragraph" xml-lang="en-US">Minimized program window, focus remains on the active window.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id3146119" role="paragraph" localize="false" xml-lang="en-US">10</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id3151112" role="paragraph" xml-lang="en-US">Full-screen display.</paragraph> + </tablecell> + </tablerow> +</table> + +<h3 id="hd_id3150419">Param</h3> +<paragraph id="par_id3149412" role="paragraph" xml-lang="en-US">Any string expression that specifies the command line that want to pass.</paragraph> + +<h3 id="hd_id3148456">bSync</h3> +<paragraph id="par_id3154096" role="paragraph" xml-lang="en-US">If this value is set to <emph>true</emph>, the <emph>Shell</emph> command and all $[officename] tasks wait until the shell process completes. If the value is set to <emph>false</emph>, the shell returns directly. The default value is <emph>false</emph>.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#err53"/> +<embed href="text/sbasic/shared/00000003.xhp#err73"/> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_idm1341273680" role="bascode" localize="false" xml-lang="en-US">Sub ExampleShellForWin</paragraph> +<paragraph id="par_idm1341272448" role="bascode" localize="false" xml-lang="en-US"> Shell("c:\windows\calc.exe",2)</paragraph> +<paragraph id="par_idm1341271200" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03130600.xhp b/helpcontent2/source/text/sbasic/shared/03130600.xhp new file mode 100644 index 000000000..849f00c86 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130600.xhp @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03130600xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Wait Statement</title> +<filename>/text/sbasic/shared/03130600.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="wait"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154136"><bookmark_value>Wait statement</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3154136" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03130600.xhp" name="Wait Statement">Wait Statement</link></paragraph> +<paragraph role="paragraph" id="par_id3149236" xml-lang="en-US">Interrupts the program execution for the amount of time that you specify in milliseconds.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="code" id="par_id3150669" xml-lang="en-US">Wait millisec</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id3154924" xml-lang="en-US"> +<emph>millisec:</emph> Numeric expression that contains the amount of time (in milliseconds) to wait before the program is executed.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="par_id3154138" xml-lang="en-US" localize="false">Sub ExampleWait</paragraph> +<paragraph role="bascode" id="par_id3154367" xml-lang="en-US" localize="false">Dim lTick As Long</paragraph> +<paragraph role="bascode" id="par_id3154909" xml-lang="en-US" localize="false"> lTick = GetSystemTicks()</paragraph> +<paragraph role="bascode" id="par_id3151042" xml-lang="en-US" localize="false"> Wait 2000</paragraph> +<paragraph role="bascode" id="par_id3154217" xml-lang="en-US" localize="false"> lTick = (GetSystemTicks() - lTick)</paragraph> +<paragraph role="bascode" id="par_id3156214" xml-lang="en-US"> MsgBox "" & lTick & " Ticks" ,0,"The pause lasted"</paragraph> +<paragraph role="bascode" id="par_id3148922" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id251546102545124"><link href="text/sbasic/shared/03130610.xhp" name="WaitUntil statement">WaitUntil statement</link></paragraph> +</section> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03130610.xhp b/helpcontent2/source/text/sbasic/shared/03130610.xhp new file mode 100644 index 000000000..dc0edc5e3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130610.xhp @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +* 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/. +* +--> + +<helpdocument version="1.0"> + <meta> + <topic id="textsbasicshared03130610xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">WaitUntil Statement</title> + <filename>/text/sbasic/shared/03130610.xhp</filename> + </topic> + </meta> + <body> + <section id="waituntil"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3154136"> + <bookmark_value>WaitUntil statement</bookmark_value> + </bookmark> + <h1 id="hd_id3154136"><link href="text/sbasic/shared/03130610.xhp" name="WaitUntil Statement">WaitUntil Statement</link></h1> + <paragraph role="paragraph" id="par_id3149236">Interrupts the program execution until the time specified.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="code" id="par_id3150669">WaitUntil Time</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id3154924"> + <emph>Time</emph>: A Date and Time expression that contains the date and time to wait before the program is executed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + + <bascode> + <paragraph role="bascode" id="par_id161546104675066">REM Wait until 6:00 PM then call MyMacro.</paragraph> + <paragraph role="bascode" id="par_id1001546104650052">REM If after 6:00 PM, exit.</paragraph> + <paragraph role="bascode" id="par_id3154138" localize="false">Sub ExampleWaitUntil</paragraph> + <paragraph role="bascode" id="par_id3154367" localize="false">Dim vTimeschedule As Double</paragraph> + <paragraph role="bascode" id="par_id3154909" localize="false"> vTimeSchedule = Date() + TimeValue("18:00:00")</paragraph> + <paragraph role="bascode" id="par_id3151042" localize="false"> If vTimeSchedule < Now() Then Exit Sub</paragraph> + <paragraph role="bascode" id="par_id3154217" localize="false"> WaitUntil vTimeSchedule</paragraph> + <paragraph role="bascode" id="par_id3156214" localize="false"> Call MyMacro</paragraph> + <paragraph role="bascode" id="par_id3148922" localize="false">End Sub</paragraph> + </bascode> + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id251546102545124"><link href="text/sbasic/shared/03130600.xhp" name="Wait statement">Wait statement</link></paragraph> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03130700.xhp b/helpcontent2/source/text/sbasic/shared/03130700.xhp new file mode 100644 index 000000000..bb7fe6cf9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130700.xhp @@ -0,0 +1,65 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03130700xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">GetSystemTicks Function</title> + <filename>/text/sbasic/shared/03130700.xhp</filename> + </topic> +</meta> + +<body> + +<section id="getsystemticks"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147143"> + <bookmark_value>GetSystemTicks function</bookmark_value> +</bookmark> + +<paragraph id="hd_id3147143" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03130700.xhp" name="GetSystemTicks Function">GetSystemTicks Function</link></paragraph> +<paragraph id="par_id3153750" role="paragraph" xml-lang="en-US">Returns the number of system ticks provided by the operating system. You can use this function to optimize certain processes.</paragraph> +</section> + +<paragraph id="hd_id3153311" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3147242" role="bascode" localize="false" xml-lang="en-US">GetSystemTicks()</paragraph> +</bascode> + +<paragraph id="hd_id3149233" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3149762" localize="false" role="paragraph">Long</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3156152" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341325552" role="bascode" localize="false" xml-lang="en-US">Sub ExampleWait</paragraph> +<paragraph id="par_idm1341324320" role="bascode" localize="false" xml-lang="en-US">Dim lTick As Long</paragraph> +<paragraph id="par_idm1341323088" role="bascode" localize="false" xml-lang="en-US"> lTick = GetSystemTicks()</paragraph> +<paragraph id="par_idm1341321840" role="bascode" localize="false" xml-lang="en-US"> Wait 2000</paragraph> +<paragraph id="par_idm1341320608" role="bascode" localize="false" xml-lang="en-US"> lTick = (GetSystemTicks() - lTick)</paragraph> +<paragraph id="par_id3154938" role="bascode" xml-lang="en-US"> MsgBox "" & lTick & " Ticks" ,0,"The pause lasted"</paragraph> +<paragraph id="par_idm1340848064" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> + <paragraph role="paragraph" id="par_id531610970649205"><embedvar href="text/sbasic/shared/03/sf_timer.xhp#TimerService"/></paragraph> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03130800.xhp b/helpcontent2/source/text/sbasic/shared/03130800.xhp new file mode 100644 index 000000000..c5e84cd5d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03130800.xhp @@ -0,0 +1,65 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03130800xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Environ Function</title> + <filename>/text/sbasic/shared/03130800.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="environ"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155364"> + <bookmark_value>Environ function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3155364" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03130800.xhp" name="Environ Function">Environ Function</link></paragraph> +<paragraph id="par_id3145090" role="paragraph" xml-lang="en-US">Returns the value of an environment variable as a string. Environment variables are dependent on the type of operating system that you have.</paragraph> +</section> + +<paragraph id="hd_id3150670" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3159176" role="bascode" xml-lang="en-US">Environ (Environment As String)</paragraph> +</bascode> + +<paragraph id="hd_id3159157" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3148473" localize="false" role="paragraph">String</paragraph> + +<paragraph id="hd_id3145609" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<paragraph id="par_id3159414" role="paragraph" xml-lang="en-US">Environment: Environment variable that you want to return the value for.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> + +<paragraph id="hd_id3148663" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341576752" role="bascode" localize="false" xml-lang="en-US">Sub ExampleEnviron</paragraph> +<paragraph id="par_idm1341575520" role="bascode" localize="false" xml-lang="en-US">Dim sTemp As String</paragraph> +<paragraph id="par_idm1341574288" role="bascode" localize="false" xml-lang="en-US"> sTemp=Environ ("TEMP")</paragraph> +<paragraph id="par_idm1341573040" role="bascode" localize="false" xml-lang="en-US"> If sTemp = "" Then sTemp=Environ("TMP")</paragraph> +<paragraph id="par_id3145419" role="bascode" xml-lang="en-US"> MsgBox "'" & sTemp & "'" ,64,"Directory of temporary files:"</paragraph> +<paragraph id="par_idm1341569888" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03131000.xhp b/helpcontent2/source/text/sbasic/shared/03131000.xhp new file mode 100644 index 000000000..92a2a316f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131000.xhp @@ -0,0 +1,57 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03131000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">GetSolarVersion Function</title> + <filename>/text/sbasic/shared/03131000.xhp</filename> + </topic> +</meta> + +<body> + +<section id="getsolarversion"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3157898"> + <bookmark_value>GetSolarVersion function</bookmark_value> +</bookmark> + +<paragraph id="hd_id3157898" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03131000.xhp" name="GetSolarVersion Function">GetSolarVersion Function</link></paragraph> +<paragraph id="par_id3152801" role="paragraph" xml-lang="en-US">Returns the internal number of the current $[officename] version.</paragraph> +</section> + +<paragraph id="hd_id3153311" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3155388" role="bascode" localize="false" xml-lang="en-US">s = GetSolarVersion</paragraph> +</bascode> + +<paragraph id="hd_id3149514" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3148685" role="paragraph" xml-lang="en-US">String</paragraph> + +<paragraph id="hd_id3143270" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341118496" role="bascode" localize="false" xml-lang="en-US">Sub ExampleGetSolarVersion</paragraph> +<paragraph id="par_idm1341117248" role="bascode" localize="false" xml-lang="en-US">Dim sSep As String</paragraph> +<paragraph id="par_idm1341116016" role="bascode" localize="false" xml-lang="en-US"> sSep = GetSolarVersion</paragraph> +<paragraph id="par_id3148947" role="bascode" xml-lang="en-US"> MsgBox sSep,64,"Version number of the solar technology"</paragraph> +<paragraph id="par_idm1341113008" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03131300.xhp b/helpcontent2/source/text/sbasic/shared/03131300.xhp new file mode 100644 index 000000000..264a5b644 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131300.xhp @@ -0,0 +1,55 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03131300xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">TwipsPerPixelX Function</title> + <filename>/text/sbasic/shared/03131300.xhp</filename> + </topic> +</meta> + +<body> + +<section id="twipsperpixelx"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153539"> + <bookmark_value>TwipsPerPixelX function</bookmark_value> +</bookmark> + +<paragraph id="hd_id3153539" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03131300.xhp" name="TwipsPerPixelX Function">TwipsPerPixelX Function</link></paragraph> +<paragraph id="par_id3153394" role="paragraph" xml-lang="en-US">Returns the number of twips that represent the width of a pixel.</paragraph> +</section> + +<paragraph id="hd_id3153527" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3151110" role="bascode" localize="false" xml-lang="en-US">n = TwipsPerPixelX</paragraph> +</bascode> + +<paragraph id="hd_id3150669" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3150503" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3159176" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1341056448" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePixelTwips</paragraph> +<paragraph id="par_id3153061" role="bascode" xml-lang="en-US"> MsgBox "" & TwipsPerPixelX() & " Twips * " & TwipsPerPixelY() & " Twips",0,"Pixel size"</paragraph> +<paragraph id="par_idm1341053376" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03131400.xhp b/helpcontent2/source/text/sbasic/shared/03131400.xhp new file mode 100644 index 000000000..5b4586b02 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131400.xhp @@ -0,0 +1,55 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03131400xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">TwipsPerPixelY Function</title> + <filename>/text/sbasic/shared/03131400.xhp</filename> + </topic> +</meta> + +<body> + +<section id="twipsperpixely"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150040"> + <bookmark_value>TwipsPerPixelY function</bookmark_value> +</bookmark> + +<paragraph id="hd_id3150040" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03131400.xhp" name="TwipsPerPixelY Function">TwipsPerPixelY Function</link></paragraph> +<paragraph id="par_id3154186" role="paragraph" xml-lang="en-US">Returns the number of twips that represent the height of a pixel.</paragraph> +</section> + +<paragraph id="hd_id3145090" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<bascode> +<paragraph id="par_id3153681" role="bascode" localize="false" xml-lang="en-US">n = TwipsPerPixelY</paragraph> +</bascode> + +<paragraph id="hd_id3148473" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> +<paragraph id="par_id3154306" role="paragraph" xml-lang="en-US">Integer</paragraph> + +<paragraph id="hd_id3149235" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<bascode> +<paragraph id="par_idm1340758544" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePixelTwips</paragraph> +<paragraph id="par_id3154142" role="bascode" xml-lang="en-US"> MsgBox "" & TwipsPerPixelX() & " Twips * " & TwipsPerPixelY() & " Twips",0,"Pixel size"</paragraph> +<paragraph id="par_idm1340755472" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03131500.xhp b/helpcontent2/source/text/sbasic/shared/03131500.xhp new file mode 100644 index 000000000..a249debd2 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131500.xhp @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + <helpdocument version="1.0"> + <meta> + <topic id="textsbasicshared03131500xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CreateUnoStruct Function</title> + <filename>/text/sbasic/shared/03131500.xhp</filename> + </topic> + <history> + <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> + </history> + </meta> + <body> + <section id="createunostruct"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150499"><bookmark_value>CreateUnoStruct function</bookmark_value> + </bookmark> + <h1 id="hd_id3150499"><link href="text/sbasic/shared/03131500.xhp" name="CreateUnoStruct Function">CreateUnoStruct Function</link></h1> + <paragraph role="paragraph" id="par_id3150713" xml-lang="en-US"><ahelp hid=".">Creates an instance of a Uno structure type.</ahelp></paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="code" id="par_id3155341" xml-lang="en-US">oStruct = CreateUnoStruct( Uno type name )</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="par_id3149762">oStruct = CreateUnoStruct( "com.sun.star.beans.Property" )</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id3147226" xml-lang="en-US">Or use the following structure for your statement:</paragraph> + <bascode> + <paragraph role="bascode" id="par_id3149177" localize="false">Dim oStruct as new com.sun.star.beans.Property</paragraph> + </bascode> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03131600.xhp b/helpcontent2/source/text/sbasic/shared/03131600.xhp new file mode 100644 index 000000000..bf62e3df4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131600.xhp @@ -0,0 +1,76 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> +<meta> + <topic id="textsbasicshared03131600xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CreateUnoService Function</title> + <filename>/text/sbasic/shared/03131600.xhp</filename> + </topic> +</meta> +<body> + <section id="createunoservice"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150682"> + <bookmark_value>CreateUnoService function</bookmark_value> + <bookmark_value>API;FilePicker</bookmark_value> + <bookmark_value>API;SimpleFileAccess</bookmark_value> + </bookmark> + <h1 id="hd_id3150682"><variable id="createunoserviceh1"><link href="text/sbasic/shared/03131600.xhp" name="CreateUnoService Function">CreateUnoService Function</link></variable></h1> + <paragraph id="par_id3152924" role="paragraph" xml-lang="en-US">Instantiates a Uno service with the <literal>ProcessServiceManager</literal>.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id511629989178074"><input>oService = CreateUnoService( UNO service name )</input></paragraph> + <tip id="par_id921629989537850">For a list of available services, visit the <link href="https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star.html" name="UNO_Service_Names">com::sun::star Module</link> reference page.</tip> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id891561653344669">The example below creates the function <literal>FileExists</literal> that uses the service <literal>com.sun.star.ucb.SimpleFileAccess</literal> to test if a given path is an existing file.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id901629989240801">Function FileExists(sPath as String) as Boolean</paragraph> + <paragraph role="bascode" localize="false" id="bas_id361629989241073"> Dim svcSFA as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461629989241289"> Set svcSFA = CreateUnoService("com.sun.star.ucb.SimpleFileAccess")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441629989241521"> Dim bExists as Boolean : bExists = svcSFA.exists(sPath)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651629989241801"> Dim bIsFolder as Boolean : bIsFolder = svcSFA.IsFolder(sPath)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id521629989242114"> FileExists = bExists And Not bIsFolder</paragraph> + <paragraph role="bascode" localize="false" id="bas_id211629989242416">End Function</paragraph> + </bascode> + <tip id="par_id351629989310797">UNO services have an extensive online documentation in the <link href="https://api.libreoffice.org/" name="API_Website">api.libreoffice.org</link> website. Visit the <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1ucb_1_1SimpleFileAccess.html" name="SimpleFileAccess_Page">SimpleFileAccess Service</link> reference page to learn more about the methods provided by the service used in the example above.</tip> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bookmark xml-lang="en-US" branch="index" id="bm_id8334604"> +<bookmark_value>filepicker;API service</bookmark_value> +</bookmark> +<paragraph id="par_idN10625" role="paragraph" xml-lang="en-US">The following code uses the service <literal>com.sun.star.ui.dialogs.FilePicker</literal> to show a file open dialog:</paragraph> +<bascode> +<paragraph id="par_idm1206777616" role="bascode" localize="false" xml-lang="en-US">Sub Main</paragraph> +<paragraph id="par_idN1062B" role="bascode" xml-lang="en-US"> fName = FileOpenDialog ("Please select a file")</paragraph> +<paragraph id="par_idN10630" role="bascode" xml-lang="en-US"> Print "file chosen: "+fName</paragraph> +<paragraph id="par_idm1206774256" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1206773152" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1206772000" role="bascode" localize="false" xml-lang="en-US">Function FileOpenDialog(title As String) As String</paragraph> +<paragraph id="bas_id11593417954966" role="bascode" localize="false" xml-lang="en-US"> res = com.sun.star.ui.dialogs.ExecutableDialogResults</paragraph> +<paragraph id="par_idm1206770832" role="bascode" localize="false" xml-lang="en-US"> filepicker = createUnoService("com.sun.star.ui.dialogs.FilePicker")</paragraph> +<paragraph id="par_idm1206769648" role="bascode" localize="false" xml-lang="en-US"> filepicker.Title = title</paragraph> +<paragraph id="par_idm1206768496" role="bascode" localize="false" xml-lang="en-US"> If res.OK = filepicker.execute() Then </paragraph> +<paragraph id="par_idm1206767344" role="bascode" localize="false" xml-lang="en-US"> files = filepicker.getSelectedFiles()</paragraph> +<paragraph id="par_idm1206766192" role="bascode" localize="false" xml-lang="en-US"> FileOpenDialog=files(0)</paragraph> +<paragraph id="bas_id11593417954" role="bascode" localize="false" xml-lang="en-US"> EndIf</paragraph> +<paragraph id="par_idm1206765040" role="bascode" localize="false" xml-lang="en-US">End Function</paragraph> +</bascode> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/calc_functions.xhp#CallingCalcFunctionsh1"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03131700.xhp b/helpcontent2/source/text/sbasic/shared/03131700.xhp new file mode 100644 index 000000000..e04eac85d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131700.xhp @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03131700xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">GetProcessServiceManager Function</title> +<filename>/text/sbasic/shared/03131700.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="getprocessservicemanager"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153255"><bookmark_value>GetProcessServiceManager function</bookmark_value> +<bookmark_value>ProcessServiceManager</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3153255" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03131700.xhp" name="GetProcessServiceManager Function">GetProcessServiceManager Function</link></paragraph> +<paragraph role="paragraph" id="par_id3156414" xml-lang="en-US">Returns the ProcessServiceManager (central Uno ServiceManager).</paragraph> +</section> +<paragraph role="paragraph" id="par_id3145136" xml-lang="en-US">This function is required when you want to instantiate a service using CreateInstanceWithArguments.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="code" localize="false" id="par_id3151110" xml-lang="en-US">oServiceManager = GetProcessServiceManager()</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph role="bascode" localize="false" id="par_id3143270" xml-lang="en-US">oServiceManager = GetProcessServiceManager()</paragraph> + <paragraph role="bascode" localize="false" id="par_id3153825" xml-lang="en-US">oIntrospection = oServiceManager.createInstance("com.sun.star.beans.Introspection");</paragraph> + <paragraph role="bascode" id="par_id3148473" xml-lang="en-US">' this is the same as the following statement:</paragraph> + <paragraph role="bascode" localize="false" id="par_id3145609" xml-lang="en-US">oIntrospection = CreateUnoService("com.sun.star.beans.Introspection")</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03131800.xhp b/helpcontent2/source/text/sbasic/shared/03131800.xhp new file mode 100644 index 000000000..26f71a677 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131800.xhp @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03131800xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">CreateUnoDialog Function</title> +<filename>/text/sbasic/shared/03131800.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> + +<body> +<section id="createunodialog"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150040"> + <bookmark_value>CreateUnoDialog function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3150040" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03131800.xhp" name="CreateUnoDialog Function">CreateUnoDialog Function</link></paragraph> +<paragraph role="paragraph" id="par_id3154186" xml-lang="en-US">Creates a Basic Uno object that represents a Uno dialog control during Basic runtime.</paragraph> +</section> +<paragraph role="paragraph" id="par_id3153750" xml-lang="en-US">Dialogs are defined in the dialog libraries. To display a dialog, a "live" dialog must be created from the library.</paragraph> +<paragraph role="paragraph" id="par_id3153681" xml-lang="en-US">See <link href="text/sbasic/guide/sample_code.xhp" name="Examples">Examples</link>.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="code" localize="false" id="par_id3159176" xml-lang="en-US">CreateUnoDialog( oDlgDesc )</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> + <paragraph id="par_id3159157" role="bascode" xml-lang="en-US">' Get dialog description from the dialog library</paragraph> + <paragraph id="par_id3149234" role="bascode" localize="false" xml-lang="en-US">oDlgDesc = DialogLibraries.Standard.Dialog1</paragraph> + <paragraph id="par_id3154923" role="bascode" xml-lang="en-US">' Generate "live" dialog</paragraph> + <paragraph id="par_id3149670" role="bascode" localize="false" xml-lang="en-US">oDlgControl = CreateUnoDialog( oDlgDesc )</paragraph> + <paragraph id="par_id3148550" role="bascode" xml-lang="en-US">' display "live" dialog</paragraph> + <paragraph id="par_id3154072" role="bascode" localize="false" xml-lang="en-US">oDlgControl.execute</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03131900.xhp b/helpcontent2/source/text/sbasic/shared/03131900.xhp new file mode 100644 index 000000000..e91105025 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03131900.xhp @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03131900xml" indexer="include" status="PUBLISH"> +<title id="tit" localize="false" xml-lang="en-US">GlobalScope</title> +<filename>/text/sbasic/shared/03131900.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="globalscope"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150682"><bookmark_value>GlobalScope specifier</bookmark_value> +<bookmark_value>library systems</bookmark_value> +<bookmark_value>Library container</bookmark_value> +<bookmark_value>GlobalScope</bookmark_value> +<bookmark_value>API; BasicLibraries</bookmark_value> +<bookmark_value>API; DialogLibraries</bookmark_value> +<bookmark_value>BasicLibraries; library container</bookmark_value> +<bookmark_value>DialogLibraries; library container</bookmark_value> +</bookmark> +<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>Application Macros</emph> or <emph>My Macros</emph>) from within a document, use the <literal>GlobalScope</literal> specifier.</paragraph> +</section> +<section id="basicdialogs"> + <paragraph role="paragraph" id="par_id3153345" xml-lang="en-US">Basic source code and dialogs are organized in library containers. Libraries can contain modules and dialogs.</paragraph> +</section> +<h2 id="hd_id3143271">In Basic:</h2> +<paragraph role="paragraph" id="par_id3153061" xml-lang="en-US">Basic libraries and modules can be managed with the <literal>BasicLibraries</literal> object. Libraries can be searched, explored and loaded on request. <link href="text/sbasic/python/python_document_events.xhp" name="Monitoring document events">Monitoring Documents Events</link> illustrates %PRODUCTNAME library loading.</paragraph> +<h2 id="hd_id3154346">In dialogs:</h2> +<paragraph role="paragraph" id="par_id3148663" xml-lang="en-US">Dialog libraries and dialogs can be managed with the <literal>DialogLibraries</literal> object. <link href="text/sbasic/guide/show_dialog.xhp" name="Opening a Dialog">Opening a Dialog With Basic</link> illustrates how to display %PRODUCTNAME shared dialogs.</paragraph> +<paragraph role="paragraph" id="par_id3150543" xml-lang="en-US"><literal>BasicLibraries</literal> and <literal>DialogLibraries</literal> containers exist at application level and within every document. Document's library containers do not need the <literal>GlobalScope</literal> specifier to be managed. If you want to call a global library container (located in <emph>Application Macros</emph> or <emph>My Macros</emph>) from within a document, you must use the <literal>GlobalScope</literal> specifier.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="code" localize="false" id="par_id3149203" xml-lang="en-US">GlobalScope specifier</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<paragraph role="paragraph" id="par_id3154124" xml-lang="en-US">Example in the document Basic</paragraph> +<bascode> + <paragraph role="bascode" id="par_id3158408" xml-lang="en-US">' calling Dialog1 in the document library Standard</paragraph> + <paragraph role="bascode" localize="false" id="par_id3125865" xml-lang="en-US">oDlgDesc = DialogLibraries.Standard.Dialog1</paragraph> + <paragraph role="bascode" id="par_id3154910" xml-lang="en-US">' calling Dialog2 in the application library Library1</paragraph> + <paragraph role="bascode" localize="false" id="par_id3156424" xml-lang="en-US">oDlgDesc = GlobalScope.DialogLibraries.Library1.Dialog2</paragraph> +</bascode> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03132000.xhp b/helpcontent2/source/text/sbasic/shared/03132000.xhp new file mode 100644 index 000000000..475fd4333 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03132000.xhp @@ -0,0 +1,131 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03132000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CreateUnoListener Function</title> + <filename>/text/sbasic/shared/03132000.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="createunolistener"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155150"> + <bookmark_value>CreateUnoListener function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3155150" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03132000.xhp" name="CreateUnoListener Function">CreateUnoListener Function</link></paragraph> +<paragraph id="par_id3149346" role="paragraph" xml-lang="en-US">Creates a Listener instance.</paragraph> +</section> +<paragraph id="par_id3153681" role="paragraph" xml-lang="en-US">Many Uno interfaces let you register listeners on a special listener interface. This allows you to listen for specific events and call up the appropriate listener method. The CreateUnoListener function waits for the called listener interface and then passes the interface an object that the interface supports. This object is then passed to the method to register the listener.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph id="par_id3143228" role="code" xml-lang="en-US">oListener = CreateUnoListener( Prefixname, ListenerInterfaceName )</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<paragraph id="par_id3154046" role="paragraph" xml-lang="en-US">The following example is based on a Basic library object.</paragraph> +<bascode> +<paragraph id="par_idm1340547456" role="bascode" localize="false" xml-lang="en-US">Dim oListener</paragraph> +<paragraph id="par_idm1340546224" role="bascode" localize="false" xml-lang="en-US">oListener = CreateUnoListener( "ContListener_","com.sun.star.container.XContainerListener" )</paragraph> +</bascode> +<paragraph id="par_id3149294" role="paragraph" xml-lang="en-US">The CreateUnoListener method requires two parameters. The first is a prefix and is explained in detail below. The second parameter is the fully qualified name of the Listener interface that you want to use.</paragraph> +<paragraph id="par_id3149670" role="paragraph" xml-lang="en-US">The Listener must then be added to the Broadcaster Object. This is done by calling the appropriate method for adding a Listener. These methods always follow the pattern "addFooListener", where "Foo" is the Listener Interface Type, without the 'X'. In this example, the addContainerListener method is called to register the XContainerListener:</paragraph> +<bascode> +<paragraph id="par_idm1340540544" role="bascode" localize="false" xml-lang="en-US">Dim oLib</paragraph> +<paragraph id="par_id3154940" role="bascode" xml-lang="en-US">oLib = BasicLibraries.Library1 ' Library1 must exist!</paragraph> +<paragraph id="par_id3150359" role="bascode" xml-lang="en-US">oLib.addContainerListener( oListener ) ' Register the listener</paragraph> +</bascode> +<paragraph id="par_id3154138" role="paragraph" xml-lang="en-US">The Listener is now registered. When an event occurs, the corresponding Listener calls the appropriate method from the com.sun.star.container.XContainerListener Interface.</paragraph> +<paragraph id="par_id3148922" role="paragraph" xml-lang="en-US">The prefix calls registered Listeners from Basic-subroutines. The Basic run-time system searches for Basic-subroutines or functions that have the name "PrefixListenerMethode" and calls them when found. Otherwise, a run-time error occurs.</paragraph> +<paragraph id="par_id3150768" role="paragraph" xml-lang="en-US">In this example, the Listener-Interface uses the following methods:</paragraph> + +<list type="unordered"> + <listitem> + <paragraph id="par_id3151176" role="listitem" xml-lang="en-US" localize="false">disposing:</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3145173" role="listitem" xml-lang="en-US">Listener base interface (com.sun.star.lang.XEventListener): base interface for all Listener Interfaces</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3156212" role="listitem" xml-lang="en-US" localize="false">elementInserted:</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3159254" role="listitem" xml-lang="en-US">Method of the com.sun.star.container.XContainerListener interface</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3147287" role="listitem" xml-lang="en-US" localize="false">elementRemoved:</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3146119" role="listitem" xml-lang="en-US">Method of the com.sun.star.container.XContainerListener interface</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3153951" role="listitem" xml-lang="en-US" localize="false">elementReplaced:</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3154013" role="listitem" xml-lang="en-US">Method of the com.sun.star.container.XContainerListener interface</paragraph> + </listitem></list> +<paragraph id="par_id3147435" role="paragraph" xml-lang="en-US">In this example, the prefix is ContListener_. The following subroutines must therefore be implemented in Basic:</paragraph> + +<list type="unordered"> + <listitem> + <paragraph id="par_id3155411" role="listitem" xml-lang="en-US" localize="false">ContListener_disposing</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3146923" role="listitem" xml-lang="en-US" localize="false">ContListener_elementInserted</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3147318" role="listitem" xml-lang="en-US" localize="false">ContListener_elementRemoved</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3152578" role="listitem" xml-lang="en-US" localize="false">ContListener_elementReplaced</paragraph> + </listitem></list> +<paragraph id="par_id3150592" role="paragraph" xml-lang="en-US">An event structure type that contains information about an event exists for every Listener type. When a Listener method is called, an instance of this event is passed to the method as a parameter. Basic Listener methods can also call these event objects, so long as the appropriate parameter is passed in the Sub declaration. For example:</paragraph> +<bascode> +<paragraph id="par_idm1340499136" role="bascode" localize="false" xml-lang="en-US">Sub ContListener_disposing( oEvent )</paragraph> +<paragraph id="par_id31538768025" role="bascode" localize="false" xml-lang="en-US"> MsgBox "disposing"</paragraph> +<paragraph id="par_idm1340496176" role="bascode" localize="false" xml-lang="en-US"> MsgBox oEvent.Dbg_Properties</paragraph> +<paragraph id="par_idm1340684736" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1340683504" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1340682256" role="bascode" localize="false" xml-lang="en-US">Sub ContListener_elementInserted( oEvent )</paragraph> +<paragraph id="par_id31540984458" role="bascode" localize="false" xml-lang="en-US"> MsgBox "elementInserted"</paragraph> +<paragraph id="par_idm1340679264" role="bascode" localize="false" xml-lang="en-US"> MsgBox oEvent.Dbg_Properties</paragraph> +<paragraph id="par_idm1340678016" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1340676784" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1340675584" role="bascode" localize="false" xml-lang="en-US">Sub ContListener_elementRemoved( oEvent )</paragraph> +<paragraph id="par_id31539470236" role="bascode" localize="false" xml-lang="en-US"> MsgBox "elementRemoved"</paragraph> +<paragraph id="par_idm1340672544" role="bascode" localize="false" xml-lang="en-US"> MsgBox oEvent.Dbg_Properties</paragraph> +<paragraph id="par_idm1340671296" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1340670064" role="bascode" localize="false" xml-lang="en-US"> </paragraph> +<paragraph id="par_idm1340668864" role="bascode" localize="false" xml-lang="en-US">Sub ContListener_elementReplaced( oEvent )</paragraph> +<paragraph id="par_id31489150148" role="bascode" localize="false" xml-lang="en-US"> MsgBox "elementReplaced"</paragraph> +<paragraph id="par_idm1340665824" role="bascode" localize="false" xml-lang="en-US"> MsgBox oEvent.Dbg_Properties</paragraph> +<paragraph id="par_idm1340664576" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<paragraph id="par_id3156056" role="paragraph" xml-lang="en-US">You do not need to include the parameter of an event object if the object is not used:</paragraph> +<bascode> +<paragraph id="par_id3150042" role="bascode" xml-lang="en-US">' Minimal implementation of Sub disposing</paragraph> +<paragraph id="par_idm1340659344" role="bascode" localize="false" xml-lang="en-US">Sub ContListener_disposing</paragraph> +<paragraph id="par_idm1340658096" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> +<paragraph id="par_id3150940" role="warning" xml-lang="en-US">Listener methods must <emph>always</emph> be implemented to avoid Basic run-time errors.</paragraph> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03132100.xhp b/helpcontent2/source/text/sbasic/shared/03132100.xhp new file mode 100644 index 000000000..c95d845ff --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03132100.xhp @@ -0,0 +1,56 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="textsbasicshared03132100xml" indexer="include" status="PUBLISH"> + <title xml-lang="en-US" id="tit">GetGuiType Function</title> + <filename>/text/sbasic/shared/03132100.xhp</filename> + </topic> + </meta> + <body> + <section id="getguitype"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3147143"><bookmark_value>GetGuiType function</bookmark_value> +</bookmark> +<h1 id="hd_id3155310"><variable id="getguitype2"><link href="text/sbasic/shared/03132100.xhp" name="GetGuiType Function">GetGuiType Function</link></variable></h1> + <paragraph xml-lang="en-US" id="par_id3152459" role="paragraph">Returns a numerical value that specifies the graphical user interface.</paragraph> + </section> + <paragraph xml-lang="en-US" id="par_id3153323" role="paragraph">This function is only provided for downward compatibility to previous versions. The return value is not defined in client-server environments.</paragraph> + <paragraph xml-lang="en-US" id="hd_id3154894" role="heading" level="2">Syntax:</paragraph> + <bascode> +<paragraph xml-lang="en-US" id="par_id3147143" role="bascode" localize="false">GetGUIType()</paragraph> +</bascode> + <paragraph xml-lang="en-US" id="hd_id3149346" role="heading" level="2">Return value:</paragraph> + <paragraph xml-lang="en-US" id="par_id3153748" role="paragraph">Integer</paragraph> + <paragraph xml-lang="en-US" id="hd_id3149177" role="heading" level="2">Return values:</paragraph> + <paragraph xml-lang="en-US" id="par_id3147242" role="paragraph">1: Windows</paragraph><comment>removed 3: Mac OS, see i95717</comment> +<paragraph xml-lang="en-US" id="par_id3156152" role="paragraph">4: UNIX</paragraph> + <paragraph xml-lang="en-US" id="hd_id3148685" role="heading" level="2">Example:</paragraph> +<bascode> + <paragraph xml-lang="en-US" id="par_id3149233" role="bascode" localize="false">Sub ExampleEnvironment</paragraph> + <paragraph xml-lang="en-US" id="par_id3145609" role="bascode" localize="false"> MsgBox GetGUIType</paragraph> + <paragraph xml-lang="en-US" id="par_id3145069" role="bascode" localize="false">End Sub</paragraph> +</bascode> + <section id="relatedtopics"> + <embed href="text/sbasic/python/python_platform.xhp#pythonplatform"/> + </section> + </body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/03132200.xhp b/helpcontent2/source/text/sbasic/shared/03132200.xhp new file mode 100644 index 000000000..b89a5d3cb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03132200.xhp @@ -0,0 +1,67 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> +<meta> + <topic id="textsbasicshared03132200xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">ThisComponent Object</title> + <filename>/text/sbasic/shared/03132200.xhp</filename> + </topic> +</meta> +<body> +<section id="thiscomponent"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3155342"> + <bookmark_value>ThisComponent object</bookmark_value> + <bookmark_value>components;addressing</bookmark_value> +</bookmark> + +<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"/> +<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> +<paragraph id="par_id3154123" role="bascode" xml-lang="en-US">' updates the "Table of Contents" in a text doc</paragraph> +<paragraph id="par_idm1341581904" role="bascode" localize="false" xml-lang="en-US">Dim allindexes, index As Object</paragraph> +<paragraph id="par_idm1341580656" role="bascode" localize="false" xml-lang="en-US"> allindexes = ThisComponent.getDocumentIndexes()</paragraph> +<paragraph id="par_id3153194" role="bascode" xml-lang="en-US"> index = allindexes.getByName("Table of Contents1")</paragraph> +<paragraph id="par_id3156422" role="bascode" xml-lang="en-US"> ' use the default name for Table of Contents and a 1</paragraph> +<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/helpcontent2/source/text/sbasic/shared/03132300.xhp b/helpcontent2/source/text/sbasic/shared/03132300.xhp new file mode 100644 index 000000000..0a490c7a3 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03132300.xhp @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03132300xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">CreateUnoValue Function</title> +<filename>/text/sbasic/shared/03132300.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="createunovalue"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150682"><bookmark_value>CreateUnoValue function</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3150682" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03132300.xhp" name="CreateUnoValue Function">CreateUnoValue Function</link></paragraph> +<paragraph role="paragraph" id="par_id3147291" xml-lang="en-US">Returns an object that represents a strictly typed value referring to the Uno type system. </paragraph> +</section> +<paragraph role="paragraph" id="par_id3143267" xml-lang="en-US">This object is automatically converted to an Any of the corresponding type when passed to Uno. The type must be specified by its fully qualified Uno type name.</paragraph> +<paragraph role="note" id="par_id3153626" xml-lang="en-US">The $[officename] API frequently uses the Any type. It is the counterpart of the Variant type known from other environments. The Any type holds one arbitrary Uno type and is used in generic Uno interfaces.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="code" id="par_id3154760" xml-lang="en-US">oUnoValue = CreateUnoValue( "[]byte", MyBasicValue ) ' to get a byte sequence.</paragraph> +<paragraph role="paragraph" id="par_id3150541" xml-lang="en-US">If <literal>CreateUnoValue</literal> cannot be converted to the specified Uno type, and error occurs. For the conversion, the <literal>com.sun.star.script.Converter</literal> service is used.</paragraph> +<paragraph role="paragraph" id="par_id3153524" xml-lang="en-US">This function is intended for use in situations where the default Basic to Uno type converting mechanism is insufficient. This can happen when you try to access generic Any based interfaces, such as <literal>XPropertySet::setPropertyValue( Name, Value )</literal> or <literal>X???Container::insertBy???( ???, Value )</literal>, from $[officename] Basic. The Basic runtime does not recognize these types as they are only defined in the corresponding service.</paragraph> +<paragraph role="paragraph" id="par_id3154366" xml-lang="en-US">In this type of situation, $[officename] Basic chooses the best matching type for the Basic type that you want to convert. However, if the wrong type is selected, an error occurs. You use the <literal>CreateUnoValue()</literal> function to create a value for the unknown Uno type.</paragraph> +<paragraph role="paragraph" id="par_id3150769" xml-lang="en-US">You can also use this function to pass non-Any values, but this is not recommend. If Basic already knows the target type, using the <literal>CreateUnoValue()</literal> function will only lead to additional converting operations that slow down the Basic execution.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03132400.xhp b/helpcontent2/source/text/sbasic/shared/03132400.xhp new file mode 100644 index 000000000..665fe359d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03132400.xhp @@ -0,0 +1,59 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03132400xhp" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CreateObject Function</title> + <filename>/text/sbasic/shared/03132400.xhp</filename> + </topic> +</meta> +<body> + <section id="createobject"> + <bookmark xml-lang="en-US" branch="index" id="bm_id659810"> + <bookmark_value>CreateObject function</bookmark_value> + </bookmark> + <h1 id="par_idN10580"><variable id="CreateObject_h1"><link href="text/sbasic/shared/03132400.xhp">CreateObject Function</link></variable></h1> + <paragraph id="par_idN10590" role="paragraph" xml-lang="en-US"><ahelp hid=".">Creates a UNO object. On Windows, can also create OLE objects.</ahelp><comment>see i70942</comment></paragraph> + <paragraph id="par_idN1059F" role="paragraph" xml-lang="en-US">This method creates instances of the type that is passed as parameter.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id721633632080570"> + <input>oObj = CreateObject(type)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id191633632167310"><emph>type:</emph> the type of the object to be created, as a string.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph id="par_idm1341251920" role="bascode" localize="false">Type address</paragraph> + <paragraph id="par_idm1341250688" role="bascode" localize="false"> Name1 As String</paragraph> + <paragraph id="par_idm1341249456" role="bascode" localize="false"> City As String</paragraph> + <paragraph id="par_idm1341248224" role="bascode" localize="false">End Type</paragraph> + <paragraph id="par_idm1341246992" role="bascode" localize="false"> </paragraph> + <paragraph id="par_idm1341245744" role="bascode" localize="false">Sub main</paragraph> + <paragraph id="par_idm1341244512" role="bascode" localize="false"> myaddress = CreateObject("address")</paragraph> + <paragraph id="par_idm1341243264" role="bascode" localize="false"> MsgBox IsObject(myaddress)</paragraph> + <paragraph id="par_idm1341242016" role="bascode" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/new_keyword.xhp#NewOperator_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03132500.xhp b/helpcontent2/source/text/sbasic/shared/03132500.xhp new file mode 100644 index 000000000..f67ad0589 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03132500.xhp @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared03132500xhp" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">GetDefaultContext Function</title> +<filename>/text/sbasic/shared/03132500.xhp</filename> +</topic> +<history> +<created date="2005-02-11T11:16:25">GetDefaultContext function</created> +</history> +</meta> +<body> +<section id="getdefaultcontext"> +<bookmark xml-lang="en-US" branch="index" id="bm_id4761192"><bookmark_value>GetDefaultContext function</bookmark_value> +</bookmark> +<paragraph role="heading" id="par_idN10580" xml-lang="en-US" level="1"><link href="text/sbasic/shared/03132500.xhp">GetDefaultContext Function</link></paragraph> +<paragraph role="paragraph" id="par_idN10590" xml-lang="en-US">Returns the default context of the process service factory, if existent, else returns a null reference. </paragraph> +</section> +<paragraph role="paragraph" id="par_idN10593" xml-lang="en-US">This function returns the default component context to be used, if instantiating services via XmultiServiceFactory. See the <item type="literal">Professional UNO</item> chapter in the <item type="literal">Developer's Guide</item> on <link href="https://api.libreoffice.org" name="api.libreoffice.org">api.libreoffice.org</link> for more information.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03140000.xhp b/helpcontent2/source/text/sbasic/shared/03140000.xhp new file mode 100644 index 000000000..2b7426f53 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140000.xhp @@ -0,0 +1,71 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">DDB Function [VBA]</title> + <filename>/text/sbasic/shared/03140000.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ddb"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>DDB function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140000.xhp" name="DDB Function [VBA]">DDB Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the depreciation of an asset for a specified period using the arithmetic-declining method.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">DDB(Cost As Double, Salvage As Double, Life as Double, Period as Double, [Factor as Variant])</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id061420170142332738" role="paragraph" xml-lang="en-US"><emph>Cost</emph> fixes the initial cost of an asset.</paragraph> +<paragraph id="par_id061420170142331999" role="paragraph" xml-lang="en-US"><emph>Salvage</emph> fixes the value of an asset at the end of its life.</paragraph> +<paragraph id="par_id061420170142338147" role="paragraph" xml-lang="en-US"><emph>Life</emph> is the number of periods (for example, years or months) defining how long the asset is to be used.</paragraph> +<paragraph id="par_id061420170142338917" role="paragraph" xml-lang="en-US"><emph>Period</emph> states the period for which the value is to be calculated.</paragraph> +<paragraph id="par_id061420170142335816" role="paragraph" xml-lang="en-US"><emph>Factor</emph> (optional) is the factor by which depreciation decreases. If a value is not entered, the default is factor 2.</paragraph> +<paragraph id="par_id3145609" role="paragraph" xml-lang="en-US">Use this form of depreciation if you require a higher initial depreciation value as opposed to linear depreciation. The depreciation value gets less with each period and is usually used for assets whose value loss is higher shortly after purchase (for example, vehicles, computers). Please note that the book value will never reach zero under this calculation type.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id061420170142119551" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDDB</paragraph> +<paragraph id="par_id061420170142169416" role="bascode" localize="false" xml-lang="en-US"> Dim ddb_yr1 As Double</paragraph> +<paragraph id="par_id06142017014218316" role="bascode" localize="false" xml-lang="en-US"> ddb_yr1 = DDB(75000,1,60,12,2)</paragraph> +<paragraph id="par_id061420170142332315" role="bascode" xml-lang="en-US"> Print ddb_yr1 ' returns 1,721.81 currency units. </paragraph> +<paragraph id="par_id061420170142255740" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060103.xhp#bm_id3149998">DDB function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03140001.xhp b/helpcontent2/source/text/sbasic/shared/03140001.xhp new file mode 100644 index 000000000..1731bcc97 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140001.xhp @@ -0,0 +1,72 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140001xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FV Function [VBA]</title> + <filename>/text/sbasic/shared/03140001.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="fv"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>FV function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140001.xhp" name="FV Function [VBA]">FV Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the future value of an investment based on periodic, constant payments and a constant interest rate (Future Value).</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">FV(Rate as Double, NPer as Double, Pmt as Double, [PV as Variant], [Due as Variant])</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id06142017042024114" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph> +<paragraph id="par_id061420170420241668" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods (payment period).</paragraph> +<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the annuity paid regularly per period.</paragraph> +<paragraph id="par_id061420170420246794" role="paragraph" xml-lang="en-US"><emph>PV</emph> (optional) is the (present) cash value of an investment.</paragraph> +<paragraph id="par_id061420170420241932" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) defines whether the payment is due at the beginning or the end of a period.</paragraph> +<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph> +<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id061420170142119551" role="bascode" localize="false" xml-lang="en-US">Sub ExampleFV</paragraph> +<paragraph id="par_id061420170142169416" role="bascode" localize="false" xml-lang="en-US"> Dim myFV As Double</paragraph> +<paragraph id="par_id06142017014218316" role="bascode" localize="false" xml-lang="en-US"> myFV = =FV(0.04, 2, 750, 2500)</paragraph> +<paragraph id="par_id061420170142332315" role="bascode" xml-lang="en-US"> Print myFV ' returns 4234.00 currency units. The value at the end of the investment is 4234.00 currency units.</paragraph> +<paragraph id="par_id061420170142255740" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060118.xhp#bm_id3151205">FV function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03140002.xhp b/helpcontent2/source/text/sbasic/shared/03140002.xhp new file mode 100644 index 000000000..9b47710a9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140002.xhp @@ -0,0 +1,73 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140002xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IPmt Function [VBA]</title> + <filename>/text/sbasic/shared/03140002.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ipmt"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>IPmt function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140002.xhp" name="IPmt Function [VBA]">IPmt Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the periodic amortizement for an investment with regular payments and a constant interest rate.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">IPmt(Rate as Double, Per as Double, NPer as Double, PV as Double, [FV as Variant], [Due as Variant])</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id061420170730135034" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph> +<paragraph id="par_id061420170730137782" role="paragraph" xml-lang="en-US"><emph>Per</emph> is the period, for which the compound interest is calculated. Period=NPER if compound interest for the last period is calculated.</paragraph> +<paragraph id="par_id061420170730134582" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which annuity is paid.</paragraph> +<paragraph id="par_id061420170730144688" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the present cash value in sequence of payments.</paragraph> +<paragraph id="par_id061420170730148520" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the desired value (future value) at the end of the periods.</paragraph> +<paragraph id="par_id061420170730141431" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) is the due date for the periodic payments.</paragraph> +<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph> +<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id061420170142119551" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIPmt</paragraph> +<paragraph id="par_id061420170142169416" role="bascode" localize="false" xml-lang="en-US"> Dim myIPmt As Double</paragraph> +<paragraph id="par_id06142017014218316" role="bascode" localize="false" xml-lang="en-US"> myIPmt = IPmt(0.05,5,7,15000)</paragraph> +<paragraph id="par_id061420170142332315" role="bascode" xml-lang="en-US"> Print myIPmt ' returns -352.97 currency units. The compound interest during the fifth period (year) is 352.97 currency units.</paragraph> +<paragraph id="par_id061420170142255740" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060118.xhp#bm_id3149339">IPMT function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03140003.xhp b/helpcontent2/source/text/sbasic/shared/03140003.xhp new file mode 100644 index 000000000..8b1707e22 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140003.xhp @@ -0,0 +1,73 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140003xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">IRR Function [VBA]</title> + <filename>/text/sbasic/shared/03140003.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="irr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>IRR function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140003.xhp" name="IRR Function [VBA]">IRR Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the internal rate of return for an investment.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">IRR(Values() as Double , [Guess as Variant])</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id061420170730135034" role="paragraph" xml-lang="en-US"><emph>Values(): </emph>The array of values of the cash-flow. The values represent cash flow values at regular intervals, at least one value must be negative (payments), and at least one value must be positive (income).</paragraph> +<paragraph id="par_id061420170730137782" role="paragraph" xml-lang="en-US"><emph>Guess</emph> An initial estimate at what the IRR will be.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id06162017021753974" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id061620170217534991" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id061620170217535111" role="bascode" localize="false" xml-lang="en-US">Sub ExampleIRR</paragraph> +<paragraph id="par_id061620170217538573" role="bascode" localize="false" xml-lang="en-US"> Dim cashFlow(0 to 3) As Double</paragraph> +<paragraph id="par_id06162017021753515" role="bascode" localize="false" xml-lang="en-US"> cashFlow(0) = -10000</paragraph> +<paragraph id="par_id061620170217538580" role="bascode" localize="false" xml-lang="en-US"> cashFlow(1) = 3500</paragraph> +<paragraph id="par_id061620170217543462" role="bascode" localize="false" xml-lang="en-US"> cashFlow(2) = 7600</paragraph> +<paragraph id="par_id061620170217549769" role="bascode" localize="false" xml-lang="en-US"> cashFlow(3) = 1000</paragraph> +<paragraph id="par_id061620170217542970" role="bascode" localize="false" xml-lang="en-US"> irrValue = IRR(cashFlow) * 100</paragraph> +<paragraph id="par_id061620170217548258" role="bascode" xml-lang="en-US"> Print irrValue ' returns 11.3321028236252 . The internal rate of return of the cash flow.</paragraph> +<paragraph id="par_id061620170217544542" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060103.xhp#bm_id3153948">IRR function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03140004.xhp b/helpcontent2/source/text/sbasic/shared/03140004.xhp new file mode 100644 index 000000000..18d65dd5a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140004.xhp @@ -0,0 +1,74 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140004xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">MIRR Function [VBA]</title> + <filename>/text/sbasic/shared/03140004.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="mirr"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>MIRR function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140004.xhp" name="MIRR Function [VBA]">MIRR Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the modified internal rate of return of a series of investments.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">MIRR(Values() as Double, Investment as Double, ReinvestRate as Double)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id061420170730135034" role="paragraph" xml-lang="en-US"><emph>Values(): </emph>An array of cash flows, representing a series of payments and income, where negative values are treated as payments and positive values are treated as income. This array must contain at least one negative and at least one positive value.</paragraph> +<paragraph id="par_id061620170513518949" role="paragraph" xml-lang="en-US"><emph>Investment</emph>: is the rate of interest of the investments (the negative values of the array).</paragraph> +<paragraph id="par_id061420170730137782" role="paragraph" xml-lang="en-US"><emph>ReinvestRate:</emph> the rate of interest of the reinvestment (the positive values of the array).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id06162017021753974" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id061620170217534991" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id061620170217535111" role="bascode" localize="false" xml-lang="en-US">Sub ExampleMIRR</paragraph> +<paragraph id="par_id061620170217538573" role="bascode" localize="false" xml-lang="en-US"> Dim cashFlow(0 to 3) As Double</paragraph> +<paragraph id="par_id06162017021753515" role="bascode" localize="false" xml-lang="en-US"> cashFlow(0) = -5</paragraph> +<paragraph id="par_id061620170217538580" role="bascode" localize="false" xml-lang="en-US"> cashFlow(1) = 10</paragraph> +<paragraph id="par_id061620170217543462" role="bascode" localize="false" xml-lang="en-US"> cashFlow(2) = 15</paragraph> +<paragraph id="par_id061620170217549769" role="bascode" localize="false" xml-lang="en-US"> cashFlow(3) = 8</paragraph> +<paragraph id="par_id061620170217542970" role="bascode" localize="false" xml-lang="en-US"> mirrValue = MIRR(cashFlow,0.5,0.1) * 100</paragraph> +<paragraph id="par_id061620170217548258" role="bascode" xml-lang="en-US"> Print mirrValue ' returns 94.16. The modified internal rate of return of the cash flow.</paragraph> +<paragraph id="par_id061620170217544542" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060119.xhp#bm_id3148974">MIRR function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03140005.xhp b/helpcontent2/source/text/sbasic/shared/03140005.xhp new file mode 100644 index 000000000..488d46ec9 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140005.xhp @@ -0,0 +1,74 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140005xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">NPer Function [VBA]</title> + <filename>/text/sbasic/shared/03140005.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="nper"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>NPer function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140005.xhp" name="NPer Function [VBA]">NPer Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the number of periods for a loan or investment.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">NPer (Rate as Double, Pmt as Double, PV as Double, [FV as Variant], [Due as Variant])</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id06142017042024114" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph> +<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the annuity paid regularly per period.</paragraph> +<paragraph id="par_id061420170420246794" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the (present) cash value of an investment.</paragraph> +<paragraph id="par_id061620170603217534" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the future value of the loan / investment.</paragraph> +<paragraph id="par_id061420170420241932" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) defines whether the payment is due at the beginning or the end of a period.</paragraph> +<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph> +<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id06162017021753974" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id061620170217534991" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id061420170142119551" role="bascode" localize="false" xml-lang="en-US">Sub ExampleNPer</paragraph> +<paragraph id="par_id061420170142169416" role="bascode" localize="false" xml-lang="en-US"> Dim period As Double</paragraph> +<paragraph id="par_id06142017014218316" role="bascode" localize="false" xml-lang="en-US"> period = NPer( 0.06, 153.75, 2600)</paragraph> +<paragraph id="par_id061420170142332315" role="bascode" xml-lang="en-US"> Print period ' returns -12,02. The payment period covers 12.02 periods.</paragraph> +<paragraph id="par_id061620170217544542" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060118.xhp#bm_id3156435">NPER function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03140006.xhp b/helpcontent2/source/text/sbasic/shared/03140006.xhp new file mode 100644 index 000000000..94b4b9bbd --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140006.xhp @@ -0,0 +1,77 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140006xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">NPV Function [VBA]</title> + <filename>/text/sbasic/shared/03140006.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="npv"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>NPV function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140006.xhp" name="NPV Function [VBA]">NPV Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the Net Present Value of an investment, based on a supplied discount rate, and a series of deposits and withdrawals.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">NPV (Rate as Double, Values() as Double)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id06142017042024114" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the discount rate for a period.</paragraph> +<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>Values()</emph> is an array that represent deposits (positive values) or withdrawals (negative values).</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id230720172234183296" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id230720172234189989" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id230720172234184331" role="bascode" localize="false" xml-lang="en-US">Sub ExampleNPV</paragraph> +<paragraph id="par_id230720172234186787" role="bascode" localize="false" xml-lang="en-US"> Dim r As Double</paragraph> +<paragraph id="par_id230720172234187720" role="bascode" localize="false" xml-lang="en-US"> Dim pValues(5) as Double</paragraph> +<paragraph id="par_id230720172234182042" role="bascode" localize="false" xml-lang="en-US"> pValues(0) = 100</paragraph> +<paragraph id="par_id230720172234187602" role="bascode" localize="false" xml-lang="en-US"> pValues(1) = 100</paragraph> +<paragraph id="par_id230720172234186650" role="bascode" localize="false" xml-lang="en-US"> pValues(2) = 100</paragraph> +<paragraph id="par_id230720172234184123" role="bascode" localize="false" xml-lang="en-US"> pValues(3) = -300</paragraph> +<paragraph id="par_id230720172234182595" role="bascode" localize="false" xml-lang="en-US"> pValues(4) = 100</paragraph> +<paragraph id="par_id230720172234183081" role="bascode" localize="false" xml-lang="en-US"> pValues(5) = 100</paragraph> +<paragraph id="par_id230720172234196719" role="bascode" localize="false" xml-lang="en-US"> r = 0.06</paragraph> +<paragraph id="par_id230720172234195414" role="bascode" localize="false" xml-lang="en-US"> p = NPV( r, pValues)</paragraph> +<paragraph id="par_id230720172234199811" role="bascode" xml-lang="en-US"> Print p ' returns 174,894967305331</paragraph> +<paragraph id="par_id230720172234199988" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060119.xhp#bm_id3149242">NPV function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03140007.xhp b/helpcontent2/source/text/sbasic/shared/03140007.xhp new file mode 100644 index 000000000..9d2e7001e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140007.xhp @@ -0,0 +1,76 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140007xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Pmt Function [VBA]</title> + <filename>/text/sbasic/shared/03140007.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="pmt"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>Pmt function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140007.xhp" name="Pmt Function [VBA]">Pmt Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Calculates the constant periodic payments for a loan or investment.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">Pmt( Rate as Double, NPer as Double , PV as Double , [FV as Variant], [Due as Variant] )</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id06142017042024114" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph> +<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which annuity is paid.</paragraph> +<paragraph id="par_id061420170420246794" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the (present) cash value of an investment.</paragraph> +<paragraph id="par_id061620170603217534" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the future value of the loan / investment.</paragraph> +<paragraph id="par_id061420170420241932" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) defines whether the payment is due at the beginning or the end of a period.</paragraph> +<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph> +<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id230720172323446745" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id230720172323448252" role="bascode" localize="false" xml-lang="en-US">Option VBASUPPORT 1</paragraph> +<paragraph id="par_id230720172323446103" role="bascode" xml-lang="en-US">' Calculate the monthly payments to a loan that is to be paid in full over 6 years.</paragraph> +<paragraph id="par_id230720172323448289" role="bascode" xml-lang="en-US">' Interest is 10% per year and payments are made at the end of the month.</paragraph> +<paragraph id="par_id230720172323447417" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePmt</paragraph> +<paragraph id="par_id230720172323446526" role="bascode" localize="false" xml-lang="en-US"> Dim myPmt As Double</paragraph> +<paragraph id="par_id230720172323442370" role="bascode" localize="false" xml-lang="en-US"> myPmt = Pmt( 0.1/12, 72, 100000 )</paragraph> +<paragraph id="par_id230720172323444810" role="bascode" xml-lang="en-US"> print MyPmt 'is calculated to be -1852,58377757705</paragraph> +<paragraph id="par_id23072017232344836" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060119.xhp#bm_id3149577">PMT function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03140008.xhp b/helpcontent2/source/text/sbasic/shared/03140008.xhp new file mode 100644 index 000000000..c9694aa3e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140008.xhp @@ -0,0 +1,82 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140008xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">PPmt Function [VBA]</title> + <filename>/text/sbasic/shared/03140008.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="ppmt"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>PPmt function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140008.xhp" name="PPmt Function [VBA]">PPmt Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns for a given period the payment on the principal for an investment that is based on periodic and constant payments and a constant interest rate.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">Pmt( Rate as Double, Per as Double, NPer as Double, PV as Double, [FV as Variant], [Due as Variant] )</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id06142017042024114" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph> +<paragraph id="par_id230720172341443986" role="paragraph" xml-lang="en-US"><emph>Per</emph> The period number for which you want to calculate the principal payment (must be an integer between 1 and Nper).</paragraph> +<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which annuity is paid.</paragraph> +<paragraph id="par_id061420170420246794" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the (present) cash value of an investment.</paragraph> +<paragraph id="par_id061620170603217534" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the future value of the loan / investment.</paragraph> +<paragraph id="par_id061420170420241932" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) defines whether the payment is due at the beginning or the end of a period.</paragraph> +<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph> +<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id230720172348086669" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id230720172348086665" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id230720172348087342" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePPmt</paragraph> +<paragraph id="par_id230720172348083623" role="bascode" xml-lang="en-US">' Calculate the principal payments during months 4 & 5, for a loan that is to be paid in full</paragraph> +<paragraph id="par_id230720172348089449" role="bascode" xml-lang="en-US">' over 6 years. Interest is 10% per year and payments are made at the end of the month.</paragraph> +<paragraph id="par_id23072017234808488" role="bascode" localize="false" xml-lang="en-US">Dim ppMth4 As Double</paragraph> +<paragraph id="par_id230720172348084787" role="bascode" localize="false" xml-lang="en-US">Dim ppMth5 As Double</paragraph> +<paragraph id="par_id230720172348088178" role="bascode" xml-lang="en-US">' Principal payment during month 4:</paragraph> +<paragraph id="par_id230720172348084356" role="bascode" localize="false" xml-lang="en-US">ppMth4 = PPmt( 0.1/12, 4, 72, 100000 )</paragraph> +<paragraph id="par_id230720172348086687" role="bascode" xml-lang="en-US">print ppMth4 ' ppMth4 is calculated to be -1044,94463903636.</paragraph> +<paragraph id="par_id230720172348081077" role="bascode" xml-lang="en-US">' Principal payment during month 5:</paragraph> +<paragraph id="par_id230720172348086143" role="bascode" localize="false" xml-lang="en-US">ppMth5 = PPmt( 0.1/12, 5, 72, 100000 )</paragraph> +<paragraph id="par_id230720172348086456" role="bascode" xml-lang="en-US">print ppMth5' ppMth5 is calculated to be -1053,65251102833.</paragraph> +<paragraph id="par_id23072017234808812" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060119.xhp#bm_id3150026">PPMT function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03140009.xhp b/helpcontent2/source/text/sbasic/shared/03140009.xhp new file mode 100644 index 000000000..2e8620daa --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140009.xhp @@ -0,0 +1,76 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140009xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">PV Function [VBA]</title> + <filename>/text/sbasic/shared/03140009.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="pv"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>PV function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140009.xhp" name="PV Function [VBA]">PV Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the Present Value of an investment resulting from a series of regular payments.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">Pmt( Rate as Double, NPer as Double, Pmt as Double, [FV as Variant], [Due as Variant] )</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id06142017042024114" role="paragraph" xml-lang="en-US"><emph>Rate</emph> is the periodic interest rate.</paragraph> +<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which annuity is paid.</paragraph> +<paragraph id="par_id061420170420246794" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the regular payment made per period.</paragraph> +<paragraph id="par_id061620170603217534" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the future value of the loan / investment.</paragraph> +<paragraph id="par_id061420170420241932" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) defines whether the payment is due at the beginning or the end of a period.</paragraph> +<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph> +<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id240720170007448066" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id240720170007447441" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id240720170007445069" role="bascode" localize="false" xml-lang="en-US">Sub ExamplePV</paragraph> +<paragraph id="par_id240720170007446775" role="bascode" xml-lang="en-US">' Calculate the present value of an annuity that pays $1,000 per month over 6 years.</paragraph> +<paragraph id="par_id240720170007459899" role="bascode" xml-lang="en-US">' Interest is 10% per year and each payment is made at the end of the month.</paragraph> +<paragraph id="par_id240720170007458577" role="bascode" localize="false" xml-lang="en-US">Dim pv1 As Double</paragraph> +<paragraph id="par_id240720170007455498" role="bascode" localize="false" xml-lang="en-US">pv1 = PV( 0.1/12, 72, -1000 )</paragraph> +<paragraph id="par_id240720170007455988" role="bascode" xml-lang="en-US">print pv1 ' pv1 is calculated to be 53978,6654781073.</paragraph> +<paragraph id="par_id240720170007456432" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060103.xhp#bm_id3147556">PV function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03140010.xhp b/helpcontent2/source/text/sbasic/shared/03140010.xhp new file mode 100644 index 000000000..f76bf540e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140010.xhp @@ -0,0 +1,77 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140010xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Rate Function [VBA]</title> + <filename>/text/sbasic/shared/03140010.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="rate"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>Rate function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140010.xhp" name="Rate Function [VBA]">Rate Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the interest rate of a loan or an investment.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">Rate( NPer as Double, Pmt as Double, PV as Double [FV as Variant], [Due as Variant], [Guess as Variant] )</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id061420170420248911" role="paragraph" xml-lang="en-US"><emph>NPer</emph> is the total number of periods, during which annuity is paid.</paragraph> +<paragraph id="par_id061420170420246794" role="paragraph" xml-lang="en-US"><emph>Pmt</emph> is the regular payment made per period.</paragraph> +<paragraph id="par_id061620170603217534" role="paragraph" xml-lang="en-US"><emph>PV</emph> is the present value of the loan / investment.</paragraph> +<paragraph id="par_id061620171603217534" role="paragraph" xml-lang="en-US"><emph>FV</emph> (optional) is the future value of the loan / investment.</paragraph> +<paragraph id="par_id061420170420241932" role="paragraph" xml-lang="en-US"><emph>Due</emph> (optional) defines whether the payment is due at the beginning or the end of a period.</paragraph> +<paragraph id="par_id0614201704292615" role="paragraph" xml-lang="en-US">0 - the payment is due at the end of the period;</paragraph> +<paragraph id="par_id061420170429263061" role="paragraph" xml-lang="en-US">1 - the payment is due at the beginning of the period.</paragraph> +<paragraph id="par_id240720170028547253" role="paragraph" xml-lang="en-US"><emph>Guess</emph>(optional) determines the estimated value of the interest with iterative calculation.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id240720170039054844" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id240720170039053945" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id240720170039056433" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRate</paragraph> +<paragraph id="par_id240720170039056654" role="bascode" xml-lang="en-US">' Calculate the interest rate required to pay off a loan of $100,000 over</paragraph> +<paragraph id="par_id240720170039057978" role="bascode" xml-lang="en-US">' 6 years, with payments of $1,500, due at the end of each month.</paragraph> +<paragraph id="par_id240720170039054755" role="bascode" localize="false" xml-lang="en-US"> Dim mRate As Double</paragraph> +<paragraph id="par_id240720170039052259" role="bascode" localize="false" xml-lang="en-US"> mRate = Rate( 72, -1500, 100000 )</paragraph> +<paragraph id="par_id240720170039052476" role="bascode" xml-lang="en-US"> print mRate' mRate is calculated to be 0.00213778025343334</paragraph> +<paragraph id="par_id240720170039056365" role="bascode" localize="false" xml-lang="en-US">End sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060118.xhp#bm_id3154267">RATE function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03140011.xhp b/helpcontent2/source/text/sbasic/shared/03140011.xhp new file mode 100644 index 000000000..6864384ba --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140011.xhp @@ -0,0 +1,72 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140011xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SLN Function [VBA]</title> + <filename>/text/sbasic/shared/03140011.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="sln"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>SLN function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140011.xhp" name="SLN Function [VBA]">SLN Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the straight-line depreciation of an asset for one period. The amount of the depreciation is constant during the depreciation period.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">SLN (Cost as Double, Salvage as Double, Life as Double)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id240720170117391741" role="paragraph" xml-lang="en-US"><emph>Cost</emph> is the initial cost of an asset.</paragraph> +<paragraph id="par_id24072017011739895" role="paragraph" xml-lang="en-US"><emph>Salvage</emph> is the value of an asset at the end of the depreciation.</paragraph> +<paragraph id="par_id240720170117395610" role="paragraph" xml-lang="en-US"><emph>Life </emph>is the depreciation period determining the number of periods in the depreciation of the asset.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id24072017011739179" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id240720170117398470" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id240720170117391109" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSLN</paragraph> +<paragraph id="par_id24072017011739366" role="bascode" xml-lang="en-US">REM Calculate the yearly depreciation of an asset that cost $10,000 at</paragraph> +<paragraph id="par_id240720170117398814" role="bascode" xml-lang="en-US">REM the start of year 1, and has a salvage value of $1,000 after 5 years.</paragraph> +<paragraph id="par_id240720170117393993" role="bascode" localize="false" xml-lang="en-US">Dim y_dep As Double</paragraph> +<paragraph id="par_id240720170117395151" role="bascode" localize="false" xml-lang="en-US">y_dep = SLN( 10000, 1000, 6 )</paragraph> +<paragraph id="par_id240720170117391728" role="bascode" xml-lang="en-US">print y_dep ' returns 1500.</paragraph> +<paragraph id="par_id240720170117394409" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060119.xhp#bm_id3148912">SLN function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03140012.xhp b/helpcontent2/source/text/sbasic/shared/03140012.xhp new file mode 100644 index 000000000..9ad42e26b --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03140012.xhp @@ -0,0 +1,74 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03140012xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">SYD Function [VBA]</title> + <filename>/text/sbasic/shared/03140012.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="syd"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>SYD function</bookmark_value> +</bookmark> + + +<paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03140012.xhp" name="SYD Function [VBA]">SYD Function [VBA]</link></paragraph> +<paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the arithmetic-declining depreciation rate.</paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> +<paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">SYD (Cost as Double, Salvage as Double, Life as Double, Period as Double)</paragraph> +</bascode> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">Double</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id240720170117391741" role="paragraph" xml-lang="en-US"><emph>Cost</emph> is the initial cost of an asset.</paragraph> +<paragraph id="par_id24072017011739895" role="paragraph" xml-lang="en-US"><emph>Salvage</emph> is the value of an asset at the end of the depreciation.</paragraph> +<paragraph id="par_id240720170117395610" role="paragraph" xml-lang="en-US"><emph>Life</emph> is the depreciation period determining the number of periods in the depreciation of the asset.</paragraph> +<paragraph id="par_id240720170144224764" role="paragraph" xml-lang="en-US"><emph>Period</emph> is the period number for which you want to calculate the depreciation.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> +<embed href="text/sbasic/shared/00000003.xhp#err5"/> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph id="par_id240720170144228912" role="bascode" localize="false" xml-lang="en-US">REM ***** BASIC *****</paragraph> +<paragraph id="par_id240720170144225359" role="bascode" localize="false" xml-lang="en-US">Option VBASupport 1</paragraph> +<paragraph id="par_id240720170144227525" role="bascode" localize="false" xml-lang="en-US">Sub ExampleSYD</paragraph> +<paragraph id="par_id240720170144225698" role="bascode" xml-lang="en-US">REM Calculate the yearly depreciation of an asset that cost $10,000 at</paragraph> +<paragraph id="par_id240720170144223210" role="bascode" xml-lang="en-US">REM the start of year 1, and has a salvage value of $1,000 after 5 years.</paragraph> +<paragraph id="par_id240720170144227162" role="bascode" localize="false" xml-lang="en-US">Dim syd_yr1 As Double</paragraph> +<paragraph id="par_id240720170144223139" role="bascode" xml-lang="en-US">REM Calculate the depreciation during year 1.</paragraph> +<paragraph id="par_id240720170144228546" role="bascode" localize="false" xml-lang="en-US">syd_yr1 = SYD( 10000, 1000, 5, 1 )</paragraph> +<paragraph id="par_id240720170144221476" role="bascode" xml-lang="en-US">print syd_yr1 ' syd_yr1 is now equal to 3000.</paragraph> +<paragraph id="par_id240720170144221275" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +</bascode> + +<section id="relatedtopics"> +<paragraph id="par_id061420170153186192" role="paragraph" xml-lang="en-US"><link href="text/scalc/01/04060103.xhp#bm_id3152978">SYD function in CALC</link></paragraph> +<embed href="text/sbasic/shared/00000003.xhp#VBA-Financial"/> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/03150000.xhp b/helpcontent2/source/text/sbasic/shared/03150000.xhp new file mode 100644 index 000000000..01ed09073 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03150000.xhp @@ -0,0 +1,142 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + <meta> + <topic id="textsbasicshared03150000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FormatDateTime Function [VBA]</title> + <filename>/text/sbasic/shared/03150000.xhp</filename> + </topic> + </meta> + + <body> + + <section id="FormatDateTime"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>FormatDateTime function</bookmark_value> + </bookmark> + + <paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03150000.xhp" name="FormatDateTime Function [VBA]">FormatDateTime Function [VBA]</link></paragraph> + <paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Applies a date and/or time format to a date expression and returns the result as a string.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">FormatDateTime (DateExpression as Date [, NamedFormat as Integer])</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">String</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id240720170117391741" role="paragraph" xml-lang="en-US"><emph>DateExpression</emph>: The date expression to be formatted.</paragraph> + <paragraph id="par_id24072017011739895" role="paragraph" xml-lang="en-US"><emph>NamedFormat</emph>: An optional <emph>vbDateTimeFormat</emph> enumeration specifying the format that is to be applied to the date and time expression. If omitted, the value <emph>vbGeneralDate</emph> is used.</paragraph> + <paragraph role="heading" id="hd_id811512136434300" level="3" xml-lang="en-US">Date and Time formats (vbDateTimeFormat enumeration)</paragraph> + <section id="FormatDateTime_constants"> + <table id="tab_0001"> + <tablerow> + <tablecell> + <paragraph role="tablehead" id="par_id201512137337536" xml-lang="en-US">Named Constant</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablehead" id="par_id481512137342798" xml-lang="en-US">Value</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablehead" id="par_id781512137345583" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontents" id="par_id121512137348477" xml-lang="en-US" localize="false">vbGeneralDate</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontents" id="par_id511512137351182" xml-lang="en-US" localize="false">0</paragraph> + </tablecell> + <tablecell> + <paragraph role="tablecontents" id="par_id991512137353869" xml-lang="en-US">Displays a date and/or time as defined in your system's General Date setting. If a date only, no time is displayed; If a time only, no date is displayed.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181512137579110" role="tablecontents" xml-lang="en-US" localize="false">vbLongDate</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651512137595327" role="tablecontents" xml-lang="en-US" localize="false">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841512137597989" role="tablecontents" xml-lang="en-US" >Display a date using the long date format specified in your computer's regional settings.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph role="tablecontents" id="par_id391512138077008" xml-lang="en-US" localize="false">vbShortDate</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651512137594327" role="tablecontents" xml-lang="en-US" localize="false">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841512137397989" role="tablecontents" xml-lang="en-US" >Display a date using the short date format specified in your computer's regional settings.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181512137679110" role="tablecontents" xml-lang="en-US" localize="false">vbLongTime</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651512137595227" role="tablecontents" xml-lang="en-US" localize="false">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841512147597989" role="tablecontents" xml-lang="en-US" >Displays a time as defined in your system's Long Time settings.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id183512137579110" role="tablecontents" xml-lang="en-US" localize="false">vbShortTime</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651512937595327" role="tablecontents" xml-lang="en-US" localize="false">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841517137597989" role="tablecontents" xml-lang="en-US" >Display a time using the 24-hour format (hh:mm).</paragraph> + </tablecell> + </tablerow> + </table> + </section> + + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err13"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id851512148348809" xml-lang="en-US" localize="false">REM ***** BASIC *****</paragraph> + <paragraph role="bascode" id="par_id981512148374491" xml-lang="en-US" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="par_id541512148389055" xml-lang="en-US" localize="false">Sub DateFormat</paragraph> + <paragraph role="bascode" id="par_id91512148403780" xml-lang="en-US" localize="false"> Dim d as Date</paragraph> + <paragraph role="bascode" id="par_id551512148424467" xml-lang="en-US" localize="false"> d = ("1958-01-29 00:25")</paragraph> + <paragraph role="bascode" id="par_id541512148446032" xml-lang="en-US"> msgbox("General date format : " & FormatDateTime(d))</paragraph> + <paragraph role="bascode" id="par_id71512148472413" xml-lang="en-US" > msgbox("Long date format : " & FormatDateTime(d,vbLongDate))</paragraph> + <paragraph role="bascode" id="par_id561512148491949" xml-lang="en-US" > msgbox("Short date format : " & FormatDateTime(d,vbShortDate))</paragraph> + <paragraph role="bascode" id="par_id521512148501199" xml-lang="en-US" > msgbox("Long time format : " & FormatDateTime(d,3))</paragraph> + <paragraph role="bascode" id="par_id521512148513930" xml-lang="en-US" > msgbox("Short time format : " & FormatDateTime(d,vbShortTime))</paragraph> + <paragraph role="bascode" id="par_id211512148529064" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/00000003.xhp#VBATimeAndDate"/> + </section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03150001.xhp b/helpcontent2/source/text/sbasic/shared/03150001.xhp new file mode 100644 index 000000000..d3e0e20c8 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03150001.xhp @@ -0,0 +1,173 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + <meta> + <topic id="textsbasicshared03150001xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">WeekdayName Function [VBA]</title> + <filename>/text/sbasic/shared/03150001.xhp</filename> + </topic> + </meta> + + <body> + + + <section id="WeekdayName"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>WeekdayName function</bookmark_value> + </bookmark> + + <paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03150001.xhp" name="WeekdayName Function [VBA]">WeekdayName Function [VBA]</link></paragraph> + <paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">The WeekdayName function returns the weekday name of a specified day of the week.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">WeekdayName(Weekday as Integer [,Abbreviate as Boolean [,FirstDayofWeek as Integer]])</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">String</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id240720170117391741" role="paragraph" xml-lang="en-US"><emph>Weekday</emph>: Value from 1 to 7, Monday to Sunday, whose Week Day Name need to be calculated.</paragraph> + <paragraph id="par_id24072017011739895" role="paragraph" xml-lang="en-US"><emph>Abbreviate</emph>: Optional. A Boolean value that indicates if the weekday name is to be abbreviated.</paragraph> + <paragraph id="par_id240720170117395610" role="paragraph" xml-lang="en-US"><emph>FirstDayofWeek</emph>: Optional. Specifies the first day of the week.</paragraph> + <paragraph role="heading" id="hd_id521512154797683" level="3" xml-lang="en-US">First day of Week:</paragraph> + <table id="tab_id921512153192034"> + <tablerow> + <tablecell> + <paragraph id="par_id921512153192034" role="tablehead" xml-lang="en-US">Named constant</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611512153251598" role="tablehead" xml-lang="en-US">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491512153274624" role="tablehead" xml-lang="en-US">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id991512153295301" role="tablecontent" xml-lang="en-US" localize="false">vbUseSystemDayOfWeek</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571512153316028" role="tablecontent" xml-lang="en-US" localize="false">0</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id611512153338316" role="tablecontent" xml-lang="en-US">Use National Language Support (NLS) API setting</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id291512153514339" role="tablecontent" xml-lang="en-US" localize="false">vbSunday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id791512153569394" role="tablecontents" xml-lang="en-US" localize="false">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151512153594420" role="tablecontents" xml-lang="en-US" >Sunday (default)</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431512153629070" role="tablecontents" xml-lang="en-US" localize="false">vbMonday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id171512153830709" role="tablecontents" xml-lang="en-US" localize="false">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211512153874765" role="tablecontents" xml-lang="en-US" >Monday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id1001512153904187" role="tablecontent" xml-lang="en-US" localize="false">vbTuesday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771512153929215" role="tablecontents" xml-lang="en-US" localize="false">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801512153944376" role="tablecontents" xml-lang="en-US" >Tuesday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id751512153958407" role="tablecontents" xml-lang="en-US" localize="false">vbWednesday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91512153983659" role="tablecontents" xml-lang="en-US" localize="false">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id551512153998501" role="tablecontents" xml-lang="en-US" >Wednesday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681512154016128" role="tablecontents" xml-lang="en-US" localize="false">vbThursday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id871512154041210" role="tablecontents" xml-lang="en-US" localize="false">5</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id121512154054207" role="tablecontents" xml-lang="en-US" >Thursday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591512154073632" role="tablecontents" xml-lang="en-US" localize="false">vbFriday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691512154099442" role="tablecontents" xml-lang="en-US" localize="false">6</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571512154112044" role="tablecontents" xml-lang="en-US" >Friday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151512154128303" role="tablecontents" xml-lang="en-US" localize="false">vbSaturday</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831512154158535" role="tablecontents" xml-lang="en-US" localize="false">7</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id541512154172107" role="tablecontents" xml-lang="en-US" >Saturday</paragraph> + </tablecell> + </tablerow> + </table> + + + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <paragraph role="paragraph" id="par_id171512156115581" xml-lang="en-US">None</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id731512155686932" xml-lang="en-US" localize="false">REM ***** BASIC *****</paragraph> + <paragraph role="bascode" id="par_id141512155672881" xml-lang="en-US" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="par_id741512155700026" xml-lang="en-US" localize="false">Sub Example_WeekdayName</paragraph> + <paragraph role="bascode" id="par_id321512155714044" xml-lang="en-US" localize="false"> Dim tgf as Integer</paragraph> + <paragraph role="bascode" id="par_id1001512155732764" xml-lang="en-US" localize="false"> tgf = 6</paragraph> + <paragraph role="bascode" id="par_id421512155749762" xml-lang="en-US" localize="false"> print tgf &" "& WeekdayName(tgf,False,vbSunday)</paragraph> + <paragraph role="bascode" id="par_id891512155760344" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + + <embed href="text/sbasic/shared/00000003.xhp#VBATimeAndDate"/> + </section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03150002.xhp b/helpcontent2/source/text/sbasic/shared/03150002.xhp new file mode 100644 index 000000000..5516ab45c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03150002.xhp @@ -0,0 +1,66 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + + <meta> + <topic id="textsbasicshared03150002xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">MonthName Function [VBA]</title> + <filename>/text/sbasic/shared/03150002.xhp</filename> + </topic> + </meta> + + <body> + <section id="MonthName"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>MonthName function</bookmark_value> + </bookmark> + + <paragraph id="hd_id3150499" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03150002.xhp" name="MonthName Function [VBA]">MonthName Function [VBA]</link></paragraph> + <paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">The MonthName function returns the localized month name of a specified month number.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">MonthName(Month as Integer [,Abbreviate as Boolean])</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">String</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id240720170117391741" role="paragraph" xml-lang="en-US"><emph>Month</emph>: Value from 1 to 12, January to December, whose localized month name need to be returned.</paragraph> + <paragraph id="par_id24072017011739895" role="paragraph" xml-lang="en-US"><emph>Abbreviate</emph>: Optional. A Boolean value that indicates if the month name is to be abbreviated.</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id731512155686932" xml-lang="en-US" localize="false">REM ***** BASIC *****</paragraph> + <paragraph role="bascode" id="par_id141512155672881" xml-lang="en-US" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="par_id741512155700026" xml-lang="en-US" localize="false">Sub Example_MonthName</paragraph> + <paragraph role="bascode" id="par_id321512155714044" xml-lang="en-US" localize="false"> Dim mBirthday as Integer</paragraph> + <paragraph role="bascode" id="par_id1001512155732764" xml-lang="en-US" localize="false"> mBirthday = 1</paragraph> + <paragraph role="bascode" id="par_id421512155749762" xml-lang="en-US" localize="false"> print mBirthday &" "& MonthName(mBirthday,False)</paragraph> + <paragraph role="bascode" id="par_id891512155760344" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/00000003.xhp#VBATimeAndDate"/> + </section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03160000.xhp b/helpcontent2/source/text/sbasic/shared/03160000.xhp new file mode 100644 index 000000000..aa429b151 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03160000.xhp @@ -0,0 +1,73 @@ +<?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/. +* +* This file incorporates work covered by the following license notice: +* +* Licensed to the Apache Software Foundation (ASF) under one or more +* contributor license agreements. See the NOTICE file distributed +* with this work for additional information regarding copyright +* ownership. The ASF licenses this file to you under the Apache +* License, Version 2.0 (the "License"); you may not use this file +* except in compliance with the License. You may obtain a copy of +* the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03160000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Input Function [VBA]</title> + <filename>/text/sbasic/shared/03160000.xhp</filename> + </topic> +</meta> + +<body> + <section id="Input"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>Input function</bookmark_value> + </bookmark> + <h1 id="hd_id141626276767913"><variable id="Input_h1"><link href="text/sbasic/shared/03160000.xhp" name="Input Function [VBA]">Input Function [VBA]</link></variable></h1> + <paragraph id="par_id3151384" role="paragraph" xml-lang="en-US">Returns the open stream of an Input or Binary file (String).</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph id="par_id3143267" role="bascode" localize="false" xml-lang="en-US">Input( Number as Integer, [# ] FileNumber as Integer)</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3150669" role="paragraph" localize="false" xml-lang="en-US">String</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id240720170117391741" role="paragraph" xml-lang="en-US"><emph>Number</emph>: Required. Numeric expression specifying the number of characters to return.</paragraph> + <paragraph id="par_id24072017011739895" role="paragraph" xml-lang="en-US"><emph>#</emph>: Optional.</paragraph> + <paragraph id="par_id240720170117395610" role="paragraph" xml-lang="en-US"><emph>FileNumber</emph>: Required. Any valid file number.</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err6"/> + <embed href="text/sbasic/shared/00000003.xhp#err52"/> + <embed href="text/sbasic/shared/00000003.xhp#err62"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id240720144228912" localize="false">REM ***** BASIC *****</paragraph> + <paragraph role="bascode" id="par_id240720144225359" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="par_id371512159801764" localize="false">Sub Example_Input</paragraph> + <paragraph role="bascode" id="par_id291512159796937" localize="false"> Dim MyData</paragraph> + <paragraph role="bascode" id="par_id251512159786757" localize="false"> Open "MyDataFile.txt" For Input As #1</paragraph> + <paragraph role="bascode" id="par_id271512159778620" localize="false"> Do While Not EOF(1)</paragraph> + <paragraph role="bascode" id="par_id361512159768651" localize="false"> MyData = Input(1, #1)</paragraph> + <paragraph role="bascode" id="par_id551512159751248" localize="false"> Print MyData</paragraph> + <paragraph role="bascode" id="par_id321512159745050" localize="false"> Loop</paragraph> + <paragraph role="bascode" id="par_id615121597830602" localize="false"> Close #1</paragraph> + <paragraph role="bascode" id="par_id240720170221275" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03020202.xhp#Input_h1"/> + <embed href="text/sbasic/shared/00000003.xhp#VBAIO"/> + </section> +</body> + +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03170000.xhp b/helpcontent2/source/text/sbasic/shared/03170000.xhp new file mode 100644 index 000000000..7f5d824fb --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03170000.xhp @@ -0,0 +1,84 @@ +<?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/. +* +* This file incorporates work covered by the following license notice: +* +* Licensed to the Apache Software Foundation (ASF) under one or more +* contributor license agreements. See the NOTICE file distributed +* with this work for additional information regarding copyright +* ownership. The ASF licenses this file to you under the Apache +* License, Version 2.0 (the "License"); you may not use this file +* except in compliance with the License. You may obtain a copy of +* the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicshared03170000xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Round Function [VBA]</title> + <filename>/text/sbasic/shared/03170000.xhp</filename> + </topic> +</meta> + +<body> + <section id="Round"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3150499"> + <bookmark_value>Round function (VBA)</bookmark_value> + </bookmark> + <h1 id="hd_id3150499"><variable id="Round_VBA_h1"><link href="text/sbasic/shared/03170000.xhp" name="Round Function [VBA]">Round Function [VBA]</link></variable></h1> + <paragraph id="par_id3151384" role="paragraph">Rounds a numeric value to a specified number of decimal digits.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <paragraph role="paragraph" id="par_id741634154499890">This function implements the rounding rule known as "round-to-even". With this rule, whenever the difference between the number to be rounded and its nearest integer is equal to 0.5, the number is rounded to the nearest even number. See the examples <link href="text/sbasic/shared/03170000.xhp#round_example" name="round_ex_link">below</link> to learn more about this rule.</paragraph> + <note id="par_id691634217736290">Beware that VBA's <literal>Round</literal> function works differently than %PRODUCTNAME Calc's <literal>Round</literal> function. In Calc, if the difference between the number to be rounded and the nearest integer is exactly 0.5, then the number is rounded up. Hence, in Calc the number 2.5 is rounded to 3 whereas using VBA's <literal>Round</literal> function the value 2.5 is rounded to 2 due to the "round-to-even" rule.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id141634153766945"> + <input>Round(expression [,numdecimalplaces])</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph id="par_id3150669" role="paragraph" localize="false">Double</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id240720170117391741" role="paragraph"><emph>expression</emph>: The numeric expression to be rounded.</paragraph> + <paragraph id="par_id240720170117395610" role="paragraph"><emph>numdecimalplaces</emph>: Optional argument that specifies the number of decimal digits in the resulting rounded value. The default value is 0.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id240720170144225359" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="par_id701512162274019" localize="false">Sub Example_Round</paragraph> + <paragraph role="bascode" id="par_id501512162266839" localize="false"> Dim r </paragraph> + <paragraph role="bascode" id="par_id91512162260091" localize="false"> r = Pi</paragraph> + <paragraph role="bascode" id="par_id571512162254456" localize="false"> print r ' 3,14159265358979</paragraph> + <paragraph role="bascode" id="par_id831512162245783" localize="false"> print Round(r, 5) ' 3,14159</paragraph> + <paragraph role="bascode" id="par_id981512162218659" localize="false"> r = exp(1)</paragraph> + <paragraph role="bascode" id="par_id761512162210883" localize="false"> print r ' 2,71828182845904</paragraph> + <paragraph role="bascode" id="par_id521512162200022" localize="false"> print Round(r) ' 3</paragraph> + <paragraph role="bascode" id="par_id240720170144221275" localize="false">End Sub</paragraph> + </bascode> + <section id="round_example"> + <paragraph role="paragraph" id="par_id541634154843718">The following examples illustrate the "round-to-even" rule:</paragraph> + </section> + <bascode> + <paragraph role="bascode" id="bas_id651634154984931">' Rounding to the nearest integer (decimalplaces = 0)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id1001634154985235">MsgBox Round(3.5) ' 4</paragraph> + <paragraph role="bascode" localize="false" id="bas_id901634154985511">MsgBox Round(4.5) ' 4</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231634154985759">MsgBox Round(5.5) ' 6</paragraph> + <paragraph role="bascode" localize="false" id="bas_id131634154986008">MsgBox Round(6.5) ' 6</paragraph> + <paragraph role="bascode" id="bas_id651634157812537">' Rounding with 2 decimal digits (decimalplaces = 2)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id741634157812848">MsgBox Round(1.555, 2) ' 1.56</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31634157813184">MsgBox Round(1.565, 2) ' 1.56</paragraph> + <paragraph role="bascode" localize="false" id="bas_id911634157813504">MsgBox Round(1.575, 2) ' 1.58</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61634157813841">MsgBox Round(1.585, 2) ' 1.58</paragraph> + </bascode> + + <section id="relatedtopics"> + <paragraph id="par_id061420170153186193" role="paragraph"><link href="text/scalc/01/04060106.xhp#Section21">Calc ROUND function</link></paragraph> + <embed href="text/sbasic/shared/00000003.xhp#VBAMath"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/03170010.xhp b/helpcontent2/source/text/sbasic/shared/03170010.xhp new file mode 100644 index 000000000..2202cd123 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03170010.xhp @@ -0,0 +1,118 @@ +<?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="textsbasicshared03170010xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">FormatNumber Function [VBA]</title> + <filename>/text/sbasic/shared/03170010.xhp</filename> + </topic> + </meta> + <body> + <section id="formatnumber"> + <bookmark id="bm_id541542193473856" xml-lang="en-US" branch="hid/zzzz" localize="false"/> + <bookmark xml-lang="en-US" branch="index" id="bm_id661542193659245"> + <bookmark_value>FormatNumber function</bookmark_value> + </bookmark> + <paragraph id="hd_id871542193473857" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03170010.xhp" name="FormatNumber Function [VBA]">FormatNumber [VBA]</link></paragraph> + <paragraph id="par_id351542193473858" role="paragraph" xml-lang="en-US">Returns a string with a number formatting applied to a numeric expression.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="bascode" id="par_id291542194090512" xml-lang="en-US" localize="false">FormatNumber( expression, numDigitsAfterDecimal as Integer, includeLeadingDigit as Integer, <br/> useParensForNegativeNumbers as Integer, groupDigits as Integer )</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id761542194361212" xml-lang="en-US">String</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + + <paragraph id="par_id240720170117391741" role="paragraph" xml-lang="en-US"><emph>expression</emph>: Required. The numeric expression to be formatted.</paragraph> + + <paragraph role="paragraph" id="par_id631542195798758" xml-lang="en-US"><emph>numDigitsAfterDecimal</emph>: Optional. A numeric value specifying the number of digits that should be displayed after the decimal. If omitted, it defaults to the value -1, meaning that the default settings for user interface locale should be used.</paragraph> + + <paragraph role="paragraph" id="par_id961542200034362" xml-lang="en-US"><emph>includeLeadingDigit</emph>: Optional. A <link href="text/sbasic/shared/03040000.xhp#addvbaconstants" name="vbtristate">vbTriState</link> enumeration value, specifying whether a leading zero should be displayed for fractional values.</paragraph> + + <list type="unordered"> + <listitem> + <paragraph id="par_id561542198440051" role="listitem" xml-lang="en-US"><emph>vbTrue or -1</emph>: Display a leading zero.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id21542198550868" role="listitem" xml-lang="en-US"><emph>vbFalse or 0</emph>: Do not display leading zeros.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id241542199046808" role="listitem" xml-lang="en-US"><emph>vbUseDefaults or -2</emph>: Use the user interface locale settings. This is the default when omitted.</paragraph> + </listitem> + </list> + <paragraph role="paragraph" id="par_id311542201637647" xml-lang="en-US"><emph>useParensForNegativeNumbers</emph>: Optional. A <link href="text/sbasic/shared/03040000.xhp#addvbaconstants" name="vbtristate">vbTriState</link> enumeration value specifying whether negative numbers should be encased in parenthesis.</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id561543198440051" role="listitem" xml-lang="en-US"><emph>vbTrue or -1</emph>: Use parenthesis for negative numbers.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id21542398550868" role="listitem" xml-lang="en-US"><emph>vbFalse or 0</emph>: Do not display parenthesis.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id241542191246808" role="listitem" xml-lang="en-US"><emph>vbUseDefaults or -2</emph>: Same as vbFalse. This is the default when omitted.</paragraph> + </listitem> + </list> + + <paragraph role="paragraph" id="par_id531542201968815" xml-lang="en-US"><emph>groupDigits</emph>: Optional. A <link href="text/sbasic/shared/03040000.xhp#addvbaconstants" name="vbtristate">vbTriState</link> enumeration value specifying the number should be grouped (into thousands, etc.), using the group delimiter that is specified on the system's regional settings.</paragraph> + + <list type="unordered"> + <listitem> + <paragraph id="par_id561543198560051" role="listitem" xml-lang="en-US"><emph>vbTrue or -1</emph>: Group digits.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id215423985506768" role="listitem" xml-lang="en-US"><emph>vbFalse or 0</emph>: Do not group digits.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id241542191267808" role="listitem" xml-lang="en-US"><emph>vbUseDefaults or -2</emph>: Same as vbFalse. This is the default when omitted.</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err13"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id381542204697430" xml-lang="en-US" localize="false">Sub TestFormatNumber</paragraph> + <paragraph role="bascode" id="par_id551542204266762" xml-lang="en-US" localize="false">testName = "Test 1: positive, 2 decimals"</paragraph> + <paragraph role="bascode" id="par_id561542204276644" xml-lang="en-US" localize="false">str2 = "12.20"</paragraph> + <paragraph role="bascode" id="par_id341542204281478" xml-lang="en-US" localize="false">str1 = FormatNumber("12.2", 2, vbFalse, vbFalse, vbFalse)</paragraph> + <paragraph role="bascode" id="par_id771542204286220" xml-lang="en-US" localize="false">msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)</paragraph> + + <paragraph role="bascode" id="par_id411542204290664" xml-lang="en-US" localize="false">testName = "Test 2: negative, 20 decimals, use leading zero"</paragraph> + <paragraph role="bascode" id="par_id411542204295496" xml-lang="en-US" localize="false">str2 = "-0.20000000000000000000"</paragraph> + <paragraph role="bascode" id="par_id391542204301416" xml-lang="en-US" localize="false">str1 = FormatNumber("-.2", 20, vbTrue, vbFalse, vbFalse)</paragraph> + <paragraph role="bascode" id="par_id671542204307459" xml-lang="en-US" localize="false">msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)</paragraph> + + <paragraph role="bascode" id="par_id741542204311861" xml-lang="en-US" localize="false">testName = "Test 3: negative, 20 decimals, no leading zero"</paragraph> + <paragraph role="bascode" id="par_id871542204316094" xml-lang="en-US" localize="false">str2 = "-.20000000000000000000"</paragraph> + <paragraph role="bascode" id="par_id911542204322988" xml-lang="en-US" localize="false">str1 = FormatNumber("-0.2", 20, vbFalse, vbFalse, vbFalse)</paragraph> + <paragraph role="bascode" id="par_id61542204328859" xml-lang="en-US" localize="false">msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)</paragraph> + + <paragraph role="bascode" id="par_id781542204333400" xml-lang="en-US" localize="false">testName = "Test 4: negative, no leading zero, use parens"</paragraph> + <paragraph role="bascode" id="par_id161542204338478" xml-lang="en-US" localize="false">str2 = "(.20)"</paragraph> + <paragraph role="bascode" id="par_id251542204342658" xml-lang="en-US" localize="false">str1 = FormatNumber("-0.2", -1, vbFalse, vbTrue, vbFalse)</paragraph> + <paragraph role="bascode" id="par_id421542204347269" xml-lang="en-US" localize="false">msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)</paragraph> + + <paragraph role="bascode" id="par_id181542204351589" xml-lang="en-US" localize="false">testName = "Test 5: negative, default leading zero, use parens"</paragraph> + <paragraph role="bascode" id="par_id561542204357496" xml-lang="en-US" localize="false">str2 = "(0.20)"</paragraph> + <paragraph role="bascode" id="par_id341542204361912" xml-lang="en-US" localize="false">str1 = FormatNumber("-0.2", -1, vbUseDefault, vbTrue, vbFalse)</paragraph> + <paragraph role="bascode" id="par_id151542204366706" xml-lang="en-US" localize="false">msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)</paragraph> + + <paragraph role="bascode" id="par_id841542204371456" xml-lang="en-US" localize="false">testName = "Test 6: group digits"</paragraph> + <paragraph role="bascode" id="par_id711542204376020" xml-lang="en-US" localize="false">str2 = "-12,345,678.00"</paragraph> + <paragraph role="bascode" id="par_id481542204380404" xml-lang="en-US" localize="false">str1 = FormatNumber("-12345678", -1, vbUseDefault, vbUseDefault, vbTrue)</paragraph> + <paragraph role="bascode" id="par_id971542204385212" xml-lang="en-US" localize="false">msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)</paragraph> + <paragraph role="bascode" id="par_id11542204687786" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/00000003.xhp#VBAMath"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/05060700.xhp b/helpcontent2/source/text/sbasic/shared/05060700.xhp new file mode 100644 index 000000000..f785cc03a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/05060700.xhp @@ -0,0 +1,372 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicshared05060700xml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Macro</title> +<filename>/text/sbasic/shared/05060700.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="macro"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3153894"><bookmark_value>events;linked to objects</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3153894" xml-lang="en-US" level="1"><link href="text/sbasic/shared/05060700.xhp" name="Macro">Macro</link></paragraph> +<paragraph role="paragraph" id="par_id3153748" xml-lang="en-US"><ahelp hid=".">Choose the macro that you want to execute when the selected graphic, frame, or OLE object is selected.</ahelp> Depending on the object that is selected, the function is either found on the <emph>Macro</emph> tab of the <emph>Object</emph> dialog, or in the <emph>Assign Macro</emph> dialog.</paragraph> +</section> +<paragraph role="heading" id="hd_id3150503" xml-lang="en-US" level="2">Event</paragraph> +<paragraph role="paragraph" id="par_id3149763" xml-lang="en-US"><ahelp hid="cui/ui/eventassignpage/assignments">Lists the events that are relevant to the macros that are currently assigned to the selected object.</ahelp></paragraph> +<paragraph role="paragraph" id="par_id3150670" xml-lang="en-US">The following table describes the macros and the events that can by linked to objects in your document:</paragraph> +<table id="tbl_id3148944"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3153360" xml-lang="en-US">Event</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3154365" xml-lang="en-US">Event trigger</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3159149" xml-lang="en-US">OLE object</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3148451" xml-lang="en-US">Graphics</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3125863" xml-lang="en-US">Frame</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3154216" xml-lang="en-US">AutoText</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3145785" xml-lang="en-US">ImageMap area</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3153138" xml-lang="en-US">Hyperlink</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US">Click object</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3152460" xml-lang="en-US">Object is selected.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147348" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147426" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3153951" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150116" xml-lang="en-US">Mouse over object</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3145253" xml-lang="en-US">Mouse moves over the object.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3144765" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3153418" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3153948" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3145652" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3155066" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3155446" xml-lang="en-US">Trigger Hyperlink</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154756" xml-lang="en-US">Hyperlink assigned to the object is clicked.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150042" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3151252" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147344" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3146920" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3159333" xml-lang="en-US">Mouse leaves object </paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147003" xml-lang="en-US">Mouse moves off of the object.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3151278" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3145257" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154122" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3156139" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3149036" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150785" xml-lang="en-US">Graphics load successful </paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3153705" xml-lang="en-US">Graphics are loaded successfully.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150343" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150202" xml-lang="en-US">Graphics load terminated</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3145584" xml-lang="en-US">Loading of graphics is stopped by the user (for example, when downloading the page).</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154259" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3155089" xml-lang="en-US">Graphics load faulty</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3153307" xml-lang="en-US">Graphics not successfully loaded, for example, if a graphic was not found.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3148840" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154533" xml-lang="en-US">Input of alpha characters </paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3155266" xml-lang="en-US">Text is entered from the keyboard.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3144768" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3145659" xml-lang="en-US">Input of non-alpha characters </paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3151131" xml-lang="en-US">Nonprinting characters are entered from the keyboard, for example, tabs and line breaks.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3159206" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150405" xml-lang="en-US">Resize frame</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3153972" xml-lang="en-US">Frame is resized with the mouse.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3152873" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3148900" xml-lang="en-US">Move frame</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3154767" xml-lang="en-US">Frame is moved with the mouse.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3155914" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3153010" xml-lang="en-US">Before inserting AutoText</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147515" xml-lang="en-US">Before a text block is inserted.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3151191" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3150956" xml-lang="en-US">After inserting AutoText</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147502" xml-lang="en-US">After a text block is inserted.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="paragraph" id="par_id3147555" xml-lang="en-US" localize="false">✓</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +<tablecell colspan="" rowspan=""> +</tablecell> +</tablerow> +</table> + +<paragraph role="heading" id="hd_id3153958" xml-lang="en-US" level="2">Macros</paragraph> +<paragraph role="paragraph" id="par_id3150432" xml-lang="en-US">Choose the macro that you want to execute when the selected event occurs.</paragraph> +<paragraph role="paragraph" id="par_id3147296" xml-lang="en-US">Frames allow you to link events to a function, so that the function can determine if it processes the event or $[officename] Writer.</paragraph> +<paragraph role="heading" id="hd_id3155587" xml-lang="en-US" level="3">Category</paragraph> +<paragraph role="paragraph" id="par_id3154068" xml-lang="en-US"><ahelp hid="cui/ui/eventassignpage/libraries">Lists the open $[officename] documents and applications. Click the name of the location where you want to save the macros.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3149744" xml-lang="en-US" level="3">Macro name</paragraph> +<paragraph role="paragraph" id="par_id3151391" xml-lang="en-US"><ahelp hid="cui/ui/eventassignpage/macros">Lists the available macros. Click the macro that you want to assign to the selected object.</ahelp></paragraph> +<paragraph role="heading" id="hd_id3159260" xml-lang="en-US" level="2">Assign</paragraph> +<paragraph role="paragraph" id="par_id3147406" xml-lang="en-US"><ahelp hid="SFX2_PUSHBUTTON_RID_SFX_TP_MACROASSIGN_PB_ASSIGN">Assigns the selected macro to the specified event.</ahelp> The assigned macro's entries are set after the event.</paragraph> +<paragraph role="heading" id="hd_id3150533" xml-lang="en-US" level="2">Remove</paragraph> +<paragraph role="paragraph" id="par_id3166456" xml-lang="en-US"><variable id="aufheb"><ahelp hid="SFX2_PUSHBUTTON_RID_SFX_TP_MACROASSIGN_PB_DELETE">Removes the macro that is assigned to the selected item.</ahelp> +</variable></paragraph> +<paragraph role="heading" id="hd_id3159126" xml-lang="en-US" level="2">Macro selection</paragraph> +<paragraph role="paragraph" id="par_id3149149" xml-lang="en-US"><ahelp hid="SFX2_LISTBOX_RID_SFX_TP_MACROASSIGN_LB_SCRIPTTYPE">Select the macro that you want to assign.</ahelp></paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/CallByName.xhp b/helpcontent2/source/text/sbasic/shared/CallByName.xhp new file mode 100644 index 000000000..1933be217 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/CallByName.xhp @@ -0,0 +1,125 @@ +<?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="textsbasicsharedCallByNamexml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">CallByName Function</title> + <filename>/text/sbasic/shared/CallByName.xhp</filename> + </topic> +</meta> + +<body> + +<section id="CallByName"> +<h1 id="hd_id3150669"><variable id="CallByName_h1"><link href="text/sbasic/shared/CallByName.xhp">CallByName Function</link></variable></h1> +<paragraph id="par_id3149670" role="paragraph">Invokes a subroutine by its string name.</paragraph> +</section> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150669"> + <bookmark_value>CallByName function</bookmark_value> + <bookmark_value>API;OfficeFilePicker</bookmark_value> +</bookmark> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<bascode> + <paragraph id="par_id3153360" role="bascode">CallByName(object As Object, ProcName As String, CallType As Integer [,arg0 [,arg1 …]])</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph id="par_id3154141" role="paragraph"><emph>result</emph>: An optional variable that contains the result of the called method or property.</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3150448" role="paragraph"><emph>object</emph>: A Basic module, <link href="text/sbasic/shared/classmodule.xhp" name="ClassModule">ClassModule</link> instance or UNO service holding properties or methods.</paragraph> +<paragraph id="par_id3150449" role="paragraph"><emph>ProcName</emph>: The <literal>Function</literal>, <literal>Sub</literal> or <literal>Property</literal> that is being called.</paragraph> +<paragraph id="par_id3150450" role="paragraph"><emph>CallType</emph>: The type of performed action such as Get, Let, Method and Set.</paragraph> +<paragraph id="par_id3150451" role="paragraph"><emph>arg0, arg1 …</emph>: The <literal>Function</literal> optional parameters given as positional arguments.</paragraph> +<paragraph role="paragraph" id="par_id951642689912087">Arguments are provided in the exact same order defined in the method signature. Keyword arguments are not possible.</paragraph> +<table id="CallType"> + <tablerow> + <tablecell><paragraph id="par_id331644505028463" role="tablehead">Value</paragraph></tablecell> + <tablecell><paragraph id="par_id541644505028463" role="tablehead">CallType Description</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id621644505028464" role="tablecontent" localize="false">1</paragraph></tablecell> + <tablecell><paragraph id="par_id661644505028464" role="tablecontent"><emph>Method</emph>: Calls a procedure as a function or a subroutine.</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id621644505028465" role="tablecontent" localize="false">2</paragraph></tablecell> + <tablecell><paragraph id="par_id661644505028465" role="tablecontent"><emph>Get</emph>: Reads a property or variable content.</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id621644505028466" role="tablecontent" localize="false">4</paragraph></tablecell> + <tablecell><paragraph id="par_id661644505028466" role="tablecontent"><emph>Let</emph>: Assigns a content to a <literal>Property</literal> or variable.</paragraph></tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id621644505028467" role="tablecontent" localize="false">8</paragraph></tablecell> + <tablecell><paragraph id="par_id661644505028467" role="tablecontent"><emph>Set</emph>: Assigns a reference value to an <literal>Object</literal> or <literal>Variant</literal> variable.</paragraph></tablecell> + </tablerow> +</table> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<list type="ordered"> + <listitem> + <paragraph id="par_id661644588401903" role="listitem">A <literal>Calc.Maths</literal> module contains a <literal>Multiply</literal> function expecting a varying list of numbers.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id711644588403951" role="listitem"><literal>ScriptForge.Platform.Architecture</literal> information is retrieved.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id651644588404943" role="listitem"><literal>DisplayDirectory</literal> property of <link href="https://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1ui_1_1dialogs_1_1FilePicker-members.html" name="FilePicker">com.sun.star.ui.dialogs.FilePicker</link> UNO service is set to the user home folder, its content is read twice.</paragraph> + </listitem> +</list> +<bascode> + <paragraph role="bascode" id="bas_id861644508337698" localize="false">Sub CallByName_example</paragraph> + <paragraph role="bascode" id="bas_id571644506474125" localize="false"> Const _Method = 1, _Get = 2, _Let = 4, _Set = 8</paragraph> + <paragraph role="bascode" id="bas_id611644506475477" localize="false"></paragraph> + <paragraph role="bascode" id="bas_id791644586147817" xml-lang="en-US"> BasicLibraries.loadLibrary("Calc") ' Calc.Maths user library.module</paragraph> + <paragraph role="bascode" id="bas_id831644509462340" localize="false"> Dim cm As Object : cm = Calc.Maths</paragraph> + <paragraph role="bascode" id="bas_id831644509462341" localize="false"> MsgBox CallByName(cm, "Multiply", _Method, 3, 45, 1, 89) ' 12015</paragraph> + <paragraph role="bascode" id="bas_id111644586063023" localize="false"> MsgBox CallByName(cm, "Multiply", _Method, 1.85e15, 44, 10^8) ' 8.14E+24</paragraph> + <paragraph role="bascode" id="bas_id461644586345928" localize="false"></paragraph> + <paragraph role="bascode" id="bas_id51644586026542" localize="false"> GlobalScope.BasicLibraries.loadLibrary("ScriptForge")</paragraph> + <paragraph role="bascode" id="bas_id611644506475669" localize="false"> Dim p As Object : p = CreateScriptService("ScriptForge.Platform")</paragraph> + <paragraph role="bascode" id="bas_id591644509462257" localize="false"> MsgBox CallByName(p, "Architecture", _Get) ' 32bit/64bit</paragraph> + <paragraph role="bascode" id="bas_id781644506475901" localize="false"></paragraph> + <paragraph id="par_idm1341471776" role="bascode" localize="false"> Dim uno As Object : uno = CreateUNOService("com.sun.star.ui.dialogs.OfficeFilePicker")</paragraph> + <paragraph id="par_idm1341417776" role="bascode" localize="false"> Dim fs As Object : fs = CreateScriptService("ScriptForge.FileSystem")</paragraph> + <paragraph id="par_idm1341471777" role="bascode" localize="false"> CallByName(uno, "DisplayDirectory", _Let, fs.HomeFolder)</paragraph> + <paragraph role="bascode" id="bas_id681644507154187" localize="false"> MsgBox CallByName(uno, "DisplayDirectory", _Get)</paragraph> + <paragraph role="bascode" id="bas_id161644507201322" localize="false"> var = CallByName(uno, "getDisplayDirectory", _Get)</paragraph> + <paragraph id="par_idm1341470544" role="bascode" localize="false">End Sub</paragraph> +</bascode> + +<h3 id="hd_id971644589733247">Calc.Maths module</h3> +<bascode> + <paragraph role="bascode" id="bas_id811644589423326" xml-lang="en-US">Option Compatible ' Calc.Maths module</paragraph> + <paragraph role="bascode" id="bas_id781644589423526" localize="false">Option Explicit</paragraph> + <paragraph role="bascode" id="bas_id691644589423728" localize="false"></paragraph> + <paragraph role="bascode" id="bas_id801644589423903" localize="false">Public Function Multiply(ParamArray args() As Double) As Variant</paragraph> + <paragraph role="bascode" id="bas_id661644589424096" xml-lang="en-US"> ''' Multiply a variable list of numbers '''</paragraph> + <paragraph role="bascode" id="bas_id861644589424279" localize="false"> Dim ndx As Integer</paragraph> + <paragraph role="bascode" id="bas_id151644589424456" localize="false"> If UBound(args) >= 0 Then</paragraph> + <paragraph role="bascode" id="bas_id521646063432572" localize="false"> Multiply = 1.0</paragraph> + <paragraph role="bascode" id="bas_id591644589424639" localize="false"> For ndx = 0 To UBound(args)</paragraph> + <paragraph role="bascode" id="bas_id931644589424831" localize="false"> Multiply = Multiply * args(ndx)</paragraph> + <paragraph role="bascode" id="bas_id271644589568598" localize="false"> Next ndx</paragraph> + <paragraph role="bascode" id="bas_id621644589568790" localize="false"> End If</paragraph> + <paragraph role="bascode" id="bas_id171644589568951" localize="false">End Function 'Calc.Maths.Multiply()</paragraph> +</bascode> + +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03090401.xhp#Call_h1"/> + <embed href="text/sbasic/shared/03/sf_platform.xhp#PlatformService"/> + <embed href="text/sbasic/shared/compatible.xhp#compatiblestatement"/> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> +</section> + +</body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/Compiler_options.xhp b/helpcontent2/source/text/sbasic/shared/Compiler_options.xhp new file mode 100644 index 000000000..675c1891c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/Compiler_options.xhp @@ -0,0 +1,49 @@ +<?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="text/sbasic/shared/compiler"> + <title id="tit" xml-lang="en-US">Compiler Options</title> + <filename>/text/sbasic/shared/Compiler_options.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="bm_id681592403821304"> + <bookmark_value>Compiler Options</bookmark_value> + <bookmark_value>Runtime conditions</bookmark_value> + </bookmark> + + <section id="classmodulefunction"> + <h1 id="hd_id951592401835244"><variable id="compileroptions"><link href="text/sbasic/shared/Compiler_options.xhp" name="Compiler Options">Compiler Options, Runtime Conditions</link></variable></h1> + <paragraph role="paragraph" id="N0084">Compiler options specified at the module level affect %PRODUCTNAME <emph>Basic compiler checks</emph> and error messages. Basic syntax as well as Basic set of instructions can be different according to the options that are in use. The less <literal>Option</literal>, the easiest and tolerant %PRODUCTNAME Basic language is. The more <literal>Option</literal>, the richer and controlled Basic language gets.</paragraph> + </section> + <note id="par_id141592406254504">Compiler options must be specified before the executable program code in a module.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id491585753339474"><image src="media/helpimg/sbasic/Option_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Option Statement diagram</alt></image></paragraph> + + <embed href="text/sbasic/shared/03103200.xhp#optionbase"/> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulefunction"/> + <embed href="text/sbasic/shared/compatible.xhp#optioncompatiblestatement"/> + <embed href="text/sbasic/shared/compatibilitymode.xhp#compatibilitymodefunction"/> + <embed href="text/sbasic/shared/03103300.xhp#optionexplicit"/> + + <h2 id="hd_id331592403410631">Option Private Module</h2> + <paragraph role="paragraph" id="par_id161592405163812">Specifies that the scope of the module is that of the Basic library it belongs to.</paragraph> + <embed href="text/sbasic/shared/03103350.xhp#optionVBASupport"/> + <warning id="par_id141592408035462">Options specified at the module level also affect %PRODUCTNAME <emph>Basic runtime conditions</emph>. The behaviour of %PRODUCTNAME Basic instructions can differ.</warning> + + <section id="relatedtopics" > + <paragraph role="paragraph" id="par_id291592407073335"><link href="text/sbasic/shared/property.xhp" name="Property statement">Property statement</link></paragraph> + <embed href="text/sbasic/shared/special_vba_func.xhp#exclusivevba"/> + <embed href="text/sbasic/shared/ErrVBA.xhp#ErrVBAh1"/> + </section> + + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/ErrVBA.xhp b/helpcontent2/source/text/sbasic/shared/ErrVBA.xhp new file mode 100644 index 000000000..1badcbf05 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/ErrVBA.xhp @@ -0,0 +1,132 @@ +<?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="text/sbasic/shared/ErrVBA"> + <title id="tit" xml-lang="en-US">Err VBA Object</title> + <filename>/text/sbasic/shared/ErrVBA.xhp</filename> + </topic> + </meta> + <body> + <section id="VBAErrObject"> + <bookmark branch="index" id="N0010"> + <bookmark_value>Err object</bookmark_value> + <bookmark_value>Error;raising</bookmark_value> + <bookmark_value>Error;handling</bookmark_value> + </bookmark> + <h1 id="N0011"><variable id="ErrVBAh1"><link href="text/sbasic/shared/ErrVBA.xhp" name="Err object [VBA]">Err Object [VBA]</link></variable></h1> + <paragraph role="paragraph" id="N0012">Use VBA <literal>Err</literal> object to raise or handle runtime errors.</paragraph> + </section> + <paragraph role="paragraph" id="N0012b"><literal>Err</literal> is a built-in VBA global object that allows:</paragraph> + <list type="unordered"> + <listitem><paragraph role="paragraph" id="N0013">to raise predefined Basic errors</paragraph></listitem> + <listitem><paragraph role="paragraph" id="N0014">to throw user-defined exceptions</paragraph></listitem> + <listitem><paragraph role="paragraph" id="N0015">to name the routine originating the error</paragraph></listitem> + <listitem><paragraph role="paragraph" id="N0016">to describe the error and possible solutions</paragraph></listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <paragraph role="paragraph" id="N0017">The VBA <literal>Err</literal> object has the following properties and methods:</paragraph> + <h2 id="N0018">Properties</h2> + <bascode> + <paragraph role="bascode" id="N0019" localize="false">Err.Description As String</paragraph> + </bascode> + <paragraph role="paragraph" id="N0020">The <emph>Description</emph> property gives the nature of the error. <emph>Description</emph> details the various reasons that may be the cause of the error. Ideally, it provides the multiple course of actions to help solve the issue and prevent its reoccurrence. The Basic alias is the <link href="text/sbasic/shared/03050300.xhp" name ="Error function">Error</link> function for %PRODUCTNAME predefined errors.</paragraph> + <bascode> + <paragraph role="bascode" id="N0021" localize="false">Err.Number As Long</paragraph> + </bascode> + <paragraph role="paragraph" id="N0022">The error code associated with the error. <literal>Err</literal> object default property is <emph>Number</emph>. The %PRODUCTNAME Basic alias is the <link href="text/sbasic/shared/03050200.xhp" name ="Err">Err</link> function.</paragraph> + <bascode> + <paragraph role="bascode" id="N0023" localize="false">Err.Source As String</paragraph> + </bascode> + <paragraph role="paragraph" id="N0024"><emph>Source</emph> indicates the name of the routine that produces the error. <emph>Source</emph> is an option for user-defined errors.</paragraph> + <h2 id="N0025">Methods</h2> + <bascode> + <paragraph role="bascode" id="N0026" localize="false">Err.Clear()</paragraph> + </bascode> + <paragraph role="paragraph" id="N0027">Resets description, <link href="text/sbasic/shared/03050100.xhp" name ="error line">Erl</link>, number and source properties of current error. The %PRODUCTNAME Basic alias is the <link href="text/sbasic/shared/03050500.xhp" name ="Resume statement">Resume</link> statement.</paragraph> + <bascode> + <paragraph role="bascode" id="N0028" localize="false">Err.Raise(Number As Long, Optional source As String, Optional description As String)</paragraph> + </bascode> + <paragraph role="paragraph" id="N0029">Throws user-defined errors or predefined errors. The %PRODUCTNAME Basic alias is the <link href="text/sbasic/shared/03050200.xhp" name ="Error statement">Error</link> statement.</paragraph> + <h3 id="N0030">Parameters</h3> + <paragraph role="paragraph" id="N0031"><emph>Number</emph>: A user-defined or predefined error code to be raised.</paragraph> + <section id="RestrictedErrorCodes"> + <note id="N0032">Error code range 0-2000 is reserved for %PRODUCTNAME Basic. User-defined errors may start from higher values in order to prevent collision with %PRODUCTNAME Basic future developments.</note> + </section> + <paragraph role="paragraph" id="N0033"><emph>Source</emph>: The name of the routine raising the error. A name in the form of "myLibrary.myModule.myProc" is recommended.</paragraph> + <paragraph role="paragraph" id="N0034"><emph>Description</emph>: A description of the problem leading to stop the running process, accompanied with the various reasons that may cause it. A detailed list of the possible course of actions that may help solve the problem is recommended.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="N0036" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="N0037" localize="false"> </paragraph> + <paragraph role="bascode" id="N0038" localize="false">Sub ThrowErrors</paragraph> + <paragraph role="bascode" id="N0039" localize="false"> Dim aDesc As String : aDesc = Space(80)</paragraph> + <paragraph role="bascode" id="N003A" localize="false"> On Local Error GoTo AlertAndExecNext</paragraph> + <paragraph role="bascode" id="N0040" localize="false"> Err.Raise(91, "ThrowErrors", Error(91))</paragraph> + <paragraph role="bascode" id="N0041" xml-lang="en-US"> Err.Raise 2020, Description:="This is an intended user-defined error …"</paragraph> + <paragraph role="bascode" id="N0042" localize="false"> Err.Raise(4096, "Standard.Module1.ThrowErrors", aDesc)</paragraph> + <paragraph role="bascode" id="N0043" localize="false"> Exit Sub</paragraph> + <paragraph role="bascode" id="N0044" localize="false">AlertAndExecNext:</paragraph> + <paragraph role="bascode" id="N0045" xml-lang="en-US"> errTitle = "Error "& Err &" at line "& Erl &" in "& Err.Source</paragraph> + <paragraph role="bascode" id="N0046" localize="false"> MsgBox Err.Description, MB_ICONEXCLAMATION, errTitle</paragraph> + <paragraph role="bascode" id="N0047" localize="false"> Resume Next</paragraph> + <paragraph role="bascode" id="N0048" localize="false">End Sub</paragraph> + </bascode> + <h2 id="N0050">Exception ClassModule</h2> + <tip id="N0049">A short <link href="text/sbasic/shared/classmodule.xhp" name="ClassModule option">ClassModule</link>, that wraps VBA <literal>Err</literal> object, can distribute <literal>Err</literal> properties and methods for standard %PRODUCTNAME Basic modules.</tip> + <bascode> + <paragraph role="bascode" id="N0051" localize="false">Option ClassModule</paragraph> + <paragraph role="bascode" id="N0052" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="N0053" localize="false"> </paragraph> + <paragraph role="bascode" id="N0054" localize="false">Public Property Get Description As String</paragraph> + <paragraph role="bascode" id="N0055" localize="false"> Description = Err.Description</paragraph> + <paragraph role="bascode" id="N0056" localize="false">End Property</paragraph> + <paragraph role="bascode" id="N0057" localize="false">Public Property Get Number As Long</paragraph> + <paragraph role="bascode" id="N0058" localize="false"> Number = Err.Number</paragraph> + <paragraph role="bascode" id="N0059" localize="false">End Property</paragraph> + <paragraph role="bascode" id="N0060" localize="false">Public Property Get Source As String</paragraph> + <paragraph role="bascode" id="N0061" localize="false"> Source = Err.Source</paragraph> + <paragraph role="bascode" id="N0062" localize="false">End Property</paragraph> + <paragraph role="bascode" id="N0063" localize="false">Public Sub Clear</paragraph> + <paragraph role="bascode" id="N0064" localize="false"> Err.Clear</paragraph> + <paragraph role="bascode" id="N0065" localize="false">End Sub</paragraph> + <paragraph role="bascode" id="N0066" localize="false">Public Sub Raise( number As Long, Optional Source As String, Optional Description As String)</paragraph> + <paragraph role="bascode" id="N0067" localize="false"> Err.Raise number, Source, Description</paragraph> + <paragraph role="bascode" id="N0068" localize="false">End Sub</paragraph> + </bascode> + <h2 id="N0069">Example</h2> + <bascode> + <paragraph role="bascode" id="N0070" localize="false">Function Exc As Object</paragraph> + <paragraph role="bascode" id="N0071" localize="false"> Exc = New Exception</paragraph> + <paragraph role="bascode" id="N0072" localize="false">End Function</paragraph> + <paragraph role="bascode" id="N0073" localize="false"> </paragraph> + <paragraph role="bascode" id="N0074" localize="false">Sub aRoutine</paragraph> + <paragraph role="bascode" id="N0075" localize="false">try:</paragraph> + <paragraph role="bascode" id="N0076" localize="false"> On Local Error GoTo catch:</paragraph> + <paragraph role="bascode" id="N0077" localize="false"> Exc.Raise(4096, "myLib.myModule.aRoutine", _</paragraph> + <paragraph role="bascode" id="N0078" xml-lang="en-US"> "Any multi-line description for this user-defined exception")</paragraph> + <paragraph role="bascode" id="N0079" xml-lang="en-US"> ' your code goes here …</paragraph> + <paragraph role="bascode" id="N0080" localize="false">finally:</paragraph> + <paragraph role="bascode" id="N0081" localize="false"> Exit Sub</paragraph> + <paragraph role="bascode" id="N0082" localize="false">catch:</paragraph> + <paragraph role="bascode" id="N0083" xml-lang="en-US"> errTitle = "Error "& Exc.Number &" at line "& Erl &" in "& Exc.Source</paragraph> + <paragraph role="bascode" id="N0084" localize="false"> MsgBox Exc.Description, MB_ICONSTOP, errTitle</paragraph> + <paragraph role="bascode" id="N0085" localize="false"> Resume finally</paragraph> + <paragraph role="bascode" id="N0086" localize="false">End Sub</paragraph> + </bascode> + <note id="N0088">The <link href="text/sbasic/shared/03050300.xhp" name="Error statement">Error</link> statement or an Exception-like class module can be used interchangeably, while the latter adds extra features.</note> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03050000.xhp#ErrHandlingh1"/> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> + <embed href="text/sbasic/shared/03103350.xhp#vbasupportstatement"/> + <embed href="text/sbasic/shared/03/sf_exception.xhp#ExceptionService"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/GetPathSeparator.xhp b/helpcontent2/source/text/sbasic/shared/GetPathSeparator.xhp new file mode 100644 index 000000000..97b22e576 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/GetPathSeparator.xhp @@ -0,0 +1,64 @@ +<?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.Libre.Libraries.GetPathSeparator.en" indexer="include" status="PUBLISH"> + <title id="tit">GetPathSeparator function</title> + <filename>/text/sbasic/shared/GetPathSeparator.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0001"> + <bookmark_value>GetPathSeparator function</bookmark_value> + </bookmark> + <section id="getpathseparator"> + <paragraph role="heading" level="1" id="N0002"><variable id="getpathseparator01"><link href="text/sbasic/shared/GetPathSeparator.xhp" name="GetPathSeparator">GetPathSeparator Function</link></variable></paragraph> + <paragraph role="paragraph" id="N0003">Returns the operating system-dependent directory separator used to specify file paths.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="code" id="N0005" localize="false">GetPathSeparator()</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id481542894937950" xml-lang="en-US" localize="false">String</paragraph> + <list type="unordered"> + <listitem> + <paragraph role="paragraph" id="N0007" localize="false">"\" Windows</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="N0008">"/" UNIX, including MacOS</paragraph> + </listitem> + </list> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="N0010"> + None. + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="N0014">Sub ExampleGetPathSeparator</paragraph> + <paragraph role="bascode" localize="false" id="N0015"> MsgBox GetPathSeparator()</paragraph> + <paragraph role="bascode" localize="false" id="N0016">End Sub</paragraph> + </bascode> + <section id="relatedtopics" > + <paragraph role="paragraph" id="N0017"> + It is recommended to use: + </paragraph> + <paragraph role="paragraph" id="N0018"> + <link href="text/sbasic/shared/03120313.xhp" name ="external">ConvertFromURL</link> function to convert a file URL to a system file name. + </paragraph> + <paragraph role="paragraph" id="N0019"> + <link href="text/sbasic/shared/03120312.xhp" name ="external">ConvertToURL</link> function to convert a system file name to a file URL. + </paragraph> + <paragraph role="paragraph" id="N0020"> + See also <link href="text/sbasic/shared/00000002.xhp" name ="external">URL Notation</link> + </paragraph> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/Resume.xhp b/helpcontent2/source/text/sbasic/shared/Resume.xhp new file mode 100644 index 000000000..fa9e60dcc --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/Resume.xhp @@ -0,0 +1,77 @@ +<?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.sBasic.Resume.en" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Resume Statement</title> + <filename>/text/sbasic/shared/Resume.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0001"> + <bookmark_value>Resume statement</bookmark_value> + </bookmark> + <section id="Resume"> + <h1 id="N0002"><variable id="resumeh1"><link href="text/sbasic/shared/Resume.xhp" name="Resume statement">Resume Statement</link></variable></h1> + <paragraph role="paragraph" id="N0003">Resets error information and indicates what to execute next.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id491585753339474"><image src="media/helpimg/sbasic/Resume_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Resume Statement diagram</alt></image></paragraph> + <bascode> + <paragraph role="bascode" id="par_id3150984" localize="false">Resume [ [0] | label | Next ]</paragraph> + </bascode> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481586090298901"><literal>0</literal>: Resets error information and re-executes the instruction that caused the error. <literal>0</literal> is optional.</paragraph> + <paragraph role="paragraph" id="par_id331586090532804"><emph>label</emph>: Resets error information and resumes execution at the specified label of the current subroutine.</paragraph> + <paragraph role="paragraph" id="par_id331586090432804"><literal>Next</literal>: Resets error information and executes the instruction following the one that caused the error.</paragraph> + <paragraph role="paragraph" id="par_id441586333320983">Error information is built with <literal>Erl</literal>, <literal>Err</literal> and <literal>Error$</literal> functions.</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id741586333516110" role="listitem"><literal>Erl</literal>: Module line number where error occurs.</paragraph></listitem> + <listitem><paragraph id="par_id81586333580520" role="listitem"><literal>Err</literal>: Error number.</paragraph></listitem> + <listitem><paragraph id="par_id721586333586263" role="listitem"><literal>Error[$]</literal>: Error description.</paragraph></listitem> + </list> + <tip id="par_id941586091561618">Using <emph>Resume</emph> to reset error information prevents the propagation of the handled condition to calling routines.</tip> + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err20"/> + <h2 id="hd_id441586092960246">Examples:</h2> + <paragraph role="paragraph" id="par_id961586248539108">Typical error handling routines are: alerting the user, fixing the error, logging error information or re-throwing custom errors that provide explanations with resolution instructions. Use <literal>Resume label</literal> when requiring such mechanisms.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id601586093064656" localize="false">Sub Error_Handling</paragraph> + <paragraph role="bascode" id="bas_id541586093121719" localize="false">try: On Error GoTo catch</paragraph> + <paragraph role="bascode" id="bas_id451586093122848" xml-lang="en-US"> ' routine code goes here</paragraph> + <paragraph role="bascode" id="bas_id515860931234846" xml-lang="en-US"> Error 91 ' example error</paragraph> + <paragraph role="bascode" id="bas_id781586093123832" localize="false">finally:</paragraph> + <paragraph role="bascode" id="bas_id361586093126654" xml-lang="en-US"> ' routine cleanup code goes here</paragraph> + <paragraph role="bascode" id="bas_id531586093128006" localize="false"> Exit Sub</paragraph> + <paragraph role="bascode" id="bas_id121586093128518" localize="false">catch:</paragraph> + <paragraph role="bascode" id="bas_id881586093129470" localize="false"> Print Erl, Err, Error$</paragraph> + <paragraph role="bascode" id="bas_id311586093129686" localize="false"> Resume finally</paragraph> + <paragraph role="bascode" id="bas_id231586093129886" localize="false">End Sub ' Error_Handling</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id61586095819168">Use <literal>Resume Next</literal>, for example, when reporting anomalies encountered for an iterating process that must not be interrupted. In which case multiple handling routines may be required.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id841586096636182" localize="false">Sub Iteration</paragraph> + <paragraph role="bascode" id="bas_id271586096636925" localize="false"> planets = Array("☿","♀","♁","♂","♃","♄","⛢","♆")</paragraph> + <paragraph role="bascode" id="bas_id441586096638421" localize="false">try:</paragraph> + <paragraph role="bascode" id="bas_id715860966358904" localize="false"> On Error GoTo ReportAndProcessNext</paragraph> + <paragraph role="bascode" id="bas_id661586096642629" localize="false"> For ndx = -3 To 11 Step 1</paragraph> + <paragraph role="bascode" id="bas_id301586096643252" localize="false"> MsgBox planets(ndx)</paragraph> + <paragraph role="bascode" id="bas_id651586096643730" localize="false"> Next</paragraph> + <paragraph role="bascode" id="bas_id931586096643946" localize="false"> On Error GoTo 0 ' Stop error catching</paragraph> + <paragraph role="bascode" id="bas_id631586096644108" localize="false">finally:</paragraph> + <paragraph role="bascode" id="bas_id421586096644283" localize="false"> Exit Sub</paragraph> + <paragraph role="bascode" id="bas_id831586096644448" localize="false">ReportAndProcessNext:</paragraph> + <paragraph role="bascode" id="bas_id861586096644620" localize="false"> Print "Error "& Err &" at line "& Erl &" - "& Error$</paragraph> + <paragraph role="bascode" id="bas_id721586096644854" localize="false"> Resume Next</paragraph> + <paragraph role="bascode" id="bas_id431586096645266" localize="false">End Sub ' Iteration</paragraph> + </bascode> + <warning id="par_id461586091018138">Using <literal>Resume</literal> without parameters to re-execute the faulty instruction can fit certain situations. However that may cause a never ending loop.</warning> + </body> +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/calc_functions.xhp b/helpcontent2/source/text/sbasic/shared/calc_functions.xhp new file mode 100644 index 000000000..fa495681f --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/calc_functions.xhp @@ -0,0 +1,1037 @@ +<?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="callingcalcfunction" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Using Calc Functions in Macros</title> + <filename>/text/sbasic/shared/calc_functions.xhp</filename> + </topic> +</meta> +<body> + <bookmark xml-lang="en-US" branch="index" id="bm_id291592361063458"> + <bookmark_value>calling Calc function;macros</bookmark_value> + <bookmark_value>setting Calc function;macros</bookmark_value> + <bookmark_value>macros;calling Calc function</bookmark_value> + <bookmark_value>macros;setting Calc function</bookmark_value> + <bookmark_value>createUNOservice function;calling Calc function</bookmark_value> + <bookmark_value>API;sheet.addin.Analysis</bookmark_value> + <bookmark_value>API;sheet.FunctionAccess</bookmark_value> + </bookmark> + <h1 id="hd_id91592352089011"><variable id="CallingCalcFunctionsh1"><link href="text/sbasic/shared/calc_functions.xhp" name="Calling Calc Functions">Using Calc Functions in Macros</link></variable></h1> + <paragraph role="paragraph" id="par_id1001592359117987">In addition to the native BASIC functions, you can call Calc functions in your macros and scripts and set Calc functions in cell formulas.</paragraph> + <h2 id="hd_id251592352174921">Calling Internal Calc functions in Basic</h2> + <paragraph role="paragraph" id="par_id731592352332694">Use the <literal>CreateUNOService</literal> function to access the <literal>com.sun.star.sheet.FunctionAccess</literal> service.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id751629987917982">The example below creates a function named <literal>MyVlook</literal> that calls the <literal>VLOOKUP</literal> Calc function over a data array passed as argument and returns the value found by the function.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id371629987889347">Function MyVlook(Lookup, DataArray As Object, Index As Integer, SortedRangeLookup as Byte)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id21629987889617"> Dim oService As Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671629987889986"> Set oService = createUnoService("com.sun.star.sheet.FunctionAccess")</paragraph> + <paragraph role="bascode" id="bas_id271629987890173"> ' Always use the function name in English</paragraph> + <paragraph role="bascode" localize="false" id="bas_id831629987890360"> MyVlook = oService.callFunction("VLOOKUP", Array(Lookup, DataArray, Index, SortedRangeLookup))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id91629987891281">End Function</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id241629988142878">The macro below presents an example of how the <literal>MyVlook</literal> function can be called. It first creates a 5-by-2 data array and then calls the function <literal>MyVlook</literal> and shows the returned value using <literal>MsgBox</literal>.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id221629988249322">Sub CallingMyVlook()</paragraph> + <paragraph role="bascode" id="bas_id331629988249519"> ' Creates a 5 by 2 array and fills it with data</paragraph> + <paragraph role="bascode" localize="false" id="bas_id281629988249703"> Dim myData(1 to 5, 1 to 2) as Variant</paragraph> + <paragraph role="bascode" id="bas_id641629988249903"> myData(1, 1) = 1 : myData(1, 2) = "Strongly disagree"</paragraph> + <paragraph role="bascode" id="bas_id201629988250130"> myData(2, 1) = 3 : myData(2, 2) = "Disagree"</paragraph> + <paragraph role="bascode" id="bas_id291629988250317"> myData(3, 1) = 5 : myData(3, 2) = "Undecided"</paragraph> + <paragraph role="bascode" id="bas_id731629988250530"> myData(4, 1) = 7 : myData(4, 2) = "Agree"</paragraph> + <paragraph role="bascode" id="bas_id641629988250759"> myData(5, 1) = 9 : myData(5, 2) = "Strongly agree"</paragraph> + <paragraph role="bascode" id="bas_id521629988250997"> ' Looks up the data array</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401629988251210"> Dim result as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331629988324037"> result = MyVlook(4, myData, 2, 1)</paragraph> + <paragraph role="bascode" id="bas_id491629988324413"> ' Shows the message "Disagree"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871629988324637"> MsgBox result</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321629988324798">End Sub</paragraph> + </bascode> + <h2 id="hd_id261632673377666">Setting Cell Formulas Containing Internal Calc Functions</h2> + <paragraph role="paragraph" id="par_id41632673385259">Use the formula text string to add a formula to a spreadsheet cell. </paragraph> + <note id="par_id291632673370039">All Calc functions must be expressed with their English names.</note> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="par_id531632673814120" xml-lang="en-US" localize="false">Sub AssignFormulaToCell</paragraph> +<paragraph role="bascode" id="par_id101632673833258" xml-lang="en-US">REM Add a formula to cell A1. Function name must be in English.</paragraph> +<paragraph role="bascode" id="par_id901632673823257" xml-lang="en-US" localize="false"> oCell = ThisComponent.Sheets.getByIndex(0).getCellRangeByName("A1")</paragraph> +<paragraph role="bascode" id="par_id131632673828344" xml-lang="en-US" localize="false"> oCell.Formula = "=SUM(B1:B10)"</paragraph> +<paragraph role="bascode" id="par_id191632673837838" xml-lang="en-US">REM Cell A1 displays the localized function name</paragraph> +<paragraph role="bascode" id="par_id471632673842154" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> + + <h2 id="hd_id561592352225441">Calling Add-In Calc Functions in BASIC</h2> + <paragraph role="paragraph" id="par_id261592359338681">The Calc Add-In functions are in the UNO services <link href="text/sbasic/shared/calc_functions.xhp#analysis" name="analysis"><literal>com.sun.star.sheet.addin.Analysis</literal></link>, <link href="text/sbasic/shared/calc_functions.xhp#dates" name="dates"><literal>com.sun.star.sheet.addin.DateFunctions</literal></link> and <link href="text/sbasic/shared/calc_functions.xhp#pricing" name="pricing"><literal>com.sun.star.sheet.addin.PricingFunctions</literal></link>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="bas_id421592358343633">REM Example calling Add-in function SQRTPI</paragraph> +<paragraph role="bascode" id="bas_id731592358351744">Function MySQRTPI(arg as double) as double</paragraph> +<paragraph role="bascode" id="bas_id731592358361242" localize="false"> Dim oService as Object</paragraph> +<paragraph role="bascode" id="bas_id971592358368906" localize="false"> oService = createUNOService("com.sun.star.sheet.addin.Analysis")</paragraph> +<paragraph role="bascode" id="bas_id211592358377026"> MySQRTPI = oService.getSqrtPi(arg)</paragraph> +<paragraph role="bascode" id="bas_id451592358385346" localize="false">End Function</paragraph> +</bascode> + +<h2 id="hd_id251632673972700">Setting Cell Formulas with Add-In Functions</h2> +<paragraph role="paragraph" id="par_id431632674656090">The Add-In function must be expressed by its UNO service name.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="par_id531632373814120" xml-lang="en-US" localize="false">Sub AssignAddInFormulaToCell</paragraph> +<paragraph role="bascode" id="par_id101632623833258" xml-lang="en-US">REM Add an Add-In formula to cell A1. Function name is the UNO service name.</paragraph> +<paragraph role="bascode" id="par_id905632673823257" xml-lang="en-US" localize="false"> oCell = ThisComponent.Sheets.getByIndex(0).getCellRangeByName("A1")</paragraph> +<paragraph role="bascode" id="par_id131612673828344" xml-lang="en-US" localize="false"> oCell.Formula = "=com.sun.star.sheet.addin.Analysis.getBin2Dec(B1)"</paragraph> +<paragraph role="bascode" id="par_id191632673867838" xml-lang="en-US">REM Cell A1 displays the localized function name</paragraph> +<paragraph role="bascode" id="par_id471632673842254" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<section id="analysis"> +<h2 id="hd_id661632676716180">UNO Service Names for Analysis Add-In Functions</h2> +<paragraph role="paragraph" id="par_id651629988674793">The table below presents a list of all Calc Analysis Add-In functions and their respective UNO service names.</paragraph> +<table id="tab_id971592356505781"> + <tablerow> + <tablecell> + <paragraph id="par_id511592356505781" role="tablehead" xml-lang="en-US">Calc Function name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471592356505782" role="tablehead" xml-lang="en-US">UNO service name</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721592355432992" role="tablecontent" xml-lang="en-US" >ACCRINT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391592355432992" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getAccrint</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id311592355461144" role="tablecontent" xml-lang="en-US" >ACCRINTM</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861592355461144" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getAccrintm</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731592355465193" role="tablecontent" xml-lang="en-US" >AMORDEGRC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261592355465193" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getAmordegrc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id361592355471024" role="tablecontent" xml-lang="en-US" >AMORLINC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211592355471024" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getAmorlinc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id11592355475920" role="tablecontent" xml-lang="en-US" >BESSELI</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461592355475920" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getBesseli</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id841592355481243" role="tablecontent" xml-lang="en-US" >BESSELJ</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id641592355481243" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getBesselj</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id781592355488489" role="tablecontent" xml-lang="en-US" >BESSELK</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691592355488489" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getBesselk</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id751592355494321" role="tablecontent" xml-lang="en-US" >BESSELY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561592355494321" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getBessely</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id661592355500416" role="tablecontent" xml-lang="en-US" >BIN2DEC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id621592355500417" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getBin2Dec</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id331592355505769" role="tablecontent" xml-lang="en-US" >BIN2HEX</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421592355505769" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getBin2Hex</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id691592355510409" role="tablecontent" xml-lang="en-US" >BIN2OCT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401592355510409" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getBin2Oct</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id1001592355515562" role="tablecontent" xml-lang="en-US" >COMPLEX</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id821592355515562" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getComplex</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id661592355519833" role="tablecontent" xml-lang="en-US" >CONVERT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421592355519833" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getConvert</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id501592355525049" role="tablecontent" xml-lang="en-US" >COUPDAYBS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771592355525049" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getCoupdaybs</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id251592355529338" role="tablecontent" xml-lang="en-US" >COUPDAYS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311592355529338" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getCoupdays</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681592355545522" role="tablecontent" xml-lang="en-US" >COUPDAYSNC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id331592355545522" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getCoupdaysnc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id151592355550475" role="tablecontent" xml-lang="en-US" >COUPNCD</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351592355550475" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getCoupncd</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id291592355554258" role="tablecontent" xml-lang="en-US" >COUPNUM</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151592355554258" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getCoupnum</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id361592355563155" role="tablecontent" xml-lang="en-US" >COUPPCD</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001592355563155" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getCouppcd</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591592355570035" role="tablecontent" xml-lang="en-US" >CUMIPMT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91592355570035" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getCumipmt</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681592355573971" role="tablecontent" xml-lang="en-US" >CUMPRINC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id161592355573971" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getCumprinc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id591592355577411" role="tablecontent" xml-lang="en-US" >DEC2BIN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781592355577411" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getDec2Bin</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id651592355580939" role="tablecontent" xml-lang="en-US" >DEC2HEX</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id231592355580939" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getDec2Hex</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id981592355585026" role="tablecontent" xml-lang="en-US" >DEC2OCT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351592355585026" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getDec2Oct</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id911592355588619" role="tablecontent" xml-lang="en-US" >DELTA</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771592355588619" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getDelta</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id931592355591947" role="tablecontent" xml-lang="en-US" >DISC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id921592355591947" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getDisc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id281592355595627" role="tablecontent" xml-lang="en-US" >DOLLARDE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id41592355595627" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getDollarde</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731592355599218" role="tablecontent" xml-lang="en-US" >DOLLARFR</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id181592355599218" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getDollarfr</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id451592355602770" role="tablecontent" xml-lang="en-US" >DURATION</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251592355602770" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getDuration</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id261592355606039" role="tablecontent" xml-lang="en-US" >EDATE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111592355606039" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getEdate</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id221592355620084" role="tablecontent" xml-lang="en-US" >EFFECT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221592355620085" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getEffect</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721592355623964" role="tablecontent" xml-lang="en-US" >EOMONTH</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741592355623964" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getEomonth</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id581592355627044" role="tablecontent" xml-lang="en-US" >ERF</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841592355627044" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getErf</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id451592355631036" role="tablecontent" xml-lang="en-US" >ERFC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701592355631036" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getErfc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851592355634629" role="tablecontent" xml-lang="en-US" >FACTDOUBLE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451592355634629" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getFactdouble</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id731592355637900" role="tablecontent" xml-lang="en-US" >FVSCHEDULE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id211592355637900" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getFvschedule</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id431592355641084" role="tablecontent" xml-lang="en-US" >GCD</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601592355641084" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getGcd</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id461592355646844" role="tablecontent" xml-lang="en-US" >GESTEP</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id571592355646845" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getGestep</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471592355650772" role="tablecontent" xml-lang="en-US" >HEX2BIN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id171592355650772" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getHex2Bin</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id91592355654156" role="tablecontent" xml-lang="en-US" >HEX2DEC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391592355654156" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getHex2Dec</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id401592355657388" role="tablecontent" xml-lang="en-US" >HEX2OCT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id771592355657388" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getHex2Oct</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id331592355660565" role="tablecontent" xml-lang="en-US" >IMABS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id241592355660565" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImabs</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id401592355663828" role="tablecontent" xml-lang="en-US" >IMAGINARY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451592355663828" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImaginary</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id571592355667021" role="tablecontent" xml-lang="en-US" >IMARGUMENT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id61592355667021" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImargument</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id921592355670053" role="tablecontent" xml-lang="en-US" >IMCONJUGATE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id141592355670053" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImconjugate</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id171592355673117" role="tablecontent" xml-lang="en-US" >IMCOS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21592355673117" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImcos</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id701592355676365" role="tablecontent" xml-lang="en-US" >IMCOSH</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451592355676365" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImcosh</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id601592355679652" role="tablecontent" xml-lang="en-US" >IMCOT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id81592355679652" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImcot</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id41592355682724" role="tablecontent" xml-lang="en-US" >IMCSC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601592355682724" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImcsc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id61592355685899" role="tablecontent" xml-lang="en-US" >IMCSCH</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201592355685899" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImcsch</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id51592355688940" role="tablecontent" xml-lang="en-US" >IMDIV</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id51592355688941" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImdiv</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id611592355692012" role="tablecontent" xml-lang="en-US" >IMEXP</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id891592355692012" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImexp</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id381592355695069" role="tablecontent" xml-lang="en-US" >IMLN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841592355695069" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImln</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id231592355698892" role="tablecontent" xml-lang="en-US" >IMLOG10</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id1001592355698892" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImlog10</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id581592355702180" role="tablecontent" xml-lang="en-US" >IMLOG2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id711592355702180" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImlog2</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id341592355705773" role="tablecontent" xml-lang="en-US" >IMPOWER</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id101592355705773" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImpower</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id301592355708742" role="tablecontent" xml-lang="en-US" >IMPRODUCT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781592355708742" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImproduct</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id621592355711845" role="tablecontent" xml-lang="en-US" >IMREAL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id701592355711845" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImreal</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id821592355714852" role="tablecontent" xml-lang="en-US" >IMSEC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id111592355714853" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImsec</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id871592355718533" role="tablecontent" xml-lang="en-US" >IMSECH</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id311592355718534" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImsech</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id871592355721957" role="tablecontent" xml-lang="en-US" >IMSIN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id271592355721957" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImsin</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681592355725045" role="tablecontent" xml-lang="en-US" >IMSINH</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id871592355725046" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImsinh</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801592355728022" role="tablecontent" xml-lang="en-US" >IMSQRT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id381592355728022" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImsqrt</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851592355731069" role="tablecontent" xml-lang="en-US" >IMSUB</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21592355731069" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImsub</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id131592355734118" role="tablecontent" xml-lang="en-US" >IMSUM</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741592355734118" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImsum</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761592355737109" role="tablecontent" xml-lang="en-US" >IMTAN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591592355737109" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getImtan</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id91592355740301" role="tablecontent" xml-lang="en-US" >INTRATE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id41592355740301" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getIntrate</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id561592355743397" role="tablecontent" xml-lang="en-US" >ISEVEN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id781592355743397" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getIseven</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id481592355746477" role="tablecontent" xml-lang="en-US" >ISODD</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id91592355746477" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getIsodd</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id621592355749526" role="tablecontent" xml-lang="en-US" >LCM</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id801592355749526" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getLcm</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id381592355752413" role="tablecontent" xml-lang="en-US" >MDURATION</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id431592355752413" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getMduration</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161592355755349" role="tablecontent" xml-lang="en-US" >MROUND</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id841592355755349" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getMround</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id601592355758534" role="tablecontent" xml-lang="en-US" >MULTINOMIAL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id851592355758534" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getMultinomial</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id241592355761822" role="tablecontent" xml-lang="en-US" >NETWORKDAYS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71592355761822" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getNetworkdays</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id121592355764950" role="tablecontent" xml-lang="en-US" >NOMINAL</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id681592355764950" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getNominal</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id161592355767958" role="tablecontent" xml-lang="en-US" >OCT2BIN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131592355767959" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getOct2Bin</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id401592355770926" role="tablecontent" xml-lang="en-US" >OCT2DEC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id591592355770926" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getOct2Dec</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id981592355773838" role="tablecontent" xml-lang="en-US" >OCT2HEX</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131592355773838" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getOct2Hex</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id51592355776830" role="tablecontent" xml-lang="en-US" >ODDFPRICE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id501592355776830" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getOddfprice</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id581592355779822" role="tablecontent" xml-lang="en-US" >ODDFYIELD</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761592355779822" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getOddfyield</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id251592355782710" role="tablecontent" xml-lang="en-US" >ODDLPRICE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151592355782710" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getOddlprice</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id331592355785647" role="tablecontent" xml-lang="en-US" >ODDLYIELD</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691592355785647" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getOddlyield</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id471592355788791" role="tablecontent" xml-lang="en-US" >PRICE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151592355788791" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getPrice</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id141592355791678" role="tablecontent" xml-lang="en-US" >PRICEDISC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id691592355791678" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getPricedisc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id341592355794671" role="tablecontent" xml-lang="en-US" >PRICEMAT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id461592355794671" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getPricemat</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id681592355799718" role="tablecontent" xml-lang="en-US" >QUOTIENT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411592355799718" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getQuotient</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id831592355803591" role="tablecontent" xml-lang="en-US" >RANDBETWEEN</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id661592355803591" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getRandbetween</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id701592355807287" role="tablecontent" xml-lang="en-US" >RECEIVED</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id721592355807287" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getReceived</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id231592355810343" role="tablecontent" xml-lang="en-US" >SERIESSUM</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id951592355810343" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getSeriessum</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id111592355816454" role="tablecontent" xml-lang="en-US" >SQRTPI</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id231592355816454" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getSqrtpi</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id521592355819614" role="tablecontent" xml-lang="en-US" >TBILLEQ</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id601592355819614" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getTbilleq</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id351592355822703" role="tablecontent" xml-lang="en-US" >TBILLPRICE</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id491592355822703" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getTbillprice</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id921592355825694" role="tablecontent" xml-lang="en-US" >TBILLYIELD</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id971592355825695" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getTbillyield</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id751592355828599" role="tablecontent" xml-lang="en-US" >WEEKNUM</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id201592355828599" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getWeeknum</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id851592355831471" role="tablecontent" xml-lang="en-US" >WORKDAY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id451592355831472" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getWorkday</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id291592355834479" role="tablecontent" xml-lang="en-US" >XIRR</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id351592355834479" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getXirr</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id521592355837464" role="tablecontent" xml-lang="en-US" >XNPV</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id551592355837464" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getXnpv</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id201592355840359" role="tablecontent" xml-lang="en-US" >YEARFRAC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id101592355840359" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getYearfrac</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id281592355843559" role="tablecontent" xml-lang="en-US" >YIELD</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id741592355843559" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getYield</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id341592355846704" role="tablecontent" xml-lang="en-US" >YIELDDISC</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id651592355846704" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getYielddisc</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id181592355849664" role="tablecontent" xml-lang="en-US" >YIELDMAT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id151592355849664" role="tablecontent" localize="false" >com.sun.star.sheet.addin.Analysis.getYieldmat</paragraph> + </tablecell> + </tablerow> +</table> +</section> +<section id="dates"> +<h2 id="hd_id661632676736180">UNO Service Names for Date Add-In Functions</h2> +<paragraph role="paragraph" id="par_id751629988674793">The table below presents a list of all Calc Date Add-In functions and their respective UNO service names.</paragraph> +<table id="tab_id971592356505781"> + <tablerow> + <tablecell> + <paragraph id="par_id511593356505781" role="tablehead" xml-lang="en-US">Calc Function name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471593356505782" role="tablehead" xml-lang="en-US">UNO service name</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721593355432992" role="tablecontent" xml-lang="en-US" >DAYSINMONTH</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391593355432992" role="tablecontent" localize="false" >com.sun.star.sheet.addin.DateFunctions.getDaysInMonth</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761641413741892" role="tablecontent" xml-lang="en-US" >DAYSINYEAR</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id361641413741893" role="tablecontent" localize="false">com.sun.star.sheet.addin.DateFunctions.getDaysInMonth</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id11641413916930" role="tablecontent" xml-lang="en-US" >MONTHS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id261641413916931" role="tablecontent" localize="false">com.sun.star.sheet.addin.DateFunctions.getDiffMonths</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id761641413962003" role="tablecontent" xml-lang="en-US" >WEEKS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id811641413962004" role="tablecontent" localize="false">com.sun.star.sheet.addin.DateFunctions.getDiffWeeks</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id71641413988924" role="tablecontent" xml-lang="en-US" >YEARS</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id401641413988926" role="tablecontent" localize="false">com.sun.star.sheet.addin.DateFunctions.getDiffYears</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id341641414018758" role="tablecontent" xml-lang="en-US" >ROT13</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id831641414018760" role="tablecontent" localize="false">com.sun.star.sheet.addin.DateFunctions.getRot13</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id171641414040589" role="tablecontent" xml-lang="en-US" >WEEKSINYEAR</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id391641414040590" role="tablecontent" localize="false">com.sun.star.sheet.addin.DateFunctions.getWeeksInYear</paragraph> + </tablecell> + </tablerow> +</table> +</section> +<section id="pricing"> +<h2 id="hd_id661632676732180">UNO Service Names for Pricing Add-In Functions</h2> +<paragraph role="paragraph" id="par_id751629983674793">The table below presents a list of all Calc Pricing Add-In functions and their respective UNO service names.</paragraph> +<table id="tab_id971592356505781"> + <tablerow> + <tablecell> + <paragraph id="par_id511593356506781" role="tablehead" xml-lang="en-US">Calc Function name</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471593356505762" role="tablehead" xml-lang="en-US">UNO service name</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id701641414383401" role="tablecontent" xml-lang="en-US">OPT_BARRIER</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id761641414383403" role="tablecontent" localize="false">com.sun.star.sheet.addin.PrincingFunctions.getOptBarrier</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id131641414493411" role="tablecontent" xml-lang="en-US">OPT_PROB_HIT</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id191641414493413" role="tablecontent" localize="false">com.sun.star.sheet.addin.PrincingFunctions.getOptProbHit</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id81641414542294" role="tablecontent" xml-lang="en-US" >OPT_PROB_INMONEY</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id861641414542296" role="tablecontent" localize="false">com.sun.star.sheet.addin.PrincingFunctions.getOptProbInMoney</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id711641414594816" role="tablecontent" xml-lang="en-US" >OPT_TOUCH</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id561641414594817" role="tablecontent" localize="false">com.sun.star.sheet.addin.PrincingFunctions.getOptTouch</paragraph> + </tablecell> + </tablerow> +</table> +</section> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/03131600.xhp#createunoserviceh1"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/classmodule.xhp b/helpcontent2/source/text/sbasic/shared/classmodule.xhp new file mode 100644 index 000000000..df14f9ad7 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/classmodule.xhp @@ -0,0 +1,63 @@ +<?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="text/sbasic/shared/ClassModule"> + <title id="tit" localize="false" xml-lang="en-US">Option ClassModule</title> + <filename>/text/sbasic/shared/classmodule.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0082" localize="false"> + <bookmark_value>Option ClassModule</bookmark_value> + </bookmark> + + <section id="classmodulefunction"> + <h1 id="N0083"><variable id="classmodulestatement"><link href="text/sbasic/shared/classmodule.xhp" name="option classmodule">Option ClassModule Statement</link></variable></h1> + <paragraph role="paragraph" id="N0084">Specifies that the module is a class module that contains members, properties, procedures and functions.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#beforeexecutable"/> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="N0089">This statement must be used jointly with <literal>Option Compatible</literal> statement or <literal>Option VBASupport 1</literal>, the former is enabling VBA compatibility mode, while the latter is enforcing VBA support on top of compatibility.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="code" localize="false" id="N0086">Option ClassModule</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="N0092">Option Compatible</paragraph> + <paragraph role="bascode" localize="false" id="N0093">Option ClassModule</paragraph> + <paragraph role="bascode" localize="false" id="N0094"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0095">' Optional members go here</paragraph> + <paragraph role="bascode" localize="false" id="N0096"> </paragraph> + <paragraph role="bascode" localize="false" id="N0097">Private Sub Class_Initialize()</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0098"> ' Optional construction code goes here</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0099">End Sub ' Constructor</paragraph> + <paragraph role="bascode" localize="false" id="N0100">Private Sub Class_Terminate()</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0101"> ' Optional destruction code goes here</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0102">End Sub ' Destructor</paragraph> + <paragraph role="bascode" localize="false" id="N0103"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0104">' Properties go here.</paragraph> + <paragraph role="bascode" localize="false" id="N0105"> </paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0106">' Procedures & functions go here.</paragraph> + <paragraph role="bascode" localize="false" id="N0107"> </paragraph> + </bascode> + <section id="relatedtopics" > + <paragraph role="paragraph" id="N0108"> + Refer to <link href="text/sbasic/python/python_platform.xhp">Identifying the Operating System</link> and <link href="text/sbasic/python/python_session.xhp">Getting Session Information</link> for class module simple examples. + </paragraph> + <paragraph role="paragraph" id="N0109"> + Multiple thorough class examples are available from <link href="text/sbasic/guide/access2base.xhp">Access2Base shared Basic library</link>. + </paragraph> + <embed href="text/sbasic/shared/03103200.xhp#optionbasestatement"/> + <embed href="text/sbasic/shared/03103300.xhp#explicitstatement"/> + <embed href="text/sbasic/shared/03103350.xhp#vbasupportstatement"/> + <embed href="text/sbasic/shared/compatible.xhp#compatiblestatement"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/code-stubs.xhp b/helpcontent2/source/text/sbasic/shared/code-stubs.xhp new file mode 100644 index 000000000..53161098a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/code-stubs.xhp @@ -0,0 +1,58 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="topic_2507201510192393"> + <title xml-lang="en-US" localize="false" id="tit">BasicCodeStubs</title> + <filename>/text/sbasic/shared/code-stubs.xhp</filename> + </topic> +</meta> +<body> + +<section id="BasicIDEOption01"> + <bascode> + <paragraph id="hd_id1000010" role="bascode" xml-lang="en-US" localize="false">Dim aPicker As com.sun.star.ui.dialogs.XFilePicker</paragraph> + </bascode> +</section> +<section id="BasicIDEOption02"> + <bascode> + <paragraph id="hd_id1000020" role="bascode" xml-lang="en-US" localize="false">aPicker.getDisplayDirectory()</paragraph> + </bascode> +</section> +<section id="BasicIDEOption03"> + <bascode> + <paragraph id="hd_id1000030" role="bascode" xml-lang="en-US" localize="false">Dim intVar as Integer</paragraph> + </bascode> +</section> +<section id="BasicIDEOption04"> + <bascode> + <paragraph id="hd_id10000400" role="bascode" xml-lang="en-US" localize="false">Sub Some_Calc_UNO_Types</paragraph> + <paragraph id="hd_id10000410" role="bascode" xml-lang="en-US" localize="true">REM A spreadsheet object</paragraph> + <paragraph id="hd_id10000420" role="bascode" xml-lang="en-US" localize="false"> Dim oSheet As com.sun.star.sheet.XSpreadsheet</paragraph> + <paragraph id="hd_id10000430" role="bascode" xml-lang="en-US" localize="false"> oSheet = ThisComponent.getSheets().getByIndex(0)</paragraph> + <paragraph id="hd_id10000470" role="bascode" xml-lang="en-US" localize="true">REM A cell object</paragraph> + <paragraph id="hd_id10000480" role="bascode" xml-lang="en-US" localize="false"> Dim oCell As com.sun.star.table.XCell</paragraph> + <paragraph id="hd_id10000490" role="bascode" xml-lang="en-US" localize="false"> oCell = oSheet.getCellByPosition(0,0)</paragraph> + <paragraph id="hd_id10000500" role="bascode" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> +</section> +</body> + +</helpdocument>
\ No newline at end of file diff --git a/helpcontent2/source/text/sbasic/shared/collection.xhp b/helpcontent2/source/text/sbasic/shared/collection.xhp new file mode 100644 index 000000000..6652dc52d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/collection.xhp @@ -0,0 +1,191 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="collectionobject" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Collection Object</title> + <filename>/text/sbasic/shared/collection.xhp</filename> + </topic> +</meta> +<body> + <section id="collection_desc"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3149205"> + <bookmark_value>Collection Object</bookmark_value> + </bookmark> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id3149225890"> + <bookmark_value>Collection;Count</bookmark_value> + </bookmark> + <h1 id="hd_id791633472607429"><variable id="Collection_h1"><link href="text/sbasic/shared/collection.xhp" name="New_Operator">Collection Object</link></variable></h1> + <paragraph role="paragraph" id="par_id581633961735332">Collections can be used to store items of different types. Each item can be accessed by its index or by an optional key associated with it.</paragraph> + </section> + <paragraph role="paragraph" id="par_id131633961959816">A <literal>Collection</literal> object has the following methods:</paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id331633962000259" role="listitem"><emph>Add:</emph> inserts a new item into the collection. Optionally a string value can be defined as the key to the item.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id181633962000767" role="listitem"><emph>Count:</emph> returns the number of items in the collection.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id521633962001072" role="listitem"><emph>Item:</emph> returns the item in the collection by passing its index or key.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id981633962001272" role="listitem"><emph>Remove:</emph> removes the specified item from the collection by its index or key.</paragraph> + </listitem> + </list> + <note id="par_id221633976539661">Items in a Collection can be accessed either by their indices (as in a 1-based single-dimensional Array) or by their associated keys.</note> + <tip id="par_id811634214809970">The <link href="text/sbasic/shared/03/sf_dictionary.xhp" name="SFDic_link"><literal>ScriptForge Dictionary</literal></link> service extends the <literal>Collection</literal> object by providing supplemental features as key retrieval and replacement, as well as import/export to Array objects and JSON strings.</tip> + <h2 id="hd_id51633962353863">Creating a Collection</h2> + <paragraph role="paragraph" id="par_id491633962366024">To create a <literal>Collection</literal> use the <literal>New</literal> keyword. The following example creates a <literal>Collection</literal> object and populates it with three items:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id91633962500725">Dim myCollection as New Collection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31633962501246">myCollection.Add("Some text")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id71633962501432">myCollection.Add(100)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id811633962501606">myCollection.Add(Array(1, 2, 3, 4))</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351633962501979">MsgBox myCollection.Count ' 3</paragraph> + </bascode> + + <h2 id="hd_id421633962742512">Adding Items</h2> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id591633974561425"> + <bookmark_value>Collection;Add</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="par_id261633962766238">The <literal>Add</literal> method can be used to add new items into the <literal>Collection</literal> object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711633530276845"> + <input>oCollection.Add(item, [key], [before|after])</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph id="par_id501633974650241" role="paragraph"><emph>item:</emph> the item to be added to the <literal>Collection</literal>. May be of any type.</paragraph> + <paragraph id="par_id181633974650705" role="paragraph"><emph>key:</emph> string value used as the unique key used to identify this value.</paragraph> + <paragraph id="par_id391633974651050" role="paragraph"><emph>before, after:</emph> optional keyword argument that indicates where the new item will be placed in the <literal>Collection</literal>. Only one of the arguments <literal>before</literal> or <literal>after</literal> can be specified to determine the index or key before which (or after which) the new item is to be placed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id211633962988398">The example below adds two elements into a <literal>Collection</literal>. The first has a key associated with it, whereas the second does not.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id231633963064060">Dim myCollection as New Collection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651633963064506">myCollection.Add(100, "first")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id241633963064748">myCollection.Add(101)</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id71633963110632">The <literal>Add</literal> method also supports keyword arguments:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id401633963141575">myCollection.Add(item := 100, key := "first")</paragraph> + </bascode> + <warning id="par_id941633963225913">Keys must be unique in a <literal>Collection</literal> object. Comparison between keys is <emph>case-insensitive</emph>. Adding duplicated keys will result in a runtime error.</warning> + <paragraph role="paragraph" id="par_id891633975568372">The example below illustrates how to use the <literal>Before</literal> and <literal>After</literal> keyword arguments to determine the position of the item that is being added.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id641633975892167">Dim myCollection as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971633975892478">myCollection = New Collection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id971633975892702">myCollection.Add(item := 101, key := "first")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id351633975892870">myCollection.Add(item := 103, key := "third")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851633975893071">myCollection.Add(item := 105, key := "fifth")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id771633975893271">MsgBox myCollection.Item(2) ' 103</paragraph> + <paragraph role="bascode" localize="false" id="bas_id331633975893495">myCollection.Add(item := 102, key := "second", before := "third")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441633975893727">MsgBox myCollection.Item(2) ' 102</paragraph> + <paragraph role="bascode" localize="false" id="bas_id201633975961057">myCollection.Add(item := 104, key := "fourth", after := 3)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id61633975961303">MsgBox myCollection.Item(4) ' 104</paragraph> + </bascode> + <note id="par_id121633976325472">Items in a <literal>Collection</literal> object are assigned an integer index value that starts at 1 and corresponds to the order in which they were added.</note> + + <h2 id="hd_id141633977141797">Accessing Items</h2> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id481633977601834"> + <bookmark_value>Collection;Item</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="par_id431633977156315">Use the <literal>Item</literal> method to access a given item by its index or key.</paragraph> + <paragraph role="paragraph" localize="false" id="par_id371633977493008"> + <input>oCollection.Item(index)</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id371633977493107"> + <input>oCollection.Item(key)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id261633976447187"><emph>index:</emph> an integer value specifying the index of the item to be returned.</paragraph> + <paragraph role="paragraph" id="par_id51633976782487"><emph>key:</emph> a string value specifying the key of the item to be returned.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671633977931198">Dim myCollection as New Collection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531633977931446">myCollection.Add(item := 101, key := "A")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371633977931670">myCollection.Add(item := 102, key := "B")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541633977931901">myCollection.Add(item := 103, key := "C")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671633977932101">MsgBox myCollection.Item("A") ' 101</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231633977932309">MsgBox myCollection.Item(3) ' 103</paragraph> + </bascode> + + <h2 id="hd_id651633976030220">Removing Items</h2> + <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id311633977567197"> + <bookmark_value>Collection;Remove</bookmark_value> + </bookmark> + <paragraph role="paragraph" id="par_id391633976125206">Use the <literal>Remove</literal> method to delete items from a <literal>Collection</literal> object.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id121633976268027">Items can be removed either by their indices or key values.</paragraph> + <paragraph role="paragraph" localize="false" id="par_id21633976180029"> + <input>oCollection.Remove(index)</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id21633976180011"> + <input>oCollection.Remove(key)</input> + </paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id261633976447289"><emph>index:</emph> an integer value specifying the index of the item to be removed.</paragraph> + <paragraph role="paragraph" id="par_id51633976782455"><emph>key:</emph> a string value specifying the key of the item to be removed.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id971633976850377">Dim myCollection as New Collection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941633976851194">myCollection.Add(item := 101, key := "first")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id111633976851408">myCollection.Add(item := 102, key := "second")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231633976851633">myCollection.Add(item := 103, key := "third")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id151633976852777">MsgBox myCollection.Count ' 3</paragraph> + <paragraph role="bascode" localize="false" id="bas_id11633977022371">' Removes the first value</paragraph> + <paragraph role="bascode" localize="false" id="bas_id401633977022620">myCollection.Remove(1)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441633977022867">' Removes the value whose key is "third"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id571633977023099">myCollection.Remove("third")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id221633977023371">MsgBox myCollection.Count ' 1</paragraph> + </bascode> + + <h2 id="hd_id491633978085731">Iterating Over all Items</h2> + <paragraph role="paragraph" id="par_id91633978099143">It is possible to use a <literal>For Each ... Next</literal> statement to iterate over all items in a <literal>Collection</literal>.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id671633977931167">Dim myCollection as New Collection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id531633977931484">myCollection.Add(item := 101, key := "A")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371633977931612">myCollection.Add(item := 102, key := "B")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id541633977931903">myCollection.Add(item := 103, key := "C")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id671633977932122">For Each value In myCollection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id231633977932310"> MsgBox value</paragraph> + <paragraph role="bascode" localize="false" id="bas_id481633978297651">Next value</paragraph> + </bascode> + + <h2 id="hd_id191634215349347">Clearing a Collection</h2> + <paragraph role="paragraph" id="par_id891634215363485">To remove all items from a <literal>Collection</literal> object call the <literal>Remove</literal> method for each item, as illustrated in the example below:</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id681634215646028">' Create a sample Collection with two entries</paragraph> + <paragraph role="bascode" localize="false" id="bas_id291634215646265">Dim myCollection as New Collection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id871634215646501">myCollection.Add(item := 10, key := "A")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id321634215646735">myCollection.Add(item := 11, key := "B")</paragraph> + <paragraph role="bascode" localize="false" id="bas_id261634215646972">MsgBox myCollection.Count ' 2</paragraph> + <paragraph role="bascode" id="bas_id391634215647196">' Removes all items in the collection</paragraph> + <paragraph role="bascode" localize="false" id="bas_id341634215647430">For i = myCollection.Count To 1 Step -1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id651634215647648"> myCollection.Remove(i)</paragraph> + <paragraph role="bascode" localize="false" id="bas_id161634215647850">Next i</paragraph> + <paragraph role="bascode" localize="false" id="bas_id31634215648034">MsgBox myCollection.Count ' 0</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03104200.xhp#Array_h1"/> + <embed href="text/sbasic/shared/03/sf_dictionary.xhp#SFDictionary"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/compatibilitymode.xhp b/helpcontent2/source/text/sbasic/shared/compatibilitymode.xhp new file mode 100644 index 000000000..f772f92c5 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/compatibilitymode.xhp @@ -0,0 +1,92 @@ +<?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="text/sbasic/shared/compatibilitymode"> + <title id="tit" xml-lang="en-US">CompatibilityMode function</title> + <filename>/text/sbasic/shared/compatibilitymode.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0103"> + <bookmark_value>CompatibilityMode</bookmark_value> + <bookmark_value>VBA compatibility mode</bookmark_value> + </bookmark> + <section id="compatibilitymodefunction"> + <h1 id="N0118"><variable id="compatibilitymodeh1"><link href="text/sbasic/shared/compatibilitymode.xhp" name="CompatibilityMode">CompatibilityMode() Function</link></variable></h1> + <paragraph role="paragraph" id="N0120"><literal>CompatibilityMode()</literal> function controls or queries runtime mode. It affects all code executed after setting or resetting the runtime mode. </paragraph> + </section> + <warning id="N0119">Use this feature with caution, limit it to document conversion for example.</warning> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph role="bascode" id="bas_id751645014686110">CompatibilityMode(Optional Enable As Boolean) As Boolean</paragraph> + </bascode> + + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id551648117368688"><literal>CompatibilityMode</literal> function always returns the mode that is active after its execution. That is if called with argument, it returns the new mode, if called without argument, it returns active mode without modifying it.</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id971648117815981"><emph>Enable</emph>: Sets or unsets new compatibility mode when the argument is present.</paragraph> + <note id="par_id371648123169691"><literal>CompatibilityMode</literal> function relates to <link href="text/sbasic/shared/03103350.xhp#vbasupportstatement" name="VBASupport compiler option">Option VBASupport 1</link>, in which case it always returns <literal>True</literal>. It is unrelated to <link href="text/sbasic/shared/compatible.xhp#compatiblestatement" name="Option Compatible compiler directive">Option Compatible</link> compiler directive.</note> + + <paragraph role="paragraph" id="N0121">This function may affect or help in the following situations:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id301645018760314" role="listitem">Scoping of variables.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0124">Running <literal>RmDir</literal> command in VBA mode. In VBA only empty directories are removed by <literal>RmDir</literal> while %PRODUCTNAME Basic removes a directory recursively.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0125">Changing behavior of Basic <literal>Dir</literal> command. The directory flag (16) for the <literal>Dir</literal> command means that only directories are returned in %PRODUCTNAME Basic, while in VBA normal files and directories are returned.</paragraph></listitem> + <listitem> + <paragraph id="par_id901639929393688" role="listitem">Color components calculation with the <link href="text/sbasic/shared/03010303.xhp" name="linkred"><literal>Red</literal></link> and <link href="text/sbasic/shared/03010301.xhp" name="linkblue"><literal>Blue</literal></link> functions which <emph>are interchanged</emph> (The <link href="text/sbasic/shared/03010302.xhp" name="linkgreen"><literal>Green</literal></link> function is not affected).</paragraph> + </listitem> + </list> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id541561646705787">Given a NOT empty directory at <emph>file:///home/me/Test</emph></paragraph> + <bascode> + <paragraph role="bascode" id="par_id491561646553280" localize="false">Sub RemoveDir</paragraph> + <paragraph role="paragraph" id="par_id731546017105932" localize="false"> MsgBox CompatibilityMode() ' False</paragraph> + <paragraph role="paragraph" id="par_id341645017408891" localize="false"></paragraph> + <paragraph role="bascode" id="par_id771561646565613" localize="false"> CompatibilityMode( True )</paragraph> + <paragraph role="bascode" id="par_id311561646572637" localize="false"> RmDir( "file:///home/me/Test" )</paragraph> + <paragraph role="bascode" id="bas_id761645015439188" localize="false"> CompatibilityMode False </paragraph> + <paragraph role="bascode" id="bas_id51645017464045" localize="false"></paragraph> + <paragraph role="paragraph" id="par_id731645017105932" localize="false"> MsgBox CompatibilityMode ' False</paragraph> + <paragraph role="bascode" id="par_id851561646579895" localize="false">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id461561646613414">With <literal>CompatibilityMode( True )</literal> the program raises an error, otherwise the <literal>Test</literal> directory and all its content is deleted.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id411561647797398">Modifying <literal>Dir</literal> behavior</paragraph> + <bascode> + <paragraph role="bascode" id="par_id941561647889938" localize="false">Sub VBADirCommand</paragraph> + <paragraph role="bascode" id="par_id831561647900147" xml-lang="en-US"> CompatibilityMode( Enable := True ) ' Shows also normal files</paragraph> + <paragraph role="bascode" id="par_id931561647920869" localize="false"> Entry$ = Dir( "file:///home/me/Tmp/*.*", 16 )</paragraph> + <paragraph role="bascode" id="par_id31561647939939" localize="false"> Total$ = ""</paragraph> + <paragraph role="bascode" id="par_id71561647964220" localize="false"> While Entry$ <> ""</paragraph> + <paragraph role="bascode" id="par_id51561647969918" localize="false"> Total$ = Total$ + Entry$ + Chr$(13)</paragraph> + <paragraph role="bascode" id="par_id111561647975134" localize="false"> Entry$ = Dir</paragraph> + <paragraph role="bascode" id="par_id751561647979743" localize="false"> Wend</paragraph> + <paragraph role="bascode" id="par_id401561647986945" localize="false"> MsgBox Total$</paragraph> + <paragraph role="bascode" id="bas_id641645017016611" xml-lang="en-US"> CompatibilityMode Enable := False ' Shows only directories</paragraph> + <paragraph role="bascode" id="par_id111561647991525" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/compatible.xhp#compatiblestatement"/> + <embed href="text/sbasic/shared/03090407.xhp#remstatement"/> + <paragraph role="paragraph" id="N0131"> + Variables scope modification in <link href="text/sbasic/shared/01020300.xhp">Using Procedures and Functions</link> with <literal>CompatibilityMode()</literal> function. + </paragraph> + <embed href="text/sbasic/shared/03103200.xhp#optionbasestatement"/> + <embed href="text/sbasic/shared/03103300.xhp#explicitstatement"/> + <embed href="text/sbasic/shared/03103350.xhp#vbasupportstatement"/> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/compatible.xhp b/helpcontent2/source/text/sbasic/shared/compatible.xhp new file mode 100644 index 000000000..271bd2511 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/compatible.xhp @@ -0,0 +1,63 @@ +<?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="text/sbasic/shared/compatible"> + <title id="tit" localize="false" xml-lang="en-US">Option Compatible</title> + <filename>/text/sbasic/shared/compatible.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" localize="false" id="N8803"> + <bookmark_value>Option Compatible</bookmark_value> + </bookmark> + + <section id="optioncompatiblestatement"> + <h1 id="N0104"><variable id="compatiblestatement"><link href="text/sbasic/shared/compatible.xhp" name="compatible">Option Compatible Statement</link></variable></h1> + <paragraph role="paragraph" id="N0106"><literal>Option Compatible</literal> extends %PRODUCTNAME Basic compiler and runtime, allowing supplemental language constructs to Basic.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#beforeexecutable"/> + <paragraph role="paragraph" id="N0107">This option may affect or assist in the following situations:</paragraph> + <list type="unordered"> + <listitem><paragraph role="listitem" id="N0108">Allow special characters as identifiers. all characters that are defined as + letter in the Latin-1 (ISO 8859-1) character set, are accepted + as part of identifiers.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0109">Create <link href="text/sbasic/shared/03040000.xhp#addvbaconstants" name="addvbaconstants">VBA constants including non-printable characters</link>.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0110">Allow the <literal>New</literal> operator to be optional in <literal>Dim</literal> statements.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0112">Allow default values for optional parameters in procedures.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0113">Use named arguments when multiple optional parameters exist.</paragraph></listitem> + <listitem><paragraph role="listitem" id="N0114">Preload of %PRODUCTNAME Basic libraries</paragraph></listitem> + </list> + <note id="N0115"><literal>Option Compatible</literal> is required when coding class modules.</note> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="code" localize="false" id="N0117">Option Compatible</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <h3 id="hd_id231561639199292">Special characters as identifiers</h3> + <bascode> + <paragraph role="bascode" id="par_id661561636654077" localize="false">Option Compatible</paragraph> + <paragraph role="bascode" id="par_id641581846957447">' With this option the code works, otherwise it causes a compiling error</paragraph> + <paragraph role="bascode" id="par_id921561636641311" localize="false">Sub Main</paragraph> + <paragraph role="bascode" id="par_id631561636632573" localize="false"> ä = 10</paragraph> + <paragraph role="bascode" id="par_id101561636625260" localize="false"> print ä</paragraph> + <paragraph role="bascode" id="par_id21561636616652" localize="false">End Sub</paragraph> + </bascode> + <tip id="par_id381561650119146">Statement <literal>Option VBAsupport 1</literal> implies <literal>Option Compatible</literal> statement automatically.</tip> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03090407.xhp#remstatement"/> + <embed href="text/sbasic/shared/compatibilitymode.xhp#compatibilitymodeh1"/> + <embed href="text/sbasic/shared/03103200.xhp#optionbasestatement"/> + <embed href="text/sbasic/shared/03103300.xhp#explicitstatement"/> + <embed href="text/sbasic/shared/03103350.xhp#vbasupportstatement"/> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> + <paragraph role="paragraph" id="N0131">Variables scope modification in <link href="text/sbasic/shared/01020300.xhp">Using Procedures and Functions</link> with <literal>CompatibilityMode()</literal> function.</paragraph> + <paragraph role="paragraph" id="N0129">Refer to <link href="text/sbasic/python/python_platform.xhp">Identifying the Operating System</link> and <link href="text/sbasic/python/python_session.xhp">Getting Session Information</link> for class module examples, or <link href="text/sbasic/guide/access2base.xhp">Access2Base shared Basic library</link> for other class examples making use of <literal>Option Compatible</literal> compiler mode.</paragraph> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/conventions.xhp b/helpcontent2/source/text/sbasic/shared/conventions.xhp new file mode 100644 index 000000000..974db923a --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/conventions.xhp @@ -0,0 +1,70 @@ +<?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.conventions"> + <title id="tit" xml-lang="en-US">Syntax Diagrams</title> + <filename>/text/sbasic/shared/conventions.xhp</filename> + </topic> + </meta> + <body> + <bookmark xml-lang="en-US" branch="index" id="bm_id861593777289558"> + <bookmark_value>Syntax diagrams; How to read</bookmark_value> + <bookmark_value>Statements syntax;How to read</bookmark_value> + <bookmark_value>Typographical conventions</bookmark_value> + </bookmark> + <h1 id="hd_id221543446540070"><link href="text/sbasic/shared/conventions.xhp" name="conventions">How to Read Syntax Diagrams and Statements</link></h1> + <paragraph role="paragraph" id="par_id601593699108443">%PRODUCTNAME Basic statements use syntax diagrams and textual conventions that follow these typographical rules:</paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id158193699546735" role="listitem">%PRODUCTNAME Basic keywords or functions use proper casing: Call, DimArray, InputBox, Property.</paragraph></listitem> + <listitem><paragraph id="par_id711593699548486" role="listitem">Lowercase characters indicate information to supply: end, expression, start, variable.</paragraph></listitem> + </list> + <paragraph role="paragraph" id="par_id881593760345504">The syntax of a %PRODUCTNAME Basic one line statement is illustrated herewith:</paragraph> + + <h2 id="hd_id871593700670279">Diagram example</h2> + <list type="unordered"> + <listitem><paragraph id="par_id181593699574635" role="listitem">Basic statement diagrams start and end with double vertical bars,</paragraph></listitem> + <listitem><paragraph id="par_id711596399548486" role="listitem">Loops indicate a possible repetition, an optional separator may be present,</paragraph></listitem> + <listitem><paragraph id="par_id541593706654897" role="listitem">Rectangles denote subsequent diagram fragments,</paragraph></listitem> + <listitem><paragraph id="par_id251593706717957" role="listitem">Diagram fragments extremities exhibit single vertical bars.</paragraph></listitem> + </list> + <paragraph role="image" id="par_id831588865616326"><image src="media/helpimg/sbasic/a_statement.svg" id="img_id651588865616326"><alt id="alt_id281588865616326">syntax of a statement</alt></image></paragraph> + <paragraph role="paragraph" id="par_id411579301639711">A set of %PRODUCTNAME Basic statements - with optional labels - is using a colon <literal>:</literal> sign to separate them, it can be terminated with an optional comment. <literal>REM</literal> or an apostrophe sign introduce a comment.</paragraph> + <paragraph role="image" id="par_id931593707147102"><image src="media/helpimg/sbasic/comment_fragment.svg" id="img_id191593707147102"><alt id="alt_id111593707147102">diagram fragment</alt></image></paragraph> + + <h2 id="hd_id71593700691968">Textual example</h2> + <section id="Typography"> + <list type="unordered"> + <listitem><paragraph id="par_id181593700546735" role="listitem"><emph>[opt1|opt2|opt3]</emph> Items inside brackets are optional, alternatives are indicated with a vertical bar,</paragraph></listitem> + <listitem><paragraph id="par_id181593699546735" role="listitem"><emph>case[[sep]…]</emph> An ellipsis indicates a possible repetition, an optional separator may be specified,</paragraph></listitem> + <listitem><paragraph id="par_id712593699548486" role="listitem"><emph>{choice1|choice2}</emph> Items inside curly braces are compulsory, alternatives are indicated with a vertical bar.</paragraph></listitem> + </list> + </section> + + <paragraph role="paragraph" id="par_id881593759547050" localize="false"><literal>[ [label:] statement [: …] ] [{REM|'} text]</literal></paragraph> + + <paragraph role="paragraph" id="par_id411593701639711">A set of %PRODUCTNAME Basic statements - with optional labels - is using a colon <literal>:</literal> sign to separate them, it can be terminated with an optional comment. <literal>REM</literal> or an apostrophe sign introduce a comment.</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="N0008" localize="false">Sub Main<br/></paragraph> + <paragraph role="bascode" id="N0018" xml-lang="en-US"> GoTo there ' skip first statement</paragraph> + <paragraph role="bascode" id="N0019" xml-lang="en-US"> here: Print 1, : there: Print 2 REM explanatory text here</paragraph> + <paragraph role="bascode" id="N0021" localize="false">End Sub</paragraph> + </bascode> + + <section id="relatedtopics" > + <embed href="text/sbasic/shared/03090302.xhp#GoToh1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> + <embed href="text/sbasic/shared/03090407.xhp#remstatement"/> + <embed href="text/sbasic/shared/03090409.xhp#Sub_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/enum.xhp b/helpcontent2/source/text/sbasic/shared/enum.xhp new file mode 100644 index 000000000..5781585ae --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/enum.xhp @@ -0,0 +1,70 @@ +<?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.Enum"> + <title id="tit" xml-lang="en-US">Enum Statement</title> + <filename>/text/sbasic/shared/enum.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" xml-lang="en-US" id="N0001"> + <bookmark_value>Enum statement</bookmark_value> + <bookmark_value>constant groups</bookmark_value> + <bookmark_value>enumerations</bookmark_value> + </bookmark> + <section id="enumheading"> + <h1 id="hd_id221543446540070"><link href="text/sbasic/shared/enum.xhp" name="command_name">Enum Statement [VBA]</link></h1> + <paragraph role="paragraph" id="N0003">Define enumerations or non UNO constant groups. An enumeration is a value list that facilitates programming and eases code logic review.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="image" id="par_id831588865616326"> + <image src="media/helpimg/sbasic/Enum_statement.svg" id="img_id651588865616326"><alt id="alt_id281588865616326">Enum syntax</alt></image> + </paragraph> + <bascode> + <paragraph role="bascode" id="par_id931543441922328" localize="false">Enum list_name<br/></paragraph> + <paragraph role="bascode" id="par_id771543441931669" localize="false"> ' Object Statement block</paragraph> + <paragraph role="bascode" id="par_id21543441938004" localize="false">End Enum ' list_name</paragraph> + </bascode> + <h2 id="N0006">Parameters:</h2> + <paragraph role="paragraph" id="N0007">Within a given enumeration, fit together values that logically relate to one another.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="N0008" localize="false">Option VBASupport 1<br/></paragraph> + <paragraph role="bascode" id="N0018" localize="false">Private Enum _WindowManager</paragraph> + <paragraph role="bascode" id="N0019" localize="false"> W1ND0WS = 1 ' Windows</paragraph> + <paragraph role="bascode" id="N0020" localize="false"> OS2PM = 2 ' OS/2 Presentation Manager</paragraph> + <paragraph role="bascode" id="N0021" localize="false"> MACINTOSH = 3 ' Macintosh</paragraph> + <paragraph role="bascode" id="N0022" localize="false"> MOTIF = 4 ' Motif Window Manager / Unix-like</paragraph> + <paragraph role="bascode" id="N0023" localize="false"> OPENLOOK = 5 ' Open Look / Unix-like</paragraph> + <paragraph role="bascode" id="N0024" localize="false">End Enum</paragraph> + <paragraph role="bascode" id="N0027" localize="false">Public Function WindowManager() As Object</paragraph> + <paragraph role="bascode" id="N0028" localize="false"> WindowManager = _WindowManager</paragraph> + <paragraph role="bascode" id="N0029" localize="false">End Function ' <library>.<module>.WindowManager.XXX</paragraph> + </bascode> + <note id="N0030">Enumerated values are rendered to <emph>Long</emph> datatype. Basic functions are public accessors to enumerations. Enumeration names and value names must be unique within a library and across modules.</note> + + <h2 id="N0036">Usage:</h2> + <paragraph role="paragraph" id="N0037">Display WindowManager grouped constant values:</paragraph> + <bascode> + <paragraph role="bascode" id="N0038" localize="false">Dim winMgr As Object : winMgr = <library>.<module>.WindowManager</paragraph> + <paragraph role="bascode" id="N0039" localize="false">With winMgr</paragraph> + <paragraph role="bascode" id="N0040" localize="false"> Print .MACINTOSH, .MOTIF, .OPENLOOK, .OS2PM, .W1ND0WS</paragraph> + <paragraph role="bascode" id="N0041" localize="false">End With</paragraph> + </bascode> + <tip id="par_id731573636687662">Enumerations can be extended to other data types using <link href="text/sbasic/shared/03090413.xhp" name ="Type statement">Type statement</link> definitions. <link href="text/sbasic/guide/basic_2_python.xhp" name ="Calling Python Scripts from Basic">Calling Python Scripts from Basic</link> illustrates that mechanism.</tip> + <section id="relatedtopics" > + <paragraph role="paragraph" id="N0051"><link href="text/sbasic/shared/03100700.xhp" name="const">Const</link> statement, <link href="text/sbasic/shared/01020100.xhp" name ="external">constants</link></paragraph> + <paragraph role="paragraph" id="N0053"><link href="text/sbasic/shared/03103350.xhp" name="Option VBASupport">Option VBASupport</link> statement</paragraph> + <paragraph role="paragraph" id="N0061"><link href="text/sbasic/shared/03090411.xhp" name="With">With</link> statement</paragraph> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/fragments.xhp b/helpcontent2/source/text/sbasic/shared/fragments.xhp new file mode 100644 index 000000000..9da8abd51 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/fragments.xhp @@ -0,0 +1,70 @@ +<?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.sBasic.fragments.en" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Basic syntax diagrams fragments</title> + <filename>/text/sbasic/shared/fragments.xhp</filename> + </topic> + </meta> + <body> + <section id="fragments"> + <h1 id="hd_id541587044867073"><variable id="fragmentsh1"><link href="text/sbasic/shared/fragments.xhp" name="Syntax fragments">Syntax fragments</link></variable></h1> + <paragraph role="paragraph" id="par_id881587044839050">%PRODUCTNAME Basic syntax fragments.</paragraph> + </section> + +<section id="argument"> + <h4 id="hd_id431587045941514"><variable id="argumenth2"><link href="text/sbasic/shared/fragments.xhp" name="arguments in Function, Sub and Property statements"></link>argument fragment</variable></h4> + <paragraph role="paragraph" id="par_id491585753339474"><image src="media/helpimg/sbasic/argument_fragment.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">argument fragment</alt></image></paragraph> + <bascode> + <paragraph role="bascode" id="par_id3151084" localize="false">{[Optional [ByRef|ByVal]]|ParamArray} argument {{As typename|char}[ = expression]|[()]As Variant}</paragraph> + </bascode> + <h4 id="hd_id811587303969210">Parameters</h4> + <paragraph role="paragraph" id="par_id481586090298901"><literal>Optional</literal>: The argument is not mandatory.</paragraph> + <paragraph role="paragraph" id="par_id331586090532804"><literal>ByRef</literal>: The argument is passed by reference. <literal>ByRef</literal> is the default.</paragraph> + <paragraph role="paragraph" id="par_id331586090432804"><literal>ByVal</literal>: The argument is passed by value. Its value can be modified by the called routine.</paragraph> + <paragraph role="paragraph" id="par_id651587044335713"><emph>char:</emph> Type declaration character.</paragraph> + <paragraph role="paragraph" id="par_id651587044336713"><emph>typename</emph>: Primitive data type name. Library or module defined types can also be specified.</paragraph> + <paragraph role="paragraph" id="par_id11587045141290"><emph>= expression</emph>: Specify a default value for the argument, matching its declared type. <literal>Optional</literal> is necessary for each argument specifying a default value.</paragraph> + <paragraph role="paragraph" id="par_id331586091432804"><literal>ParamArray</literal>: Use <literal>ParamArray</literal> when the number of parameters is undetermined. A typical scenario is that of a Calc user-defined function. Using <literal>ParamArray</literal> should be limited to the last argument of a routine.</paragraph> + <tip id="par_id851587050837107">Using<literal>ParamArray</literal> or <emph>= expression</emph> require <link href="text/sbasic/shared/compatible.xhp" name ="Option Compatible">Option Compatible</link> to be placed before the executable program code in a module.</tip> + <warning id="par_id391587571321063">When using <link href="text/sbasic/shared/vbasupport.xhp" name ="Option VBASupport">Option VBASupport 1</link>, <literal>Optional</literal> arguments with no default value (<emph>= expression</emph>) are initialized according to their data type, except if <literal>Variant</literal>.</warning> +</section> + +<section id="array"> + <h4 id="hd_id231587046013456"><variable id="arrayh4"><link href="text/sbasic/shared/fragments.xhp" name="array syntax fragment">array fragment</link></variable></h4> + <paragraph role="paragraph" id="par_id491586753339473"><image src="media/helpimg/sbasic/array_fragment.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">array fragment</alt></image></paragraph> + <bascode> + <paragraph role="bascode" id="par_id3150983" localize="false">( [[start To] end], .. )</paragraph> + </bascode> + <h4 id="hd_id731587304120258">Parameters</h4> + <paragraph role="paragraph" id="par_id951587051619162"><emph>start:</emph> Lower bound of a dimension.</paragraph> + <paragraph role="paragraph" id="par_id951587052619162"><emph>end:</emph> Upper bound of a dimension.</paragraph> + <paragraph role="paragraph" id="par_id961587051702571">Multiple dimensions for an array are denoted using comma (<emph>,</emph>) sign.</paragraph> +</section> + +<section id="typename"> + <h4 id="hd_id231587046013458"><variable id="typenameh4">typename fragment</variable></h4> + <paragraph role="paragraph" id="par_id501586753339474"><image src="media/helpimg/sbasic/typename_fragment.svg" id="img_id4157296484514"><alt xml-lang="en-US" id="alt_id15152796484515">primitive data types fragment</alt></image></paragraph> + <bascode> + <paragraph role="bascode" id="par_id3150985" localize="false">{Boolean|Byte|Currency|Date|Double|Integer|Long|Object|Single|String|Variant}</paragraph> + </bascode> +</section> + +<section id="char"> + <h4 id="hd_id231587046013459"><variable id="charh4">char fragment</variable></h4> + <paragraph role="paragraph" id="par_id511586753339474"><image src="media/helpimg/sbasic/char_fragment.svg" id="img_id4157296484514"><alt xml-lang="en-US" id="alt_id15152796484516">type declaration characters</alt></image></paragraph> + <bascode> + <paragraph role="bascode" id="par_id3150986" localize="false">{ % | & | ! | # | $ | @ }</paragraph> + </bascode> +</section> + +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/is_keyword.xhp b/helpcontent2/source/text/sbasic/shared/is_keyword.xhp new file mode 100644 index 000000000..0724cfe66 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/is_keyword.xhp @@ -0,0 +1,71 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="iskeywordtopic" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Is Operator</title> + <filename>/text/sbasic/shared/is_keyword.xhp</filename> + </topic> +</meta> +<body> + <section id="is_keyword_desc"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3149205"> + <bookmark_value>Is Operator</bookmark_value> + </bookmark> + <h1 id="hd_id791633472607429"><variable id="IsOperator_h1"><link href="text/sbasic/shared/is_keyword.xhp" name="Is_Operator">Is Operator</link></variable></h1> + <paragraph role="paragraph" id="par_id3145090">Tests if two Basic variables refer to the same object instance.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711633530276845"> + <input>result = oObj1 Is oObj2</input> + </paragraph> + <paragraph role="paragraph" id="par_id441633531311929">If <literal>oObj1</literal> and <literal>oObj2</literal> are references to the same object instance, the result will be <emph>True</emph>.</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id771633473462939">The example below first defines a new type <literal>Student</literal>. Calling <literal>TestObjects</literal> creates the object <literal>oStudent1</literal> as a new object of this type.</paragraph> + <paragraph role="paragraph" id="par_id841633532400710">The assignment <literal>oStudent2 = oStudent1</literal> actually copies the reference to the same object. Hence the result of applying the <literal>Is</literal> operator is <emph>True</emph>.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id981633473836933">Type Student</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941633473837598"> FirstName as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941633473837123"> Program as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371633532557876">End Type</paragraph> + <paragraph role="bascode" localize="false" id="bas_id301633532616004"></paragraph> + <paragraph role="bascode" localize="false" id="bas_id481633532558146">Sub TestObjects</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471633532558363"> Dim oStudent1 as new Student</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991633532558572"> Dim oStudent2 as Variant</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181633532558771"> oStudent2 = oStudent1</paragraph> + <paragraph role="bascode" localize="false" id="bas_id891633532558970"> MsgBox Student1 Is Student2 ' True</paragraph> + <paragraph role="bascode" localize="false" id="bas_id501633532559284">End Sub</paragraph> + </bascode> + <paragraph role="paragraph" id="par_id181633473874216">The example below returns <emph>False</emph> because <literal>oStudent1</literal> and <literal>oStudent2</literal> are references to two different object instances, each created with the <literal>New</literal> operator.</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id941633533047593">Sub TestObjects_v2</paragraph> + <paragraph role="bascode" localize="false" id="bas_id981633533047852"> Dim oStudent1 as new Student</paragraph> + <paragraph role="bascode" localize="false" id="bas_id101633533048041"> Dim oStudent2 as new Student</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821633533048265"> MsgBox oStudent1 Is oStudent2 ' False</paragraph> + <paragraph role="bascode" localize="false" id="bas_id451633533048471">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03104600.xhp#EqualUnoObjects_h1"/> + <embed href="text/sbasic/shared/03102800.xhp#IsObject_h1"/> + <embed href="text/sbasic/shared/03090413.xhp#Type_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/keys.xhp b/helpcontent2/source/text/sbasic/shared/keys.xhp new file mode 100644 index 000000000..5dfef6e6c --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/keys.xhp @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicsharedkeysxml" indexer="include" status="PUBLISH"> +<title id="tit" xml-lang="en-US">Keyboard Shortcuts in the Basic IDE</title> +<filename>/text/sbasic/shared/keys.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> +<section id="keys"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3154760"><bookmark_value>keyboard;in IDE</bookmark_value> +<bookmark_value>shortcut keys;Basic IDE</bookmark_value> +<bookmark_value>IDE;keyboard shortcuts</bookmark_value> +</bookmark> +<paragraph role="heading" id="hd_id3154760" xml-lang="en-US" level="1"><link href="text/sbasic/shared/keys.xhp" name="Keyboard Shortcuts in the Basic IDE">Keyboard Shortcuts in the Basic IDE</link></paragraph> +</section> +<paragraph role="paragraph" id="par_id3149655" xml-lang="en-US">In the Basic IDE you can use the following keyboard shortcuts:</paragraph> +<table id="tbl_id3153381"> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3154908" xml-lang="en-US">Action</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablehead" id="par_id3153192" xml-lang="en-US">Keyboard shortcut</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3159254" xml-lang="en-US">Run code starting from the first line, or from the current breakpoint, if the program stopped there before.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3163712" xml-lang="en-US">F5</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3150010" xml-lang="en-US">Stop</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3154319" xml-lang="en-US">Shift+F5</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3151073" xml-lang="en-US">Add <link href="text/sbasic/shared/01050100.xhp" name="watch">watch</link> for the variable at the cursor.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3154731" xml-lang="en-US">F7</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3148455" xml-lang="en-US">Single step through each statement, starting at the first line or at that statement where the program execution stopped before.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3150716" xml-lang="en-US">F8</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3156275" xml-lang="en-US">Single step as with F8, but a function call is considered to be only <emph>one</emph> statement.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3153764" xml-lang="en-US">Shift+F8</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3150323" xml-lang="en-US">Set or remove a <link href="text/sbasic/shared/01030300.xhp" name="breakpoint">breakpoint</link> at the current line or all breakpoints in the current selection.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3147339" xml-lang="en-US">F9</paragraph> +</tablecell> +</tablerow> +<tablerow> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3153963" xml-lang="en-US">Enable/disable the breakpoint at the current line or all breakpoints in the current selection.</paragraph> +</tablecell> +<tablecell colspan="" rowspan=""> +<paragraph role="tablecontent" id="par_id3155175" xml-lang="en-US">Shift+F9</paragraph> +</tablecell> +</tablerow> +</table> + +<paragraph role="paragraph" id="par_id3154702" xml-lang="en-US">A running macro can be aborted with Shift+<switchinline select="sys"><caseinline select="MAC">Command</caseinline><defaultinline>Ctrl</defaultinline></switchinline>+Q, also from outside of the Basic IDE. If you are inside the Basic IDE and the macro halts at a breakpoint, Shift+<switchinline select="sys"><caseinline select="MAC">Command</caseinline><defaultinline>Ctrl</defaultinline></switchinline>+Q stops execution of the macro, but you can recognize this only after the next F5, F8, or Shift+F8.</paragraph> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/main0211.xhp b/helpcontent2/source/text/sbasic/shared/main0211.xhp new file mode 100644 index 000000000..ab420627d --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/main0211.xhp @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!-- + * 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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<helpdocument version="1.0"> +<meta> +<topic id="textsbasicsharedmain0211xml" indexer="include" status="PUBLISH"> +<title xml-lang="en-US" id="tit">Macro Toolbar</title> +<filename>/text/sbasic/shared/main0211.xhp</filename> +</topic> +<history> +<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> +</history> +</meta> +<body> + + + <section id="macro"> + <bookmark id="bm_id3150543" branch="index" xml-lang="en-US"><bookmark_value>toolbars; Basic IDE</bookmark_value><bookmark_value>macro toolbar</bookmark_value></bookmark><!-- removed HID HID_BASICIDE_TOOLBOX --><bookmark branch="hid/.uno:MacroBarVisible" xml-lang="en-US" id="bm_id3153539" localize="false"/><paragraph id="hd_id3150543" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/main0211.xhp" name="Macro Toolbar">Macro Toolbar</link></paragraph> + <paragraph role="paragraph" id="par_id3147288" xml-lang="en-US"><ahelp visibility="visible" hid=".uno:MacroBarVisible">The <emph>Macro Toolbar </emph>contains commands to create, edit, and run macros.</ahelp></paragraph> + </section> + <embed href="text/sbasic/shared/02/11010000.xhp#bibliothek"/> + <embed href="text/sbasic/shared/02/11010000.xhp#sybibliothek"/> + <embed href="text/sbasic/shared/02/11020000.xhp#compile"/> + <embed href="text/sbasic/shared/02/11020000.xhp#sycompile"/> + <embed href="text/sbasic/shared/02/11030000.xhp#run"/> + <embed href="text/sbasic/shared/02/11030000.xhp#syrun"/> + <embed href="text/sbasic/shared/02/11040000.xhp#stop"/> + <embed href="text/sbasic/shared/02/11040000.xhp#systop"/> + <embed href="text/sbasic/shared/02/11060000.xhp#procedure_step"/> + <embed href="text/sbasic/shared/02/11060000.xhp#syprocedure_step"/> + <embed href="text/sbasic/shared/02/11050000.xhp#single_step"/> + <embed href="text/sbasic/shared/02/11050000.xhp#sysingle_step"/> + <embed href="text/sbasic/shared/02/11160000.xhp#stepout"/> + <embed href="text/sbasic/shared/02/11160000.xhp#systepout"/> + <embed href="text/sbasic/shared/02/11070000.xhp#breakpoint"/> + <embed href="text/sbasic/shared/02/11070000.xhp#sybreakpoint"/> + <embed href="text/sbasic/shared/02/11170000.xhp#manage_breakpoints"/> + <embed href="text/sbasic/shared/02/11170000.xhp#sybreakpoints"/> + <embed href="text/sbasic/shared/02/11080000.xhp#watch"/> + <embed href="text/sbasic/shared/02/11080000.xhp#sywatch"/> + <embed href="text/sbasic/shared/02/11090000.xhp#ocatalog"/> + <embed href="text/sbasic/shared/02/11090000.xhp#syobjectcatalog"/> + <embed href="text/sbasic/shared/02/11100000.xhp#macros"/> + <embed href="text/sbasic/shared/02/11100000.xhp#symacros"/> + <embed href="text/sbasic/shared/02/11110000.xhp#module"/> + <embed href="text/sbasic/shared/02/11110000.xhp#symodule"/> + <embed href="text/sbasic/shared/02/11120000.xhp#parentheses"/> + <embed href="text/sbasic/shared/02/11120000.xhp#syparentheses"/> + <embed href="text/sbasic/shared/02/11140000.xhp#insertsource"/> + <embed href="text/sbasic/shared/02/11140000.xhp#syinsertsource"/> + <embed href="text/sbasic/shared/02/11150000.xhp#savesource"/> + <embed href="text/sbasic/shared/02/11150000.xhp#sysavesource"/> + <embed href="text/sbasic/shared/02/11180000.xhp#import"/> + <embed href="text/sbasic/shared/02/11180000.xhp#syimport"/> + <embed href="text/sbasic/shared/02/11190000.xhp#export"/> + <embed href="text/sbasic/shared/02/11190000.xhp#syexport"/> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/main0601.xhp b/helpcontent2/source/text/sbasic/shared/main0601.xhp new file mode 100644 index 000000000..569773563 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/main0601.xhp @@ -0,0 +1,79 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicsharedmain0601xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">$[officename] Basic Help</title> + <filename>/text/sbasic/shared/main0601.xhp</filename> + </topic> +</meta> + +<body> + +<bookmark xml-lang="en-US" branch="hid/HID_GLOBAL_FALLBACK" id="bm_id3143284" localize="false"/> + +<h1 id="hd_id3154232"><variable id="mainsbasic"><link href="text/sbasic/shared/main0601.xhp" name="$[officename] Basic Help">%PRODUCTNAME Basic Help</link></variable></h1> +<embed href="text/shared/06/youtubevideos.xhp#whatisit"/> +<section id="basicalt"> +<paragraph id="par_id3153894" role="paragraph" xml-lang="en-US">%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></paragraph> +<paragraph id="par_id3147226" role="paragraph" xml-lang="en-US">This help section explains the most common functions of %PRODUCTNAME Basic. For more in-depth information please refer to the <link href="https://wiki.documentfoundation.org/Documentation/BASIC_Guide" name="wiki.documentfoundation.org BASIC Guide">OpenOffice.org BASIC Programming Guide</link> on the Wiki.</paragraph> +</section> + +<paragraph id="hd_id3146957" role="heading" level="3" xml-lang="en-US">Working with %PRODUCTNAME Basic</paragraph> +<embed href="text/sbasic/shared/01000000.xhp#doc_title"/> +<embed href="text/sbasic/shared/03000000.xhp#doc_title"/> +<embed href="text/shared/guide/macro_recording.xhp#macro_recording"/> +<embed href="text/sbasic/guide/create_dialog.xhp#create_dialog"/> +<embed href="text/sbasic/guide/insert_control.xhp#insert_control"/> +<embed href="text/sbasic/guide/control_properties.xhp#control_properties"/> +<embed href="text/sbasic/guide/show_dialog.xhp#show_dialog"/> +<embed href="text/sbasic/guide/sample_code.xhp#sample_code"/> +<embed href="text/sbasic/guide/basic_examples.xhp#basicexamplestit"/> + +<paragraph id="hd_id05182017030838384" role="heading" level="3" xml-lang="en-US">Working with VBA Macros</paragraph> +<embed href="text/sbasic/shared/vbasupport.xhp#vbamacros"/> +<embed href="text/sbasic/shared/special_vba_func.xhp#exclusivevba"/> + +<h3 id="hd_id191548155077269">Working with Macros in Python</h3> +<embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/> +<embed href="text/sbasic/python/python_ide.xhp#pythonideh1"/> +<embed href="text/sbasic/python/python_locations.xhp#pythonlocations1"/> +<embed href="text/sbasic/python/python_shell.xhp#pythonshell1"/> +<embed href="text/sbasic/python/python_programming.xhp#pythonprogrammingheading"/> +<embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> +<embed href="text/sbasic/python/python_2_basic.xhp#py2ba_h1"/> + +<paragraph role="heading" id="hd_id51528998827009" level="3" xml-lang="en-US">%PRODUCTNAME internal Basic macro libraries</paragraph> +<paragraph role="paragraph" id="par_id441528998842556" xml-lang="en-US">%PRODUCTNAME installs a set of Basic macro libraries that can be accessed from your Basic macros.</paragraph> +<embed href="text/sbasic/shared/03/lib_tools.xhp#tools_lib"/> +<embed href="text/sbasic/shared/03/lib_depot.xhp#depot_lib"/> +<embed href="text/sbasic/shared/03/lib_euro.xhp#euro_lib"/> +<embed href="text/sbasic/shared/03/lib_formwizard.xhp#formwizard_lib"/> +<embed href="text/sbasic/shared/03/lib_gimmicks.xhp#gimmicks_lib"/> +<embed href="text/sbasic/shared/03/lib_importwiz.xhp#importwiz_lib"/> +<embed href="text/sbasic/shared/03/lib_schedule.xhp#schedule_lib"/> +<embed href="text/sbasic/shared/03/lib_script.xhp#script_lib"/> +<embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#ScriptForge_lib"/> +<embed href="text/sbasic/shared/03/lib_template.xhp#template_lib"/> +<embed href="text/sbasic/shared/03/lib_wikieditor.xhp#wikieditor_lib"/> + +<embed href="text/swriter/main0000.xhp#helpabouthelp"/> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/new_keyword.xhp b/helpcontent2/source/text/sbasic/shared/new_keyword.xhp new file mode 100644 index 000000000..c6df340a4 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/new_keyword.xhp @@ -0,0 +1,78 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + --> + +<meta> + <topic id="newkeywordtopic" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">New Operator</title> + <filename>/text/sbasic/shared/new_keyword.xhp</filename> + </topic> +</meta> +<body> + <section id="new_keyword_desc"> + <bookmark xml-lang="en-US" branch="index" id="bm_id3149205"> + <bookmark_value>New Operator</bookmark_value> + </bookmark> + <h1 id="hd_id791633472607429"><variable id="NewOperator_h1"><link href="text/sbasic/shared/new_keyword.xhp" name="New_Operator">New Operator</link></variable></h1> + <paragraph role="paragraph" id="par_id3145090">Use the <literal>New</literal> operator to instantiate objects of user-defined types, as well as Uno services, structs and enumerations.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" localize="false" id="par_id711633530276845"> + <input>Dim oObj as New ObjectType</input> + </paragraph> + <paragraph role="paragraph" localize="false" id="par_id411633630491643"> + <input>oObj = New ObjectType</input> + </paragraph> + <note id="par_id831633630704012">The <literal>New</literal> operator can be used either during variable declaration or in an assignment operation.</note> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <paragraph role="paragraph" id="par_id621633630563936">The following example uses the <literal>New</literal> operator to create an instance of the <literal>PropertyValue</literal> Uno struct.</paragraph> + <bascode> + <paragraph role="bascode" id="bas_id631633630856218">' Instantiating the object during variable declaration</paragraph> + <paragraph role="bascode" localize="false" id="bas_id801633630856388">Dim oProp1 as New com.sun.star.beans.PropertyValue</paragraph> + <paragraph role="bascode" localize="false" id="bas_id901633630856534">oProp1.Name = "Some name"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id441633630856694">oProp1.Value = 100</paragraph> + <paragraph role="bascode" id="bas_id11633631135918">' The same can be accomplished with an assignment</paragraph> + <paragraph role="bascode" localize="false" id="bas_id821633631136215">Dim oProp2 as Object</paragraph> + <paragraph role="bascode" localize="false" id="bas_id851633631136449">oProp2 = New com.sun.star.beans.PropertyValue</paragraph> + <paragraph role="bascode" localize="false" id="bas_id461633631136636">oProp2.Name = "Other name"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id121633631136838">oProp2.Value = 200</paragraph> + </bascode> + <embed href="text/sbasic/shared/03102100.xhp#optionalNew"/> + <paragraph role="paragraph" id="par_id971633631328827">The example below creates a new type <literal>Student</literal> and instantiates an object of this type:</paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id981633473836933">Type Student</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941633473837598"> FirstName as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id941633473837123"> Program as String</paragraph> + <paragraph role="bascode" localize="false" id="bas_id371633532557876">End Type</paragraph> + <paragraph role="bascode" localize="false" id="bas_id301633532616004"></paragraph> + <paragraph role="bascode" localize="false" id="bas_id481633532558146">Sub TestObjects</paragraph> + <paragraph role="bascode" localize="false" id="bas_id471633532558363"> Dim oStudent1 as New Student</paragraph> + <paragraph role="bascode" localize="false" id="bas_id991633532558572"> oStudent1.FirstName = "John"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id181633532558771"> oStudent2.Program = "Computer Science"</paragraph> + <paragraph role="bascode" localize="false" id="bas_id501633532559284">End Sub</paragraph> + </bascode> + + <section id="relatedtopics"> + <embed href="text/sbasic/shared/03102100.xhp#Dimh1"/> + <embed href="text/sbasic/shared/03132400.xhp#CreateObject_h1"/> + <embed href="text/sbasic/shared/03103700.xhp#Set_h1"/> + <embed href="text/sbasic/shared/03090413.xhp#Type_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/partition.xhp b/helpcontent2/source/text/sbasic/shared/partition.xhp new file mode 100644 index 000000000..617f0d806 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/partition.xhp @@ -0,0 +1,60 @@ +<?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="vbapartition" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Partition Function</title> + <filename>/text/sbasic/shared/partition.xhp</filename> + </topic> + </meta> + <body> + <section id="vbapartition"> + <bookmark xml-lang="en-US" branch="index" id="bm_id31548421805896"> + <bookmark_value>Partition Function</bookmark_value> + </bookmark> + <h1 id="hd_id171548419512929"><link href="text/sbasic/shared/partition.xhp" name="Partition function">Partition Function [VBA]</link></h1> + <paragraph role="paragraph" id="par_id461548419700445">Returns a string indicating where a number occurs within a calculated series of ranges.</paragraph> + </section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="code" id="par_id111548419647867">Partition( Number, Start, End, Interval)</paragraph> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" localize="false" id="par_id971548420129767">String</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id481548420000538"><emph>Number</emph>: Required. The number to determine the partition.</paragraph> + <paragraph role="paragraph" id="par_id841548420006137"><emph>Start</emph>: Required. An integer number defining the lower value of the range of numbers.</paragraph> + <paragraph role="paragraph" id="par_id781548420012105"><emph>End</emph>: Required. An integer number defining the highest value of the range.</paragraph> + <paragraph role="paragraph" id="par_id371548420017250"><emph>Interval</emph>: Required. An integer number that specifies the size of the partitions within the range of numbers (between Start and End).</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id321548420503855" xml-lang="en-US" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="par_id431548420514604" xml-lang="en-US" localize="false">Option Explicit</paragraph> + <paragraph role="bascode" id="par_id181548420522842" xml-lang="en-US" localize="false">Sub Test_Partition</paragraph> + <paragraph role="bascode" id="par_id721548420527861" xml-lang="en-US" localize="false"> Dim retStr As String</paragraph> + <paragraph role="bascode" id="par_id21548420534821" xml-lang="en-US" localize="false"> retStr = Partition(20, 0, 98, 5)</paragraph> + <paragraph role="bascode" id="par_id561548420541509" xml-lang="en-US"> print "20:24 the number 20 occurs in the range: " & retStr</paragraph> + <paragraph role="bascode" id="par_id261548420553088" xml-lang="en-US" localize="false"> retStr = Partition(20, 0, 99, 1)</paragraph> + <paragraph role="bascode" id="par_id161548420558523" xml-lang="en-US"> print " 20: 20 the number 20 occurs in the range: " & retStr</paragraph> + <paragraph role="bascode" id="par_id251548420573894" xml-lang="en-US" localize="false"> retStr = Partition(120, 0, 99, 5)</paragraph> + <paragraph role="bascode" id="par_id561548420579525" xml-lang="en-US"> print "100: the number 120 occurs in the range: " & retStr</paragraph> + <paragraph role="bascode" id="par_id611548420591014" xml-lang="en-US" localize="false"> retStr = Partition(-5, 0, 99, 5)</paragraph> + <paragraph role="bascode" id="par_id921548420596118" xml-lang="en-US"> print " : -1 the number -5 occurs in the range: " & retStr</paragraph> + <paragraph role="bascode" id="par_id561548420604604" xml-lang="en-US" localize="false"> retStr = Partition(2, 0, 5, 2)</paragraph> + <paragraph role="bascode" id="par_id861548420616153" xml-lang="en-US" > print " 2: 3 the number 2 occurs in the range: " & retStr</paragraph> + <paragraph role="bascode" id="par_id841548421054219" xml-lang="en-US" localize="false">End Sub</paragraph> + </bascode> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/00000003.xhp#VBAMath"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/property.xhp b/helpcontent2/source/text/sbasic/shared/property.xhp new file mode 100644 index 000000000..7a72e417e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/property.xhp @@ -0,0 +1,127 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + <meta> + <topic id="text/sbasic/shared/Property"> + <title id="Property Statement" xml-lang="en-US">Property Statement</title> + <filename>/text/sbasic/shared/property.xhp</filename> + </topic> + </meta> + <body> + <bookmark branch="index" id="N0181"> + <bookmark_value>Property statement</bookmark_value> + </bookmark> + + <h1 id="N0182"><variable id="Property_h1"><link href="text/sbasic/shared/Property.xhp" name="Property statement">Property Statement</link></variable></h1> + <paragraph role="paragraph" id="N0183">A property, also called field or attribute, characterizes a given object or piece of information. Properties can be used to control access to data. It is common use to include instructions at setting or reading time of properties. Code can vary from simple assignment to complex context dependent routines. Using <emph>Get</emph>, <emph>Let</emph> or <emph>Set</emph> accessors enforces properties' consistency when necessary.</paragraph> + <warning id="N0184">This statement requires <link href="text/sbasic/shared/compatible.xhp" name ="Option Compatible">Option Compatible</link> to be placed before the executable program code in a module. </warning> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Property-Get_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Property Get Statement diagram</alt></image> + </paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="N0185">[Private | Public] Property Get name[char | As typename]</paragraph> + <paragraph role="bascode" localize="false" id="N0185b">End Property</paragraph> + </bascode> + + <paragraph role="paragraph" id="par_id972787473488701"> + <image src="media/helpimg/sbasic/Property-Set_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Property Set Statement diagram</alt></image> + </paragraph> + <bascode> + <paragraph role="bascode" localize="false" id="N0186">[Private | Public] Property [Let | Set] name[char] [([Optional [ByRef | ByVal]]value[char | As typename])] [As typename]</paragraph> + <paragraph role="bascode" localize="false" id="N0187">End Property</paragraph> + </bascode> + + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id941588582710020"> <emph>name: </emph>The property name.</paragraph> + + <paragraph id="par_id3147229" role="paragraph" xml-lang="en-US"> <emph>argument:</emph> Value to be passed to the <literal>Property</literal> setter routine.</paragraph> + <note id="par_id301588583826717"><literal>Property</literal> setters often use a single argument. Multiple arguments are equally accepted.</note> + + <embed href="text/sbasic/shared/fragments.xhp#argument"/> + <embed href="text/sbasic/shared/fragments.xhp#typename"/> + <embed href="text/sbasic/shared/fragments.xhp#char"/> + + <h2 id="N0188">Examples</h2> + <bascode> + <paragraph role="bascode" localize="false" id="N0189">Option Compatible</paragraph> + <paragraph role="bascode" localize="false" id="N0190">Sub Main</paragraph> + <paragraph role="bascode" localize="false" id="N0191"> ProductName = "Office"</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0192"> Print ProductName ' displays "%PRODUCTNAME"</paragraph> + <paragraph role="bascode" localize="false" id="N0193">End Sub</paragraph> + <paragraph role="bascode" localize="false" id="N0194"></paragraph> + <paragraph role="bascode" localize="false" id="N0195">Private _office As String</paragraph> + <paragraph role="bascode" localize="false" id="N0196">Property Get ProductName As String</paragraph> + <paragraph role="bascode" localize="false" id="N0197"> ProductName = _office</paragraph> + <paragraph role="bascode" localize="false" id="N0198">End Property</paragraph> + <paragraph role="bascode" localize="false" id="N0199">Property Let ProductName(value As String)</paragraph> + <paragraph role="bascode" localize="false" id="N0200"> _office = "Libre"& value</paragraph> + <paragraph role="bascode" localize="false" id="N0201">End Property</paragraph> + </bascode> + <tip id="N0202">In the absence of Property <emph>Let</emph> or Property <emph>Set</emph>, Property <emph>Get</emph> helps define protected information, which can not be accidently altered by a foreign module:</tip> + <bascode> + <paragraph role="bascode" localize="false" id="N0203">Option Compatible</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0204">Public Property Get PathDelimiter As String ' Read-only variable</paragraph> + <paragraph role="bascode" localize="false" id="N0205"> Static this As String</paragraph> + <paragraph role="bascode" localize="false" id="N0206"> If this = "" Then : Select Case GetGuiType()</paragraph> + <paragraph role="bascode" localize="false" id="N0207"> Case 1 : this = ";" ' Windows</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0208"> Case 4 : this = ":" ' Linux or macOS</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0209"> Case Else : Error 423 ' Property or method not defined: PathDelimiter</paragraph> + <paragraph role="bascode" localize="false" id="N0210"> End Select : End If</paragraph> + <paragraph role="bascode" localize="false" id="N0211"> PathDelimiter = this</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0212">End Property ' read-only PathDelimiter</paragraph> + <paragraph role="bascode" localize="false" id="N0213"></paragraph> + <paragraph role="bascode" localize="false" id="N0214">Sub Main</paragraph> + <paragraph role="bascode" xml-lang="en-US" id="N0215"> PathDelimiter = "a sentence" ' does nothing</paragraph> + <paragraph role="bascode" localize="false" id="N0216">End Sub</paragraph> + </bascode> + <note id="N0217">Use <emph>Let</emph> or <emph>Set</emph> when handling UNO services or class objects:</note> + <bascode> + <paragraph role="bascode" localize="false" id="N0218">Option Compatible</paragraph> + <paragraph role="bascode" localize="false" id="N0219">Sub Main</paragraph> + <paragraph role="bascode" localize="false" id="N0220"> 'Set anObject = CreateUnoService( "com.sun.star.frame.Desktop" )</paragraph> + <paragraph role="bascode" localize="false" id="N0221"> anObject = CreateUnoService( "com.sun.star.frame.Desktop" )</paragraph> + <paragraph role="bascode" localize="false" id="N0222"> Print anObject.SupportedServiceNames(0) ' displays "com.sun.star.frame.Frame"</paragraph> + <paragraph role="bascode" localize="false" id="N0223">End Sub</paragraph> + <paragraph role="bascode" localize="false" id="N0224"></paragraph> + <paragraph role="bascode" localize="false" id="N0225">Property Get anObject As Object</paragraph> + <paragraph role="bascode" localize="false" id="N0226"> Set anObject = _obj</paragraph> + <paragraph role="bascode" localize="false" id="N0227">End Property</paragraph> + <paragraph role="bascode" localize="false" id="N0228"></paragraph> + <paragraph role="bascode" localize="false" id="N0229">Private _obj As Object</paragraph> + <paragraph role="bascode" localize="false" id="N0230"></paragraph> + <paragraph role="bascode" localize="false" id="N0231">'Property Set anObject(value As Object)</paragraph> + <paragraph role="bascode" localize="false" id="N0232"> 'Set _obj = value.CurrentFrame</paragraph> + <paragraph role="bascode" localize="false" id="N0233">'End Property</paragraph> + <paragraph role="bascode" localize="false" id="N0234">Property Let anObject(value As Object)</paragraph> + <paragraph role="bascode" localize="false" id="N0235"> Set _obj = value.CurrentFrame</paragraph> + <paragraph role="bascode" localize="false" id="N0236">End Property</paragraph> + </bascode> + <section id="relatedtopics" > + <paragraph role="paragraph" id="par_id181647247913872"><link href="text/sbasic/shared/01010210.xhp" name="Subroutine basics">Subroutines basics</link></paragraph> + <embed href="text/sbasic/shared/01020300.xhp#UsingSubs_h1"/> + <embed href="text/sbasic/shared/03090406.xhp#Function_h1"/> + <embed href="text/sbasic/shared/03090409.xhp#Sub_h1"/> + <paragraph role="paragraph" id="N0237"><link href="text/sbasic/shared/03090404.xhp" name="End">End</link>, <link href="text/sbasic/shared/03090412.xhp" name="Exit">Exit</link> statements</paragraph> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/> + <embed href="text/sbasic/shared/compatible.xhp#compatiblestatement"/> + </section> + </body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/replace.xhp b/helpcontent2/source/text/sbasic/shared/replace.xhp new file mode 100644 index 000000000..091a2f082 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/replace.xhp @@ -0,0 +1,62 @@ +<?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="sbasicsharedreplace" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Replace Function</title> + <filename>/text/sbasic/shared/replace.xhp</filename> + </topic> + </meta> + <body> + <section id="replace"> + <bookmark xml-lang="en-US" branch="index" id="bm_id721552551162491"> + <bookmark_value>Replace function</bookmark_value> + </bookmark> + <h1 id="hd_id781552551013521"><link href="text/sbasic/shared/replace.xhp" name="Replace Function">Replace Function</link></h1> + <paragraph id="par_id291552551013522" role="paragraph">Replaces some string by another.</paragraph> + </section> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <bascode> + <paragraph role="bascode" localize="false" id="bas_id51623159758550">Replace (Expression As String, Find As String, Replace As String [, Start = 1 [, Count = -1 [, Compare = True]]]) As String</paragraph> + </bascode> + <embed href="text/sbasic/shared/01020300.xhp#kwargs"/> + <embed href="text/sbasic/shared/00000003.xhp#functvalue"/> + <paragraph role="paragraph" id="par_id911552552252024">String</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functparameters"/> + <paragraph role="paragraph" id="par_id721552552263062"><emph>Expression:</emph> Any string expression that you want to modify.</paragraph> + <paragraph role="paragraph" id="par_id901552552269836"><emph>Find:</emph> Any string expression that shall be searched for.</paragraph> + <paragraph role="paragraph" id="par_id791552552275383"><emph>Replace:</emph> Any string expression that shall replace the found search string.</paragraph> + <paragraph role="paragraph" id="par_id111552552283060"><emph>Start:</emph> Optional numeric expression that indicates the character position where the search starts and also the start of the substring to be returned.</paragraph> + <paragraph role="paragraph" id="par_id921552552289833"><emph>Count:</emph> Optional maximum number of times the replace shall be performed. When set to -1, all possible replacements are performed.</paragraph> + <paragraph role="paragraph" id="par_id891552552302894"><emph>Compare:</emph> Optional boolean expression that defines the type of comparison. The value of this parameter can be <literal>True</literal> or <literal>False</literal>. The default value of <literal>True</literal> specifies a text comparison that is not case-sensitive. The value of <literal>False</literal> specifies a binary comparison that is case-sensitive. You can as well use 0 instead of <literal>False</literal> or 1 instead of <literal>True</literal>.</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> + <embed href="text/sbasic/shared/00000003.xhp#err5"/> + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + + <bascode> + <paragraph role="bascode" id="par_id991552552420717">MsgBox Replace ("aBbcnnbnn", "b", "$", 1, 1, False) 'returns "aB$cnnbnn"</paragraph> + <paragraph role="bascode" id="par_id321552552440672" xml-lang="en-US">REM meaning: "b" should be replaced, but</paragraph> + <paragraph role="bascode" id="par_id571552552467647" xml-lang="en-US">REM * only when lowercase (compare=False), hence second occurrence of "b"</paragraph> + <paragraph role="bascode" id="par_id71552552474769" xml-lang="en-US">REM * only first (respecting case) occurrence (count=1)</paragraph> + <paragraph role="bascode" id="par_id501587778372566" localize="false">MsgBox Replace ("ABCDEFGHI", "E", "*", 4)</paragraph> + <paragraph role="bascode" id="par_id861587778446685" xml-lang="en-US">REM returns D*FGHI because the search starts at position 4, which is also the start of the returned string.</paragraph> + <paragraph role="bascode" id="bas_id491622734884707" xml-lang="en-US">MsgBox Replace("aBbcnnbnn", "b", "$£", compare:=False) 'returns "aB$£cnn$£nn"</paragraph> + <paragraph role="bascode" id="bas_id341622734993202" xml-lang="en-US">REM Replace all (count = -1) "b" with "$£" respecting casing (compare=False) starting from first letter (start=1) </paragraph> + </bascode> + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id161599082457466" localize="false"><embedvar href="text/sbasic/shared/00000003.xhp#stringfunctions"/></paragraph> + <paragraph role="paragraph" id="par_id361623159933508" localize="false"><embedvar href="text/sbasic/shared/03/sf_string.xhp#StringService"/></paragraph> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/special_vba_func.xhp b/helpcontent2/source/text/sbasic/shared/special_vba_func.xhp new file mode 100644 index 000000000..92e88d44e --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/special_vba_func.xhp @@ -0,0 +1,121 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicsharedspecial_vba_funcxml"> + <title id="tit" xml-lang="en-US">Exclusive VBA functions</title> + <filename>/text/sbasic/shared/special_vba_func.xhp</filename> + </topic> +</meta> + +<body> +<section id="exclusive_vba_functions"> +<bookmark xml-lang="en-US" branch="index" id="bm_id051920170350145208"> +<bookmark_value>VBA Functions;Introduction</bookmark_value> +</bookmark> + +<h1 id="hd_id051820170313205718"><variable id="exclusivevba"><link href="text/sbasic/shared/special_vba_func.xhp">Exclusive VBA Functions and Statements</link></variable></h1> +<paragraph id="par_id051820170314436068" role="paragraph" xml-lang="en-US"><ahelp hid=".">%PRODUCTNAME Basic adds this set of functions when VBA support is enabled.</ahelp></paragraph> +</section> +<paragraph id="hd_id051820170407499827" role="paragraph" xml-lang="en-US">These exclusive VBA functions are enabled when the statement <item type="literal">Option VBASupport 1</item> is placed before the first macro of a %PRODUCTNAME Basic module. </paragraph> + +<section id="vbastatements"> +<bookmark xml-lang="en-US" branch="index" id="bm_id71543455697570"> +<bookmark_value>VBA Statements</bookmark_value> +</bookmark> + <h2 id="hd_id31543446449360">VBA Statements</h2> + <comment> Option Compatible is not a VBA statement, it extends LibreOffice Basic constructs. </comment> + <embed href="text/sbasic/shared/classmodule.xhp#classmodulefunction"/> + <embed href="text/sbasic/shared/03103350.xhp#optionVBASupport"/> + <embed href="text/sbasic/shared/enum.xhp#enumheading"/> +</section> + +<section id="VBAString"> +<bookmark xml-lang="en-US" branch="index" id="bm_id05192017035621676"> +<bookmark_value>VBA Functions;Text Functions</bookmark_value> +</bookmark> +<h2 id="par_id051820170355592834">Text functions</h2> +<embed href="text/sbasic/shared/03120111.xhp#ascw"/> +<embed href="text/sbasic/shared/03120112.xhp#chrw"/> +<embed href="text/sbasic/shared/03120411.xhp#instrrev"/> +<embed href="text/sbasic/shared/03120412.xhp#strreverse"/> +<embed href="text/sbasic/shared/strconv.xhp#vbastrconv"/> +</section> + +<section id="VBAFinancial"> +<bookmark xml-lang="en-US" branch="index" id="bm_id051920170357078705"> +<bookmark_value>VBA Functions;Financial Functions</bookmark_value> +</bookmark> +<h2 id="par_id051820170355592581">Financial functions</h2> +<embed href="text/sbasic/shared/03140000.xhp#ddb"/> +<embed href="text/sbasic/shared/03140001.xhp#fv"/> +<embed href="text/sbasic/shared/03140002.xhp#ipmt"/> +<embed href="text/sbasic/shared/03140003.xhp#irr"/> +<embed href="text/sbasic/shared/03140004.xhp#mirr"/> +<embed href="text/sbasic/shared/03140005.xhp#nper"/> +<embed href="text/sbasic/shared/03140006.xhp#npv"/> +<embed href="text/sbasic/shared/03140007.xhp#pmt"/> +<embed href="text/sbasic/shared/03140008.xhp#ppmt"/> +<embed href="text/sbasic/shared/03140009.xhp#pv"/> +<embed href="text/sbasic/shared/03140010.xhp#rate"/> +<embed href="text/sbasic/shared/03140011.xhp#sln"/> +<embed href="text/sbasic/shared/03140012.xhp#syd"/> +</section> + +<section id="VBADateTime"> +<bookmark xml-lang="en-US" branch="index" id="bm_id051920170358102074"> +<bookmark_value>VBA Functions;Date and Time Functions</bookmark_value> +</bookmark> +<h2 id="par_id051820170356005357">Date and time functions</h2> +<embed href="text/sbasic/shared/03150000.xhp#FormatDateTime"/> +<embed href="text/sbasic/shared/03150002.xhp#MonthName"/> +<embed href="text/sbasic/shared/03150001.xhp#WeekdayName"/> +</section> + +<section id="VBAIO"> +<bookmark xml-lang="en-US" branch="index" id="bm_id051920170358002074"> +<bookmark_value>VBA Functions;I/O Functions</bookmark_value> +</bookmark> + +<h2 id="par_id051820170356006501">I/O Functions</h2> +<embed href="text/sbasic/shared/03160000.xhp#Input"/> +</section> + +<section id="VBAMath"> +<bookmark xml-lang="en-US" branch="index" id="bm_id051920170358346963"> +<bookmark_value>VBA Functions;Mathematical Functions</bookmark_value> +<bookmark_value>VBA Functions;formatting numbers</bookmark_value> +<bookmark_value>VBA Functions;partitioning numbers</bookmark_value> +</bookmark> +<h2 id="par_id051820170356005221">Mathematical Functions</h2> +<embed href="text/sbasic/shared/03170000.xhp#Round"/> +<embed href="text/sbasic/shared/03170010.xhp#formatnumber"/> +<embed href="text/sbasic/shared/partition.xhp#vbapartition"/> +</section> + +<section id="VBAObject"> +<bookmark xml-lang="en-US" branch="index" id="bm_id051920170359045662"> +<bookmark_value>VBA Functions;Object Properties and Methods</bookmark_value> +</bookmark> +<h2 id="hd_id051920170347039686">Object Properties and Methods</h2> +<embed href="text/sbasic/shared/ErrVBA.xhp#VBAErrObject"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/stardesktop.xhp b/helpcontent2/source/text/sbasic/shared/stardesktop.xhp new file mode 100644 index 000000000..fec1efd76 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/stardesktop.xhp @@ -0,0 +1,38 @@ +<?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.StarDesktop" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">StarDesktop object</title> + <filename>/text/sbasic/shared/stardesktop.xhp</filename> + </topic> + </meta> + <body> + + <section id="stardesktop"> + <bookmark branch="index" xml-lang="en-US" id="N0089"> + <bookmark_value>StarDesktop</bookmark_value> + <bookmark_value>API; Desktop</bookmark_value> + </bookmark> + <bookmark id="bm_id341544551916349" xml-lang="en-US" branch="hid/zzzz" localize="false"/> + <h1 id="hd_id401544551916353"><link href="text/sbasic/shared/stardesktop.xhp" name="StarDesktop">StarDesktop object</link></h1> + <paragraph role="paragraph" id="N0091">The <literal>StarDesktop</literal> object represents %PRODUCTNAME application. Some routines or user interface objects such as current window can be used via <literal>StarDesktop</literal>.</paragraph> + </section> + <h2 id="N0092">Example:</h2> + <bascode> + <paragraph role="bascode" id="N0093" localize="false">Dim docURL As String</paragraph> + <paragraph role="bascode" id="N0094" localize="false">Dim doc As Object, docProperties()</paragraph> + <paragraph role="bascode" id="N0095" localize="false">docURL = ConvertToURL("C:\My Documents\example.odt")</paragraph> + <paragraph role="bascode" id="N0096" localize="false">Rem com.sun.star.frame.Desktop</paragraph> + <paragraph role="bascode" id="N0097" localize="false">doc = StarDesktop.LoadComponentFromURL(docURL, "_blank", 0, docProperties)</paragraph> + </bascode> +</body> +</helpdocument> + diff --git a/helpcontent2/source/text/sbasic/shared/strconv.xhp b/helpcontent2/source/text/sbasic/shared/strconv.xhp new file mode 100644 index 000000000..e00a005e0 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/strconv.xhp @@ -0,0 +1,181 @@ +<?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="strconvvbafunc" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">StrConv Function [VBA]</title> + <filename>/text/sbasic/shared/strconv.xhp</filename> + </topic> +</meta> +<body> +<bookmark xml-lang="en-US" branch="index" id="bm_id941622761814292"> +<bookmark_value>StrConv function</bookmark_value> +</bookmark> +<section id="vbastrconv"> + <h1 id="hd_id791622761498015"><link href="text/sbasic/shared/strconv.xhp" name="StrConv Function">StrConv Function</link></h1> + <paragraph id="par_id621622761498018" role="paragraph" xml-lang="en-US"><variable id="variable name">Convert a string as specified by a conversion type.</variable></paragraph> +</section> +<embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="code" id="par_id771622762489917">StrConv(Text, Conversion, [ LCID ])</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functvalue"/> +<paragraph role="paragraph" id="par_id971548420129767" localize="false">String</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph role="paragraph" id="par_id421622762822934"><emph>Text</emph>: Any valid string expression.</paragraph> +<paragraph role="paragraph" id="par_id671622762931475"><emph>Conversion</emph>: The type of conversion to perform, as defined in the table below.</paragraph> +<section id="StrConv_constants"> +<table id="tab_id91622763145456"> + <tablerow> + <tablecell> + <paragraph id="par_id531622763145456" role="tablehead">Conversion</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id131622763145457" role="tablehead">Value</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id411622763145457" role="tablehead">Description</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id721622763145457" role="tablecontent" localize="false">vbUpperCase</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id11622763145458" role="tablecontent" localize="false">1</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id421622763145458" role="tablecontent">Converts <emph>Text</emph> characters to uppercase.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id91622763415122" role="tablecontent" localize="false">vbLowerCase</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911622763415123" role="tablecontent" localize="false">2</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id251622763427976" role="tablecontent" xml-lang="en-US">Converts <emph>Text</emph> characters lowercase.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id1001622764064614" role="tablecontent" localize="false">vbProperCase</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21622764064614" role="tablecontent" localize="false">3</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531622764070154" role="tablecontent" xml-lang="en-US">Converts the first letter of every word in <emph>Text</emph> to uppercase.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id891622764187452" role="tablecontent" localize="false">vbWide</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id471622764187452" role="tablecontent" localize="false">4</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id881622764192628" role="tablecontent" xml-lang="en-US" >Converts narrow (<link href="text/shared/00/00000005.xhp#halfwidth" name="halfwidth">half-width</link>) characters in <emph>Text</emph> to wide (<link href="text/shared/00/00000005.xhp#halfwidth" name="halfwidth">full-width</link>) characters.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id121622764454098" role="tablecontent" localize="false">vbNarrow</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id31622764454099" role="tablecontent" localize="false">8</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id71622764459352" role="paragraph" xml-lang="en-US">Converts wide (<link href="text/shared/00/00000005.xhp#halfwidth" name="halfwidth">full-width</link>) characters in <emph>Text</emph> to narrow (<link href="text/shared/00/00000005.xhp#halfwidth" name="halfwidth">half-width</link>) characters.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id801622764558261" role="tablecontent" localize="false">vbKatakana</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id531622764558262" role="tablecontent" localize="false">16</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id371622764565366" role="tablecontent" xml-lang="en-US" >Converts Hiragana characters in <emph>Text</emph> to Katakana characters.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id771622764721149" role="tablecontent" localize="false">vbHiragana</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id901622764721150" role="tablecontent" localize="false">32</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id911622764728794" role="tablecontent" xml-lang="en-US">Converts Katakana characters in <emph>Text</emph> to Hiragana characters.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id211622764833771" role="tablecontent" localize="false">vbUnicode</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id321622764833772" role="tablecontent" localize="false">64</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id21622764841321" role="tablecontent" xml-lang="en-US">Converts <emph>Text</emph> characters to Unicode characters using the default code page of the system.</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell> + <paragraph id="par_id901622764984846" role="tablecontent" localize="false">vbFromUnicode</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id281622764984846" role="tablecontent" localize="false">128</paragraph> + </tablecell> + <tablecell> + <paragraph id="par_id221622764991492" role="tablecontent" xml-lang="en-US" >Converts <emph>Text</emph> characters from Unicode to the default code page of the system.</paragraph> + </tablecell> + </tablerow> +</table> +</section> +<paragraph role="paragraph" id="par_id761622765118156"><emph>LCID</emph> Optional. The Locale ID in decimal number. If this parameter is omitted, it assumes the system Locale ID. Refer to the file <link href="https://opengrok.libreoffice.org/xref/core/l10ntools/source/ulfconv/msi-encodinglist.txt" name="LCID">msi-encodinglist.txt</link> for the available LCID values.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<bascode> +<paragraph role="bascode" id="par_id321548420503855" xml-lang="en-US" localize="false">Option VBASupport 1</paragraph> +<paragraph role="bascode" id="par_id431548420514604" xml-lang="en-US" localize="false">Option Explicit</paragraph> +<paragraph role="bascode" id="par_id181548420522842" xml-lang="en-US" localize="false">Sub Test_StrConv</paragraph> + <paragraph role="bascode" id="par_id251622770431375" xml-lang="en-US" localize="false">Print StrConv("abc EFG hij", vbUpperCase) '= "ABC EFG HIJ"</paragraph> + <paragraph role="bascode" id="par_id321622770438020" xml-lang="en-US" localize="false">Print StrConv("abc EFG hij", vbLowerCase) ' = "abc efg hij"</paragraph> + <paragraph role="bascode" id="par_id271622770442247" xml-lang="en-US" localize="false">Print StrConv("abc EFG hij", vbProperCase) ' = "Abc Efg Hij"</paragraph> + + <paragraph role="bascode" id="par_id311622770486052" xml-lang="en-US">REM Converts narrow (single-byte) characters in string to wide</paragraph> + <paragraph role="bascode" id="par_id31622770457020" xml-lang="en-US" localize="false">Print StrConv("ABCDEVB¥ì¥¹¥¥å©", vbWide) ' = "ＡＢＣＤＥＶＢ￥ì￥¹￥￥å©"</paragraph> + + <paragraph role="bascode" id="par_id231622770493491" xml-lang="en-US">REM Converts wide (double-byte) characters in string to narrow (single-byte) characters</paragraph> + <paragraph role="bascode" id="par_id371622770464200" xml-lang="en-US" localize="false">Print StrConv("ＡＢＣＤ＠＄％２３＇？ＥＧ", vbNarrow) ' = "ABCD@$%23'?EG"</paragraph> + + <paragraph role="bascode" id="par_id871622770498992" xml-lang="en-US">REM Converts Hiragana characters in string to Katakana characters</paragraph> + <paragraph role="bascode" id="par_id291622770470204" xml-lang="en-US" localize="false">Print StrConv("かたかな", vbKatakana) ' = "カタカナ"</paragraph> + + <paragraph role="bascode" id="par_id351622770504087" xml-lang="en-US">REM Converts Katakana characters in string to Hiragana characters</paragraph> + <paragraph role="bascode" id="par_id601622770474346" xml-lang="en-US" localize="false">Print StrConv("カタカナ", vbHiragana) '= "かたかな"</paragraph> + + <paragraph role="bascode" id="par_id861622770508875" xml-lang="en-US">REM Assumes CP-1252 encoding associated with en-US locale used in unit tests.</paragraph> + <paragraph role="bascode" id="par_id481622770521394" xml-lang="en-US" localize="false">Dim x() As Byte</paragraph> + <paragraph role="bascode" id="par_id691622770750591" xml-lang="en-US" localize="false">x = StrConv("ÉϺ£ÊÐABC", vbFromUnicode)</paragraph> + <paragraph role="bascode" id="par_id841622770962002" xml-lang="en-US">Print UBound(x) ' 8 characters</paragraph> + <paragraph role="bascode" id="par_id931622770966903" xml-lang="en-US" localize="false">Print x(2) ' = 186</paragraph> + <paragraph role="bascode" id="par_id91622770974484" xml-lang="en-US" localize="false">Print StrConv(x, vbUnicode)' = "ÉϺ£ÊÐABC"</paragraph> +<paragraph role="bascode" id="par_id121622772546703" xml-lang="en-US" localize="false">End Sub</paragraph> +</bascode> +<section id="relatedtopics"> + <embed href="text/sbasic/shared/special_vba_func.xhp#exclusivevba"/> +</section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/thisdbdoc.xhp b/helpcontent2/source/text/sbasic/shared/thisdbdoc.xhp new file mode 100644 index 000000000..8f4a1c61c --- /dev/null +++ b/helpcontent2/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/helpcontent2/source/text/sbasic/shared/uno_objects.xhp b/helpcontent2/source/text/sbasic/shared/uno_objects.xhp new file mode 100644 index 000000000..1916fa279 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/uno_objects.xhp @@ -0,0 +1,59 @@ +<?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="unoobjects" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">UNO Objects</title> + <filename>/text/sbasic/shared/uno_objects.xhp</filename> + </topic> +</meta> +<body> + <bookmark xml-lang="en-US" branch="index" id="bm_id171544787218331"> + <bookmark_value>programming;UNO objects</bookmark_value> + <bookmark_value>UNO objects</bookmark_value> + <bookmark_value>UNO functions</bookmark_value> + </bookmark> + <section id="unoobjects"> + <h1 id="hd_id3156027"><variable id="UnoObjects_h1"><link href="text/sbasic/shared/uno_objects.xhp" name="UnoObjects_help">UNO Objects, Functions and Services</link></variable></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"/> + <embed href="text/sbasic/shared/03132000.xhp#createunolistener"/> + <embed href="text/sbasic/shared/03132300.xhp#createunovalue"/> + <embed href="text/sbasic/shared/03132400.xhp#createobject"/> + <embed href="text/sbasic/shared/03104600.xhp#equalunoobjects"/> + <embed href="text/sbasic/shared/03131600.xhp#createunoservice"/> + <embed href="text/sbasic/shared/03104400.xhp#hasunointerfaces"/> + <embed href="text/sbasic/shared/03104500.xhp#isunostruct"/> + <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> + + <section id="relatedtopics"> + <embed href="text/shared/guide/dev_tools.xhp#DevTools_h1"/> + </section> +</body> +</helpdocument> diff --git a/helpcontent2/source/text/sbasic/shared/vbasupport.xhp b/helpcontent2/source/text/sbasic/shared/vbasupport.xhp new file mode 100644 index 000000000..e07bc4817 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/vbasupport.xhp @@ -0,0 +1,54 @@ +<?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/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> + +<meta> + <topic id="textsbasicsharedvbasupportxml"> + <title id="tit" xml-lang="en-US">Support for VBA Macros</title> + <filename>/text/sbasic/shared/vbasupport.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="support_for_vba_macros"> +<paragraph id="hd_id051720170332046289" role="heading" level="1" xml-lang="en-US"><variable id="vbamacros"><link href="text/sbasic/shared/vbasupport.xhp">Working with VBA Macros</link></variable></paragraph> +<paragraph id="par_id05172017033242490" role="paragraph" xml-lang="en-US"><ahelp hid=".">Visual Basic for Applications (VBA) is an implementation of Microsoft's Visual Basic which is built into all Microsoft Office applications. </ahelp></paragraph> +</section> +<paragraph id="par_id051720170332428854" role="paragraph" xml-lang="en-US">Support for VBA is not complete, but it covers a large portion of the common usage patterns. Most macros use a manageable subset of objects in the Excel API (such as the Range, Worksheet, Workbook, etc.) and the support include those objects, and the most commonly used method/properties of those objects.</paragraph> + +<paragraph id="hd_id051720170350145604" role="heading" level="2" xml-lang="en-US">Loading Microsoft Office documents with executable VBA macros</paragraph> +<paragraph id="par_id051720170350147298" role="paragraph" xml-lang="en-US">Choose <switchinline select="sys"><caseinline select="MAC"><emph>%PRODUCTNAME - Preferences</emph></caseinline><defaultinline><emph>Tools - Options</emph></defaultinline></switchinline><emph> - Load/Save - VBA Properties</emph> and mark the <emph>Executable code</emph> checkbox. Then load or open your document.</paragraph> +<embed href="text/shared/optionen/01130100.xhp#executablecode"/> + +<paragraph id="hd_id051720170400536628" role="heading" level="2" xml-lang="en-US">Running VBA Macros</paragraph> +<paragraph id="par_id051720170400539565" role="paragraph" xml-lang="en-US">Run VBA macros in the same way as %PRODUCTNAME Basic macros.</paragraph> +<paragraph id="par_id051720170407404013" role="warning" xml-lang="en-US">Since support for VBA is not complete, you may have to edit the VBA code and complete the missing support with %PRODUCTNAME Basic objects, statements and functions.</paragraph> + +<paragraph id="hd_id051720170400533411" role="heading" level="2" xml-lang="en-US">Editing VBA Macros</paragraph> +<paragraph id="par_id051720170400532486" role="paragraph" xml-lang="en-US">VBA macros can be edited in the %PRODUCTNAME Basic IDE.</paragraph> + +<section id="relatedtopics"> +<paragraph id="par_id051720171119254111" role="paragraph" xml-lang="en-US"><link href="text/shared/optionen/01130100.xhp">VBA Properties</link></paragraph> +<paragraph id="par_id051720170407401872" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/01030000.xhp">%PRODUCTNAME Basic IDE</link></paragraph> +</section> +</body> + +</helpdocument> |